pep-484 for pool

also extends into some areas of utils, events and others
as needed.

Formalizes a public hierarchy for pool API,
with ManagesConnection -> PoolProxiedConnection /
ConnectionPoolEntry for connectionfairy / connectionrecord,
which are now what's exposed in the event API and other
APIs.  all public API docs moved to the new objects.

Corrects the mypy plugin's check for sqlalchemy-stubs
not being insatlled, which has to be imported using the
dash in the name to be effective.

Change-Id: I16c2cb43b2e840d28e70a015f370a768e70f3581

1 files changed, 11 insertions, 3 deletions

diff --git a/lib/sqlalchemy/engine/interfaces.py b/lib/sqlalchemy/engine/interfaces.py
index ce884614c..aab6b2de8 100644
--- a/lib/sqlalchemy/engine/interfaces.py
+++ b/lib/sqlalchemy/engine/interfaces.py
@@ -59,7 +59,7 @@ class DBAPIConnection(Protocol):
     def commit(self) -> None:
         ...
 
-    def cursor(self) -> "DBAPICursor":
+    def cursor(self) -> DBAPICursor:
         ...
 
     def rollback(self) -> None:
@@ -657,6 +657,9 @@ class Dialect:
 
     """
 
+    is_async: bool
+    """Whether or not this dialect is intended for asyncio use."""
+
     def create_connect_args(
         self, url: "URL"
     ) -> Tuple[Tuple[str], Mapping[str, Any]]:
@@ -1091,7 +1094,7 @@ class Dialect:
 
         raise NotImplementedError()
 
-    def do_close(self, dbapi_connection: PoolProxiedConnection) -> None:
+    def do_close(self, dbapi_connection: DBAPIConnection) -> None:
         """Provide an implementation of ``connection.close()``, given a DBAPI
         connection.
 
@@ -1104,6 +1107,11 @@ class Dialect:
 
         raise NotImplementedError()
 
+    def do_ping(self, dbapi_connection: DBAPIConnection) -> bool:
+        """ping the DBAPI connection and return True if the connection is
+        usable."""
+        raise NotImplementedError()
+
     def do_set_input_sizes(
         self,
         cursor: DBAPICursor,
@@ -1679,7 +1687,7 @@ class Dialect:
 
         """
 
-    def get_driver_connection(self, connection: PoolProxiedConnection) -> Any:
+    def get_driver_connection(self, connection: DBAPIConnection) -> Any:
         """Returns the connection object as returned by the external driver
         package.