Make type checkers happy.

Author: anthony-tuininga

src/oracledb/__init__.py

@@ -30,76 +30,118 @@
 
 import sys
 
-from .version import __version__
+from .version import (
+    __version__ as __version__
+)
+
 from .constants import *
 from .exceptions import *
-from .errors import _Error
-from .defaults import defaults
-from .connection import connect, Connection
-from .cursor import Cursor
-from .pool import create_pool, ConnectionPool
-from .connect_params import ConnectParams
-from .pool_params import PoolParams
-from .lob import LOB
-from .dbobject import DbObject, DbObjectType
-from .var import Var
-from .dsn import makedsn
-from .driver_mode import is_thin_mode
+
+from .errors import (
+    _Error as _Error
+)
+
+from .defaults import (
+    defaults as defaults
+)
+
+from .connection import (
+    connect as connect,
+    Connection as Connection
+)
+
+from .cursor import (
+    Cursor as Cursor
+)
+
+from .pool import (
+    create_pool as create_pool,
+    ConnectionPool as ConnectionPool
+)
+
+from .connect_params import (
+    ConnectParams as ConnectParams
+)
+
+from .pool_params import (
+    PoolParams as PoolParams
+)
+
+from .lob import (
+    LOB as LOB
+)
+
+from .dbobject import (
+    DbObject as DbObject,
+    DbObjectType as DbObjectType
+)
+
+from .var import (
+    Var as Var
+)
+
+from .dsn import (
+    makedsn as makedsn
+)
+
+from .driver_mode import (
+    is_thin_mode as is_thin_mode
+)
 
 from .base_impl import (
 
     # database types
-    DB_TYPE_BFILE,
-    DB_TYPE_BINARY_DOUBLE,
-    DB_TYPE_BINARY_FLOAT,
-    DB_TYPE_BINARY_INTEGER,
-    DB_TYPE_BLOB,
-    DB_TYPE_BOOLEAN,
-    DB_TYPE_CHAR,
-    DB_TYPE_CLOB,
-    DB_TYPE_CURSOR,
-    DB_TYPE_DATE,
-    DB_TYPE_INTERVAL_DS,
-    DB_TYPE_INTERVAL_YM,
-    DB_TYPE_JSON,
-    DB_TYPE_LONG,
-    DB_TYPE_LONG_NVARCHAR,
-    DB_TYPE_LONG_RAW,
-    DB_TYPE_NCHAR,
-    DB_TYPE_NCLOB,
-    DB_TYPE_NUMBER,
-    DB_TYPE_NVARCHAR,
-    DB_TYPE_OBJECT,
-    DB_TYPE_RAW,
-    DB_TYPE_ROWID,
-    DB_TYPE_TIMESTAMP,
-    DB_TYPE_TIMESTAMP_LTZ,
-    DB_TYPE_TIMESTAMP_TZ,
-    DB_TYPE_UNKNOWN,
-    DB_TYPE_UROWID,
-    DB_TYPE_VARCHAR,
+    DB_TYPE_BFILE as DB_TYPE_BFILE,
+    DB_TYPE_BINARY_DOUBLE as DB_TYPE_BINARY_DOUBLE,
+    DB_TYPE_BINARY_FLOAT as DB_TYPE_BINARY_FLOAT,
+    DB_TYPE_BINARY_INTEGER as DB_TYPE_BINARY_INTEGER,
+    DB_TYPE_BLOB as DB_TYPE_BLOB,
+    DB_TYPE_BOOLEAN as DB_TYPE_BOOLEAN,
+    DB_TYPE_CHAR as DB_TYPE_CHAR,
+    DB_TYPE_CLOB as DB_TYPE_CLOB,
+    DB_TYPE_CURSOR as DB_TYPE_CURSOR,
+    DB_TYPE_DATE as DB_TYPE_DATE,
+    DB_TYPE_INTERVAL_DS as DB_TYPE_INTERVAL_DS,
+    DB_TYPE_INTERVAL_YM as DB_TYPE_INTERVAL_YM,
+    DB_TYPE_JSON as DB_TYPE_JSON,
+    DB_TYPE_LONG as DB_TYPE_LONG,
+    DB_TYPE_LONG_NVARCHAR as DB_TYPE_LONG_NVARCHAR,
+    DB_TYPE_LONG_RAW as DB_TYPE_LONG_RAW,
+    DB_TYPE_NCHAR as DB_TYPE_NCHAR,
+    DB_TYPE_NCLOB as DB_TYPE_NCLOB,
+    DB_TYPE_NUMBER as DB_TYPE_NUMBER,
+    DB_TYPE_NVARCHAR as DB_TYPE_NVARCHAR,
+    DB_TYPE_OBJECT as DB_TYPE_OBJECT,
+    DB_TYPE_RAW as DB_TYPE_RAW,
+    DB_TYPE_ROWID as DB_TYPE_ROWID,
+    DB_TYPE_TIMESTAMP as DB_TYPE_TIMESTAMP,
+    DB_TYPE_TIMESTAMP_LTZ as DB_TYPE_TIMESTAMP_LTZ,
+    DB_TYPE_TIMESTAMP_TZ as DB_TYPE_TIMESTAMP_TZ,
+    DB_TYPE_UNKNOWN as DB_TYPE_UNKNOWN,
+    DB_TYPE_UROWID as DB_TYPE_UROWID,
+    DB_TYPE_VARCHAR as DB_TYPE_VARCHAR,
 
     # API types
-    BINARY,
-    DATETIME,
-    NUMBER,
-    ROWID,
-    STRING
+    BINARY as BINARY,
+    DATETIME as DATETIME,
+    NUMBER as NUMBER,
+    ROWID as ROWID,
+    STRING as STRING
 )
 
 from .thick_impl import (
-    clientversion,
-    init_oracle_client
+    clientversion as clientversion,
+    init_oracle_client as init_oracle_client
 )
 
 from .constructors import (
-    Binary,
-    Date,
-    DateFromTicks,
-    Time,
-    TimeFromTicks,
-    Timestamp,
-    TimestampFromTicks
+    Binary as Binary,
+    Date as Date,
+    DateFromTicks as DateFromTicks,
+    Time as Time,
+    TimeFromTicks as TimeFromTicks,
+    Timestamp as Timestamp,
+    TimestampFromTicks as TimestampFromTicks
 )
 
 package = sys.modules[__name__]

