Added group info

Author: TomAugspurger

src/zarr/__init__.py

@@ -1,3 +1,4 @@
+from zarr._info import GroupInfo
 from zarr._version import version as __version__
 from zarr.api.synchronous import (
     array,
@@ -38,6 +39,7 @@
     "AsyncArray",
     "AsyncGroup",
     "Group",
+    "GroupInfo",
     "__version__",
     "array",
     "config",

src/zarr/_info.py

@@ -0,0 +1,60 @@
+import dataclasses
+import textwrap
+from typing import Literal
+
+import zarr.abc.store
+
+# Group
+# Name        : /
+# Type        : zarr.hierarchy.Group
+# Read-only   : False
+# Store type  : zarr.storage.MemoryStore
+# No. members : 0
+# No. arrays  : 0
+# No. groups  : 0
+
+
+# In [19]: z.info
+# Out[19]:
+# Type               : zarr.core.Array
+# Data type          : int32
+# Shape              : (1000000,)
+# Chunk shape        : (100000,)
+# Order              : C
+# Read-only          : False
+# Compressor         : Blosc(cname='lz4', clevel=5, shuffle=SHUFFLE, blocksize=0)
+# Store type         : zarr.storage.KVStore
+# No. bytes          : 4000000 (3.8M)
+# No. bytes stored   : 320
+# Storage ratio      : 12500.0
+# Chunks initialized : 0/10
+
+
+@dataclasses.dataclass(kw_only=True)
+class GroupInfo:
+    name: str
+    type: Literal["Group"] = "Group"
+    read_only: bool
+    store_type: str
+    count_members: int | None = None
+    count_arrays: int | None = None
+    count_groups: int | None = None
+
+    def __repr__(self) -> str:
+        template = textwrap.dedent("""\
+        Name        : {name}
+        Type        : {type}
+        Read-only   : {read_only}
+        Store type  : {store_type}""")
+
+        if self.count_members is not None:
+            template += ("\nNo. members : {count_members}")
+        if self.count_arrays is not None:
+            template += ("\nNo. arrays  : {count_arrays}")
+        if self.count_groups is not None:
+            template += ("\nNo. groups  : {count_groups}")
+        return template.format(
+            **dataclasses.asdict(self)
+        )
+
+    # def _repr_html_(self): ...

src/zarr/core/array.py

@@ -1145,7 +1145,11 @@ async def update_attributes(self, new_attributes: dict[str, JSON]) -> Self:
     def __repr__(self) -> str:
         return f"<AsyncArray {self.store_path} shape={self.shape} dtype={self.dtype}>"
 
-    async def info(self) -> None:
+    @property
+    def info(self) -> ...:
+        ...
+
+    async def info_full(self) -> None:
         raise NotImplementedError
 
 
@@ -2818,10 +2822,12 @@ def update_attributes(self, new_attributes: dict[str, JSON]) -> Array:
     def __repr__(self) -> str:
         return f"<Array {self.store_path} shape={self.shape} dtype={self.dtype}>"
 
+    @property
     def info(self) -> None:
-        return sync(
-            self._async_array.info(),
-        )
+        return self._async_array.info
+
+    def info_full(self) -> None:
+        ...
 
 
 def nchunks_initialized(

src/zarr/core/group.py

@@ -13,6 +13,7 @@
 import numpy.typing as npt
 from typing_extensions import deprecated
 
+from zarr._info import GroupInfo
 import zarr.api.asynchronous as async_api
 from zarr.abc.metadata import Metadata
 from zarr.abc.store import Store, set_or_delete
@@ -792,8 +793,37 @@ def attrs(self) -> dict[str, Any]:
         return self.metadata.attributes
 
     @property
-    def info(self) -> None:
-        raise NotImplementedError
+    def info(self) -> GroupInfo:
+        if self.metadata.consolidated_metadata:
+            members = list(self.metadata.consolidated_metadata.flattened_metadata.values())
+        else:
+            members = None
+        return self._info(members=members)
+
+    async def info_complete(self) -> GroupInfo:
+        members = [x[1].metadata async for x in self.members(max_depth=None)]
+        return self._info(members=members)
+
+    def _info(self, members: list[ArrayV2Metadata | ArrayV3Metadata | GroupMetadata] | None = None) -> GroupInfo:
+        kwargs = {}
+        if members is not None:
+            kwargs["count_members"] = len(members)
+            count_arrays = 0
+            count_groups = 0
+            for member in members:
+                if isinstance(member, GroupMetadata):
+                    count_groups += 1
+                else:
+                    count_arrays += 1
+            kwargs["count_arrays"] = count_arrays
+            kwargs["count_groups"] = count_groups
+
+        return GroupInfo(
+            name=self.store_path.path,
+            read_only=self.store_path.store.mode.readonly,
+            store_type=type(self.store_path.store).__name__,
+            **kwargs
+        )
 
     @property
     def store(self) -> Store:
@@ -1438,8 +1468,11 @@ def attrs(self) -> Attributes:
         return Attributes(self)
 
     @property
-    def info(self) -> None:
-        raise NotImplementedError
+    def info(self) -> GroupInfo:
+        return self._async_group.info
+
+    def info_complete(self) -> GroupInfo:
+        return self._sync(self._async_group.info_complete())
 
     @property
     def store(self) -> Store:

tests/v3/test_group.py

@@ -9,6 +9,7 @@
 import pytest
 
 import zarr
+from zarr._info import GroupInfo
 import zarr.api.asynchronous
 import zarr.api.synchronous
 from zarr import Array, AsyncArray, AsyncGroup, Group
@@ -18,6 +19,7 @@
 from zarr.core.sync import sync
 from zarr.errors import ContainsArrayError, ContainsGroupError
 from zarr.storage import LocalStore, MemoryStore, StorePath, ZipStore
+import zarr.storage
 from zarr.storage.common import make_store_path
 
 from .conftest import parse_store
@@ -768,15 +770,6 @@ async def test_asyncgroup_attrs(store: Store, zarr_format: ZarrFormat) -> None:
     assert agroup.attrs == agroup.metadata.attributes == attributes
 
 
-async def test_asyncgroup_info(store: Store, zarr_format: ZarrFormat) -> None:
-    agroup = await AsyncGroup.from_store(  # noqa: F841
-        store,
-        zarr_format=zarr_format,
-    )
-    pytest.xfail("Info is not implemented for metadata yet")
-    # assert agroup.info == agroup.metadata.info
-
-
 async def test_asyncgroup_open(
     store: Store,
     zarr_format: ZarrFormat,
@@ -1322,6 +1315,34 @@ def test_from_dict_extra_fields(self):
         assert result == expected
 
 
+class TestInfo:
+    def test_info(self):
+        store = zarr.storage.MemoryStore(mode="w")
+        A = zarr.group(store=store, path="A")
+        B = A.create_group(name="B")
+
+        B.create_array(name="x", shape=(1,))
+        B.create_array(name="y", shape=(2,))
+
+        result = A.info
+        expected = GroupInfo(
+            name="A",
+            read_only=False,
+            store_type="MemoryStore",
+        )
+        assert result == expected
+
+        result = A.info_complete()
+        expected = GroupInfo(
+            name="A",
+            read_only=False,
+            store_type="MemoryStore",
+            count_members=3,
+            count_arrays=2,
+            count_groups=1,
+        )
+        assert result == expected
+
 def test_update_attrs() -> None:
     # regression test for https://github.com/zarr-developers/zarr-python/issues/2328
     root = Group.from_store(

tests/v3/test_info.py

@@ -0,0 +1,29 @@
+import textwrap
+
+from zarr._info import GroupInfo
+
+
+def test_group_info_repr() -> None:
+    info = GroupInfo(name="a", store_type="MemoryStore", read_only=False)
+    result = repr(info)
+    expected = textwrap.dedent("""\
+        Name        : a
+        Type        : Group
+        Read-only   : False
+        Store type  : MemoryStore""")
+    assert result == expected
+
+
+def test_group_info_complete() -> None:
+    info = GroupInfo(name="a", store_type="MemoryStore", read_only=False, count_arrays=10, count_groups=4, count_members=14)
+    result = repr(info)
+    expected = textwrap.dedent("""\
+        Name        : a
+        Type        : Group
+        Read-only   : False
+        Store type  : MemoryStore
+        No. members : 14
+        No. arrays  : 10
+        No. groups  : 4""")
+    assert result == expected
+