You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafusion.apache.org by ti...@apache.org on 2026/04/23 22:28:59 UTC
(datafusion-python) branch main updated: Add SKILL.md and enrich package docstring (#1497)
This is an automated email from the ASF dual-hosted git repository.
timsaucer pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-python.git
The following commit(s) were added to refs/heads/main by this push:
new 40309978 Add SKILL.md and enrich package docstring (#1497)
40309978 is described below
commit 40309978c920bd123a4c7b764a2ddfdb97758607
Author: Tim Saucer <ti...@gmail.com>
AuthorDate: Thu Apr 23 18:28:55 2026 -0400
Add SKILL.md and enrich package docstring (#1497)
* Add AGENTS.md and enrich __init__.py module docstring
Add python/datafusion/AGENTS.md as a comprehensive DataFrame API guide
for AI agents and users. It ships with pip automatically (Maturin includes
everything under python-source = "python"). Covers core abstractions,
import conventions, data loading, all DataFrame operations, expression
building, a SQL-to-DataFrame reference table, common pitfalls, idiomatic
patterns, and a categorized function index.
Enrich the __init__.py module docstring from 2 lines to a full overview
with core abstractions, a quick-start example, and a pointer to AGENTS.md.
Closes #1394 (PR 1a)
Co-Authored-By: Claude Opus 4.6 (1M context) <no...@anthropic.com>
* Clarify audience of root vs package AGENTS.md
The root AGENTS.md (symlinked as CLAUDE.md) is for contributors working
on the project. Add a pointer to python/datafusion/AGENTS.md which is
the user-facing DataFrame API guide shipped with the package. Also add
the Apache license header to the package AGENTS.md.
Co-Authored-By: Claude Opus 4.6 (1M context) <no...@anthropic.com>
* Add PR template and pre-commit check guidance to AGENTS.md
Document that all PRs must follow .github/pull_request_template.md and
that pre-commit hooks must pass before committing. List all configured
hooks (actionlint, ruff, ruff-format, cargo fmt, cargo clippy, codespell,
uv-lock) and the command to run them manually.
Co-Authored-By: Claude Opus 4.6 (1M context) <no...@anthropic.com>
* Remove duplicated hook list from AGENTS.md
Let the hooks be discoverable from .pre-commit-config.yaml rather than
maintaining a separate list that can drift.
Co-Authored-By: Claude Opus 4.6 (1M context) <no...@anthropic.com>
* Fix AGENTS.md: Arrow C Data Interface, aggregate filter, fluent example
- Clarify that DataFusion works with any Arrow C Data Interface
implementation, not just PyArrow.
- Show the filter keyword argument on aggregate functions (the idiomatic
HAVING equivalent) instead of the post-aggregate .filter() pattern.
- Update the SQL reference table to show FILTER (WHERE ...) syntax.
- Remove the now-incorrect "Aggregate then filter for HAVING" pitfall.
- Add .collect() to the fluent chaining example so the result is clearly
materialized.
Co-Authored-By: Claude Opus 4.6 (1M context) <no...@anthropic.com>
* Update agents file after working through the first tpc-h query using only the text description
* Add feedback from working through each of the TPC-H queries
* Address Copilot review feedback on AGENTS.md
- Wrap CASE/WHEN method-chain examples in parentheses and assign to a
variable so they are valid Python as shown (Copilot #1, #2).
- Fix INTERSECT/EXCEPT mapping: the default distinct=False corresponds to
INTERSECT ALL / EXCEPT ALL, not the distinct forms. Updated both the
Set Operations section and the SQL reference table to show both the
ALL and distinct variants (Copilot #4).
- Change write_parquet / write_csv / write_json examples to file-style
paths (output.parquet, etc.) to match the convention used in existing
tests and examples. Note that a directory path is also valid for
partitioned output (Copilot #5).
Verified INTERSECT/EXCEPT semantics with a script:
df1.intersect(df2) -> [1, 1, 2] (= INTERSECT ALL)
df1.intersect(df2, distinct=True) -> [1, 2] (= INTERSECT)
Co-Authored-By: Claude Opus 4.6 (1M context) <no...@anthropic.com>
* Use short-form comparisons in AGENTS.md examples
Drop lit() on the RHS of comparison operators since Expr auto-wraps raw
Python values, matching the style the guide recommends (Copilot #3, #6).
Updates examples in the Aggregation, CASE/WHEN, SQL reference table,
Common Pitfalls, Fluent Chaining, and Variables-as-CTEs sections, plus
the __init__.py quick-start snippet. Prose explanations of the rule
(which cite the long form as the thing to avoid) are left unchanged.
Co-Authored-By: Claude Opus 4.6 (1M context) <no...@anthropic.com>
* Move user guide from python/datafusion/AGENTS.md to SKILL.md
The in-wheel AGENTS.md was not a real distribution channel -- no shipping
agent walks site-packages for AGENTS.md files. Moving to SKILL.md at the
repo root, with YAML frontmatter, lets the skill ecosystems (npx skills,
Claude Code plugin marketplaces, community aggregators) discover it.
Update the pointers in the contributor AGENTS.md and the __init__.py
module docstring accordingly. The docstring now references the GitHub
URL since the file no longer ships with the wheel.
Co-Authored-By: Claude Opus 4.7 (1M context) <no...@anthropic.com>
* Address review feedback: doctest, streaming, date/timestamp
- Convert the __init__.py quick-start block to doctest format so it is
picked up by `pytest --doctest-modules` (already the project default),
preventing silent rot.
- Extract streaming into its own SKILL.md subsection with guidance on
when to prefer execute_stream() over collect(), sync and async
iteration, and execute_stream_partitioned() for per-partition streams.
- Generalize the date-arithmetic rule from Date32 to both Date32 and
Date64 (both reject Duration at any precision, both accept
month_day_nano_interval), and note that Timestamp columns differ and
do accept Duration.
- Document the PyArrow-inherited type mapping returned by
to_pydict()/to_pylist(), including the nanosecond fallback to
pandas.Timestamp / pandas.Timedelta and the to_pandas() footgun where
date columns come back as an object dtype.
Co-Authored-By: Claude Opus 4.7 (1M context) <no...@anthropic.com>
* Distinguish user guide from agent reference in module docstring
The docstring pointed readers at SKILL.md as a "comprehensive guide," but
SKILL.md is written in a dense, skill-oriented format for agents — humans
are better served by the online user guide. Put the online docs first as
the primary reference and label the SKILL.md link as the agent reference.
Co-Authored-By: Claude Opus 4.7 (1M context) <no...@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <no...@anthropic.com>
---
AGENTS.md | 34 +-
SKILL.md | 733 ++++++++++++++++++++++++++++++++++++++++++
python/datafusion/__init__.py | 42 ++-
3 files changed, 804 insertions(+), 5 deletions(-)
diff --git a/AGENTS.md b/AGENTS.md
index 86c2e9c3..7d326271 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -17,7 +17,14 @@
under the License.
-->
-# Agent Instructions
+# Agent Instructions for Contributors
+
+This file is for agents working **on** the datafusion-python project (developing,
+testing, reviewing). If you need to **use** the DataFusion DataFrame API (write
+queries, build expressions, understand available functions), see the user-facing
+skill at [`SKILL.md`](SKILL.md).
+
+## Skills
This project uses AI agent skills stored in `.ai/skills/`. Each skill is a directory containing a `SKILL.md` file with instructions for performing a specific task.
@@ -26,6 +33,31 @@ Skills follow the [Agent Skills](https://agentskills.io) open standard. Each ski
- `SKILL.md` — The skill definition with YAML frontmatter (name, description, argument-hint) and detailed instructions.
- Additional supporting files as needed.
+## Pull Requests
+
+Every pull request must follow the template in
+`.github/pull_request_template.md`. The description must include these sections:
+
+1. **Which issue does this PR close?** — Link the issue with `Closes #NNN`.
+2. **Rationale for this change** — Why the change is needed (skip if the issue
+ already explains it clearly).
+3. **What changes are included in this PR?** — Summarize the individual changes.
+4. **Are there any user-facing changes?** — Note any changes visible to users
+ (new APIs, changed behavior, new files shipped in the package, etc.). If
+ there are breaking changes to public APIs, add the `api change` label.
+
+## Pre-commit Checks
+
+Always run pre-commit checks **before** committing. The hooks are defined in
+`.pre-commit-config.yaml` and run automatically on `git commit` if pre-commit
+is installed as a git hook. To run all hooks manually:
+
+```bash
+pre-commit run --all-files
+```
+
+Fix any failures before committing.
+
## Python Function Docstrings
Every Python function must include a docstring with usage examples.
diff --git a/SKILL.md b/SKILL.md
new file mode 100644
index 00000000..9ba1c0ca
--- /dev/null
+++ b/SKILL.md
@@ -0,0 +1,733 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+---
+name: datafusion-python
+description: Use when the user is writing datafusion-python (Apache DataFusion Python bindings) DataFrame or SQL code. Covers imports, data loading, DataFrame operations, expression building, SQL-to-DataFrame mappings, idiomatic patterns, and common pitfalls.
+---
+
+# DataFusion Python DataFrame API Guide
+
+## What Is DataFusion?
+
+DataFusion is an **in-process query engine** built on Apache Arrow. It is not a
+database -- there is no server, no connection string, and no external
+dependencies. You create a `SessionContext`, point it at data (Parquet, CSV,
+JSON, Arrow IPC, Pandas, Polars, or raw Python dicts/lists), and run queries
+using either SQL or the DataFrame API described below.
+
+All data flows through **Apache Arrow**. The canonical Python implementation is
+PyArrow (`pyarrow.RecordBatch` / `pyarrow.Table`), but any library that
+conforms to the [Arrow C Data Interface](https://arrow.apache.org/docs/format/CDataInterface.html)
+can interoperate with DataFusion.
+
+## Core Abstractions
+
+| Abstraction | Role | Key import |
+|---|---|---|
+| `SessionContext` | Entry point. Loads data, runs SQL, produces DataFrames. | `from datafusion import SessionContext` |
+| `DataFrame` | Lazy query builder. Each method returns a new DataFrame. | Returned by context methods |
+| `Expr` | Expression tree node (column ref, literal, function call, ...). | `from datafusion import col, lit` |
+| `functions` | 290+ built-in scalar, aggregate, and window functions. | `from datafusion import functions as F` |
+
+## Import Conventions
+
+```python
+from datafusion import SessionContext, col, lit
+from datafusion import functions as F
+```
+
+## Data Loading
+
+```python
+ctx = SessionContext()
+
+# From files
+df = ctx.read_parquet("path/to/data.parquet")
+df = ctx.read_csv("path/to/data.csv")
+df = ctx.read_json("path/to/data.json")
+
+# From Python objects
+df = ctx.from_pydict({"a": [1, 2, 3], "b": ["x", "y", "z"]})
+df = ctx.from_pylist([{"a": 1, "b": "x"}, {"a": 2, "b": "y"}])
+df = ctx.from_pandas(pandas_df)
+df = ctx.from_polars(polars_df)
+df = ctx.from_arrow(arrow_table)
+
+# From SQL
+df = ctx.sql("SELECT a, b FROM my_table WHERE a > 1")
+```
+
+To make a DataFrame queryable by name in SQL, register it first:
+
+```python
+ctx.register_parquet("my_table", "path/to/data.parquet")
+ctx.register_csv("my_table", "path/to/data.csv")
+```
+
+## DataFrame Operations Quick Reference
+
+Every method returns a **new** DataFrame (immutable/lazy). Chain them fluently.
+
+### Projection
+
+```python
+df.select("a", "b") # preferred: plain names as strings
+df.select(col("a"), (col("b") + 1).alias("b_plus_1")) # use col()/Expr only when you need an expression
+
+df.with_column("new_col", col("a") + lit(10)) # add one column
+df.with_columns(
+ col("a").alias("x"),
+ y=col("b") + lit(1), # named keyword form
+)
+
+df.drop("unwanted_col")
+df.with_column_renamed("old_name", "new_name")
+```
+
+When a column is referenced by name alone, pass the name as a string rather
+than wrapping it in `col()`. Reach for `col()` only when the projection needs
+arithmetic, aliasing, casting, or another expression operation.
+
+**Case sensitivity**: both `select("Name")` and `col("Name")` lowercase the
+identifier. For a column whose real name has uppercase letters, embed double
+quotes inside the string: `select('"MyCol"')` or `col('"MyCol"')`. Without the
+inner quotes the lookup will fail with `No field named mycol`.
+
+### Filtering
+
+```python
+df.filter(col("a") > 10)
+df.filter(col("a") > 10, col("b") == "x") # multiple = AND
+df.filter("a > 10") # SQL expression string
+```
+
+Raw Python values on the right-hand side of a comparison are auto-wrapped
+into literals by the `Expr` operators, so prefer `col("a") > 10` over
+`col("a") > lit(10)`. See the Comparisons section and pitfall #2 for the
+full rule.
+
+### Aggregation
+
+```python
+# GROUP BY a, compute sum(b) and count(*)
+df.aggregate(["a"], [F.sum(col("b")), F.count(col("a"))])
+
+# HAVING equivalent: use the filter keyword on the aggregate function
+df.aggregate(
+ ["region"],
+ [F.sum(col("sales"), filter=col("sales") > 1000).alias("large_sales")],
+)
+```
+
+As with `select()`, group keys can be passed as plain name strings. Reach for
+`col(...)` only when the grouping expression needs arithmetic, aliasing,
+casting, or another expression operation.
+
+Most aggregate functions accept an optional `filter` keyword argument. When
+provided, only rows where the filter expression is true contribute to the
+aggregate.
+
+### Sorting
+
+```python
+df.sort(col("a")) # ascending (default)
+df.sort(col("a").sort(ascending=False)) # descending
+df.sort(col("a").sort(nulls_first=False)) # override null placement
+```
+
+A plain expression passed to `sort()` is already treated as ascending. Only
+reach for `col(...).sort(...)` when you need to override a default (descending
+order or null placement). Writing `col("a").sort(ascending=True)` is redundant.
+
+### Joining
+
+```python
+# Equi-join on shared column name
+df1.join(df2, on="key")
+df1.join(df2, on="key", how="left")
+
+# Different column names
+df1.join(df2, left_on="id", right_on="fk_id", how="inner")
+
+# Expression-based join (supports inequality predicates)
+df1.join_on(df2, col("a") == col("b"), how="inner")
+
+# Semi join: keep rows from left where a match exists in right (like EXISTS)
+df1.join(df2, on="key", how="semi")
+
+# Anti join: keep rows from left where NO match exists in right (like NOT EXISTS)
+df1.join(df2, on="key", how="anti")
+```
+
+Join types: `"inner"`, `"left"`, `"right"`, `"full"`, `"semi"`, `"anti"`.
+
+Inner is the default `how`. Prefer `df1.join(df2, on="key")` over
+`df1.join(df2, on="key", how="inner")` — drop `how=` unless you need a
+non-inner join type.
+
+When the two sides' join columns have different native names, use
+`left_on=`/`right_on=` with the original names rather than aliasing one side
+to match the other — see pitfall #7.
+
+### Window Functions
+
+```python
+from datafusion import WindowFrame
+
+# Row number partitioned by group, ordered by value
+df.window(
+ F.row_number(
+ partition_by=[col("group")],
+ order_by=[col("value")],
+ ).alias("rn")
+)
+
+# Using a Window object for reuse
+from datafusion.expr import Window
+
+win = Window(
+ partition_by=[col("group")],
+ order_by=[col("value").sort(ascending=True)],
+)
+df.select(
+ col("group"),
+ col("value"),
+ F.sum(col("value")).over(win).alias("running_total"),
+)
+
+# With explicit frame bounds
+win = Window(
+ partition_by=[col("group")],
+ order_by=[col("value").sort(ascending=True)],
+ window_frame=WindowFrame("rows", 0, None), # current row to unbounded following
+)
+```
+
+### Set Operations
+
+```python
+df1.union(df2) # UNION ALL (by position)
+df1.union(df2, distinct=True) # UNION DISTINCT
+df1.union_by_name(df2) # match columns by name, not position
+df1.intersect(df2) # INTERSECT ALL
+df1.intersect(df2, distinct=True) # INTERSECT (distinct)
+df1.except_all(df2) # EXCEPT ALL
+df1.except_all(df2, distinct=True) # EXCEPT (distinct)
+```
+
+### Limit and Offset
+
+```python
+df.limit(10) # first 10 rows
+df.limit(10, offset=20) # skip 20, then take 10
+```
+
+### Deduplication
+
+```python
+df.distinct() # remove duplicate rows
+df.distinct_on( # keep first row per group (like DISTINCT ON in Postgres)
+ [col("a")], # uniqueness columns
+ [col("a"), col("b")], # output columns
+ [col("b").sort(ascending=True)], # which row to keep
+)
+```
+
+## Executing and Collecting Results
+
+DataFrames are lazy until you collect.
+
+```python
+df.show() # print formatted table to stdout
+batches = df.collect() # list[pa.RecordBatch]
+arr = df.collect_column("col_name") # pa.Array | pa.ChunkedArray (single column)
+table = df.to_arrow_table() # pa.Table
+pandas_df = df.to_pandas() # pd.DataFrame
+polars_df = df.to_polars() # pl.DataFrame
+py_dict = df.to_pydict() # dict[str, list]
+py_list = df.to_pylist() # list[dict]
+count = df.count() # int
+```
+
+### Date and Timestamp Type Conversion
+
+The Python type returned by `to_pydict()` / `to_pylist()` depends on the Arrow
+column type, and the mapping is inherited from PyArrow:
+
+| Arrow type | Python type returned |
+|---|---|
+| `timestamp(s)` / `(ms)` / `(us)` | `datetime.datetime` |
+| `timestamp(ns)` | `pandas.Timestamp` |
+| `date32` / `date64` | `datetime.date` |
+| `duration(s)` / `(ms)` / `(us)` | `datetime.timedelta` |
+| `duration(ns)` | `pandas.Timedelta` |
+
+The nanosecond-precision fallback to pandas types is the main surprise:
+pandas is not a hard dependency of `datafusion`, but PyArrow reaches for it
+when `datetime.datetime` / `datetime.timedelta` would lose precision (stdlib
+types only go to microseconds). If you need plain stdlib types, cast to a
+coarser unit before collecting, e.g.
+`df.select(col("ts").cast(pa.timestamp("us")))`.
+
+`df.to_pandas()` has its own footgun for dates: pandas has no pure-date dtype,
+so a `date32`/`date64` column comes back as an `object` column of
+`datetime.date` values rather than `datetime64[ns]`. If downstream code
+expects a datetime column, cast on the DataFusion side first:
+`col("ship_date").cast(pa.timestamp("ns"))`.
+
+### Streaming Results
+
+Prefer streaming over `collect()` when the result is too large to materialize
+in memory, when you want to start processing before the query finishes, or
+when you may break out of the loop early. `execute_stream()` pulls one
+`RecordBatch` at a time from the execution plan rather than buffering the
+whole result up front.
+
+```python
+# Single-partition stream; batch is a datafusion.RecordBatch
+stream = df.execute_stream()
+for batch in stream:
+ process(batch.to_pyarrow()) # convert to pa.RecordBatch if needed
+
+# DataFrame is iterable directly (delegates to execute_stream)
+for batch in df:
+ process(batch.to_pyarrow())
+
+# One stream per partition, for parallel consumption
+for stream in df.execute_stream_partitioned():
+ for batch in stream:
+ process(batch.to_pyarrow())
+```
+
+Async iteration is also supported via `async for batch in df: ...` (or
+`df.execute_stream()`), which is useful when batches are interleaved with
+other I/O.
+
+### Writing Results
+
+```python
+df.write_parquet("output.parquet")
+df.write_csv("output.csv")
+df.write_json("output.json")
+```
+
+You can also pass a directory path (e.g., `"output/"`) to write a multi-file
+partitioned output.
+
+## Expression Building
+
+### Column References and Literals
+
+```python
+col("column_name") # reference a column
+lit(42) # integer literal
+lit("hello") # string literal
+lit(3.14) # float literal
+lit(pa.scalar(value)) # PyArrow scalar (preserves Arrow type)
+```
+
+`lit()` accepts PyArrow scalars directly -- prefer this over converting Arrow
+data to Python and back when working with values extracted from query results.
+
+### Arithmetic
+
+```python
+col("price") * col("quantity") # multiplication
+col("a") + lit(1) # addition
+col("a") - col("b") # subtraction
+col("a") / lit(2) # division
+col("a") % lit(3) # modulo
+```
+
+### Date Arithmetic
+
+`Date32` and `Date64` columns both require `Interval` types for arithmetic,
+not `Duration`. Use PyArrow's `month_day_nano_interval` type, which takes a
+`(months, days, nanos)` tuple:
+
+```python
+import pyarrow as pa
+
+# Subtract 90 days from a date column
+col("ship_date") - lit(pa.scalar((0, 90, 0), type=pa.month_day_nano_interval()))
+
+# Subtract 3 months
+col("ship_date") - lit(pa.scalar((3, 0, 0), type=pa.month_day_nano_interval()))
+```
+
+**Important**: `lit(datetime.timedelta(days=90))` creates a `Duration(µs)`
+literal, which is **not** compatible with `Date32`/`Date64` arithmetic
+(`Duration(ms)` and `Duration(ns)` are rejected too). Always use
+`pa.month_day_nano_interval()` for date operations.
+
+**Timestamps behave differently**: `Timestamp` columns *do* accept `Duration`,
+so `col("ts") - lit(datetime.timedelta(days=1))` works. The interval-only
+rule applies specifically to date columns.
+
+### Comparisons
+
+```python
+col("a") > 10
+col("a") >= 10
+col("a") < 10
+col("a") <= 10
+col("a") == "x"
+col("a") != "x"
+col("a") == None # same as col("a").is_null()
+col("a") != None # same as col("a").is_not_null()
+```
+
+Comparison operators auto-wrap the right-hand Python value into a literal,
+so writing `col("a") > lit(10)` is redundant. Drop the `lit()` in
+comparisons. Reach for `lit()` only when auto-wrapping does not apply — see
+pitfall #2.
+
+### Boolean Logic
+
+**Important**: Python's `and`, `or`, `not` keywords do NOT work with Expr
+objects. You must use the bitwise operators:
+
+```python
+(col("a") > 1) & (col("b") < 10) # AND
+(col("a") > 1) | (col("b") < 10) # OR
+~(col("a") > 1) # NOT
+```
+
+Always wrap each comparison in parentheses when combining with `&`, `|`, `~`
+because Python's operator precedence for bitwise operators is different from
+logical operators.
+
+### Null Handling
+
+```python
+col("a").is_null()
+col("a").is_not_null()
+col("a").fill_null(lit(0)) # replace NULL with a value
+F.coalesce(col("a"), col("b")) # first non-null value
+F.nullif(col("a"), lit(0)) # return NULL if a == 0
+```
+
+### CASE / WHEN
+
+```python
+# Simple CASE (matching on a single expression)
+status_label = (
+ F.case(col("status"))
+ .when(lit("A"), lit("Active"))
+ .when(lit("I"), lit("Inactive"))
+ .otherwise(lit("Unknown"))
+)
+
+# Searched CASE (each branch has its own predicate)
+severity = (
+ F.when(col("value") > 100, lit("high"))
+ .when(col("value") > 50, lit("medium"))
+ .otherwise(lit("low"))
+)
+```
+
+### Casting
+
+```python
+import pyarrow as pa
+
+col("a").cast(pa.float64())
+col("a").cast(pa.utf8())
+col("a").cast(pa.date32())
+```
+
+### Aliasing
+
+```python
+(col("a") + col("b")).alias("total")
+```
+
+### BETWEEN and IN
+
+```python
+col("a").between(lit(1), lit(10)) # 1 <= a <= 10
+F.in_list(col("a"), [lit(1), lit(2), lit(3)]) # a IN (1, 2, 3)
+F.in_list(col("a"), [lit(1), lit(2)], negated=True) # a NOT IN (1, 2)
+```
+
+### Struct and Array Access
+
+```python
+col("struct_col")["field_name"] # access struct field
+col("array_col")[0] # access array element (0-indexed)
+col("array_col")[1:3] # array slice (0-indexed)
+```
+
+## SQL-to-DataFrame Reference
+
+| SQL | DataFrame API |
+|---|---|
+| `SELECT a, b` | `df.select("a", "b")` |
+| `SELECT a, b + 1 AS c` | `df.select(col("a"), (col("b") + lit(1)).alias("c"))` |
+| `SELECT *, a + 1 AS c` | `df.with_column("c", col("a") + lit(1))` |
+| `WHERE a > 10` | `df.filter(col("a") > 10)` |
+| `GROUP BY a` with `SUM(b)` | `df.aggregate(["a"], [F.sum(col("b"))])` |
+| `SUM(b) FILTER (WHERE b > 100)` | `F.sum(col("b"), filter=col("b") > 100)` |
+| `ORDER BY a DESC` | `df.sort(col("a").sort(ascending=False))` |
+| `LIMIT 10 OFFSET 5` | `df.limit(10, offset=5)` |
+| `DISTINCT` | `df.distinct()` |
+| `a INNER JOIN b ON a.id = b.id` | `a.join(b, on="id")` |
+| `a LEFT JOIN b ON a.id = b.fk` | `a.join(b, left_on="id", right_on="fk", how="left")` |
+| `WHERE EXISTS (SELECT ...)` | `a.join(b, on="key", how="semi")` |
+| `WHERE NOT EXISTS (SELECT ...)` | `a.join(b, on="key", how="anti")` |
+| `UNION ALL` | `df1.union(df2)` |
+| `UNION` (distinct) | `df1.union(df2, distinct=True)` |
+| `INTERSECT ALL` | `df1.intersect(df2)` |
+| `INTERSECT` (distinct) | `df1.intersect(df2, distinct=True)` |
+| `EXCEPT ALL` | `df1.except_all(df2)` |
+| `EXCEPT` (distinct) | `df1.except_all(df2, distinct=True)` |
+| `CASE x WHEN 1 THEN 'a' END` | `F.case(col("x")).when(lit(1), lit("a")).end()` |
+| `CASE WHEN x > 1 THEN 'a' END` | `F.when(col("x") > 1, lit("a")).end()` |
+| `x IN (1, 2, 3)` | `F.in_list(col("x"), [lit(1), lit(2), lit(3)])` |
+| `x BETWEEN 1 AND 10` | `col("x").between(lit(1), lit(10))` |
+| `CAST(x AS DOUBLE)` | `col("x").cast(pa.float64())` |
+| `ROW_NUMBER() OVER (...)` | `F.row_number(partition_by=[...], order_by=[...])` |
+| `SUM(x) OVER (...)` | `F.sum(col("x")).over(window)` |
+| `x IS NULL` | `col("x").is_null()` |
+| `COALESCE(a, b)` | `F.coalesce(col("a"), col("b"))` |
+
+## Common Pitfalls
+
+1. **Boolean operators**: Use `&`, `|`, `~` -- not Python's `and`, `or`, `not`.
+ Always parenthesize: `(col("a") > 1) & (col("b") < 2)`.
+
+2. **Wrapping scalars with `lit()`**: Prefer raw Python values on the
+ right-hand side of comparisons — `col("a") > 10`, `col("name") == "Alice"`
+ — because the Expr comparison operators auto-wrap them. Writing
+ `col("a") > lit(10)` is redundant. Reserve `lit()` for places where
+ auto-wrapping does *not* apply:
+ - standalone scalars passed into function calls:
+ `F.coalesce(col("a"), lit(0))`, not `F.coalesce(col("a"), 0)`
+ - arithmetic between two literals with no column involved:
+ `lit(1) - col("discount")` is fine, but `lit(1) - lit(2)` needs both
+ - values that must carry a specific Arrow type, via `lit(pa.scalar(...))`
+ - `.when(...)`, `.otherwise(...)`, `F.nullif(...)`, `.between(...)`,
+ `F.in_list(...)` and similar method/function arguments
+
+3. **Column name quoting**: Column names are normalized to lowercase by default
+ in both `select("...")` and `col("...")`. To reference a column with
+ uppercase letters, use double quotes inside the string:
+ `select('"MyColumn"')` or `col('"MyColumn"')`.
+
+4. **DataFrames are immutable**: Every method returns a **new** DataFrame. You
+ must capture the return value:
+ ```python
+ df = df.filter(col("a") > 1) # correct
+ df.filter(col("a") > 1) # WRONG -- result is discarded
+ ```
+
+5. **Window frame defaults**: When using `order_by` in a window, the default
+ frame is `RANGE BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW`. For a full
+ partition frame, set `window_frame=WindowFrame("rows", None, None)`.
+
+6. **Arithmetic on aggregates belongs in a later `select`, not inside
+ `aggregate`**: Each item in the aggregate list must be a single aggregate
+ call (optionally aliased). Combining aggregates with arithmetic inside
+ `aggregate(...)` fails with `Internal error: Invalid aggregate expression`.
+ Alias the aggregates, then compute the combination downstream:
+ ```python
+ # WRONG -- arithmetic wraps two aggregates
+ df.aggregate([], [(lit(100) * F.sum(col("a")) / F.sum(col("b"))).alias("ratio")])
+
+ # CORRECT -- aggregate first, then combine
+ (df.aggregate([], [F.sum(col("a")).alias("num"), F.sum(col("b")).alias("den")])
+ .select((lit(100) * col("num") / col("den")).alias("ratio")))
+ ```
+
+7. **Don't alias a join column to match the other side**: When equi-joining
+ with `on="key"`, renaming the join column on one side via `.alias("key")`
+ in a fresh projection creates a schema where one side's `key` is
+ qualified (`?table?.key`) and the other is unqualified. The join then
+ fails with `Schema contains qualified field name ... and unqualified
+ field name ... which would be ambiguous`. Use `left_on=`/`right_on=` with
+ the native names, or use `join_on(...)` with an explicit equality.
+ ```python
+ # WRONG -- alias on one side produces ambiguous schema after join
+ failed = orders.select(col("o_orderkey").alias("l_orderkey"))
+ li.join(failed, on="l_orderkey") # ambiguous l_orderkey error
+
+ # CORRECT -- keep native names, use left_on/right_on
+ failed = orders.select("o_orderkey")
+ li.join(failed, left_on="l_orderkey", right_on="o_orderkey")
+
+ # ALSO CORRECT -- explicit predicate via join_on
+ # (note: join_on keeps both key columns in the output, unlike on="key")
+ li.join_on(failed, col("l_orderkey") == col("o_orderkey"))
+ ```
+
+## Idiomatic Patterns
+
+### Fluent Chaining
+
+```python
+result = (
+ ctx.read_parquet("data.parquet")
+ .filter(col("year") >= 2020)
+ .select(col("region"), col("sales"))
+ .aggregate(["region"], [F.sum(col("sales")).alias("total")])
+ .sort(col("total").sort(ascending=False))
+ .limit(10)
+)
+result.show()
+```
+
+### Using Variables as CTEs
+
+Instead of SQL CTEs (`WITH ... AS`), assign intermediate DataFrames to
+variables:
+
+```python
+base = ctx.read_parquet("orders.parquet").filter(col("status") == "shipped")
+by_region = base.aggregate(["region"], [F.sum(col("amount")).alias("total")])
+top_regions = by_region.filter(col("total") > 10000)
+```
+
+### Reusing Expressions as Variables
+
+Just like DataFrames, expressions (`Expr`) can be stored in variables and used
+anywhere an `Expr` is expected. This is useful for building up complex
+expressions or reusing a computed value across multiple operations:
+
+```python
+# Build an expression and reuse it
+disc_price = col("price") * (lit(1) - col("discount"))
+df = df.select(
+ col("id"),
+ disc_price.alias("disc_price"),
+ (disc_price * (lit(1) + col("tax"))).alias("total"),
+)
+
+# Use a collected scalar as an expression
+max_val = result_df.collect_column("max_price")[0] # PyArrow scalar
+cutoff = lit(max_val) - lit(pa.scalar((0, 90, 0), type=pa.month_day_nano_interval()))
+df = df.filter(col("ship_date") <= cutoff) # cutoff is already an Expr
+```
+
+**Important**: Do not wrap an `Expr` in `lit()`. `lit()` is for converting
+Python/PyArrow values into expressions. If a value is already an `Expr`, use it
+directly.
+
+### Window Functions for Scalar Subqueries
+
+Where SQL uses a correlated scalar subquery, the idiomatic DataFrame approach
+is a window function:
+
+```sql
+-- SQL scalar subquery
+SELECT *, (SELECT SUM(b) FROM t WHERE t.group = s.group) AS group_total FROM s
+```
+
+```python
+# DataFrame: window function
+win = Window(partition_by=[col("group")])
+df = df.with_column("group_total", F.sum(col("b")).over(win))
+```
+
+### Semi/Anti Joins for EXISTS / NOT EXISTS
+
+```sql
+-- SQL: WHERE EXISTS (SELECT 1 FROM other WHERE other.key = main.key)
+-- DataFrame:
+result = main.join(other, on="key", how="semi")
+
+-- SQL: WHERE NOT EXISTS (SELECT 1 FROM other WHERE other.key = main.key)
+-- DataFrame:
+result = main.join(other, on="key", how="anti")
+```
+
+### Computed Columns
+
+```python
+# Add computed columns while keeping all originals
+df = df.with_column("full_name", F.concat(col("first"), lit(" "), col("last")))
+df = df.with_column("discounted", col("price") * lit(0.9))
+```
+
+## Available Functions (Categorized)
+
+The `functions` module (imported as `F`) provides 290+ functions. Key categories:
+
+**Aggregate**: `sum`, `avg`, `min`, `max`, `count`, `count_star`, `median`,
+`stddev`, `stddev_pop`, `var_samp`, `var_pop`, `corr`, `covar`, `approx_distinct`,
+`approx_median`, `approx_percentile_cont`, `array_agg`, `string_agg`,
+`first_value`, `last_value`, `bit_and`, `bit_or`, `bit_xor`, `bool_and`,
+`bool_or`, `grouping`, `regr_*` (9 regression functions)
+
+**Window**: `row_number`, `rank`, `dense_rank`, `percent_rank`, `cume_dist`,
+`ntile`, `lag`, `lead`, `first_value`, `last_value`, `nth_value`
+
+**String**: `length`, `lower`, `upper`, `trim`, `ltrim`, `rtrim`, `lpad`,
+`rpad`, `starts_with`, `ends_with`, `contains`, `substr`, `substring`,
+`replace`, `reverse`, `repeat`, `split_part`, `concat`, `concat_ws`,
+`initcap`, `ascii`, `chr`, `left`, `right`, `strpos`, `translate`, `overlay`,
+`levenshtein`
+
+`F.substr(str, start)` takes **only two arguments** and returns the tail of
+the string from `start` onward — passing a third length argument raises
+`TypeError: substr() takes 2 positional arguments but 3 were given`. For the
+SQL-style 3-arg form (`SUBSTRING(str FROM start FOR length)`), use
+`F.substring(col("s"), lit(start), lit(length))`. For a fixed-length prefix,
+`F.left(col("s"), lit(n))` is cleanest.
+
+```python
+# WRONG — substr does not accept a length argument
+F.substr(col("c_phone"), lit(1), lit(2))
+# CORRECT
+F.substring(col("c_phone"), lit(1), lit(2)) # explicit length
+F.left(col("c_phone"), lit(2)) # prefix shortcut
+```
+
+**Math**: `abs`, `ceil`, `floor`, `round`, `trunc`, `sqrt`, `cbrt`, `exp`,
+`ln`, `log`, `log2`, `log10`, `pow`, `signum`, `pi`, `random`, `factorial`,
+`gcd`, `lcm`, `greatest`, `least`, sin/cos/tan and inverse/hyperbolic variants
+
+**Date/Time**: `now`, `today`, `current_date`, `current_time`,
+`current_timestamp`, `date_part`, `date_trunc`, `date_bin`, `extract`,
+`to_timestamp`, `to_timestamp_millis`, `to_timestamp_micros`,
+`to_timestamp_nanos`, `to_timestamp_seconds`, `to_unixtime`, `from_unixtime`,
+`make_date`, `make_time`, `to_date`, `to_time`, `to_local_time`, `date_format`
+
+**Conditional**: `case`, `when`, `coalesce`, `nullif`, `ifnull`, `nvl`, `nvl2`
+
+**Array/List**: `array`, `make_array`, `array_agg`, `array_length`,
+`array_element`, `array_slice`, `array_append`, `array_prepend`,
+`array_concat`, `array_has`, `array_has_all`, `array_has_any`, `array_position`,
+`array_remove`, `array_distinct`, `array_sort`, `array_reverse`, `flatten`,
+`array_to_string`, `array_intersect`, `array_union`, `array_except`,
+`generate_series`
+(Most `array_*` functions also have `list_*` aliases.)
+
+**Struct/Map**: `struct`, `named_struct`, `get_field`, `make_map`, `map_keys`,
+`map_values`, `map_entries`, `map_extract`
+
+**Regex**: `regexp_like`, `regexp_match`, `regexp_replace`, `regexp_count`,
+`regexp_instr`
+
+**Hash**: `md5`, `sha224`, `sha256`, `sha384`, `sha512`, `digest`
+
+**Type**: `arrow_typeof`, `arrow_cast`, `arrow_metadata`
+
+**Other**: `in_list`, `order_by`, `alias`, `col`, `encode`, `decode`,
+`to_hex`, `to_char`, `uuid`, `version`, `bit_length`, `octet_length`
diff --git a/python/datafusion/__init__.py b/python/datafusion/__init__.py
index 80dfa2fa..e4972411 100644
--- a/python/datafusion/__init__.py
+++ b/python/datafusion/__init__.py
@@ -15,10 +15,44 @@
# specific language governing permissions and limitations
# under the License.
-"""DataFusion python package.
-
-This is a Python library that binds to Apache Arrow in-memory query engine DataFusion.
-See https://datafusion.apache.org/python for more information.
+"""DataFusion: an in-process query engine built on Apache Arrow.
+
+DataFusion is not a database -- it has no server and no external dependencies.
+You create a :py:class:`SessionContext`, point it at data sources (Parquet, CSV,
+JSON, Arrow IPC, Pandas, Polars, or raw Python dicts/lists), and run queries
+using either SQL or the DataFrame API.
+
+Core abstractions
+-----------------
+- **SessionContext** -- entry point for loading data, running SQL, and creating
+ DataFrames.
+- **DataFrame** -- lazy query builder. Every method returns a new DataFrame;
+ call :py:meth:`~datafusion.dataframe.DataFrame.collect` or a ``to_*``
+ method to execute.
+- **Expr** -- expression tree node for column references, literals, and function
+ calls. Build with :py:func:`col` and :py:func:`lit`.
+- **functions** -- 290+ built-in scalar, aggregate, and window functions.
+
+Quick start
+-----------
+
+>>> from datafusion import SessionContext, col
+>>> from datafusion import functions as F
+>>> ctx = SessionContext()
+>>> df = ctx.from_pydict({"a": [1, 2, 3], "b": [4, 5, 6]})
+>>> result = (
+... df.filter(col("a") > 1)
+... .with_column("total", col("a") + col("b"))
+... .aggregate([], [F.sum(col("total")).alias("grand_total")])
+... )
+>>> result.to_pydict()
+{'grand_total': [16]}
+
+User guide and full documentation: https://datafusion.apache.org/python
+
+AI agent reference (SQL-to-DataFrame mappings, expression-building patterns,
+common pitfalls), written in a dense, skill-oriented format:
+https://github.com/apache/datafusion-python/blob/main/SKILL.md
"""
from __future__ import annotations
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org