src/oracledb/aq.py

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2021, 2022, Oracle and/or its affiliates.
+# Copyright (c) 2021, 2023, Oracle and/or its affiliates.
 #
 # This software is dual-licensed to you under the Universal Permissive License
 # (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
@@ -32,7 +32,7 @@
 import datetime
 
 from . import connection as connection_module
-from typing import Union, List
+from typing import Any, Union, List
 from . import errors, exceptions
 from .dbobject import DbObject, DbObjectType
 
@@ -491,7 +491,7 @@ def payload(self) -> Union[bytes, DbObject]:
         return self._impl.payload
 
     @payload.setter
-    def payload(self, value: object) -> None:
+    def payload(self, value: Any) -> None:
         if isinstance(value, DbObject):
             self._impl.set_payload_object(value._impl)
         elif not isinstance(value, (str, bytes)):

src/oracledb/connection.py

@@ -533,7 +533,7 @@ def module(self, value: str) -> None:
         self._verify_connected()
         self._impl.set_module(value)
 
-    def msgproperties(self, payload: Union[bytes, DbObject]=None,
+    def msgproperties(self, payload: Union[bytes, str, DbObject]=None,
                       correlation: str=None, delay: int=None,
                       exceptionq: str=None, expiration: int=None,
                       priority: int=None, recipients: list=None) -> MessageProperties:

src/oracledb/cursor.py

@@ -240,10 +240,10 @@ def bindvars(self) -> list:
         self._verify_open()
         return self._impl.get_bind_vars()
 
-    def callfunc(self, name: str, return_type: object,
+    def callfunc(self, name: str, return_type: Any,
                  parameters: Union[list, tuple]=None,
                  keyword_parameters: dict=None, *,
-                 keywordParameters: dict=None) -> object:
+                 keywordParameters: dict=None) -> Any:
         """
         Call a function with the given name. The return type is specified in
         the same notation as is required by setinputsizes(). The sequence of
@@ -309,7 +309,7 @@ def description(self) -> tuple:
 
     def execute(self, statement: Union[str, None],
                 parameters: Union[list, tuple, dict]=None,
-                **keyword_parameters: Any) -> Union["Cursor", None]:
+                **keyword_parameters: Any) -> Any:
         """
         Execute a statement against the database.
 
@@ -495,7 +495,7 @@ def fetchmany(self, size: int=None, numRows: int=None) -> list:
             result.append(row)
         return result
 
-    def fetchone(self) -> object:
+    def fetchone(self) -> Any:
         """
         Fetch the next row of a query result set, returning a single tuple or
         None when no more data is available.

src/oracledb/dbobject.py

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2021, 2022, Oracle and/or its affiliates.
+# Copyright (c) 2021, 2023, Oracle and/or its affiliates.
 #
 # This software is dual-licensed to you under the Universal Permissive License
 # (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
@@ -29,7 +29,7 @@
 # object type metadata: DbObject, DbObjectType and DbObjectAttr.
 #------------------------------------------------------------------------------
 
-from typing import Sequence, Union
+from typing import Any, Sequence, Union
 
 from . import errors
 from . import __name__ as MODULE_NAME
@@ -69,7 +69,7 @@ def _from_impl(cls, impl):
         obj._type = None
         return obj
 
-    def append(self, element: object) -> None:
+    def append(self, element: Any) -> None:
         """
         Append an element to the collection object. If no elements exist in the
         collection, this creates an element at index 0; otherwise, it creates
@@ -147,7 +147,7 @@ def first(self) -> int:
         self._ensure_is_collection()
         return self._impl.get_first_index()
 
-    def getelement(self, index: int) -> object:
+    def getelement(self, index: int) -> Any:
         """
         Return the element at the specified index of the collection. If no
         element exists at that index, an exception is raised.
@@ -181,7 +181,7 @@ def prev(self, index: int) -> int:
         self._ensure_is_collection()
         return self._impl.get_prev_index(index)
 
-    def setelement(self, index: int, value: object) -> None:
+    def setelement(self, index: int, value: Any) -> None:
         """
         Set the value in the collection at the specified index to the given
         value.

src/oracledb/lob.py

@@ -28,7 +28,7 @@
 # Contains the LOB class for managing BLOB, CLOB, NCLOB and BFILE data.
 #------------------------------------------------------------------------------
 
-from typing import Union
+from typing import Any, Union
 
 from . import __name__ as MODULE_NAME
 from . import errors
@@ -146,7 +146,7 @@ def trim(self, new_size: int=0, *, newSize: int=None) -> None:
         self._impl.trim(new_size)
 
     @property
-    def type(self) -> object:
+    def type(self) -> Any:
         """
         Returns the type of the LOB as one of the database type constants.
         """

src/oracledb/soda.py

@@ -1,5 +1,5 @@
 #------------------------------------------------------------------------------
-# Copyright (c) 2021, 2022, Oracle and/or its affiliates.
+# Copyright (c) 2021, 2023, Oracle and/or its affiliates.
 #
 # This software is dual-licensed to you under the Universal Permissive License
 # (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
@@ -29,7 +29,7 @@
 # SodaDatabase, SodaCollection, SodaDocument, SodaDocCursor and SodaOperation.
 #------------------------------------------------------------------------------
 
-from typing import Union, List
+from typing import Any, Union, List
 import json
 
 from . import connection, errors
@@ -46,7 +46,7 @@ def _from_impl(cls, conn, impl):
         db._impl = impl
         return db
 
-    def _get_content_bytes(self, content: object) -> bytes:
+    def _get_content_bytes(self, content: Any) -> bytes:
         """
         Internal method used for returning the bytes to store in document
         content.
@@ -84,7 +84,7 @@ def createCollection(self, name: str, metadata: Union[str, dict]=None,
         collection_impl = self._impl.create_collection(name, metadata, mapMode)
         return SodaCollection._from_impl(self, collection_impl)
 
-    def createDocument(self, content: object, key: str=None,
+    def createDocument(self, content: Any, key: str=None,
                        mediaType: str="application/json") -> "SodaDocument":
         """
         Creates a SODA document usable for SODA write operations. You only need
@@ -245,16 +245,15 @@ def insertManyAndGet(self, docs: list, hint: str=None) -> list:
                                                   return_docs=True)
         return [SodaDocument._from_impl(i) for i in return_doc_impls]
 
