attributes method naming, expose put()

Author: alimanfoo

zarr/attrs.py

@@ -9,6 +9,9 @@
 
 
 class Attributes(MutableMapping):
+    """Class providing access to user attributes on an array or group. Should not be
+    instantiated directly, will be available via the `.attrs` property of an array or
+    group."""
 
     def __init__(self, store, key='.zattrs', read_only=False, cache=True,
                  synchronizer=None):
@@ -19,7 +22,7 @@ def __init__(self, store, key='.zattrs', read_only=False, cache=True,
         self._cached_asdict = None
         self.synchronizer = synchronizer
 
-    def _get(self):
+    def _get_nosync(self):
         try:
             data = self.store[self.key]
         except KeyError:
@@ -28,16 +31,11 @@ def _get(self):
             d = json.loads(text_type(data, 'ascii'))
         return d
 
-    def _put(self, d):
-        s = json.dumps(d, indent=4, sort_keys=True, ensure_ascii=True, separators=(',', ': '))
-        self.store[self.key] = s.encode('ascii')
-        if self.cache:
-            self._cached_asdict = d
-
     def asdict(self):
+        """Retrieve all attributes as a dictionary."""
         if self.cache and self._cached_asdict is not None:
             return self._cached_asdict
-        d = self._get()
+        d = self._get_nosync()
         if self.cache:
             self._cached_asdict = d
         return d
@@ -67,43 +65,57 @@ def __setitem__(self, item, value):
     def _setitem_nosync(self, item, value):
 
         # load existing data
-        d = self._get()
+        d = self._get_nosync()
 
         # set key value
         d[item] = value
 
         # _put modified data
-        self._put(d)
+        self._put_nosync(d)
 
     def __delitem__(self, item):
         self._write_op(self._delitem_nosync, item)
 
     def _delitem_nosync(self, key):
 
         # load existing data
-        d = self._get()
+        d = self._get_nosync()
 
         # delete key value
         del d[key]
 
         # _put modified data
-        self._put(d)
+        self._put_nosync(d)
+
+    def put(self, d):
+        """Overwrite all attributes with the key/value pairs in the provided dictionary
+        `d` in a single operation."""
+        self._write_op(self._put_nosync, d)
+
+    def _put_nosync(self, d):
+        s = json.dumps(d, indent=4, sort_keys=True, ensure_ascii=True, separators=(',', ': '))
+        self.store[self.key] = s.encode('ascii')
+        if self.cache:
+            self._cached_asdict = d
 
     def update(self, *args, **kwargs):
-        # override to provide update in a single write
+        """Update the values of several attributes in a single operation."""
         self._write_op(self._update_nosync, *args, **kwargs)
 
     def _update_nosync(self, *args, **kwargs):
 
         # load existing data
-        d = self._get()
+        d = self._get_nosync()
 
         # update
         d.update(*args, **kwargs)
 
         # _put modified data
-        self._put(d)
+        self._put_nosync(d)
 
+    def keys(self):
+        return self.asdict().keys()
+    
     def __iter__(self):
         return iter(self.asdict())