4.0 subclass signatures fix (#404)

* aligned acquire method for IOPool

* more align

* alignment

Author: martin-neotech

neo4j/io/__init__.py

@@ -85,6 +85,10 @@
     PoolConfig,
     WorkspaceConfig,
 )
+from neo4j.api import (
+    READ_ACCESS,
+    WRITE_ACCESS,
+)
 
 # Set up logger
 log = getLogger("neo4j")
@@ -413,11 +417,12 @@ def time_remaining():
                     raise ClientError("Failed to obtain a connection from pool "
                                       "within {!r}s".format(timeout))
 
-    def acquire(self, access_mode=None, timeout=None):
+    def acquire(self, access_mode=None, timeout=None, database=None):
         """ Acquire a connection to a server that can satisfy a set of parameters.
 
         :param access_mode:
         :param timeout:
+        :param database:
         """
 
     def release(self, *connections):
@@ -459,7 +464,7 @@ def deactivate(self, address):
             if not connections:
                 self.remove(address)
 
-    def on_write_failure(self, *, address):
+    def on_write_failure(self, address):
         raise WriteServiceUnavailable("No write service available for pool {}".format(self))
 
     def remove(self, address):
@@ -488,7 +493,15 @@ def close(self):
 class BoltPool(IOPool):
 
     @classmethod
-    def open(cls, address, *, auth=None, pool_config, workspace_config):
+    def open(cls, address, *, auth, pool_config, workspace_config):
+        """Create a new BoltPool
+
+        :param address:
+        :param auth:
+        :param pool_config:
+        :param workspace_config:
+        :return: BoltPool
+        """
 
         def opener(addr, timeout):
             return Bolt.open(addr, auth=auth, timeout=timeout, **pool_config)
@@ -505,7 +518,7 @@ def __init__(self, opener, pool_config, workspace_config, address):
     def __repr__(self):
         return "<{} address={!r}>".format(self.__class__.__name__, self.address)
 
-    def acquire(self, *, access_mode=None, timeout=None, database=None):
+    def acquire(self, access_mode=None, timeout=None, database=None):
         # The access_mode and database is not needed for a direct connection, its just there for consistency.
         return self._acquire(self.address, timeout)
 
@@ -515,7 +528,16 @@ class Neo4jPool(IOPool):
     """
 
     @classmethod
-    def open(cls, *addresses, auth=None, routing_context=None, pool_config=None, workspace_config=None):
+    def open(cls, *addresses, auth, pool_config, workspace_config, routing_context=None):
+        """Create a new Neo4jPool
+
+        :param addresses: one or more address as positional argument
+        :param auth:
+        :param pool_config:
+        :param workspace_config:
+        :param routing_context:
+        :return: Neo4jPool
+        """
 
         def opener(addr, timeout):
             return Bolt.open(addr, auth=auth, timeout=timeout, **pool_config)
@@ -842,7 +864,12 @@ def _select_address(self, *, access_mode, database):
                 raise WriteServiceUnavailable("No write service currently available")
         return choice(addresses_by_usage[min(addresses_by_usage)])
 
-    def acquire(self, *, access_mode, timeout, database):
+    def acquire(self, access_mode=None, timeout=None, database=None):
+        if access_mode not in (WRITE_ACCESS, READ_ACCESS):
+            raise ClientError("Non valid 'access_mode'; {}".format(access_mode))
+        if not timeout:
+            raise ClientError("'timeout' must be a float larger than 0; {}".format(timeout))
+
         from neo4j.api import check_access_mode
         access_mode = check_access_mode(access_mode)
         while True:
@@ -859,7 +886,7 @@ def acquire(self, *, access_mode, timeout, database):
             else:
                 return connection
 
-    def deactivate(self, *, address):
+    def deactivate(self, address):
         """ Deactivate an address from the connection pool,
         if present, remove from the routing table and also closing
         all idle connections to that address.
@@ -874,7 +901,7 @@ def deactivate(self, *, address):
         log.debug("[#0000]  C: <ROUTING> table=%r", self.routing_tables)
         super(Neo4jPool, self).deactivate(address)
 
-    def on_write_failure(self, *, address):
+    def on_write_failure(self, address):
         """ Remove a writer address from the routing table, if present.
         """
         log.debug("[#0000]  C: <ROUTING> Removing writer %r", address)

neo4j/io/_bolt3.py

@@ -272,7 +272,7 @@ def send_all(self):
                              self.server_info.address,
                              "; ".join(map(repr, error.args))))
             if self.pool:
-                self.pool.deactivate(self.unresolved_address)
+                self.pool.deactivate(address=self.unresolved_address)
             raise
 
     def fetch_message(self):
@@ -302,7 +302,7 @@ def fetch_message(self):
                              self.server_info.address,
                              "; ".join(map(repr, error.args))))
             if self.pool:
-                self.pool.deactivate(self.unresolved_address)
+                self.pool.deactivate(address=self.unresolved_address)
             raise
 
         if details:

neo4j/io/_bolt4x0.py

@@ -276,7 +276,7 @@ def send_all(self):
                              self.server_info.address,
                              "; ".join(map(repr, error.args))))
             if self.pool:
-                self.pool.deactivate(self.unresolved_address)
+                self.pool.deactivate(address=self.unresolved_address)
             raise
 
     def fetch_message(self):
@@ -306,7 +306,7 @@ def fetch_message(self):
                              self.server_info.address,
                              "; ".join(map(repr, error.args))))
             if self.pool:
-                self.pool.deactivate(self.unresolved_address)
+                self.pool.deactivate(address=self.unresolved_address)
             raise
 
         if details:

tests/unit/io/test_direct.py

@@ -90,7 +90,7 @@ def opener(addr, timeout):
         super().__init__(opener, self.pool_config, self.workspace_config)
         self.address = address
 
-    def acquire(self, access_mode=None, timeout=None):
+    def acquire(self, access_mode=None, timeout=None, database=None):
         return self._acquire(self.address, timeout)