Make key_source restrict-only: add key_source_restriction, deprecate parent-redefining overrides
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- python
- Bereich
- data-engineering, databases
Rechercherichtung
Beginne mit der Autopopulate spec §2 und den dort referenzierten How-to-Seiten und verfolge anschließend populate() und make(key), um das aktuelle Verhalten von key_source zu verstehen. Prüfe die koordinierte datajoint-docs-Aufgabe zusammen mit den Anforderungen für den Rollout. Die Aufgabe ist abgeschlossen, wenn key_source_restriction unterstützt wird, Überschreibungen, die das Parent neu definieren, Warnungen ausgeben und die Dokumentation restriction und das master–part-Batching empfiehlt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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
- Vorherrschende Sprache
- Python
- Sterne
- 197
- Forks
- 98
- Ø Merge
- 6 T. 10 Std.
- Gemergte PRs (30 T.)
- 4
Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus datajoint/datajoint-python
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
datajoint/datajoint-python#1539 · 3 Kommentare ·
-
dj.Diagram SVG output is not byte-reproducible: set iteration order leaks into node emission order Offenbug
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 78/100
datajoint/datajoint-python#1551 ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100
datajoint/datajoint-python#1550 ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100
datajoint/datajoint-python#1547 ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 52/100
datajoint/datajoint-python#1546 · 1 Kommentar ·
Alle Issues in datajoint/datajoint-python
Ähnliche Issues
-
documentation help wanted
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 90/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 90/100
simonw/sqlite-utils#872 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100