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

refactor: split metadata into v2 and v3 modules #2163

Merged
merged 8 commits into from
Sep 12, 2024

Conversation

d-v-b
Copy link
Contributor

@d-v-b d-v-b commented Sep 9, 2024

A clean re-implementation of #2059.

  • Splits metadata.py into metadata/common.py, metadata/v2.py, and metadata/v3.py
  • removes the _v2 or _v3 suffix that adorned quite a few parsing functions.
  • exports ArrayV3Metadata and ArrayV2Metadata from metadata. This might also be a good time to reconsider the names of those two classes, if anyone is bothered by them (ArrayMetadataV2, or V2ArrayMetadata could seem a bit more logical than ArrayV2Metadata).

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/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Copy link
Member

@jhamman jhamman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few nits but this is a really nice improvement. Thanks @d-v-b!

src/zarr/core/metadata/v2.py Outdated Show resolved Hide resolved
src/zarr/core/metadata/v2.py Outdated Show resolved Hide resolved
src/zarr/core/metadata/v2.py Outdated Show resolved Hide resolved
@d-v-b d-v-b merged commit 52d6849 into zarr-developers:v3 Sep 12, 2024
26 checks passed
@d-v-b d-v-b deleted the refactor/metadata-by-zarr-version branch September 12, 2024 18:30
dcherian added a commit to dcherian/zarr-python that referenced this pull request Sep 16, 2024
* v3:
  fix: opening a group with unspecified format finds either v2 or v3 (zarr-developers#2183)
  test: check that store, array, and group classes are serializable  (zarr-developers#2006)
  feature(store): V3 ZipStore (zarr-developers#2078)
  More typing fixes for tests (zarr-developers#2173)
  refactor: split metadata into v2 and v3 modules (zarr-developers#2163)
  Accept dictionaries for `store` argument (zarr-developers#2164)
  Simplify mypy config for tests (zarr-developers#2156)
  Fixed path segment duplication in open_array (zarr-developers#2167)
  Fixed test warnings (zarr-developers#2168)
  chore: update pre-commit hooks (zarr-developers#2165)
  Ensure that store_dict used for empty dicts (zarr-developers#2162)
  Bump pypa/gh-action-pypi-publish from 1.10.0 to 1.10.1 in the actions group (zarr-developers#2160)
dstansby pushed a commit to dstansby/zarr-python that referenced this pull request Sep 17, 2024
* refactor: split metadata into v2 and v3 modules

* add more explicit typeguards

* port fill value normalization from v2

* remove v2 suffix from zarr format parsing

* remove v2 suffix from zarr format parsing
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