Merge pull request #435 from aogier/feature/only-one-id

Removed document._document_id logic

Author: smithsz

CHANGES.md

@@ -4,6 +4,8 @@
   uncaught exceptions being raised inside `with` block.
 - [FIXED] Fixed parameter type of `selector` in docstring.
 - [IMPROVED] Updated `Getting started` section with a `get_query_result` example.
+- [FIXED] Removed internal `Document._document_id` property to allow a safe use of
+  dict's methods.
 
 # 2.11.0 (2019-01-21)
 

src/cloudant/document.py

@@ -63,9 +63,8 @@ def __init__(self, database, document_id=None, **kwargs):
         self._database = database
         self._database_host = self._client.server_url
         self._database_name = database.database_name
-        self._document_id = document_id
-        if self._document_id is not None:
-            self['_id'] = self._document_id
+        if document_id:
+            self['_id'] = document_id
         self.encoder = kwargs.get('encoder') or self._client.encoder
         self.decoder = kwargs.get('decoder') or json.JSONDecoder
 
@@ -85,23 +84,23 @@ def document_url(self):
 
         :returns: Document URL
         """
-        if self._document_id is None:
+        if '_id' not in self or self['_id'] is None:
             return None
 
         # handle design document url
-        if self._document_id.startswith('_design/'):
+        if self['_id'].startswith('_design/'):
             return '/'.join((
                 self._database_host,
                 url_quote_plus(self._database_name),
                 '_design',
-                url_quote(self._document_id[8:], safe='')
+                url_quote(self['_id'][8:], safe='')
             ))
 
         # handle document url
         return '/'.join((
             self._database_host,
             url_quote_plus(self._database_name),
-            url_quote(self._document_id, safe='')
+            url_quote(self['_id'], safe='')
         ))
 
     def exists(self):
@@ -111,7 +110,7 @@ def exists(self):
         :returns: True if the document exists in the remote database,
             otherwise False
         """
-        if self._document_id is None:
+        if '_id' not in self or self['_id'] is None:
             return False
 
         resp = self.r_session.head(self.document_url)
@@ -136,8 +135,6 @@ def create(self):
         updates the locally cached Document object with the ``_id``
         and ``_rev`` returned as part of the successful response.
         """
-        if self._document_id is not None:
-            self['_id'] = self._document_id
 
         # Ensure that an existing document will not be "updated"
         doc = dict(self)
@@ -152,7 +149,6 @@ def create(self):
         )
         resp.raise_for_status()
         data = response_to_json_dict(resp)
-        self._document_id = data['id']
         super(Document, self).__setitem__('_id', data['id'])
         super(Document, self).__setitem__('_rev', data['rev'])
 
@@ -318,8 +314,9 @@ def delete(self):
             params={"rev": self["_rev"]},
         )
         del_resp.raise_for_status()
+        _id = self['_id']
         self.clear()
-        self.__setitem__('_id', self._document_id)
+        self['_id'] = _id
 
     def __enter__(self):
         """
@@ -349,23 +346,6 @@ def __exit__(self, exc_type, exc_value, traceback):
         if exc_type is None:
             self.save()
 
-    def __setitem__(self, key, value):
-        """
-        Sets the _document_id when setting the '_id' field.
-        The _document_id is used to construct the document url.
-        """
-        if key == '_id':
-            self._document_id = value
-        super(Document, self).__setitem__(key, value)
-
-    def __delitem__(self, key):
-        """
-        Sets the _document_id to None when deleting the '_id' field.
-        """
-        if key == '_id':
-            self._document_id = None
-        super(Document, self).__delitem__(key)
-
     def get_attachment(
             self,
             attachment,

tests/unit/document_tests.py

@@ -680,10 +680,8 @@ def test_setting_id(self):
         """
         doc = Document(self.db)
         self.assertIsNone(doc.get('_id'))
-        self.assertEqual(doc._document_id, None)
         doc['_id'] = 'julia006'
         self.assertEqual(doc['_id'], 'julia006')
-        self.assertEqual(doc._document_id, 'julia006')
 
     def test_removing_id(self):
         """
@@ -693,7 +691,6 @@ def test_removing_id(self):
         doc['_id'] = 'julia006'
         del doc['_id']
         self.assertIsNone(doc.get('_id'))
-        self.assertEqual(doc._document_id, None)
 
     def test_get_text_attachment(self):
         """