Skip to content
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

Update numcodecs tests and docs for zarr-python 3.0 #675

Merged
merged 5 commits into from
Jan 4, 2025
Merged

Conversation

normanrz
Copy link
Member

@normanrz normanrz commented Jan 4, 2025

  • Updates docs with new terms (e.g. compressors, filters, serializer)
  • Overrides _Numcodecs.__repr__ because I was getting bulky names in zarr-python tests (e.g. _make_array_array_codec.<locals>._Codec(codec_name='numcodecs.delta', codec_config={'id': 'delta'})) although the code is setting __name__. Advice appreciated.
  • Change tests to use zarr.create_array and zarr.open_array

TODO:

  • Unit tests and/or doctests in docstrings
  • Tests pass locally
  • Docstrings and API docs for any new/modified user-facing classes and functions
  • Changes documented in docs/release.rst
  • Docs build locally
  • GitHub Actions CI passes
  • Test coverage to 100% (Codecov passes)

@normanrz normanrz requested a review from dstansby January 4, 2025 11:35
@normanrz normanrz self-assigned this Jan 4, 2025
Copy link

codecov bot commented Jan 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.92%. Comparing base (7cdffa1) to head (a2f4b9b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #675       +/-   ##
===========================================
+ Coverage   89.80%   99.92%   +10.12%     
===========================================
  Files          62       62               
  Lines        2747     2754        +7     
===========================================
+ Hits         2467     2752      +285     
+ Misses        280        2      -278     
Files with missing lines Coverage Δ
numcodecs/tests/test_zarr3.py 100.00% <100.00%> (+94.73%) ⬆️
numcodecs/zarr3.py 100.00% <100.00%> (+94.47%) ⬆️

@normanrz normanrz changed the title Update numcodecs tests and docs for zarr-python 3rc1 Update numcodecs tests and docs for zarr-python 3.0 Jan 4, 2025
@dstansby
Copy link
Contributor

dstansby commented Jan 4, 2025

Is this something it would be good to release before zarr-python 3.0? If so I can try and wrap up some other PRs, and do a 0.15 release.

@normanrz
Copy link
Member Author

normanrz commented Jan 4, 2025

Is this something it would be good to release before zarr-python 3.0? If so I can try and wrap up some other PRs, and do a 0.15 release.

That would be nice but not required.

@dstansby dstansby merged commit c5cf0c5 into main Jan 4, 2025
45 checks passed
@dstansby dstansby deleted the zarr3-updates branch January 4, 2025 18:10
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