Skip to content

Remove id from zarr3 config serialization #685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 17, 2025
Merged

Remove id from zarr3 config serialization #685

merged 5 commits into from
Jan 17, 2025

Conversation

normanrz
Copy link
Member

@normanrz normanrz commented Jan 9, 2025

Removes the "id" attribute from the serialization when used as zarr3 codec, because it is redundant.
Before

{"name": "numcodecs.zfpy", "configuration": {"id": "zfpy", "mode": 3, "precision": 20}}

After:

{"name": "numcodecs.zfpy", "configuration": {"mode": 3, "precision": 20}}

See https://ossci.zulipchat.com/#narrow/channel/423692-Zarr/topic/using.20numcodecs.20codecs.20with.20zarr_format.3D3/near/492599440

TODO:

  • Unit tests and/or doctests in docstrings
  • Tests pass locally
  • Changes documented in docs/release.rst
  • Docs build locally
  • GitHub Actions CI passes
  • Test coverage to 100% (Codecov passes)

@normanrz normanrz self-assigned this Jan 9, 2025
@normanrz normanrz requested a review from dstansby January 9, 2025 09:09
Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.78%. Comparing base (32545ec) to head (17f35b4).
Report is 29 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #685      +/-   ##
==========================================
+ Coverage   99.70%   99.78%   +0.07%     
==========================================
  Files          62       62              
  Lines        2749     2748       -1     
==========================================
+ Hits         2741     2742       +1     
+ Misses          8        6       -2     
Files with missing lines Coverage Δ
numcodecs/json.py 100.00% <ø> (+3.92%) ⬆️
numcodecs/tests/test_zarr3.py 100.00% <100.00%> (ø)
numcodecs/zarr3.py 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

LDeakin added a commit to zarrs/zarrs that referenced this pull request Jan 9, 2025
@dstansby dstansby merged commit 30155c7 into main Jan 17, 2025
44 of 45 checks passed
@normanrz normanrz deleted the normanrz-patch-2 branch January 20, 2025 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants