Corrected and enhanced type checking issues (#52, #54, #60).

Author: anthony-tuininga

doc/src/release_notes.rst

@@ -25,6 +25,12 @@ Thick Mode Changes
 Common Changes
 ++++++++++++++
 
+#)  Fixed type checking errors
+    (`issue 52 <https://github.com/oracle/python-oracledb/issues/52>`__).
+#)  Enhanced type checking
+    (`issue 54 <https://github.com/oracle/python-oracledb/issues/54>`__),
+    (`issue 60 <https://github.com/oracle/python-oracledb/issues/60>`__).
+
 
 oracledb 1.1.0 (September 2022)
 -------------------------------

src/oracledb/aq.py

@@ -32,7 +32,7 @@
 import datetime
 
 from . import connection as connection_module
-from typing import Type, Union
+from typing import Union, List
 from . import errors, exceptions
 from .dbobject import DbObject, DbObjectType
 
@@ -48,7 +48,7 @@ def _from_impl(cls, connection, impl):
         queue._impl = impl
         return queue
 
-    def _verify_message(self, message: Type["MessageProperties"]) -> None:
+    def _verify_message(self, message: "MessageProperties") -> None:
         """
         Internal method used for verifying a message.
         """
@@ -58,7 +58,7 @@ def _verify_message(self, message: Type["MessageProperties"]) -> None:
             errors._raise_err(errors.ERR_MESSAGE_HAS_NO_PAYLOAD)
 
     @property
-    def connection(self) -> Type["connection_module.Connection"]:
+    def connection(self) -> "connection_module.Connection":
         """
         Returns the connection on which the queue was created.
         """
@@ -72,13 +72,13 @@ def deqmany(self, max_num_messages: int) -> list:
         message_impls = self._impl.deq_many(max_num_messages)
         return [MessageProperties._from_impl(impl) for impl in message_impls]
 
-    def deqMany(self, max_num_messages: int) -> list:
+    def deqMany(self, max_num_messages: int) -> List["MessageProperties"]:
         """
         Deprecated: use deqmany() instead.
         """
         return self.deqmany(max_num_messages)
 
-    def deqone(self) -> Union[Type["MessageProperties"], None]:
+    def deqone(self) -> Union["MessageProperties", None]:
         """
         Dequeues at most one message from the queue and returns it. If no
         message is dequeued, None is returned.
@@ -87,22 +87,22 @@ def deqone(self) -> Union[Type["MessageProperties"], None]:
         if message_impl is not None:
             return MessageProperties._from_impl(message_impl)
 
-    def deqOne(self) -> Union[Type["MessageProperties"], None]:
+    def deqOne(self) -> Union["MessageProperties", None]:
         """
         Deprecated: use deqone() instead.
         """
         return self.deqone()
 
     @property
-    def deqoptions(self) -> Type["DeqOptions"]:
+    def deqoptions(self) -> "DeqOptions":
         """
         Returns the options that will be used when dequeuing messages from the
         queue.
         """
         return self._deq_options
 
     @property
-    def deqOptions(self) -> Type["DeqOptions"]:
+    def deqOptions(self) -> "DeqOptions":
         """
         Deprecated: use deqoptions instead.
         """
@@ -131,7 +131,7 @@ def enqMany(self, messages: list) -> None:
         """
         return self.enqmany(messages)
 
-    def enqone(self, message: Type["MessageProperties"]) -> None:
+    def enqone(self, message: "MessageProperties") -> None:
         """
         Enqueues a single message into the queue. The message must be a message
         property object which has had its payload attribute set to a value that
@@ -140,22 +140,22 @@ def enqone(self, message: Type["MessageProperties"]) -> None:
         self._verify_message(message)
         self._impl.enq_one(message._impl)
 
-    def enqOne(self, message: Type["MessageProperties"]) -> None:
+    def enqOne(self, message: "MessageProperties") -> None:
         """
         Deprecated: use enqone() instead.
         """
         return self.enqone(message)
 
     @property
-    def enqoptions(self) -> Type["EnqOptions"]:
+    def enqoptions(self) -> "EnqOptions":
         """
         Returns the options that will be used when enqueuing messages into the
         queue.
         """
         return self._enq_options
 
     @property
-    def enqOptions(self) -> Type["EnqOptions"]:
+    def enqOptions(self) -> "EnqOptions":
         """
         Deprecated: use enqoptions() instead.
         """

src/oracledb/connect_params.py

@@ -34,7 +34,7 @@
 #------------------------------------------------------------------------------
 
 import functools
-from typing import Type, Union, Callable
+from typing import Union, Callable
 
 import oracledb
 
@@ -575,7 +575,7 @@ def wallet_location(self) -> Union[list, str]:
         """
         return self._impl.wallet_location
 
-    def copy(self) -> Type["ConnectParams"]:
+    def copy(self) -> "ConnectParams":
         """
         Creates a copy of the parameters and returns it.
         """

src/oracledb/connection.py

@@ -64,7 +64,7 @@ class Connection:
 
     def __init__(self,
                  dsn: str=None, *,
-                 pool: Type["pool_module.ConnectionPool"]=None,
+                 pool: "pool_module.ConnectionPool"=None,
                  params: ConnectParams=None,
                  **kwargs) -> None:
         """
@@ -603,7 +603,7 @@ def prepare(self) -> bool:
         """
         return self.tpc_prepare()
 
-    def queue(self, name: str, payload_type: [DbObjectType, str]=None, *,
+    def queue(self, name: str, payload_type: Union[DbObjectType, str]=None, *,
               payloadType: DbObjectType=None) -> Queue:
         """
         Creates and returns a queue which is used to enqueue and dequeue
@@ -1001,7 +1001,7 @@ class constructor does not check the validity of the supplied keyword
     """
     @functools.wraps(f)
     def connect(dsn: str=None, *,
-                pool: Type["pool_module.ConnectionPool"]=None,
+                pool: "pool_module.ConnectionPool"=None,
                 conn_class: Type[Connection]=Connection,
                 params: ConnectParams=None,
                 **kwargs) -> Connection:
@@ -1014,7 +1014,7 @@ def connect(dsn: str=None, *,
 
 @_connection_factory
 def connect(dsn: str=None, *,
-            pool: Type["pool_module.ConnectionPool"]=None,
+            pool: "pool_module.ConnectionPool"=None,
             conn_class: Type[Connection]=Connection,
             params: ConnectParams=None,
             user: str=None,

src/oracledb/cursor.py

@@ -29,7 +29,7 @@
 # fetching results from queries.
 #------------------------------------------------------------------------------
 
-from typing import Any, Type, Union, Callable
+from typing import Any, Union, Callable
 
 from . import __name__ as MODULE_NAME
 from . import errors, exceptions
@@ -42,7 +42,7 @@
 class Cursor:
     __module__ = MODULE_NAME
 
-    def __init__(self, connection: Type["connection_module.Connection"],
+    def __init__(self, connection: "connection_module.Connection",
                  scrollable: bool = False) -> None:
         self._impl = None
         self.connection = connection
@@ -309,7 +309,7 @@ def description(self) -> tuple:
 
     def execute(self, statement: Union[str, None],
                 parameters: Union[list, tuple, dict]=None,
-                **keyword_parameters: dict) -> Union[Type["Cursor"], None]:
+                **keyword_parameters: dict) -> Union["Cursor", None]:
         """
         Execute a statement against the database.
 
@@ -739,7 +739,7 @@ def var(self,
             encoding_errors: str=None,
             bypass_decode: bool=False,
             *,
-            encodingErrors: str=None) -> Type["Var"]:
+            encodingErrors: str=None) -> "Var":
         """
         Create a variable with the specified characteristics. This method was
         designed for use with PL/SQL in/out variables where the length or type

src/oracledb/dbobject.py

@@ -29,7 +29,7 @@
 # object type metadata: DbObject, DbObjectType and DbObjectAttr.
 #------------------------------------------------------------------------------
 
-from typing import Sequence, Type, Union
+from typing import Sequence, Union
 
 from . import __name__ as MODULE_NAME
 from .base_impl import DbType
@@ -91,7 +91,7 @@ def aslist(self) -> list:
             ix = self._impl.get_next_index(ix)
         return result
 
-    def copy(self) -> Type["DbObject"]:
+    def copy(self) -> "DbObject":
         """
         Create a copy of the object and return it.
         """
@@ -181,7 +181,7 @@ def trim(self, num: int) -> None:
         self._impl.trim(num)
 
     @property
-    def type(self) -> Type["DbObjectType"]:
+    def type(self) -> "DbObjectType":
         """
         Returns an ObjectType corresponding to the type of the object.
         """
@@ -211,7 +211,7 @@ def name(self) -> str:
         return self._impl.name
 
     @property
-    def type(self) -> Union[Type["DbObjectType"], DbType]:
+    def type(self) -> Union["DbObjectType", DbType]:
         """
         This read-only attribute returns the type of the attribute. This will
         be an Oracle Object Type if the variable binds Oracle objects;
@@ -274,7 +274,7 @@ def name(self) -> str:
         return self._impl.name
 
     @property
-    def element_type(self) -> Union[Type["DbObjectType"], DbType]:
+    def element_type(self) -> Union["DbObjectType", DbType]:
         """
         This read-only attribute returns the type of elements found in
         collections of this type, if iscollection is True; otherwise, it

src/oracledb/pool.py

@@ -120,7 +120,7 @@ def acquire(self,
                 tag: str=None,
                 matchanytag: bool=False,
                 shardingkey: list=None,
-                supershardingkey: list=None) -> Type["connection_module.Connection"]:
+                supershardingkey: list=None) -> "connection_module.Connection":
         """
         Acquire a connection from the pool and return it.
 
@@ -177,7 +177,7 @@ def close(self, force: bool=False) -> None:
         self._impl.close(force)
         self._impl = None
 
-    def drop(self, connection: Type["connection_module.Connection"]) -> None:
+    def drop(self, connection: "connection_module.Connection") -> None:
         """
         Drop the connection from the pool, which is useful if the connection is
         no longer usable (such as when the database session is killed).
@@ -322,7 +322,7 @@ def ping_interval(self) -> int:
     def ping_interval(self, value: int) -> None:
         self._impl.set_ping_interval(value)
 
-    def release(self, connection: Type["connection_module.Connection"],
+    def release(self, connection: "connection_module.Connection",
                 tag: str=None) -> None:
         """
         Release the connection back to the pool now, rather than whenever

src/oracledb/pool_params.py

@@ -468,7 +468,7 @@ def wait_timeout(self) -> int:
         """
         return self._impl.wait_timeout
 
-    def copy(self) -> Type["PoolParams"]:
+    def copy(self) -> "PoolParams":
         """
         Creates a copy of the parameters and returns it.
         """