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

V3 reorg #1809

Merged
merged 4 commits into from
Apr 23, 2024
Merged

V3 reorg #1809

merged 4 commits into from
Apr 23, 2024

Conversation

jhamman
Copy link
Member

@jhamman jhamman commented Apr 23, 2024

This PR moves the v3 source code to the project root and preserves the v2 sources in a new v2 directory.

Process taken:
Step 1: move all v2 sources and tests to v2 directories, update imports and tests, commit -> ee09dec
Stepo 2: move all v3 sources from v3 directory to zarr root, update imports, tests, docs, and pyproject.toml, commit -> 51780ed

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 requested a review from d-v-b April 23, 2024 04:27
SQLiteStore,
TempStore,
ZipStore,
from __future__ import annotations
Copy link
Member Author

Choose a reason for hiding this comment

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

this is showing up as a line-edit diff but no edits were made. I first moved the original __init__.py -> v2/__init__.py, then made a commit. Then the v3/__init__.py file was moved here in a second commit.

@@ -36,8 +34,7 @@ def test_storage(self):
d = json.loads(str(store[attrs_key], "utf-8"))
assert dict(foo="bar", baz=42) == d

def test_utf8_encoding(self):
project_root = pathlib.Path(zarr.__file__).resolve().parent.parent
def test_utf8_encoding(self, project_root):
Copy link
Member Author

Choose a reason for hiding this comment

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

this is an actual change, although not a very consequential one.

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.

I didn't check every change, but the general direction looks good and if there's any rough edges we can iron those out later.

@joshmoore
Copy link
Member

A pretty uninformed question, please take it with a grain of salt, but would keeping the main directories and aliasing into the main namespace be more forward compatible? (i.e., avoid the need to move everything back to v3 when/if v4 comes along)

@normanrz
Copy link
Contributor

A pretty uninformed question, please take it with a grain of salt, but would keeping the main directories and aliasing into the main namespace be more forward compatible? (i.e., avoid the need to move everything back to v3 when/if v4 comes along)

Imo, the v2 directory should be gone before we release. We're just keeping it for now to easier move code around. I don't think it would be wise to keep essentially 2 code bases to maintain.

@jhamman jhamman merged commit d1a0d99 into zarr-developers:v3 Apr 23, 2024
14 checks passed
@jhamman jhamman deleted the v3-reorg branch April 23, 2024 14:47
@maxrjones maxrjones mentioned this pull request May 8, 2024
6 tasks
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.

4 participants