Make examples/ behave like examples: runnable, and consistent with the extension guide

Abierto
#1,723 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
python, rust

Línea de trabajo

Empieza por extension-guide/codecs.md y user-guide/data-sources.md:219; después inspecciona los tres árboles bajo examples/ y datafusion-ffi-example/logical_extension_codec.rs:148. Ejecuta las suites de pytest existentes para establecer sus puntos de entrada actuales. Se considera terminado cuando los ejemplos se puedan ejecutar, el códec lógico ya no dependa de un registro de proveedores global al proceso, la cuarentena del plan físico sea explícita y la guía coincida con el código.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation enhancement

#1721 added examples/distributed as a worked example and, in doing so, exposed two structural problems with the older example trees that the new one throws into relief.

The guide contradicts the code it points at. extension-guide/codecs.md tells authors to encode durable metadata, then spends a paragraph explaining that our own examples do not. Readers copy examples; an example that contradicts the rule beside it is worse than no example. #1719 records the reference-implementation half of this as G9, which examples/distributed/storage-library now satisfies — but the crate a reader is most likely to open first still does the wrong thing.

Two of the three trees have no runnable entry point. datafusion-ffi-example is 13 pytest files and no script; datafusion-ffi-query-planner-example is one pytest file and no script. This is not only an aesthetic problem: user-guide/data-sources.md:219 calls datafusion-ffi-example a "user example" and routes Python users to it from the user guide. They arrive at a test suite.

Investigation while reviewing #1721 found the first problem is smaller and differently shaped than the guide claims. Each item below was checked against the source, not inferred:

  • datafusion-ffi-query-planner-example has no object registry at all — grep -rn "HashMap\|OnceLock\|TOKEN" src/ is empty. It claims node.is::<DistributedExec>() narrowly and writes a fixed durable marker. The guide named it anyway. Corrected in #1721.
  • datafusion-ffi-example's logical codec parks providers in a process-global HashMap, and this is cheaply fixable: it claims MemTable narrowly (logical_extension_codec.rs:148), and a MemTable is fully describable as schema plus batches.
  • datafusion-ffi-example's physical codec parks plans, and this is not fixable here. It is forced by the greedy ForeignExecutionPlan claim, which is load-bearing for upstream defect apache/datafusion#25152 — that is G2 in #1719. Once you claim a node you cannot introspect, parking it is the only remaining option. The work is to make it uncopyable, not to remove it.

So the end state is one quarantined arm carrying an issue number and a delete-when condition, rather than a systemic contradiction.

Decided while planning this: the example trees stay in examples/. Relocating the conformance beds to an integration-tests/ tree was considered and rejected — making them runnable resolves the "these aren't examples" complaint, and a move would churn roughly 40 doc, README, and agent-skill references, none of which any build step validates.

Sub-issues track the pieces. They are ordered: the prose rewrite describes the state the first two produce.

Lenguaje dominante
Python
Estrellas
605
Forks
176
Merge medio
1 d 23 h
PR fusionados (30 d)
8

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de apache/datafusion-python

Todos los issues de apache/datafusion-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.