Make key_source restrict-only: add key_source_restriction, deprecate parent-redefining overrides
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- python
- Área
- data-engineering, databases
Línea de trabajo
Empieza por Autopopulate spec §2 y las páginas how-to referenciadas, y luego sigue populate() y make(key) para entender el comportamiento actual de key_source. Revisa la tarea coordinada de datajoint-docs junto con los requisitos del rollout. Se considera terminado cuando se admite key_source_restriction, las sobrescrituras que redefinen el parent emiten advertencias y la documentación recomienda restriction y el batching master–part.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Summary
Make key_source a restrict-only surface. Today key_source can be overridden freely, including in ways that redefine the parent join — and that is the source of subtle, hard-to-diagnose bugs. Introduce a first-class key_source_restriction that applies a restriction to the default key_source without changing the parents, and steer users (and the docs) toward it.
Background
key_source defaults to the join of the tables referenced by the foreign keys in a computed/imported table's primary key (Autopopulate → Key Source Calculation). populate() iterates over it, passing each key to make(key).
The default is almost always correct. In practice, the only legitimate reason to modify it is to restrict it — compute a subset of the default source (e.g. a completion barrier that fires only when all members of a batch have results). Restricting keeps the parents and the grain intact; each make(key) still receives a fully-formed primary key.
Overriding key_source to redefine the parent join — dropping a parent, adding one, or reconstructing the key from an aggregate — is a different and dangerous operation: it can change or drop primary-key attributes, so make(key) receives a key that is missing attributes or has attributes the table's primary key doesn't declare. The downstream effects (partial inserts, mismatched keys, silent miscomputation) are hard to reason about, and the framework was not designed for it.
Proposal
- Introduce
key_source_restriction— a declared restriction applied to the defaultkey_source. It may be any valid DataJoint restriction, including a restriction by another table (a dependency visible inkey_sourcebut not necessarily as a formal FK edge). The computed source isdefault_key_source & key_source_restriction; the parents and grain are never changed. - Deprecate user-facing redefinition of
key_source. Treatkey_sourceas an internal of the auto-populate machinery. Emit a warning when a subclass overrideskey_sourcein a way that changes the parent join. - Batching is a master–part concern, not a
key_sourceconcern. A run/cohort-level batch should be a master keyed on the batch with per-member results on a part — consistent with the DataJoint 2 rule that an auto-populated table introduces no new dimension (only its parts may). This removes the historical "batch by overridingkey_source" motivation.
Rollout (per the 2026-07-24 design discussion)
- 2.4: add
key_source_restriction; begin warning on parent-redefiningkey_sourceoverrides. - Docs now: remove
key_source-override guidance/recommendations from the documentation; documentkey_source_restrictionas the supported way to narrow a source. - Later: make
key_sourcerestriction-only (the override path removed as a user surface).
Docs task (coordinated)
datajoint-docs: pull any recommendation to override key_source, and document key_source_restriction + the "batch via master–part" guidance. (Autopopulate spec §2 and the how-to pages.)
cc @MilagrosMarin @ttngu207
- Lenguaje dominante
- Python
- Estrellas
- 197
- Forks
- 98
- Merge medio
- 6 d 10 h
- PR fusionados (30 d)
- 4
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de datajoint/datajoint-python
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
datajoint/datajoint-python#1539 · 3 comentarios ·
-
dj.Diagram SVG output is not byte-reproducible: set iteration order leaks into node emission order Abiertobug
Dificultad 3/5 1-2 días Aptitud para principiantes 78/100
datajoint/datajoint-python#1551 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
datajoint/datajoint-python#1550 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
datajoint/datajoint-python#1547 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 52/100
datajoint/datajoint-python#1546 · 1 comentario ·
Todos los issues de datajoint/datajoint-python
Issues similares
-
bug ci good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
documentation
Dificultad 2/5 Medio día Aptitud para principiantes 62/100
inmanta/inmanta-core#10835 ·
-
sponsored
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
opensubtitlescom: moviehash never sent when opensubtitles (.org) is not in the provider list Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
Diaoul/subliminal#1382 ·