Require the codec `context` kwarg: remove connection context from the `key` dict

Đang mở
#1,557 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 6 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
54/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
databases

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

stale

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 context only 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 in key and 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.py builds them alongside codec_context; decode_attribute builds {"_config": ...} alongside {"config": ...}. Both halves collapse to the context one, and key reverts to meaning the primary key, as it does everywhere else in DataJoint.
  • Drop the fallback in _extract_context and Codec._codec_config, along with the DeprecationWarning.
  • Drop the capability check. With every supported codec declaring context, _accepts_kwarg(fn, "context") can go and the argument is passed unconditionally. The store_name check 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.

Ngôn ngữ chính
Python
Star
198
Fork
103
Merge trung bình
6 ngày 1 giờ
Pull request đã merge (30 ngày)
10

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của datajoint/datajoint-python

Tất cả issue của datajoint/datajoint-python

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.