Merge pull request #200 from Alexsaphir/feature-db-contains

Add __contains__ method to allow to easily check if an id reference a valid document

Author: tariqdaouda

README.rst

@@ -13,8 +13,8 @@ pyArango
    :alt: downloads_week
    :target: https://pepy.tech/project/pyarango/week
 
-.. image:: https://travis-ci.org/tariqdaouda/pyArango.svg?branch=1.2.2
-    :target: https://travis-ci.org/tariqdaouda/pyArango
+.. image:: https://travis-ci.com/Alexsaphir/pyArango.svg?branch=master
+    :target: https://travis-ci.com/github/Alexsaphir/pyArango
 .. image:: https://img.shields.io/badge/python-2.7%2C%203.5-blue.svg
 .. image:: https://img.shields.io/badge/arangodb-3.0-blue.svg
 

pyArango/database.py

@@ -220,10 +220,15 @@ def dropAllCollections(self):
                 self[collection_name].delete()
         return
 
-    def AQLQuery(self, query, batchSize = 100, rawResults = False, bindVars = {}, options = {}, count = False, fullCount = False,
+    def AQLQuery(self, query, batchSize = 100, rawResults = False, bindVars = None, options = None, count = False, fullCount = False,
                  json_encoder = None, **moreArgs):
         """Set rawResults = True if you want the query to return dictionnaries instead of Document objects.
         You can use **moreArgs to pass more arguments supported by the api, such as ttl=60 (time to live)"""
+        if bindVars is None:
+            bindVars = {}
+        if options is None:
+            options = {}
+
         return AQLQuery(self, query, rawResults = rawResults, batchSize = batchSize, bindVars  = bindVars, options = options, count = count, fullCount = fullCount,
                         json_encoder = json_encoder, **moreArgs)
 
@@ -455,8 +460,11 @@ def no_fetch_run(
             return
         raise AQLFetchError("No results should be returned for the query.")
 
-    def explainAQLQuery(self, query, bindVars={}, allPlans = False):
+    def explainAQLQuery(self, query, bindVars = None, allPlans = False):
         """Returns an explanation of the query. Setting allPlans to True will result in ArangoDB returning all possible plans. False returns only the optimal plan"""
+        if bindVars is None:
+            bindVars = {}
+
         payload = {'query' : query, 'bindVars' : bindVars, 'allPlans' : allPlans}
         request = self.connection.session.post(self.getExplainURL(), data = json.dumps(payload, default=str))
         return request.json()
@@ -502,6 +510,14 @@ def transaction(self, collections, action, waitForSync = False, lockTimeout = No
     def __repr__(self):
         return "ArangoDB database: %s" % self.name
 
+    def __contains__(self, _id):
+        """allows to check if _id:str is the id of an existing document"""
+        col, key = _id.split('/')
+        try:
+            return key in self[col]
+        except KeyError:
+            return False
+
     def __getitem__(self, collectionName):
         """use database[collectionName] to get a collection from the database"""
         try:

pyArango/document.py

@@ -7,7 +7,12 @@ class DocumentStore(object):
     """Store all the data of a document in hierarchy of stores and handles validation.
     Does not store private information, these are in the document."""
 
-    def __init__(self, collection, validators={}, initDct={}, patch=False, subStore=False, validateInit=False):
+    def __init__(self, collection, validators=None, initDct=None, patch=False, subStore=False, validateInit=False):
+        if validators is None:
+            validators = {}
+        if initDct is None:
+            initDct = {}
+
         self.store = {}
         self.patchStore = {}
         self.collection = collection
@@ -128,7 +133,7 @@ def __dict__(self):
         return dict(self.store) + dict(self.patchStore)
 
     def __contains__(self, field):
-        return field in store
+        return field in self.store
 
     def __getitem__(self, field):
         """Get an element from the store"""

pyArango/query.py

@@ -156,8 +156,10 @@ def __init__(self, database, query, batchSize, bindVars, options, count, fullCou
         except QueryError as e:
             raise AQLQueryError( message = e.message, query = self.query, errors = e.errors)
 
-    def explain(self, bindVars={}, allPlans = False):
+    def explain(self, bindVars = None, allPlans = False):
         """Returns an explanation of the query. Setting allPlans to True will result in ArangoDB returning all possible plans. False returns only the optimal plan"""
+        if bindVars is None:
+            bindVars = {}
         return self.database.explainAQLQuery(self.query, bindVars, allPlans)
 
     def _raiseInitFailed(self, request):

pyArango/tests/tests.py

@@ -336,6 +336,16 @@ def test_document_fetch_by_key(self):
         doc2 = collection.fetchDocument(doc._key)
         self.assertEqual(doc._id, doc2._id)
 
+    def test_database_contains_id(self):
+        collection = self.db.createCollection(name="lala")
+        doc = collection.createDocument()
+        doc["name"] = 'iop'
+        doc.save()
+        result = doc["_id"] in self.db
+        self.assertTrue(result)
+        result = doc["_id"] + '1' in self.db
+        self.assertFalse(result)
+
     # @unittest.skip("stand by")
     def test_document_set_private_w_rest(self):
         collection = self.db.createCollection(name = "lala")

pyArango/theExceptions.py

@@ -178,7 +178,9 @@ def __str__(self):
 
 class ExportError(pyArangoException):
     """ Something went wrong using the export cursor """
-    def __init__(self, message, errors = {} ):
+    def __init__(self, message, errors = None ):
+        if errors is None:
+            errors = {}
         pyArangoException.__init__(self, message, errors)
 
 class DocumentNotFoundError(pyArangoException):