Require the codec `context` kwarg: remove connection context from the `key` dict
メンテナーはふだん 6 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 54/100
調査の方向性
Start in table.py, decode_attribute, _extract_context, Codec._codec_config, _build_path, and _get_backend; trace where codec_context and config are passed before removing the legacy underscore-key path. Check the four named ecosystem codecs for migration readiness before removing compatibility. Done means supported codecs require context, config is explicit in the path/backend helpers, and the legacy fallback and capability check are gone.
索引モデルが issue の本文から書いたものです。
説明
The breaking half of #1550, deliberately deferred out of #1556 so that 2.3.4 stayed additive.
What 2.3.4 shipped
encode/decode gained an explicit context argument carrying schema, table, field and config. Nothing broke, by three deliberate choices:
- DataJoint passes
contextonly to codecs whose signature declares it, so a codec with the old signature is never offered the argument. - The underscore keys —
_schema,_table,_field,_config— stay inkeyand are still populated. _extract_context(key)still accepts one argument, warning only when it actually falls back to those keys.
The documentation already teaches the new signature as the signature, in both repos, so codecs written from 2.3.4 onward are ready for this.
What this issue removes
- Stop populating the underscore keys.
table.pybuilds them alongsidecodec_context;decode_attributebuilds{"_config": ...}alongside{"config": ...}. Both halves collapse to thecontextone, andkeyreverts to meaning the primary key, as it does everywhere else in DataJoint. - Drop the fallback in
_extract_contextandCodec._codec_config, along with theDeprecationWarning. - Drop the capability check. With every supported codec declaring
context,_accepts_kwarg(fn, "context")can go and the argument is passed unconditionally. Thestore_namecheck stays — that one is genuinely optional.
Worth doing at the same time
Make config a required parameter of _build_path and _get_backend rather than defaulting to None with a global-config fallback. That fallback is what made the original defect silent: omitting config resolved a different store rather than raising, which is how dj-figpack-codecs#6 and dj-canvasxpress-codecs#3 both shipped broken. A required parameter turns that into a TypeError at the call site.
This is the part with real value, and it is why the deprecation window exists.
Migration
For a codec author it is two lines:
# before
def encode(self, value, *, key=None, store_name=None):
schema, table, field, pk = self._extract_context(key)
config = (key or {}).get("_config")
# after
def encode(self, value, *, key=None, context=None, store_name=None):
schema, table, field, pk = self._extract_context(key, context)
config = self._codec_config(key, context)
Before closing
Check the four codecs in the ecosystem — dj-figpack-codecs, dj-canvasxpress-codecs, dj-zarr-codecs, dj-photon-codecs. All four were on the old signature when 2.3.4 was cut; each needs the two-line change above before the legacy path is removed, and a release that requires DataJoint >= 2.4.
- 主要言語
- Python
- スター
- 198
- フォーク
- 103
- 平均マージ
- 6日 1時間
- マージ済み PR(30日)
- 10
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
datajoint/datajoint-python のほかの issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
datajoint/datajoint-python#1703 ·
メンテナーはふだん 6 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
datajoint/datajoint-python#1702 ·
メンテナーはふだん 6 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
datajoint/datajoint-python#1701 ·
メンテナーはふだん 6 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
datajoint/datajoint-python#1691 ·
メンテナーはふだん 6 日以内に返信
-
dependencies needs-discussion
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
datajoint/datajoint-python#1687 ·
メンテナーはふだん 6 日以内に返信
datajoint/datajoint-python の issue をすべて見る
似ている issue
-
needs-triage
難易度 1/5 1〜3時間 初心者へのやさしさ 85/100
gke-labs/kube-agents#6620 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
open-webui/open-webui#34719 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
cognition
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
One non-object JSON record makes the session catalog exit対応中かも @he-yufeng が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
collabnix/awesome-mcp-lists#433 ·
メンテナーはふだん 4 日以内に返信