Merge pull request #12 from janelia-cellmap/items_to_members

Items to members

Author: d-v-b

docs/index.md

@@ -22,7 +22,7 @@ print(spec.dict())
 {
     'zarr_version': 2,
     'attrs': {},
-    'items': {
+    'members': {
         'bar': {
             'zarr_version': 2,
             'attrs': {'metadata': 'hello'},
@@ -68,11 +68,11 @@ Note the use of the term "schematized": Zarr arrays also represent N-dimensional
 Accordingly, in `pydantic-zarr`, Zarr groups are encoded by the `GroupSpec` class with two fields:
 
 - `GroupSpec.attrs`: either a `Mapping` or a `pydantic.BaseModel`. 
-- `GroupSpec.items`: a mapping with string keys and values that must be `GroupSpec` or `ArraySpec` instances.
+- `GroupSpec.members`: a mapping with string keys and values that must be `GroupSpec` or `ArraySpec` instances.
 
 Zarr arrays are represented by the `ArraySpec` class, which has a similar `attrs` field, as well as fields for all the Zarr array properties (`dtype`, `shape`, `chunks`, etc).
 
-`GroupSpec` and `ArraySpec` are both [generic models](https://docs.pydantic.dev/1.10/usage/models/#generic-models). `GroupSpec` takes two type parameters, the first specializing the type of `GroupSpec.attrs`, and the second specializing the type of the *values* of `GroupSpec.items` (they keys of `GroupSpec.items` are always strings). `ArraySpec` only takes one type parameter, which specializes the type of `ArraySpec.attrs`.
+`GroupSpec` and `ArraySpec` are both [generic models](https://docs.pydantic.dev/1.10/usage/models/#generic-models). `GroupSpec` takes two type parameters, the first specializing the type of `GroupSpec.attrs`, and the second specializing the type of the *values* of `GroupSpec.items` (the keys of `GroupSpec.members` are strings). `ArraySpec` only takes one type parameter, which specializes the type of `ArraySpec.attrs`.
 
 Examples using this generic typing functionality can be found in the [usage guide](usage.md#using-generic-types).
 

docs/usage.md

@@ -34,7 +34,7 @@ print(spec.dict())
 {
     'zarr_version': 2,
     'attrs': {'group_metadata': 10},
-    'items': {
+    'members': {
         'bar': {
             'zarr_version': 2,
             'attrs': {'array_metadata': True},
@@ -55,7 +55,7 @@ print(spec.dict())
 spec2 = spec.copy()
 spec2.attrs = {'a': 100, 'b': 'metadata'}
 
-spec2.items['bar'].shape = (100,)
+spec2.members['bar'].shape = (100,)
 
 # serialize the spec to the store
 group2 = spec2.to_zarr(grp.store, path='foo2')
@@ -128,40 +128,40 @@ except ValidationError as exc:
 
 # this passes validation
 print(SpecificAttrsGroup(attrs={'a': 100, 'b': 100}))
-#> zarr_version=2 attrs={'a': 100, 'b': 100} items={}
+#> zarr_version=2 attrs={'a': 100, 'b': 100} members={}
 
 # a Zarr group that only contains arrays -- no subgroups!
 # we re-use the TAttrs type variable defined in pydantic_zarr.core
 ArraysOnlyGroup = GroupSpec[TAttr, ArraySpec]
 
 try:
-    ArraysOnlyGroup(attrs={}, items={'foo': GroupSpec(attrs={})})
+    ArraysOnlyGroup(attrs={}, members={'foo': GroupSpec(attrs={})})
 except ValidationError as exc:
     print(exc)
     """
     4 validation errors for GroupSpec[TAttr, ArraySpec]
-    items -> foo -> shape
+    members -> foo -> shape
       field required (type=value_error.missing)
-    items -> foo -> chunks
+    members -> foo -> chunks
       field required (type=value_error.missing)
-    items -> foo -> dtype
+    members -> foo -> dtype
       field required (type=value_error.missing)
-    items -> foo -> items
+    members -> foo -> members
       extra fields not permitted (type=value_error.extra)
     """
 
 # this passes validation
-items = {'foo': ArraySpec(attrs={}, 
-                          shape=(1,), 
-                          dtype='uint8', 
-                          chunks=(1,), 
-                          compressor=None)}
-print(ArraysOnlyGroup(attrs={}, items=items).dict())
+members = {'foo': ArraySpec(attrs={}, 
+                            shape=(1,), 
+                            dtype='uint8', 
+                            chunks=(1,), 
+                            compressor=None)}
+print(ArraysOnlyGroup(attrs={}, members=members).dict())
 """
 {
     'zarr_version': 2,
     'attrs': {},
-    'items': {
+    'members': {
         'foo': {
             'zarr_version': 2,
             'attrs': {},