Public access to hidden attributes (_job_*, _prov): no reader exists
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- mysql, postgresql, python
調査の方向性
Start with expression.py, heading.py, and the pinned cases in test_hidden_job_metadata.py and test_entry_provenance.py; compare the proposed hidden view with the narrow-reader alternative before choosing an API. Trace matching, projection, joins, restrictions, and insert handling, then run the listed tests on MySQL and PostgreSQL. Done means decoded hidden values are readable without changing default output, joins, restrictions, DDL round-trips, or singleton behavior.
索引モデルが issue の本文から書いたものです。
説明
Platform-managed columns — _job_start_time, _job_duration, _job_version, _prov, _singleton — are stored per row and have no public reader. to_arrays('_job_start_time') and proj('_prov') both raise DataJointError: Attribute '...' not found., because Heading.attributes (heading.py:258-267) excludes hidden names and every accessor derives from it.
reference/specs/job-metadata.md documented to_arrays('_job_start_time', ...) as the access path. That call has never worked; the docs are corrected in datajoint/datajoint-docs#288 to describe the SQL workaround until this lands. Supersedes datajoint-docs#1553.
Deferred out of 2.3.4 deliberately — the mechanism touches query machinery and should not be designed under release pressure.
What works today, so the gap is scoped correctly
Measured on MySQL 8.0, not assumed:
Restrict, string form — & "_prov IS NULL" |
works |
Restrict, mapping form — & {"_prov.system": ...} |
silently returns every row — #1561 |
make_sql(["subject_id", "_prov"]) + decode_attribute |
works, composes with restrictions, decodes JSON to a dict on both backends |
to_arrays('_prov'), proj('_prov'), heading['_prov'] |
raise |
So the missing piece is reading values through a supported surface. Restriction already works in its string form, and a correctly decoded read is reachable today in about six lines — which means the design can be judged on ergonomics and safety rather than on feasibility.
Proposed direction: QueryExpression.hidden
A property returning a copy whose heading also carries the hidden attributes:
Analysis.hidden.to_dicts() # includes _job_* and a decoded _prov
Analysis.hidden.proj('_job_version')
Target.insert(Source.hidden) # INSERT ... SELECT carries them
Returning a copy is what makes it safe: describe(), alter(), diagram and every un-opted query keep the heading they have now.
The invariant
.hidden changes what is selected and returned. It never changes what is matched on. Join and restriction keys must keep coming from the visible set unconditionally. Three findings make that non-negotiable:
expression.py:398,430build theUSINGlist fromheading.names. Hidden namesakes there reproduce exactly the NATURAL JOIN defect the USING clause was introduced to prevent (specs/job-metadata.md, "Excluding Hidden Attributes from Binary Operators").- Hidden attributes never get a lineage row (
lineage.py:366-369skips any column starting with_), soassert_join_compatibility(condition.py:264-289) would raise "lineage missing on one side" for every join of two metadata-bearing tables. condition.py:441selects restriction keys the same way, and that one fails silently.
Where the work is
heading.py— an opt-in flag pluswith_hidden(); an unconditionally-filtered name list for matching;select()(:641) must carry hidden through,join()(:698) must not._attributesalready holds everything with correctjson/uuid/codec/dtypeflags (:499-503), so nothing new is loaded.expression.py— thehiddenproperty (copy idiom at:1507-1516);proj's validator at:572-576.table.py:877-886— theINSERT ... SELECTbranch currently appends_provby name. Generalizing it is tempting but needs thought: copying_singleton, or_job_*from one table to another, is not meaningful. The_prov-specific carry may be correct because it is specific.
Two defects found on this path
expression.py:578-583is a dead validator.next(a for a in mentions if not self.heading.names)tests whether the heading is empty, not whetherais in it. It never fires, for any name.proj(x='_prov')silently drops the column —_provmatchesrename_pattern, bypassing the positional check, andHeading.select's loop never reaches it. No error, no column. Same family as #1561.
The alternative worth taking seriously
Keep hidden attributes fully hidden and add a narrow documented reader instead — a function taking an expression and attribute names, doing the SELECT and decode_attribute itself. It serves the known consumer (provenance-export, which needs _job_version and _prov per row for audit packets) with decoded values and restriction composition, and touches no query machinery.
The case for it is not weak: attributes' filter currently does five distinct jobs — join-key selection, restriction-key selection, output shaping, insert validation, and DDL round-tripping through describe() ↔ prepare_declare ↔ alter. Splitting them is where silent breakage comes from. The case against is that it is a second way to query, outside the algebra.
Decide between them before implementing.
What must not change
| Behavior | Pinned at |
|---|---|
_job_* absent from heading.names and to_dicts() |
test_hidden_job_metadata.py:184-201 |
| Hidden attributes absent from a join result | test_hidden_job_metadata.py:208-224 |
_prov out of heading, fetch, joins |
test_entry_provenance.py:140-152 |
An author cannot write _prov |
test_entry_provenance.py:155-158 |
Config.heading.primary_key == [] for a singleton |
test_declare.py:421 |
describe() omits _singleton |
test_declare.py:477-490 |
| Users cannot declare an underscore attribute | tests/unit/test_declare_hidden_attribute.py |
.hidden would expose _singleton, so primary_key becomes ['_singleton'] in the opted-in view. Correct, but keys() and restriction run off the primary key — verify on a singleton table.
Acceptance
- Reading returns a decoded
_provdict on both MySQL (json) and PostgreSQL (jsonb); backend-consistent decoding is the likeliest thing to break. - Default
to_dicts()byte-identical to today. A * Bwith_job_*on both sides joins on the visible key only, no lineage error.describe()andalter()round-trip unchanged, including a singleton.test_entry_provenance.py's raw-SQL_raw_provhelper is replaced by the new API — that is the real acceptance test.- Also closes the
declare.py:965error message, which tells users to "useproj()" — currently false.
- 主要言語
- Python
- スター
- 197
- フォーク
- 98
- 平均マージ
- 23時間 9分
- マージ済み PR(30日)
- 6
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
datajoint/datajoint-python のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
datajoint/datajoint-python#1539 · コメント 3 件 ·
-
Python 3.15 ships Oct 9 and we cap below it; 3.10 went EOL Oct 1対応中かも @dimitri-yatsenko が 1 日前に担当しました。 オープンenhancement
datajoint/datajoint-python#1569 · 担当者 1 名 ·
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 75/100
datajoint/datajoint-python#1564 ·
-
bug
難易度 4/5 3〜5日 初心者へのやさしさ 68/100
datajoint/datajoint-python#1563 ·
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 75/100
datajoint/datajoint-python#1561 · コメント 1 件 ·
datajoint/datajoint-python の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 3 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
modelcontextprotocol/python-sdk#3648 ·
メンテナーはふだん 1 日以内に返信
-
docs good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
VenetoStato/giorgio#6 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 70/100
EclipseFdn/open-vsx.org#13831 ·
メンテナーはふだん 1 日以内に返信