coverage to 100%; readonly->read_only

Author: alimanfoo

docs/api/sync.rst

@@ -4,4 +4,3 @@ Synchronization (``zarr.sync``)
 
 .. autoclass:: ThreadSynchronizer
 .. autoclass:: ProcessSynchronizer
-.. autoclass:: SynchronizedArray

docs/tutorial.rst

@@ -276,10 +276,11 @@ array with thread synchronization::
     >>> z = zarr.zeros((10000, 10000), chunks=(1000, 1000), dtype='i4',
     ...                 synchronizer=zarr.ThreadSynchronizer())
     >>> z
-    zarr.sync.SynchronizedArray((10000, 10000), int32, chunks=(1000, 1000), order=C)
+    zarr.core.Array((10000, 10000), int32, chunks=(1000, 1000), order=C)
       compression: blosc; compression_opts: {'clevel': 5, 'cname': 'lz4', 'shuffle': 1}
       nbytes: 381.5M; nbytes_stored: 313; ratio: 1277955.3; initialized: 0/100
-      store: builtins.dict; synchronizer: zarr.sync.ThreadSynchronizer
+      store: builtins.dict
+      synchronizer: zarr.sync.ThreadSynchronizer
 
 This array is safe to read or write within a multi-threaded program.
 
@@ -291,10 +292,11 @@ provided that all processes have access to a shared file system. E.g.::
     ...               chunks=(1000, 1000), dtype='i4',
     ...               synchronizer=synchronizer)
     >>> z
-    zarr.sync.SynchronizedArray((10000, 10000), int32, chunks=(1000, 1000), order=C)
+    zarr.core.Array((10000, 10000), int32, chunks=(1000, 1000), order=C)
       compression: blosc; compression_opts: {'clevel': 5, 'cname': 'lz4', 'shuffle': 1}
       nbytes: 381.5M; nbytes_stored: 313; ratio: 1277955.3; initialized: 0/100
-      store: zarr.storage.DirectoryStore; synchronizer: zarr.sync.ProcessSynchronizer
+      store: zarr.storage.DirectoryStore
+      synchronizer: zarr.sync.ProcessSynchronizer
 
 This array is safe to read or write from multiple processes.
 

zarr/attrs.py

@@ -10,11 +10,11 @@
 
 class Attributes(MutableMapping):
 
