Skip to content

Commit 737d983

Browse files
committed
added helper functions in AGENTS.md
1 parent 7c4bd1e commit 737d983

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

AGENTS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,28 @@ This repository contains Python bindings for Rust's DataFusion.
2222
## Notes
2323
- The repository mixes Python and Rust; ensure changes build for both languages.
2424
- If adding new dependencies, update `pyproject.toml` and run `uv sync --dev --no-install-package datafusion`.
25+
26+
## Helper Functions
27+
- `python/datafusion/io.py` offers global context readers:
28+
- `read_parquet`
29+
- `read_json`
30+
- `read_csv`
31+
- `read_avro`
32+
- `python/datafusion/user_defined.py` exports convenience creators for user-defined functions:
33+
- `udf` (scalar)
34+
- `udaf` (aggregate)
35+
- `udwf` (window)
36+
- `udtf` (table)
37+
- `python/datafusion/col.py` exposes the `Col` helper with `col` and `column` instances for building column expressions using attribute access.
38+
- `python/tests/generic.py` includes utilities for test data generation:
39+
- `data`
40+
- `data_with_nans`
41+
- `data_datetime`
42+
- `data_date32`
43+
- `data_timedelta`
44+
- `data_binary_other`
45+
- `write_parquet`
46+
- `python/tests/conftest.py` defines reusable pytest fixtures:
47+
- `ctx` creates a `SessionContext`.
48+
- `database` registers a sample CSV dataset.
49+
- `src/dataframe.rs` provides the `collect_record_batches_to_display` helper to fetch the first non-empty record batch and flag if more are available.

0 commit comments

Comments
 (0)