docs, tests

Author: TomAugspurger

src/zarr/_info.py

@@ -2,18 +2,37 @@
 import textwrap
 from typing import Literal
 
-# Group
-# Name        : /
-# Type        : zarr.hierarchy.Group
-# Read-only   : False
-# Store type  : zarr.storage.MemoryStore
-# No. members : 0
-# No. arrays  : 0
-# No. groups  : 0
-
 
 @dataclasses.dataclass(kw_only=True)
 class GroupInfo:
+    """
+    Information about a group.
+
+    Parameters
+    ----------
+    name : str
+        The path of the group within the Store
+    type : "Group"
+    zarr_format : {2, 3}
+        The zarr format of the Group.
+    read_only : bool
+        Whether the Group's access mode is read only.
+    store_type : str
+        The name of the Store class containing this group.
+    count_members : int, optional
+        The number of child members below this group. This
+        will be set when the Group has consolidated metadata
+        or when using :class:`Group.info_complete`.
+    count_arrays : int, optional
+        The number of child arrays below this group. This
+        will be set when the Group has consolidated metadata
+        or when using :class:`Group.info_complete`.
+    count_groups : int, optional
+        The number of child groups below this group. This
+        will be set when the Group has consolidated metadata
+        or when using :class:`Group.info_complete`.
+    """
+
     name: str
     type: Literal["Group"] = "Group"
     zarr_format: Literal[2, 3]

tests/v3/test_info.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from zarr._info import ArrayInfo, GroupInfo
+from zarr._info import ArrayInfo, GroupInfo, human_readable_size
 from zarr.core.common import ZarrFormat
 
 ZARR_FORMATS = [2, 3]
@@ -111,3 +111,19 @@ def test_array_info_complete(
         No. bytes stored   : {count_bytes_stored_formatted}
         Storage ratio      : {storage_ratio_formatted}
         Chunks Initialized : 5""")
+
+
+@pytest.mark.parametrize(
+    ("size", "expected"),
+    [
+        (1, "1"),
+        (2**10, "1.0K"),
+        (2**20, "1.0M"),
+        (2**30, "1.0G"),
+        (2**40, "1.0T"),
+        (2**50, "1.0P"),
+    ],
+)
+def test_human_readable_size(size: int, expected: str) -> None:
+    result = human_readable_size(size)
+    assert result == expected