apache / apache/datafusion-python

Give the two FFI example crates a runnable entry point

Ouverte
#1,727 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
enhancement python
Langage dominant
Python
Étoiles
604
Forks
174
Merge moyen
1 j 7 h
PR mergées (30 j)
4

Description

Neither `datafusion-ffi-example` nor `datafusion-ffi-query-planner-example` has a script you can run. They are 51 and 47 pytest assertions respectively. Meanwhile `user-guide/data-sources.md:219` calls the first one a **"user example"** and sends Python users there from the user guide, and `io/table_provider.md:30` calls it "a complete example". We promise a runnable example and deliver a test suite.

**Precedent:** `examples/tpch/` — the script is the artifact and a pytest keeps it honest. CI already runs `pytest python/tests/_test*.py` in each crate directory (`test.yml:136-150`), so a driver test needs **zero workflow changes**.

Layout per crate: `run_demo.py` at the tree root, parallel to the existing `examples/distributed/run_tpch.py`, and a driver at `python/tests/_test_run_demo.py` that runs it via `subprocess.run([sys.executable, script])` and asserts on anchor lines. Subprocess rather than `import_module` or `runpy`, because it proves the thing being asked for: that it runs standalone with no pytest around it.

Each script should open with an import guard that turns the one real failure mode into an instruction rather than a traceback:

```python
try:
from datafusion_ffi_example import MyTableProvider
except ImportError:
sys.exit("build the extension first:\n uv run maturin develop\nSee README.md.")
```

- [ ] **`datafusion-ffi-example/run_demo.py`** — walk the conformance matrix in numbered sections: table provider, functions, catalog provider, config extension, codec round-trip, then *the same bytes decoded a second time*. That last section is only truthful after the logical-codec sub-issue lands, and it is the one place in the repository where the guide's central rule is demonstrated rather than asserted.
- [ ] **`datafusion-ffi-query-planner-example/run_demo.py`** — print plans, not rows. Planner nesting is understood by seeing the indented tree, and the existing tests assert on plan strings they never show. Cover the logical plan handed to the planner, the physical plan returned, the effect of `SET ffi_query_planner.max_rows`, and two planners nesting. Use `.display_indent()`.
- [ ] **`Role:` header on each tree's README**, so the label survives the click from `examples/README.md`, which already distinguishes the trees but loses the distinction as soon as you follow the link. Three lines: what this tree is, where to go if you are learning the protocol, and how to run it.

**Scope note:** make them runnable, but do not promise `datafusion-ffi-example` reads as a tutorial. It is a coverage matrix — `.ai/skills/check-upstream/SKILL.md:455` instructs adding every new FFI type to it — so it grows under protocol pressure rather than narrative need. The planner crate is single-topic and can carry the stronger claim.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Start with examples/tpch/run_tpch.py, the existing pytest files under python/tests in both FFI crates, and test.yml:136-150 to confirm the test command. Add each root run_demo.py, its subprocess driver with anchor assertions, and the README Role header; done means both scripts run standalone and their driver tests pass, with the second decode section following the logical-codec sub-issue.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python, rust
Domaine
developer-experience, documentation, testing
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
Active
Clarté
Clairement spécifiée
Accessibilité débutants
68/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.