-
-
Notifications
You must be signed in to change notification settings - Fork 359
[v3] reorganize package - move most modules to zarr.core #2072
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lgtm
…nto feature/core-subpackage
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As a general comment, objects should only be listed in one all throughout the codebase. This should be where we are expecting users to import the object from. We are still free to import from other locations internally, but all signals where the public API lives.
@zarr-developers/python-core-devs - this is ready for a real review now. Thanks @dstansby and @normanrz for an initial look. With these changes, the package organization now looks like this:
|
…nto feature/core-subpackage
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! I left some optional suggestions to move the __all__
to the tops of files.
Once this is in it should unblock #2002, which will make it easier to see what the documented public API looks like 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it! I do think we should move the __all__
declarations to the top of each file as per @dstansby's suggestion, but other than that I think it's good to go
merging! thanks @jhamman |
* v3: [v3] reorganize package - move most modules to zarr.core (zarr-developers#2072)
This PR creates a
core
subpackage in the zarr package and begins to move some modules there. As I explained in #2037 (comment), this is designed to clarify which parts of the zarr project are public API and which are internal (everything incore
).In my in my initial commit, I only moved
array.py
,config.py
,group.py
,indexing.py
, andsync.py
. More to be done but I wanted to put this up for an initial reactions before going through the complete set of modules.closes #2037