Internal changes to ensure that no circular imports occur.

Author: anthony-tuininga

doc/src/release_notes.rst

@@ -27,6 +27,8 @@ Thick Mode Changes
 Common Changes
 ++++++++++++++
 
+#)  Internal changes to ensure that no circular imports occur.
+
 
 oracledb 2.2.0 (May 2024)
 -------------------------

src/oracledb/__init__.py

@@ -40,13 +40,47 @@
     )
     warnings.warn(message)
 
-from .version import __version__ as __version__
+from . import base_impl, thick_impl, thin_impl
 
-from .constants import (
-    # mandated DB API constants
-    apilevel as apilevel,
-    threadsafety as threadsafety,
-    paramstyle as paramstyle,
+from .base_impl import (
+    # database types
+    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,
+    DB_TYPE_VECTOR as DB_TYPE_VECTOR,
+    DB_TYPE_XMLTYPE as DB_TYPE_XMLTYPE,
+    # API types
+    BINARY as BINARY,
+    DATETIME as DATETIME,
+    NUMBER as NUMBER,
+    ROWID as ROWID,
+    STRING as STRING,
     # authentication modes
     AUTH_MODE_DEFAULT as AUTH_MODE_DEFAULT,
     AUTH_MODE_PRELIM as AUTH_MODE_PRELIM,
@@ -66,6 +100,19 @@
     PURITY_DEFAULT as PURITY_DEFAULT,
     PURITY_NEW as PURITY_NEW,
     PURITY_SELF as PURITY_SELF,
+    # vector formats
+    VECTOR_FORMAT_FLOAT32 as VECTOR_FORMAT_FLOAT32,
+    VECTOR_FORMAT_FLOAT64 as VECTOR_FORMAT_FLOAT64,
+    VECTOR_FORMAT_INT8 as VECTOR_FORMAT_INT8,
+)
+
+from .version import __version__ as __version__
+
+from .constants import (
+    # mandated DB API constants
+    apilevel as apilevel,
+    threadsafety as threadsafety,
+    paramstyle as paramstyle,
     # AQ delivery modes
     MSG_BUFFERED as MSG_BUFFERED,
     MSG_PERSISTENT as MSG_PERSISTENT,
@@ -148,10 +195,6 @@
     # flags for tpc_end()
     TPC_END_NORMAL as TPC_END_NORMAL,
     TPC_END_SUSPEND as TPC_END_SUSPEND,
-    # vector types
-    VECTOR_FORMAT_FLOAT32 as VECTOR_FORMAT_FLOAT32,
-    VECTOR_FORMAT_FLOAT64 as VECTOR_FORMAT_FLOAT64,
-    VECTOR_FORMAT_INT8 as VECTOR_FORMAT_INT8,
 )
 
 from .exceptions import (
@@ -190,6 +233,13 @@
     create_pool_async as create_pool_async,
 )
 
+from .subscr import (
+    Message as Message,
+    MessageQuery as MessageQuery,
+    MessageRow as MessageRow,
+    MessageTable as MessageTable,
+)
+
 from .connect_params import ConnectParams as ConnectParams
 
 from .pool_params import PoolParams as PoolParams
@@ -209,49 +259,6 @@
 
 from .driver_mode import is_thin_mode as is_thin_mode
 
-from . import base_impl, thick_impl, thin_impl
-
-from .base_impl import (
-    # database types
-    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,
-    DB_TYPE_VECTOR as DB_TYPE_VECTOR,
-    DB_TYPE_XMLTYPE as DB_TYPE_XMLTYPE,
-    # API types
-    BINARY as BINARY,
-    DATETIME as DATETIME,
-    NUMBER as NUMBER,
-    ROWID as ROWID,
-    STRING as STRING,
-)
-
 from .thick_impl import (
     clientversion as clientversion,
     init_oracle_client as init_oracle_client,

src/oracledb/base_impl.pxd

@@ -107,6 +107,57 @@ cdef enum:
     TNS_LONG_LENGTH_INDICATOR = 254
     TNS_NULL_LENGTH_INDICATOR = 255
 
+cpdef enum:
+    AUTH_MODE_DEFAULT = 0
+    AUTH_MODE_PRELIM = 0x00000008
+    AUTH_MODE_SYSASM = 0x00008000
+    AUTH_MODE_SYSBKP = 0x00020000
+    AUTH_MODE_SYSDBA = 0x00000002
+    AUTH_MODE_SYSDGD = 0x00040000
+    AUTH_MODE_SYSKMT = 0x00080000
+    AUTH_MODE_SYSOPER = 0x00000004
+    AUTH_MODE_SYSRAC = 0x00100000
+
+cpdef enum:
+    POOL_GETMODE_WAIT = 0
+    POOL_GETMODE_NOWAIT = 1
+    POOL_GETMODE_FORCEGET = 2
+    POOL_GETMODE_TIMEDWAIT = 3
+
+cpdef enum:
+    PURITY_DEFAULT = 0
+    PURITY_NEW = 1
+    PURITY_SELF = 2
+
+cpdef enum:
+    VECTOR_FORMAT_FLOAT32 = 2
+    VECTOR_FORMAT_FLOAT64 = 3
+    VECTOR_FORMAT_INT8 = 4
+
+cdef type PY_TYPE_ASYNC_CURSOR
+cdef type PY_TYPE_ASYNC_LOB
+cdef type PY_TYPE_BOOL
+cdef type PY_TYPE_CURSOR
+cdef type PY_TYPE_DATE
+cdef type PY_TYPE_DATETIME
+cdef type PY_TYPE_DECIMAL
+cdef type PY_TYPE_DB_OBJECT
+cdef type PY_TYPE_DB_OBJECT_TYPE
+cdef type PY_TYPE_FETCHINFO
+cdef type PY_TYPE_JSON_ID
+cdef type PY_TYPE_INTERVAL_YM
+cdef type PY_TYPE_LOB
+cdef type PY_TYPE_MESSAGE
+cdef type PY_TYPE_MESSAGE_QUERY
+cdef type PY_TYPE_MESSAGE_ROW
+cdef type PY_TYPE_MESSAGE_TABLE
+cdef type PY_TYPE_TIMEDELTA
+cdef type PY_TYPE_VAR
+
+cdef str DRIVER_NAME
+cdef str DRIVER_VERSION
+cdef str DRIVER_INSTALLATION_URL
+
 cdef const char* ENCODING_UTF8
 cdef const char* ENCODING_UTF16
 

src/oracledb/base_impl.pyx

@@ -58,8 +58,7 @@ cydatetime.import_datetime()
 
 include "impl/base/types.pyx"
 
-from . import constants, errors, exceptions, utils
-
+# Python types used by the driver
 cdef type PY_TYPE_ASYNC_CURSOR
 cdef type PY_TYPE_ASYNC_LOB
 cdef type PY_TYPE_BOOL = bool
@@ -76,16 +75,11 @@ cdef type PY_TYPE_TIMEDELTA = datetime.timedelta
 cdef type PY_TYPE_VAR
 cdef type PY_TYPE_FETCHINFO
 
-# purity values
-cdef uint32_t PURITY_NEW = constants.PURITY_NEW
-cdef uint32_t PURITY_SELF = constants.PURITY_SELF
-cdef uint32_t PURITY_DEFAULT = constants.PURITY_DEFAULT
-
-# vector types
-cdef uint8_t VECTOR_FORMAT_FLOAT32 = constants.VECTOR_FORMAT_FLOAT32
-cdef uint8_t VECTOR_FORMAT_FLOAT64 = constants.VECTOR_FORMAT_FLOAT64
-cdef uint8_t VECTOR_FORMAT_INT8 = constants.VECTOR_FORMAT_INT8
-
+cdef const char* DRIVER_NAME = "python-oracledb"
+cdef const char* DRIVER_VERSION
+cdef const char* DRIVER_INSTALLATION_URL = \
+        "https://python-oracledb.readthedocs.io/en/" \
+        "latest/user_guide/initialization.html"
 cdef const char* ENCODING_UTF8 = "UTF-8"
 cdef const char* ENCODING_UTF16 = "UTF-16BE"
 

src/oracledb/constants.py

@@ -33,28 +33,6 @@
 threadsafety = 2
 paramstyle = "named"
 
-# authentication modes
-AUTH_MODE_DEFAULT = 0
-AUTH_MODE_PRELIM = 0x00000008
-AUTH_MODE_SYSASM = 0x00008000
-AUTH_MODE_SYSBKP = 0x00020000
-AUTH_MODE_SYSDBA = 0x00000002
-AUTH_MODE_SYSDGD = 0x00040000
-AUTH_MODE_SYSKMT = 0x00080000
-AUTH_MODE_SYSOPER = 0x00000004
-AUTH_MODE_SYSRAC = 0x00100000
-
-# pool "get" modes
-POOL_GETMODE_WAIT = 0
-POOL_GETMODE_NOWAIT = 1
-POOL_GETMODE_FORCEGET = 2
-POOL_GETMODE_TIMEDWAIT = 3
-
-# purity values
-PURITY_DEFAULT = 0
-PURITY_NEW = 1
-PURITY_SELF = 2
-
 # AQ delivery modes
 MSG_BUFFERED = 2
 MSG_PERSISTENT = 1
@@ -155,18 +133,5 @@
 TPC_END_NORMAL = 0
 TPC_END_SUSPEND = 0x00100000
 
-# vector types
-VECTOR_FORMAT_FLOAT32 = 2
-VECTOR_FORMAT_FLOAT64 = 3
-VECTOR_FORMAT_INT8 = 4
-
 # vector metadata flags
 VECTOR_META_FLAG_FLEXIBLE_DIM = 0x01
-
-# basic configuration constants
-DRIVER_NAME = "python-oracledb"
-INSTALLATION_URL = (
-    "https://python-oracledb.readthedocs.io/en/"
-    "latest/user_guide/initialization.html"
-)
-ENCODING = "UTF-8"

src/oracledb/errors.py

@@ -182,6 +182,18 @@ def _raise_err(
     raise error.exc_type(error) from cause
 
 
+def _raise_not_supported(feature: str) -> None:
+    """
+    Raises an exception that the specified feature is not supported. This is
+    used as the default implementation of all functions for the implementation
+    objects.
+    """
+    driver_type = "thick" if is_thin_mode() else "thin"
+    _raise_err(
+        ERR_FEATURE_NOT_SUPPORTED, feature=feature, driver_type=driver_type
+    )
+
+
 # prefix used for all error messages
 ERR_PREFIX = "DPY"