Add compatibility for Python 3.x

Author: Joohwan Oh

README.md

@@ -11,7 +11,7 @@ Driver for ArangoDB REST API
 Overview
 --------
 
-py-arango is a Python (2.7) driver for ArangoDB
+py-arango is a Python (2.7, 3.4) driver for ArangoDB
 (<https://www.arangodb.com/>)
 
 Documentation
@@ -25,13 +25,13 @@ Installation
 -   Stable
 
 ```bash
-sudo pip install py-arango 
+sudo pip install py-arango
 ```
 
 -   Latest
 
 ```bash
-git clone https://github.com/Joowani/py-arango.git 
+git clone https://github.com/Joowani/py-arango.git
 cd py-arango
 python2.7 setup.py install
 ```
@@ -244,17 +244,17 @@ Simple Queries (Collection-Specific)
 
 ```python
 # Return the first 5 documents in collection "my_col"
-my_col.first(5)           
+my_col.first(5)
 
 # Return the last 3 documents
-my_col.last(3)                          
+my_col.last(3)
 
 # Return all documents (cursor generator object)
 my_col.all()
 list(my_col.all())
 
 # Return a random document
-my_col.any()  
+my_col.any()
 
 # Return first document whose "value" is 1
 my_col.get_first_example({"value": 1})
@@ -263,15 +263,15 @@ my_col.get_first_example({"value": 1})
 my_col.get_by_example({"value": 1})
 
 # Update all documents whose "value" is 1 with a new attribute
-my_col.update_by_example(               
+my_col.update_by_example(
   {"value": 1}, new_value={"new_attr": 1}
 )
 
 # Return all documents within a radius around a given coordinate (requires geo-index)
 my_col.within(latitude=100, longitude=20, radius=15)
 
 # Return all documents near a given coordinate (requires geo-index)
-my_col.near(latitude=100, longitude=20) 
+my_col.near(latitude=100, longitude=20)
 ```
 
 Graphs

arango/__init__.py

@@ -167,4 +167,4 @@ def remove_database(self, name):
 
 if __name__ == "__main__":
     a = Arango()
-    print a.version
+    print(a.version)

arango/api.py

@@ -3,6 +3,7 @@
 import json
 
 from arango.clients.default import DefaultArangoClient
+from arango.utils import is_string
 
 
 class ArangoAPI(object):
@@ -44,13 +45,13 @@ def url_prefix(self):
         :rtype: str
         """
         return "{protocol}://{host}:{port}/_db/{db}".format(
-            protocol = self.protocol,
-            host = self.host,
-            port = self.port,
-            db = self.db_name,
+            protocol=self.protocol,
+            host=self.host,
+            port=self.port,
+            db=self.db_name,
         )
 
-    def head(self, path, params=None, headers=None, batch=False):
+    def head(self, path, params=None, headers=None):
         """Execute an HTTP HEAD method."""
         return self.client.head(
             url=self.url_prefix + path,
@@ -59,7 +60,7 @@ def head(self, path, params=None, headers=None, batch=False):
             auth=(self.username, self.password)
         )
 
-    def get(self, path, params=None, headers=None, batch=False):
+    def get(self, path, params=None, headers=None):
         """Execute an HTTP GET method."""
         return self.client.get(
             url=self.url_prefix + path,
@@ -68,37 +69,37 @@ def get(self, path, params=None, headers=None, batch=False):
             auth=(self.username, self.password),
         )
 
-    def put(self, path, data=None, params=None, headers=None, batch=False):
+    def put(self, path, data=None, params=None, headers=None):
         """Execute an HTTP PUT method."""
         return self.client.put(
             url=self.url_prefix + path,
-            data=data if isinstance(data, basestring) else json.dumps(data),
+            data=data if is_string(data) else json.dumps(data),
             params=params,
             headers=headers,
             auth=(self.username, self.password)
         )
 
-    def post(self, path, data=None, params=None, headers=None, batch=False):
+    def post(self, path, data=None, params=None, headers=None):
         """Execute an HTTP POST method."""
         return self.client.post(
             url=self.url_prefix + path,
-            data=data if isinstance(data, basestring) else json.dumps(data),
+            data=data if is_string(data) else json.dumps(data),
             params=params,
             headers=headers,
             auth=(self.username, self.password)
         )
 
-    def patch(self, path, data=None, params=None, headers=None, batch=False):
+    def patch(self, path, data=None, params=None, headers=None):
         """Execute an HTTP PATCH method."""
         return self.client.patch(
             url=self.url_prefix + path,
-            data=data if isinstance(data, basestring) else json.dumps(data),
+            data=data if is_string(data) else json.dumps(data),
             params=params,
             headers=headers,
             auth=(self.username, self.password)
         )
 
-    def delete(self, path, params=None, headers=None, batch=False):
+    def delete(self, path, params=None, headers=None):
         """Execute an HTTP DELETE method."""
         return self.client.delete(
             url=self.url_prefix + path,

arango/batch.py

@@ -1,7 +1,9 @@
 import json
 import inspect
-from urllib import urlencode
-
+try:
+    from urllib import urlencode
+except ImportError:
+    from urllib.parse import urlencode
 from arango.exceptions import (
     BatchInvalidError,
     BatchExecuteError
@@ -53,7 +55,7 @@ def stringify_request(method, path, params=None, headers=None, data=None):
     path = path + "?" + urlencode(params) if params else path
     request_string = "{} {} HTTP/1.1".format(method, path)
     if headers:
-        for key, value in headers.iteritems():
+        for key, value in headers.items():
             request_string += "\r\n{key}: {value}".format(
                 key=key, value=value
             )

arango/clients/session.py

@@ -0,0 +1,69 @@
+"""Session based client using requests.  This is much faster than default."""
+
+import requests
+
+from arango.response import ArangoResponse
+from arango.clients.base import BaseArangoClient
+
+
+class SessionArangoClient(BaseArangoClient):
+
+    def __init__(self):
+        self.s = requests.Session()
+
+    def head(self, url, params=None, headers=None, auth=None):
+        res = self.s.head(
+            url=url,
+            params=params,
+            headers=headers,
+            auth=auth,
+        )
+        return ArangoResponse(res.status_code, res.text)
+
+    def get(self, url, params=None, headers=None, auth=None):
+        res = self.s.get(
+            url=url,
+            params=params,
+            headers=headers,
+            auth=auth,
+        )
+        return ArangoResponse(res.status_code, res.text)
+
+    def put(self, url, data=None, params=None, headers=None, auth=None):
+        res = self.s.put(
+            url=url,
+            data=data,
+            params=params,
+            headers=headers,
+            auth=auth,
+        )
+        return ArangoResponse(res.status_code, res.text)
+
+    def post(self, url, data=None, params=None, headers=None, auth=None):
+        res = self.s.post(
+            url=url,
+            data="" if data is None else data,
+            params={} if params is None else params,
+            headers={} if headers is None else headers,
+            auth=auth
+        )
+        return ArangoResponse(res.status_code, res.text)
+
+    def patch(self, url, data=None, params=None, headers=None, auth=None):
+        res = self.s.patch(
+            url=url,
+            data=data,
+            params=params,
+            headers=headers,
+            auth=auth,
+        )
+        return ArangoResponse(res.status_code, res.text)
+
+    def delete(self, url, params=None, headers=None, auth=None):
+        res = self.s.delete(
+            url=url,
+            params=params,
+            headers=headers,
+            auth=auth,
+        )
+        return ArangoResponse(res.status_code, res.text)

arango/exceptions.py

@@ -66,6 +66,7 @@ class DatabaseRemoveError(ArangoRequestError):
 # Collections #
 ###############
 
+
 class CollectionCorruptedError(Exception):
     """The collection is corrupted (unknown status)."""
 
@@ -125,6 +126,7 @@ class CollectionBulkImportError(ArangoRequestError):
 # Documents #
 #############
 
+
 class DocumentInvalidError(Exception):
     """The document is invalid."""
 
@@ -229,6 +231,7 @@ class IndexRemoveError(ArangoRequestError):
 # Queries #
 ###########
 
+
 class QueryExplainError(ArangoRequestError):
     """Failed to explain the query."""
 
@@ -260,6 +263,7 @@ class AQLFunctionRemoveError(ArangoRequestError):
 # Simple Queries #
 ##################
 
+
 class SimpleQueryGetByExampleError(ArangoRequestError):
     """Failed to execute the ``by-example`` simple query."""
 
@@ -319,13 +323,15 @@ class SimpleQueryError(ArangoRequestError):
 # Transactions #
 ################
 
+
 class TransactionExecuteError(ArangoRequestError):
     """Failed to execute a transaction."""
 
 ###########
 # Batches #
 ###########
 
+
 class BatchInvalidError(Exception):
     """The Batch request is malformed."""
 
@@ -337,6 +343,7 @@ class BatchExecuteError(ArangoRequestError):
 # Graphs #
 ##########
 
+
 class GraphNotFoundError(ArangoNotFoundError):
     """Failed to find the graph."""
 
@@ -368,6 +375,7 @@ class GraphTraversalError(ArangoRequestError):
 # Vertex Collections #
 ######################
 
+
 class VertexCollectionListError(ArangoRequestError):
     """Failed to list the vertex collections."""
 
@@ -383,6 +391,7 @@ class VertexCollectionRemoveError(ArangoRequestError):
 # Edge Collections/Definitions #
 ################################
 
+
 class EdgeDefinitionListError(ArangoRequestError):
     """Failed to list the edge collections."""
 

arango/graph.py

@@ -372,7 +372,7 @@ def remove_vertex(self, vertex_id, rev=None, wait_for_sync=False,
         :raises: RevisionMismatchError, VertexRemoveError
         """
         path = "/_api/gharial/{}/vertex/{}".format(self.name, vertex_id)
-        params={"waitForSync": wait_for_sync}
+        params = {"waitForSync": wait_for_sync}
         if rev is not None:
             params["rev"] = rev
         if _batch:
@@ -584,8 +584,8 @@ def remove_edge(self, edge_id, rev=None, wait_for_sync=False,
 
     def execute_traversal(self, start_vertex, direction=None,
             strategy=None, order=None, item_order=None, uniqueness=None,
-            max_iterations=None, min_depth=None, max_depth=None,
-            init=None, filters=None, visitor=None, expander=None, sort=None):
+            max_iterations=None, min_depth=None, max_depth=None, init=None,
+            filters=None, visitor=None, expander=None, sort=None):
         """Execute a graph traversal and return the visited vertices.
 
         For more details on ``init``, ``filter``, ``visitor``, ``expander``

arango/tests/test_aql_functions.py

@@ -65,4 +65,4 @@ def test_remove_aql_functions_by_group(self):
 
 
 if __name__ == "__main__":
-    unittest.main()
+    unittest.main()

arango/tests/test_collection.py

@@ -4,11 +4,13 @@
 
 from arango import Arango
 from arango.exceptions import *
+from arango.utils import is_string
 from arango.tests.utils import (
     get_next_col_name,
     get_next_db_name
 )
 
+
 class CollectionManagementTest(unittest.TestCase):
 
     def setUp(self):
@@ -84,7 +86,7 @@ def test_collection_add_with_config(self):
         self.assertFalse(col.do_compact)
         self.assertTrue(col.wait_for_sync)
         self.assertTrue(col.is_edge)
-        self.assertTrue(isinstance(col.id, basestring))
+        self.assertTrue(is_string(col.id))
         self.assertTrue(isinstance(col.figures, dict))
 
     def test_collection_setters(self):
@@ -117,4 +119,3 @@ def test_collection_rotate_journal(self):
 
 if __name__ == "__main__":
     unittest.main()
-