Fix a bug in BaseCollection.properties method

Author: joowani

arango/collections/base.py

@@ -102,11 +102,13 @@ def _status(self, code):
 
         :param code: the collection status code
         :type code: int
-        :returns: the collection status text
-        :rtype: str  | unicode
+        :returns: the collection status text or ``None``
+        :rtype: str  | unicode | None
         :raises arango.exceptions.CollectionBadStatusError: if the collection
             status code is unknown
         """
+        if code is None:  # pragma: no cover
+            return None
         try:
             return self.STATUSES[code]
         except KeyError:
@@ -217,10 +219,10 @@ def handler(res):
     def properties(self):
         """Return the collection properties.
 
-        :returns: the collection properties
+        :returns: The collection properties.
         :rtype: dict
-        :raises arango.exceptions.CollectionPropertiesError: if the
-            collection properties cannot be retrieved
+        :raises arango.exceptions.CollectionPropertiesError: If the
+            collection properties cannot be retrieved.
         """
         request = Request(
             method='get',
@@ -230,24 +232,24 @@ def properties(self):
         def handler(res):
             if res.status_code not in HTTP_OK:
                 raise CollectionPropertiesError(res)
-            result = {
-                'id': res.body['id'],
-                'name': res.body['name'],
-                'edge': res.body['type'] == 3,
-                'sync': res.body['waitForSync'],
-                'status': self._status(res.body['status']),
-                'compact': res.body['doCompact'],
-                'system': res.body['isSystem'],
-                'volatile': res.body['isVolatile'],
-                'journal_size': res.body['journalSize'],
-                'keygen': res.body['keyOptions']['type'],
-                'user_keys': res.body['keyOptions']['allowUserKeys'],
+
+            key_options = res.body.get('keyOptions', {})
+
+            return {
+                'id': res.body.get('id'),
+                'name': res.body.get('name'),
+                'edge': res.body.get('type') == 3,
+                'sync': res.body.get('waitForSync'),
+                'status': self._status(res.body.get('status')),
+                'compact': res.body.get('doCompact'),
+                'system': res.body.get('isSystem'),
+                'volatile': res.body.get('isVolatile'),
+                'journal_size': res.body.get('journalSize'),
+                'keygen': key_options.get('type'),
+                'user_keys': key_options.get('allowUserKeys'),
+                'key_increment': key_options.get('increment'),
+                'key_offset': key_options.get('offset')
             }
-            if 'increment' in res.body['keyOptions']:
-                result['key_increment'] = res.body['keyOptions']['increment']
-            if 'offset' in res.body['keyOptions']:
-                result['key_offset'] = res.body['keyOptions']['offset']
-            return result
 
         return request, handler
 
@@ -257,9 +259,9 @@ def configure(self, sync=None, journal_size=None):
 
         Only *sync* and *journal_size* properties are configurable.
 
-        :param sync: wait for the operation to sync to disk
+        :param sync: Wait for the operation to sync to disk.
         :type sync: bool
-        :param journal_size: the journal size
+        :param journal_size: The journal size.
         :type journal_size: int
         :returns: the new collection properties
         :rtype: dict
@@ -281,22 +283,24 @@ def configure(self, sync=None, journal_size=None):
         def handler(res):
             if res.status_code not in HTTP_OK:
                 raise CollectionConfigureError(res)
-            result = {
-                'id': res.body['id'],
-                'name': res.body['name'],
-                'edge': res.body['type'] == 3,
-                'sync': res.body['waitForSync'],
-                'status': self._status(res.body['status']),
-                'compact': res.body['doCompact'],
-                'system': res.body['isSystem'],
-                'volatile': res.body['isVolatile'],
-                'journal_size': res.body['journalSize'],
-                'keygen': res.body['keyOptions']['type'],
-                'user_keys': res.body['keyOptions']['allowUserKeys'],
-                'key_increment': res.body['keyOptions'].get('increment'),
-                'key_offset': res.body['keyOptions'].get('offset')
+
+            key_options = res.body.get('keyOptions', {})
+
+            return {
+                'id': res.body.get('id'),
+                'name': res.body.get('name'),
+                'edge': res.body.get('type') == 3,
+                'sync': res.body.get('waitForSync'),
+                'status': self._status(res.body.get('status')),
+                'compact': res.body.get('doCompact'),
+                'system': res.body.get('isSystem'),
+                'volatile': res.body.get('isVolatile'),
+                'journal_size': res.body.get('journalSize'),
+                'keygen': key_options.get('type'),
+                'user_keys': key_options.get('allowUserKeys'),
+                'key_increment': key_options.get('increment'),
+                'key_offset': key_options.get('offset')
             }
-            return result
 
         return request, handler
 

arango/version.py

@@ -1 +1 @@
-VERSION = '3.10.0'
+VERSION = '3.10.1'

setup.py

@@ -14,6 +14,7 @@
     packages=find_packages(),
     include_package_data=True,
     install_requires=['requests', 'six'],
+    tests_require=['pytest'],
     classifiers=[
         'Intended Audience :: Developers',
         'Intended Audience :: End Users/Desktop',

tests/test_collection.py

@@ -44,9 +44,9 @@ def test_properties():
     assert isinstance(properties['journal_size'], int)
     assert properties['keygen'] in ('autoincrement', 'traditional')
     assert isinstance(properties['user_keys'], bool)
-    if 'key_increment' in properties:
+    if properties['key_increment'] is not None:
         assert isinstance(properties['key_increment'], int)
-    if 'key_offset' in properties:
+    if properties['key_offset'] is not None :
         assert isinstance(properties['key_offset'], int)
     with pytest.raises(CollectionBadStatusError):
         assert getattr(col, '_status')(10)