refactor: bring in types from zarr-metadata#3961
Conversation
|
cc @chuckwondo |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3961 +/- ##
==========================================
- Coverage 93.28% 93.27% -0.01%
==========================================
Files 87 87
Lines 11745 11732 -13
==========================================
- Hits 10956 10943 -13
Misses 789 789
🚀 New features to boost your workflow:
|
| 'google-crc32c>=1.5', | ||
| 'typing_extensions>=4.13', | ||
| 'donfig>=0.8', | ||
| 'zarr-metadata>=0.1.1', |
There was a problem hiding this comment.
So development of these packages will proceed entirely independently and one is not developed against another? Or is there a secrete setting somewhere that enables this to be linked?
There was a problem hiding this comment.
can you explain what you mean? zarr-metadata is on pypi, which is how we expect people who install zarr-python to get that package. zarr-metadata will be developed with the goal of primarily supporting zarr-python, and when new versions of zarr-metadata are released, we would update zarr-python to depend on them.
There was a problem hiding this comment.
My concern is that without an upper bound, something could be developed in zarr-metadata that breaks zarr-python. So maybe it makes sense to have a hatch job added to the test suite that tests zarr-python against what is in zarr-metadata?
There was a problem hiding this comment.
yeah that's a good idea! this should run whenever we make changes to zarr-metadata. I'll add that to this PR.
There was a problem hiding this comment.
i made a few changes in this area:
- we put an upper bound on the supported version of zarr-metadata
- we ensure that the default
zarr-pythontests run on the package-localzarr-metadata(so we don't need an explicit upstream test) - we ensure that our min deps tests run on the pypi-installed
zarr-metadata(so we know if we break compatibility with the oldest version on pypi). We use a pre-commit check to ensure that the version ofzarr-metadatapinned in the min deps environment matches the lowest versionzarr-pythonis compatible with (i.e., if we bump the minimum version ofzarr-metadatain our main deps, we see a pre-commit failure if we don't also bump the version pinned in the min deps environment)
…into use-zarr-metadata
- set `zarr-metadata` to resolve locally in local development - add a section to the docs outlining the relationship between zarr and zarr-metadata packages
…e the lower zarr-metadata bound is published
…d drop workspaces for min deps test
…ck via pre-commit
replaces some of our types with exports from zarr-metadata. I expect a few related PRs, alternating between ones like this (importing types) and ones that add missing types to zarr-metadata.
TODO:
docs/user-guide/*.mdchanges/