Merge pull request #26 from joowani/develop

Develop

Author: joowani

README.rst

@@ -56,16 +56,14 @@ To install a stable version from PyPi_:
 
 .. code-block:: bash
 
-    pip install python-arango
+    ~$ pip install python-arango
 
 
 To install the latest version directly from GitHub_:
 
 .. code-block:: bash
 
-    git clone https://github.com/joowani/python-arango.git
-    cd python-arango
-    python setup.py install
+    ~$ pip install -e git+git@github.com:joowani/python-arango.git@master#egg=python-arango
 
 You may need to use ``sudo`` depending on your environment setup.
 

arango/aql.py

@@ -45,7 +45,7 @@ def explain(self, query, all_plans=False, max_plans=None, opt_rules=None):
         """Inspect the query and return its metadata.
 
         :param query: the query to inspect
-        :type query: str
+        :type query: str | unicode
         :param all_plans: if ``True`` all possible execution plans are
             returned, otherwise only the optimal one is returned
         :type all_plans: bool
@@ -82,7 +82,7 @@ def validate(self, query):
         """Validate the query.
 
         :param query: the query to validate
-        :type query: str
+        :type query: str | unicode
         :returns: whether the validation was successful
         :rtype: bool
         :raises arango.exceptions.AQLQueryValidateError: if the query cannot be
@@ -110,7 +110,7 @@ def execute(self, query, count=False, batch_size=None, ttl=None,
         """Execute the query and return the result cursor.
 
         :param query: the AQL query to execute
-        :type query: str
+        :type query: str | unicode
         :param count: whether the document count should be returned
         :type count: bool
         :param batch_size: maximum number of documents in one round trip
@@ -186,9 +186,9 @@ def create_function(self, name, code):
         """Create a new AQL function.
 
         :param name: the name of the new AQL function to create
-        :type name: str
+        :type name: str | unicode
         :param code: the definition of the function in Javascript
-        :type code: str
+        :type code: str | unicode
         :returns: whether the AQL function was created successfully
         :rtype: bool
         :raises arango.exceptions.AQLFunctionCreateError: if the AQL function
@@ -218,7 +218,7 @@ def delete_function(self, name, group=None, ignore_missing=False):
         including any namespaces.
 
         :param name: the name of the AQL function to delete
-        :type name: str
+        :type name: str | unicode
         :param group: treat the name as a namespace prefix
         :type group: bool
         :param ignore_missing: ignore missing functions
@@ -279,7 +279,7 @@ def configure(self, mode=None, limit=None):
         """Configure the AQL query cache.
 
         :param mode: the operation mode (``"off"``, ``"on"`` or ``"demand"``)
-        :type mode: str
+        :type mode: str | unicode
         :param limit: the maximum number of results to be stored
         :type limit: int
         :returns: the result of the operation

arango/async.py

@@ -90,7 +90,7 @@ def collection(self, name):
         a fire-and-forget style.
 
         :param name: the name of the collection
-        :type name: str
+        :type name: str | unicode
         :returns: the collection object
         :rtype: arango.collections.Collection
         """
@@ -104,7 +104,7 @@ def graph(self, name):
         style.
 
         :param name: the name of the graph
-        :type name: str
+        :type name: str | unicode
         :returns: the graph object
         :rtype: arango.graph.Graph
         """
@@ -119,7 +119,7 @@ class AsyncJob(object):
     :param connection: ArangoDB database connection
     :type connection: arango.connection.Connection
     :param job_id: the ID of the async job
-    :type job_id: str
+    :type job_id: str | unicode
     :param handler: the response handler
     :type handler: callable
     """
@@ -137,7 +137,7 @@ def id(self):
         """Return the ID of the async job.
 
         :returns: the ID of the async job
-        :rtype: str
+        :rtype: str | unicode
         """
         return self._id
 
@@ -147,7 +147,7 @@ def status(self):
         :returns: the status of the async job, which can be ``"pending"`` (the
             job is still in the queue), ``"done"`` (the job finished or raised
             an exception)
-        :rtype: str
+        :rtype: str | unicode
         :raises arango.exceptions.AsyncJobStatusError: if the status of the
             async job cannot be retrieved from the server
         """

arango/batch.py

@@ -65,7 +65,7 @@ def id(self):
         """Return the UUID of the batch request.
 
         :return: the UUID of the batch request
-        :rtype: str
+        :rtype: str | unicode
         """
         return self._id
 
@@ -187,7 +187,7 @@ def collection(self, name):
         and committed as a whole in a single HTTP call to the ArangoDB server.
 
         :param name: the name of the collection
-        :type name: str
+        :type name: str | unicode
         :returns: the collection object
         :rtype: arango.collections.Collection
         """
@@ -200,7 +200,7 @@ def graph(self, name):
         and committed as a whole in a single HTTP call to the ArangoDB server.
 
         :param name: the name of the graph
-        :type name: str
+        :type name: str | unicode
         :returns: the graph object
         :rtype: arango.graph.Graph
         """
@@ -226,7 +226,7 @@ def id(self):
         """Return the UUID of the batch job.
 
         :return: the UUID of the batch job
-        :rtype: str
+        :rtype: str | unicode
         """
         return self._id
 
@@ -249,7 +249,7 @@ def status(self):
         :returns: the batch job status, which can be ``"pending"`` (the job is
             still waiting to be committed), ``"done"`` (the job completed) or
             ``"error"`` (the job raised an exception)
-        :rtype: str
+        :rtype: str | unicode
         """
         return self._status