-    def insertOne(self, doc: object) -> None:
+    def insertOne(self, doc: Any) -> None:
         """
         Inserts a given document into the collection. The input document can be
         a dictionary or list or an existing SODA document object.
         """
         doc_impl = self._process_doc_arg(doc)
         self._impl.insert_one(doc_impl, hint=None, return_doc=False)
 
-    def insertOneAndGet(self, doc: object,
-                        hint: str=None) -> "SodaDocument":
+    def insertOneAndGet(self, doc: Any, hint: str=None) -> "SodaDocument":
         """
         Similarly to insertOne() this method inserts a given document into the
         collection. The only difference is that it returns a SODA Document
@@ -291,7 +290,7 @@ def name(self) -> str:
         """
         return self._impl.name
 
-    def save(self, doc: object) -> None:
+    def save(self, doc: Any) -> None:
         """
         Saves a document into the collection. This method is equivalent to
         insertOne() except that if client-assigned keys are used, and the
@@ -301,7 +300,7 @@ def save(self, doc: object) -> None:
         doc_impl = self._process_doc_arg(doc)
         self._impl.save(doc_impl, hint=None, return_doc=False)
 
-    def saveAndGet(self, doc: object, hint: str=None) -> "SodaDocument":
+    def saveAndGet(self, doc: Any, hint: str=None) -> "SodaDocument":
         """
         Saves a document into the collection. This method is equivalent to
         insertOneAndGet() except that if client-assigned keys are used, and the
@@ -601,7 +600,7 @@ def remove(self) -> int:
         """
         return self._collection._impl.remove(self)
 
-    def replaceOne(self, doc: object) -> bool:
+    def replaceOne(self, doc: Any) -> bool:
         """
         Replaces a single document in the collection with the specified
         document. The input document can be a dictionary or list or an existing
@@ -615,7 +614,7 @@ def replaceOne(self, doc: object) -> bool:
         return self._collection._impl.replace_one(self, doc_impl,
                                                   return_doc=False)
 
-    def replaceOneAndGet(self, doc: object) -> "SodaDocument":
+    def replaceOneAndGet(self, doc: Any) -> "SodaDocument":
         """
         Similarly to replaceOne(), this method replaces a single document in
         the collection with the specified document. The only difference is that