Added info for Group and Array #2400
Conversation
src/zarr/_info.py
Outdated
| return template.format(**dataclasses.asdict(self)) | ||
|
|
||
|
|
||
| def human_readable_size(size: int) -> str: |
There was a problem hiding this comment.
This was taken from the 2.x implementation.
| def info(self) -> ArrayInfo: | ||
| return self._info() | ||
|
|
||
| async def info_complete(self) -> ArrayInfo: |
There was a problem hiding this comment.
Maybe we just don't have this in the API till we implement it (since it's new).
| else: | ||
| kwargs["codecs"] = str(self.metadata.codecs) | ||
| kwargs["data_type"] = str(self.metadata.data_type) | ||
| # just regular? |
There was a problem hiding this comment.
Need to figure out what to do here for other chunking types.
There was a problem hiding this comment.
until we have other chunk grid types, I'd say we can either raise an error here (my preference) or leave this field null.
| @@ -38,6 +39,7 @@ | |||
| "AsyncArray", | |||
| "AsyncGroup", | |||
| "Group", | |||
| "GroupInfo", | |||
There was a problem hiding this comment.
Can you explain why we want to put this in the user API?
There was a problem hiding this comment.
I think any object that a user can get through a public API (like zarr.group().info) should be part of the API somewhere, if only to enable things like static typing without using private imports.
I don't have a preference for whether it's in the top-level API like I've added here, or some submodule.
| else: | ||
| kwargs["codecs"] = str(self.metadata.codecs) | ||
| kwargs["data_type"] = str(self.metadata.data_type) | ||
| # just regular? |
There was a problem hiding this comment.
until we have other chunk grid types, I'd say we can either raise an error here (my preference) or leave this field null.
| ) | ||
| @property | ||
| def info(self) -> ArrayInfo: | ||
| return self._async_array.info |
There was a problem hiding this comment.
please add docstrings here and in info_complete
Quick pass at adding
.infoto Group and Array. Like 2.x,infois a property, but it will only contain information that's known statically. I've added aGroup.info_completemethod that actually calls the store to get dynamic information (for group this is children).I've punted on a similar
Array.info_complete. For that, we'll need to expand the Store ABC to give us annbytesmethod to get the size of the array in bytes. Maybe similar for the actual number of chunks written. Doable, but separate from this PR I think .Closes #2135