-    def __init__(self, store, key='.zattrs', readonly=False,
+    def __init__(self, store, key='.zattrs', read_only=False,
                  synchronizer=None):
         self.store = store
         self.key = key
-        self.readonly = readonly
+        self.read_only = read_only
         self.synchronizer = synchronizer
 
     def __contains__(self, x):
@@ -30,7 +30,7 @@ def _put(self, d):
     def _write_op(self, f, *args, **kwargs):
 
         # guard condition
-        if self.readonly:
+        if self.read_only:
             raise ReadOnlyError('attributes are read-only')
 
         # synchronization

zarr/core.py

@@ -27,7 +27,7 @@ class Array(object):
         Array store, already initialized.
     path : string, optional
         Storage path.
-    readonly : bool, optional
+    read_only : bool, optional
         True if array should be protected against modification.
     chunk_store : MutableMapping, optional
         Separate storage for chunks. If not provided, `store` will be used
@@ -40,7 +40,7 @@ class Array(object):
     store
     path
     name
-    readonly
+    read_only
     chunk_store
     shape
     chunks
@@ -67,7 +67,7 @@ class Array(object):
 
     """  # flake8: noqa
 
-    def __init__(self, store, path=None, readonly=False, chunk_store=None,
+    def __init__(self, store, path=None, read_only=False, chunk_store=None,
                  synchronizer=None):
         # N.B., expect at this point store is fully initialized with all
         # configuration metadata fully specified and normalized
@@ -78,7 +78,7 @@ def __init__(self, store, path=None, readonly=False, chunk_store=None,
             self._key_prefix = self._path + '/'
         else:
             self._key_prefix = ''
-        self._readonly = readonly
+        self._read_only = read_only
         if chunk_store is None:
             self._chunk_store = store
         else:
@@ -106,7 +106,7 @@ def __init__(self, store, path=None, readonly=False, chunk_store=None,
 
         # initialize attributes
         akey = self._key_prefix + attrs_key
-        self._attrs = Attributes(store, key=akey, readonly=readonly,
+        self._attrs = Attributes(store, key=akey, read_only=read_only,
                                  synchronizer=synchronizer)
 
     def _flush_metadata(self):
@@ -139,9 +139,9 @@ def name(self):
         return None
 
     @property
-    def readonly(self):
+    def read_only(self):
         """A boolean, True if modification operations are not permitted."""
-        return self._readonly
+        return self._read_only
 
     @property
     def chunk_store(self):
@@ -249,7 +249,7 @@ def __eq__(self, other):
         return (
             isinstance(other, Array) and
             self.store == other.store and
-            self.readonly == other.readonly and
+            self.read_only == other.read_only and
             self.path == other.path
             # N.B., no need to compare other properties, should be covered by
             # store comparison
@@ -453,7 +453,7 @@ def __setitem__(self, key, value):
         """
 
         # guard conditions
-        if self._readonly:
+        if self._read_only:
             raise ReadOnlyError('array is read-only')
 
         # normalize selection
@@ -674,7 +674,7 @@ def __repr__(self):
         return r
 
     def __getstate__(self):
-        return self._store, self._path, self._readonly, self._chunk_store, \
+        return self._store, self._path, self._read_only, self._chunk_store, \
                self._synchronizer
 
     def __setstate__(self, state):
@@ -683,7 +683,7 @@ def __setstate__(self, state):
     def _write_op(self, f, *args, **kwargs):
 
         # guard condition
-        if self._readonly:
+        if self._read_only:
             raise ReadOnlyError('array is read-only')
 
         # synchronization

zarr/creation.py

@@ -263,7 +263,7 @@ def open_array(path, mode='a', shape=None, chunks=None, dtype=None,
     path : string
         Path to directory in file system in which to store the array.
     mode : {'r', 'r+', 'a', 'w', 'w-'}
-        Persistence mode: 'r' means readonly (must exist); 'r+' means
+        Persistence mode: 'r' means read only (must exist); 'r+' means
         read/write (must exist); 'a' means read/write (create if doesn't
         exist); 'w' means create (overwrite if exists); 'w-' means create
         (fail if exists).
@@ -320,7 +320,7 @@ def open_array(path, mode='a', shape=None, chunks=None, dtype=None,
 
     # use same mode semantics as h5py, although N.B., here `path` is a
     # directory:
-    # r : readonly, must exist
+    # r : read only, must exist
     # r+ : read/write, must exist
     # w : create, delete if exists
     # w- or x : create, fail if exists
@@ -362,11 +362,11 @@ def open_array(path, mode='a', shape=None, chunks=None, dtype=None,
                        compression_opts=compression_opts,
                        fill_value=fill_value, order=order)
 
-    # determine readonly status
-    readonly = mode == 'r'
+    # determine read only status
+    read_only = mode == 'r'
 
     # instantiate array
-    z = Array(store, readonly=readonly, synchronizer=synchronizer)
+    z = Array(store, read_only=read_only, synchronizer=synchronizer)
 
     return z
 

zarr/hierarchy.py

@@ -27,7 +27,7 @@ class Group(Mapping):
         Group store, already initialized.
     path : string, optional
         Storage path.
-    readonly : bool, optional
+    read_only : bool, optional
         True if group should be protected against modification.
     chunk_store : MutableMapping, optional
         Separate storage for chunks. If not provided, `store` will be used 
@@ -40,7 +40,7 @@ class Group(Mapping):
     store
     path
     name
-    readonly
+    read_only
     chunk_store
     synchronizer
     attrs
@@ -74,7 +74,7 @@ class Group(Mapping):
 
     """
 
-    def __init__(self, store, path=None, readonly=False, chunk_store=None,
+    def __init__(self, store, path=None, read_only=False, chunk_store=None,
                  synchronizer=None):
 
         self._store = store
@@ -83,7 +83,7 @@ def __init__(self, store, path=None, readonly=False, chunk_store=None,
             self._key_prefix = self._path + '/'
         else:
             self._key_prefix = ''
-        self._readonly = readonly
+        self._read_only = read_only
         if chunk_store is None:
             self._chunk_store = store
         else:
@@ -106,7 +106,7 @@ def __init__(self, store, path=None, readonly=False, chunk_store=None,
 
         # setup attributes
         akey = self._key_prefix + attrs_key
-        self._attrs = Attributes(store, key=akey, readonly=readonly,
+        self._attrs = Attributes(store, key=akey, read_only=read_only,
                                  synchronizer=synchronizer)
 
     @property
@@ -131,9 +131,9 @@ def name(self):
         return '/'
 
     @property
-    def readonly(self):
+    def read_only(self):
         """A boolean, True if modification operations are not permitted."""
-        return self._readonly
+        return self._read_only
 
     @property
     def chunk_store(self):
@@ -156,7 +156,7 @@ def __eq__(self, other):
         return (
             isinstance(other, Group) and
             self._store == other.store and
-            self._readonly == other.readonly and
+            self._read_only == other.read_only and
             self._path == other.path
             # N.B., no need to compare attributes, should be covered by
             # store comparison
@@ -223,7 +223,7 @@ def __repr__(self):
         return r
 
     def __getstate__(self):
-        return self._store, self._path, self._readonly, self._chunk_store, \
+        return self._store, self._path, self._read_only, self._chunk_store, \
                self._synchronizer
 
     def __setstate__(self, state):
@@ -291,11 +291,11 @@ def __getitem__(self, item):
         """  # flake8: noqa
         path = self._item_path(item)
         if contains_array(self._store, path):
-            return Array(self._store, readonly=self._readonly, path=path, 
+            return Array(self._store, read_only=self._read_only, path=path,
                          chunk_store=self._chunk_store,
                          synchronizer=self._synchronizer)
         elif contains_group(self._store, path):
-            return Group(self._store, readonly=self._readonly, path=path, 
+            return Group(self._store, read_only=self._read_only, path=path,
                          chunk_store=self._chunk_store,
                          synchronizer=self._synchronizer)
         else:
@@ -342,7 +342,7 @@ def groups(self):
             path = self._key_prefix + key
             if contains_group(self._store, path):
                 yield key, Group(self._store, path=path,
-                                 readonly=self._readonly,
+                                 read_only=self._read_only,
                                  chunk_store=self._chunk_store,
                                  synchronizer=self._synchronizer)
 
@@ -387,14 +387,14 @@ def arrays(self):
             path = self._key_prefix + key
             if contains_array(self._store, path):
                 yield key, Array(self._store, path=path,
-                                 readonly=self._readonly,
+                                 read_only=self._read_only,
                                  chunk_store=self._chunk_store,
                                  synchronizer=self._synchronizer)
 
     def _write_op(self, f, *args, **kwargs):
 
         # guard condition
-        if self._readonly:
+        if self._read_only:
             raise ReadOnlyError('group is read-only')
 
         # synchronization
@@ -449,7 +449,7 @@ def _create_group_nosync(self, name):
             raise KeyError(name)
         else:
             init_group(self._store, path=path, chunk_store=self._chunk_store)
-            return Group(self._store, path=path, readonly=self._readonly,
+            return Group(self._store, path=path, read_only=self._read_only,
                          chunk_store=self._chunk_store,
                          synchronizer=self._synchronizer)
 
@@ -495,7 +495,7 @@ def _require_group_nosync(self, name):
             elif not contains_group(self._store, p):
                 init_group(self._store, path=p, chunk_store=self._chunk_store)
 
-        return Group(self._store, path=path, readonly=self._readonly,
+        return Group(self._store, path=path, read_only=self._read_only,
                      chunk_store=self._chunk_store,
                      synchronizer=self._synchronizer)
 
@@ -644,7 +644,7 @@ def _require_dataset_nosync(self, name, shape, dtype=None, exact=False,
 
         if contains_array(self._store, path):
             synchronizer = kwargs.get('synchronizer', self._synchronizer)
-            a = Array(self._store, path=path, readonly=self._readonly,
+            a = Array(self._store, path=path, read_only=self._read_only,
                       chunk_store=self._chunk_store, synchronizer=synchronizer)
             shape = normalize_shape(shape)
             if shape != a.shape:
@@ -838,7 +838,7 @@ def group(store=None, overwrite=False, chunk_store=None, synchronizer=None):
     elif not contains_group(store):
         init_group(store, chunk_store=chunk_store)
 
-    return Group(store, readonly=False, chunk_store=chunk_store,
+    return Group(store, read_only=False, chunk_store=chunk_store,
                  synchronizer=synchronizer)
 
 
@@ -851,7 +851,7 @@ def open_group(path, mode='a', synchronizer=None):
     path : string
         Path to directory in file system in which to store the group.
     mode : {'r', 'r+', 'a', 'w', 'w-'}
-        Persistence mode: 'r' means readonly (must exist); 'r+' means
+        Persistence mode: 'r' means read only (must exist); 'r+' means
         read/write (must exist); 'a' means read/write (create if doesn't
         exist); 'w' means create (overwrite if exists); 'w-' means create
         (fail if exists).
@@ -910,7 +910,7 @@ def open_group(path, mode='a', synchronizer=None):
         else:
             init_group(store)
 
-    # determine readonly status
-    readonly = mode == 'r'
+    # determine read only status
+    read_only = mode == 'r'
 
-    return Group(store, readonly=readonly, synchronizer=synchronizer)
+    return Group(store, read_only=read_only, synchronizer=synchronizer)

zarr/tests/test_attrs.py

@@ -14,8 +14,8 @@
 
 class TestAttributes(unittest.TestCase):
 
-    def init_attributes(self, store, readonly=False):
-        return Attributes(store, key='attrs', readonly=readonly)
+    def init_attributes(self, store, read_only=False):
+        return Attributes(store, key='attrs', read_only=read_only)
 
     def test_storage(self):
 
@@ -74,9 +74,9 @@ def test_iterators(self):
         eq({'bar', 42}, set(a.values()))
         eq({('foo', 'bar'), ('baz', 42)}, set(a.items()))
 
-    def test_readonly(self):
+    def test_read_only(self):
         store = dict()
-        a = self.init_attributes(store, readonly=True)
+        a = self.init_attributes(store, read_only=True)
         store['attrs'] = json.dumps(dict(foo='bar', baz=42)).encode('ascii')
         eq(a['foo'], 'bar')
         eq(a['baz'], 42)