Skip to content

feat: expose public type aliases from zarr.types#3886

Open
maxrjones wants to merge 1 commit intozarr-developers:mainfrom
maxrjones:public-types
Open

feat: expose public type aliases from zarr.types#3886
maxrjones wants to merge 1 commit intozarr-developers:mainfrom
maxrjones:public-types

Conversation

@maxrjones
Copy link
Copy Markdown
Member

Many types used in Zarr's public API signatures (e.g. create_array, array indexing) are defined in internal modules like zarr.core.common, zarr.core.array, and zarr.core.indexing. Users who want to type-annotate their own code have to reach into zarr.core.*, which is not a stable API surface. This PR establishes zarr.types as the canonical public module for these types.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.md
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@d-v-b
Copy link
Copy Markdown
Contributor

d-v-b commented Apr 8, 2026

related : #3355, #3284

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.98%. Comparing base (bd23984) to head (a0bff9a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3886   +/-   ##
=======================================
  Coverage   92.98%   92.98%           
=======================================
  Files          87       87           
  Lines       11246    11253    +7     
=======================================
+ Hits        10457    10464    +7     
  Misses        789      789           
Files with missing lines Coverage Δ
src/zarr/types.py 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@maxrjones
Copy link
Copy Markdown
Member Author

related : #3355, #3284

oh, sorry! I should've checked first 🤦‍♂️

@maxrjones maxrjones closed this Apr 8, 2026
@d-v-b
Copy link
Copy Markdown
Contributor

d-v-b commented Apr 8, 2026

no you can keep this one open! that old PR is stale anyways. I just want to make sure we have all the related stuff here, so we can close those when it's resolved

@maxrjones maxrjones reopened this Apr 8, 2026
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