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

test: check that store, array, and group classes are serializable #2006

Merged
merged 13 commits into from
Sep 14, 2024

Conversation

jhamman
Copy link
Member

@jhamman jhamman commented Jul 2, 2024

This PR adds tests to insure that our store/array/group classes are serializable w/ using pickle and can be reliably roundtripped. This is important for Dask and other libraries that need to be able to share Zarr objects between processes/machines.

A necessary side effect of this work was the creation of a few additional __eq__ methods.

closes #1760

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)

@jhamman jhamman added V3 Related to compatibility with V3 spec tests labels Jul 2, 2024
@jhamman jhamman added this to the 3.0.0 milestone Jul 2, 2024
tests/v3/test_group.py Outdated Show resolved Hide resolved
tests/v3/test_array.py Outdated Show resolved Hide resolved
jhamman and others added 2 commits August 9, 2024 13:54
Co-authored-by: Davis Bennett <davis.v.bennett@gmail.com>
src/zarr/buffer.py Outdated Show resolved Hide resolved
tests/v3/test_array.py Outdated Show resolved Hide resolved
tests/v3/test_group.py Outdated Show resolved Hide resolved
Copy link
Contributor

@d-v-b d-v-b left a comment

Choose a reason for hiding this comment

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

Some typos in the test names but otherwise this looks good to go

@jhamman jhamman merged commit ceb3b36 into zarr-developers:v3 Sep 14, 2024
26 checks passed
@@ -681,152 +680,22 @@ async def test_asyncgroup_update_attributes(store: Store, zarr_format: ZarrForma
assert agroup_new_attributes.attrs == attributes_new


async def test_group_members_async(store: LocalStore | MemoryStore) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

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

@jhamman was this test_group_members_async test moved somewhere, or deliberately removed?

Copy link
Member Author

Choose a reason for hiding this comment

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

Not deliberately removed. Must have been a bad merge conflict resolution. I'll bring it back today. Sorry!

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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tests V3 Related to compatibility with V3 spec
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[v3] Test serialization of arrays and groups
4 participants