Correct typing for connect(), connect_async(), create_pool() and

create_pool_async() (#438) (from PR #444).

Author: anthony-tuininga

doc/src/release_notes.rst

@@ -142,6 +142,10 @@ Common Changes
 #)  All Oracle errors that result in the connection no longer being usable will
     be raised as ``DPY-4011: the database or network closed the connection``
     with the underlying reason being included in the error message.
+#)  Fix typing issue with :meth:`oracledb.connect()`,
+    :meth:`oracledb.connect_async()`, :meth:`oracledb.create_pool()` and
+    :meth:`oracledb.create_pool_async()`
+    (`issue 438 <https://github.com/oracle/python-oracledb/issues/438>`__).
 #)  Error ``DPY-2053: python-oracledb thin mode cannot be used because thick
     mode has already been enabled`` is now raised when attempting to use
     asyncio in thick mode

src/oracledb/connection.py

@@ -1206,7 +1206,9 @@ def unsubscribe(self, subscr: Subscription) -> None:
         subscr._impl.unsubscribe(self._impl)
 
 
-def _connection_factory(f):
+def _connection_factory(
+    f: Callable[..., Connection]
+) -> Callable[..., Connection]:
     """
     Decorator which checks the validity of the supplied keyword parameters by
     calling the original function (which does nothing), then creates and
@@ -2025,7 +2027,9 @@ async def tpc_rollback(self, xid: Optional[Xid] = None) -> None:
         await self._impl.tpc_rollback(xid)
 
 
-def _async_connection_factory(f):
+def _async_connection_factory(
+    f: Callable[..., AsyncConnection]
+) -> Callable[..., AsyncConnection]:
     """
     Decorator which checks the validity of the supplied keyword parameters by
     calling the original function (which does nothing), then creates and

src/oracledb/pool.py

@@ -569,7 +569,9 @@ def reconfigure(
             self.ping_interval = ping_interval
 
 
-def _pool_factory(f):
+def _pool_factory(
+    f: Callable[..., ConnectionPool]
+) -> Callable[..., ConnectionPool]:
     """
     Decorator which checks the validity of the supplied keyword parameters by
     calling the original function (which does nothing), then creates and
@@ -1097,7 +1099,9 @@ async def release(
         await connection.close()
 
 
-def _async_pool_factory(f):
+def _async_pool_factory(
+    f: Callable[..., AsyncConnectionPool]
+) -> Callable[..., AsyncConnectionPool]:
     """
     Decorator which checks the validity of the supplied keyword parameters by
     calling the original function (which does nothing), then creates and

utils/templates/connection.py

@@ -1204,7 +1204,9 @@ def unsubscribe(self, subscr: Subscription) -> None:
         subscr._impl.unsubscribe(self._impl)
 
 
-def _connection_factory(f):
+def _connection_factory(
+    f: Callable[..., Connection]
+) -> Callable[..., Connection]:
     """
     Decorator which checks the validity of the supplied keyword parameters by
     calling the original function (which does nothing), then creates and
@@ -1775,7 +1777,9 @@ async def tpc_rollback(self, xid: Optional[Xid] = None) -> None:
         await self._impl.tpc_rollback(xid)
 
 
-def _async_connection_factory(f):
+def _async_connection_factory(
+    f: Callable[..., AsyncConnection]
+) -> Callable[..., AsyncConnection]:
     """
     Decorator which checks the validity of the supplied keyword parameters by
     calling the original function (which does nothing), then creates and

utils/templates/pool.py

@@ -567,7 +567,9 @@ def reconfigure(
             self.ping_interval = ping_interval
 
 
-def _pool_factory(f):
+def _pool_factory(
+    f: Callable[..., ConnectionPool]
+) -> Callable[..., ConnectionPool]:
     """
     Decorator which checks the validity of the supplied keyword parameters by
     calling the original function (which does nothing), then creates and
@@ -778,7 +780,9 @@ async def release(
         await connection.close()
 
 
-def _async_pool_factory(f):
+def _async_pool_factory(
+    f: Callable[..., AsyncConnectionPool]
+) -> Callable[..., AsyncConnectionPool]:
     """
     Decorator which checks the validity of the supplied keyword parameters by
     calling the original function (which does nothing), then creates and