Desupported items for version 2.0.

anthony-tuininga · anthony-tuininga · commit afddb4cb0b77 · 2023-12-19T11:43:07.000-07:00
diff --git a/doc/src/api_manual/connection.rst b/doc/src/api_manual/connection.rst
@@ -670,18 +670,6 @@ Connection Attributes
 
         This attribute is an extension to the DB API definition.
 
-.. attribute:: Connection.encoding
-
-    This read-only attribute returns the IANA character set name of the
-    character set in use by the Oracle client for regular strings. The
-    encodings in use are always UTF-8.
-
-    .. deprecated:: cx_Oracle 8.2
-
-    .. note::
-
-        This attribute is an extension to the DB API definition.
-
 .. attribute:: Connection.external_name
 
     This read-write attribute specifies the external name that is used by the
@@ -753,21 +741,6 @@ Connection Attributes
         server and the client.
 
 
-.. attribute:: Connection.maxBytesPerCharacter
-
-    This deprecated, read-only attribute returns the value 4 since encodings
-    are always UTF-8.
-
-    Previously it returned the maximum number of bytes each character can use
-    for the client character set.
-
-    .. deprecated:: cx_Oracle 8.2
-
-    .. note::
-
-        This attribute is an extension to the DB API definition.
-
-
 .. attribute:: Connection.max_open_cursors
 
     This read-only attribute specifies the maximum number of cursors that the
@@ -791,16 +764,6 @@ Connection Attributes
 
         This attribute is an extension to the DB API definition.
 
-.. attribute:: Connection.nencoding
-
-    This read-only attribute returns the IANA character set name of the
-    national character set in use by the Oracle client. This is always the value "UTF-8".
-
-    .. deprecated:: cx_Oracle 8.2
-
-    .. note::
-
-        This attribute is an extension to the DB API definition.
 
 .. attribute:: Connection.outputtypehandler
 
@@ -886,19 +849,6 @@ Connection Attributes
 
         This attribute is an extension to the DB API definition.
 
-.. attribute:: Connection.tnsentry
-
-    This read-only attribute returns the TNS entry of the database to which a
-    connection has been established.
-
-    .. deprecated:: cx_Oracle 8.2
-
-    Use the attribute :attr:`~Connection.dsn` instead.
-
-    .. note::
-
-        This attribute is an extension to the DB API definition.
-
 .. attribute:: Connection.transaction_in_progress
 
     This read-only attribute specifies whether a transaction is currently in
diff --git a/doc/src/api_manual/connection_pool.rst b/doc/src/api_manual/connection_pool.rst
@@ -307,15 +307,6 @@ ConnectionPool Attributes
     terminated. Note that in python-oracledb Thick mode with older Oracle
     Client Libraries, the termination only occurs when the pool is accessed.
 
-.. attribute:: ConnectionPool.tnsentry
-
-    This read-only attribute returns the TNS entry of the database to which a
-    connection has been established.
-
-    .. deprecated:: cx_Oracle 8.2
-
-    Use the attribute :attr:`~ConnectionPool.dsn` instead.
-
 
 .. attribute:: ConnectionPool.username
 
diff --git a/doc/src/api_manual/deprecations.rst b/doc/src/api_manual/deprecations.rst
@@ -11,13 +11,43 @@ if applicable. The most recent deprecations are listed first.
 .. list-table-with-summary:: Desupported in python-oracledb 2.0
     :header-rows: 1
     :class: wy-table-responsive
-    :summary: The first column, Name, displays the deprecated or desupported API name. The second column, Comments, includes information about when the API was deprecated or desupported and what API to use, if applicable.
-    :name: _deprecations_2_0
+    :summary: The first column, Name, displays the desupported API name. The second column, Comments, includes information about when the API  desupported and what API to use, if applicable.
+    :name: _desupported_2_0
 
     * - Name
       - Comments
     * - ``oracledb.__future__.old_json_col_as_obj``
-      - This attribute is desupported and does not need to be set to fetch VARCHAR2 and LOB columns that contain JSON data.
+      - VARCHAR2 and LOB columns created with the ``IS JSON`` check constraint
+        are now always fetched as JSON.  Use an :ref:`output type handler
+        <outputtypehandlers>` if the old behavior is required.
+    * - Parameters ``encoding`` and ``nencoding`` of :func:`oracledb.connect()`
+        and :func:`oracledb.create_pool()`, and the related attributes on the
+        objects created
+      - The driver encodings are always UTF-8. Remove uses of ``encoding`` and
+        ``nencoding`` from your code.
+    * - Parameter ``threaded`` of :func:`oracledb.connect()` and
+        :func:`oracledb.create_pool()`
+      - Threading is always used. Remove uses of ``threaded`` from your code.
+    * - Parameter ``waitTimeout`` of :func:`oracledb.create_pool()` and
+        ``oracledb.SessionPool()``
+      - Replace with parameter ``wait_timeout``
+    * - Parameter ``maxLifetimeSession`` of :func:`oracledb.create_pool()` and
+        ``oracledb.SessionPool()``
+      - Replace with parameter ``max_lifetime_session``
+    * - Parameter ``sessionCallback`` of :func:`oracledb.create_pool()` and
+        ``oracledb.SessionPool()``
+      - Replace with parameter ``session_callback``
+    * - Parameter ``maxSessionsPerShard`` of :func:`oracledb.create_pool()` and
+        ``oracledb.SessionPool()``
+      - Replace with parameter ``max_sessions_per_shard``
+    * - Attribute ``maxBytesPerCharacter`` of the :ref:`connection object
+        <connobj>`
+      - The driver encodings are always UTF-8 so this attribute can be replaced by
+        the constant value 4
+    * - ``Connection.tnsentry``
+      - Replace with :attr:`Connection.dsn`
+    * - ``SessionPool.tnsentry``
+      - Replace with :attr:`ConnectionPool.dsn`
 
 .. list-table-with-summary:: Deprecated in python-oracledb 1.4
     :header-rows: 1
@@ -173,7 +203,7 @@ python-oracledb are listed below:
     * - ``maxSessionsPerShard`` parameter to `cx_Oracle.SessionPool() <https://cx-oracle.readthedocs.io/en/latest/api_manual/module.html#cx_Oracle.SessionPool>`_
       - Replace with parameter name ``max_sessions_per_shard``
     * - ``SessionPool.tnsentry``
-      - Replace with `SessionPool.dsn <https://cx-oracle.readthedocs.io/en/latest/api_manual/session_pool.html#SessionPool.dsn>`_
+      - Replace with :attr:`ConnectionPool.dsn`
     * - ``payloadType`` parameter to `Connection.queue() <https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.queue>`_
       - Replace with parameter name ``payload_type`` if using keyword parameters.
     * - ``ipAddress`` parameter to `Connection.subscribe() <https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.subscribe>`_
@@ -189,7 +219,7 @@ python-oracledb are listed below:
     * - ``Connection.callTimeout``
       - Replace with `Connection.call_timeout <https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.call_timeout>`_
     * - ``Connection.tnsentry``
-      - Replace with `Connection.dsn <https://cx-oracle.readthedocs.io/en/latest/api_manual/connection.html#Connection.dsn>`_
+      - Replace with :attr:`Connection.dsn`
     * - `keywordParameters` parameter to `Cursor.callfunc() <https://cx-oracle.readthedocs.io/en/latest/api_manual/cursor.html#Cursor.callfunc>`_
       - Replace with parameter name ``keyword_parameters``
     * - ``keywordParameters`` parameter to `Cursor.callproc() <https://cx-oracle.readthedocs.io/en/latest/api_manual/cursor.html#Cursor.callproc>`_
diff --git a/doc/src/api_manual/module.rst b/doc/src/api_manual/module.rst
@@ -1409,11 +1409,6 @@ General
     resource without wrapping it using a mutex semaphore to implement resource
     locking.
 
-    Note that in order to make use of multiple threads in a program which
-    intends to connect and disconnect in different threads, the ``threaded``
-    parameter to :meth:`connect()` must be True.
-
-
 .. data:: version
 .. data:: __version__
 
diff --git a/doc/src/release_notes.rst b/doc/src/release_notes.rst
@@ -50,11 +50,8 @@ Common Changes
 ++++++++++++++
 
 #)  Dropped support for Python 3.6.
-#)  The attribute ``oracledb.__future__.old_json_col_as_obj`` no longer needs to
-    be set to fetch JSON data from VARCHAR2 and LOB columns (which have the "IS
-    JSON" constraint) as objects, similar to fetching Oracle Database 21c JSON
-    columns. An :ref:`output type handler <outputtypehandlers>` can be used if
-    the previous default behavior of fetching as VARCHAR2 or LOB is desired.
+#)  Desupported a number of parameters and attributes that were previously
+    deprecated. See :ref:`desupport notices<_desupported_2_0>` for details.
 #)  Added property :attr:`Cursor.warning` for database warnings (such as PL/SQL
     compilation warnings) generated by calls to :meth:`Cursor.execute()` or
     :meth:`Cursor.executemany()`.
diff --git a/doc/src/user_guide/appendix_c.rst b/doc/src/user_guide/appendix_c.rst
@@ -89,7 +89,7 @@ from cx_Oracle:
   can be used to encapsulate connection properties. See :ref:`usingconnparams`
   for more information.
 
-- The following parameters are deprecated and ignored:
+- The following parameters are desupported:
 
   - ``encoding`` and ``nencoding``: The encodings in use are always UTF-8.
 
diff --git a/src/oracledb/connect_params.py b/src/oracledb/connect_params.py
@@ -95,9 +95,6 @@ def __init__(
         ssl_context: Any = None,
         sdu: int = 8192,
         handle: int = 0,
-        threaded: bool = True,
-        encoding: str = None,
-        nencoding: str = None,
     ):
         """
         All parameters are optional. A brief description of each parameter
@@ -723,9 +720,6 @@ def set(
         ssl_context: Any = None,
         sdu: int = None,
         handle: int = None,
-        threaded: bool = None,
-        encoding: str = None,
-        nencoding: str = None,
     ):
         """
         All parameters are optional. A brief description of each parameter
diff --git a/src/oracledb/connection.py b/src/oracledb/connection.py
@@ -235,14 +235,6 @@ def edition(self) -> str:
         self._verify_connected()
         return self._impl.get_edition()
 
-    @property
-    def encoding(self) -> str:
-        """
-        Specifies the IANA character set name of the character set in use. This
-        is always the value "UTF-8".
-        """
-        return "UTF-8"
-
     @property
     def external_name(self) -> str:
         """
@@ -718,14 +710,6 @@ def msgproperties(
             props.recipients = recipients
         return props
 
-    @property
-    def nencoding(self) -> str:
-        """
-        Specifies the IANA character set name of the national character set in
-        use. This is always the value "UTF-8".
-        """
-        return "UTF-8"
-
     def ping(self) -> None:
         """
         Pings the database to verify the connection is valid.
@@ -995,13 +979,6 @@ def thin(self) -> bool:
         self._verify_connected()
         return isinstance(self._impl, thin_impl.ThinConnImpl)
 
-    @property
-    def tnsentry(self) -> str:
-        """
-        Deprecated. Use dsn property instead.
-        """
-        return self.dsn
-
     def tpc_begin(
         self, xid: Xid, flags: int = constants.TPC_BEGIN_NEW, timeout: int = 0
     ) -> None:
@@ -1193,9 +1170,6 @@ def connect(
     ssl_context: Any = None,
     sdu: int = 8192,
     handle: int = 0,
-    threaded: bool = True,
-    encoding: str = None,
-    nencoding: str = None,
 ) -> Connection:
     """
     Factory function which creates a connection to the database and returns it.
@@ -1756,9 +1730,6 @@ def connect_async(
     ssl_context: Any = None,
     sdu: int = 8192,
     handle: int = 0,
-    threaded: bool = True,
-    encoding: str = None,
-    nencoding: str = None,
 ) -> Connection:
     """
     Factory function which creates a connection to the database and returns it.
diff --git a/src/oracledb/impl/base/pool_params.pyx b/src/oracledb/impl/base/pool_params.pyx
@@ -82,16 +82,12 @@ cdef class PoolParamsImpl(ConnectParamsImpl):
         _set_uint_param(args, "getmode", &self.getmode)
         _set_bool_param(args, "homogeneous", &self.homogeneous)
         _set_uint_param(args, "timeout", &self.timeout)
-        _set_uint_param_with_deprecated_name(args, "wait_timeout",
-                                             "waitTimeout", &self.wait_timeout)
-        _set_uint_param_with_deprecated_name(args, "max_lifetime_session",
-                                             "maxLifetimeSession",
-                                             &self.max_lifetime_session)
-        _set_obj_param_with_deprecated_name(args, "session_callback",
-                                            "sessionCallback", self)
-        _set_uint_param_with_deprecated_name(args, "max_sessions_per_shard",
-                                             "maxSessionsPerShard",
-                                             &self.max_sessions_per_shard)
+        _set_uint_param(args, "wait_timeout", &self.wait_timeout)
+        _set_uint_param(args, "max_lifetime_session",
+                        &self.max_lifetime_session)
+        self.session_callback = args.get("session_callback")
+        _set_uint_param(args, "max_sessions_per_shard",
+                        &self.max_sessions_per_shard)
         _set_bool_param(args, "soda_metadata_cache", &self.soda_metadata_cache)
         _set_int_param(args, "ping_interval", &self.ping_interval)
 
diff --git a/src/oracledb/impl/base/utils.pyx b/src/oracledb/impl/base/utils.pyx
@@ -91,41 +91,6 @@ cdef int _set_uint_param(dict args, str name, uint32_t* out_val) except -1:
         out_val[0] = int(in_val)
 
 
-cdef int _set_uint_param_with_deprecated_name(dict args, str name,
-                                              str deprecated_name,
-                                              uint32_t* out_val) except -1:
-    """
-    Similar to _set_uint_param() but also checks to see if the deprecated
-    parameter name has been used.
-    """
-    in_val = args.get(name)
-    deprecated_val = args.get(deprecated_name)
-    if in_val is not None and deprecated_val is not None:
-        errors._raise_err(errors.ERR_DUPLICATED_PARAMETER,
-                          deprecated_name=deprecated_name, new_name=name)
-    elif in_val is not None:
-        out_val[0] = int(in_val)
-    elif deprecated_val is not None:
-        out_val[0] = int(deprecated_val)
-
-cdef int _set_obj_param_with_deprecated_name(dict args, str name,
-                                             str deprecated_name,
-                                             object target) except -1:
-    """
-    Sets an object parameter to the value provided in the dictionary. If a
-    value is specified it is set directly on the target.
-    """
-    in_val = args.get(name)
-    deprecated_val = args.get(deprecated_name)
-    if in_val is not None and deprecated_val is not None:
-        errors._raise_err(errors.ERR_DUPLICATED_PARAMETER,
-                          deprecated_name=deprecated_name, new_name=name)
-    elif in_val is not None:
-        setattr(target, name, in_val)
-    elif deprecated_val is not None:
-        setattr(target, name, deprecated_val)
-
-
 cdef int _set_protocol_param(dict args, str name, object target) except -1:
     """
     Sets a protocol parameter to the value provided in the dictionary. This
diff --git a/src/oracledb/pool.py b/src/oracledb/pool.py
@@ -635,13 +635,6 @@ def create_pool(
     ssl_context: Any = None,
     sdu: int = 8192,
     handle: int = 0,
-    threaded: bool = True,
-    encoding: str = None,
-    nencoding: str = None,
-    waitTimeout: int = None,
-    maxLifetimeSession: int = None,
-    maxSessionsPerShard: int = None,
-    sessionCallback: Callable = None,
 ) -> ConnectionPool:
     """
     Creates a connection pool with the supplied parameters and returns it.
@@ -1037,13 +1030,6 @@ def create_pool_async(
     ssl_context: Any = None,
     sdu: int = 8192,
     handle: int = 0,
-    threaded: bool = True,
-    encoding: str = None,
-    nencoding: str = None,
-    waitTimeout: int = None,
-    maxLifetimeSession: int = None,
-    maxSessionsPerShard: int = None,
-    sessionCallback: Callable = None,
 ) -> AsyncConnectionPool:
     """
     Creates a connection pool with the supplied parameters and returns it.
diff --git a/src/oracledb/pool_params.py b/src/oracledb/pool_params.py
@@ -107,13 +107,6 @@ def __init__(
         ssl_context: Any = None,
         sdu: int = 8192,
         handle: int = 0,
-        threaded: bool = True,
-        encoding: str = None,
-        nencoding: str = None,
-        waitTimeout: int = None,
-        maxLifetimeSession: int = None,
-        maxSessionsPerShard: int = None,
-        sessionCallback: Callable = None,
     ):
         """
         All parameters are optional. A brief description of each parameter
@@ -561,13 +554,6 @@ def set(
         ssl_context: Any = None,
         sdu: int = None,
         handle: int = None,
-        threaded: bool = None,
-        encoding: str = None,
-        nencoding: str = None,
-        waitTimeout: int = None,
-        maxLifetimeSession: int = None,
-        maxSessionsPerShard: int = None,
-        sessionCallback: Callable = None,
     ):
         """
         All parameters are optional. A brief description of each parameter
diff --git a/tests/test_1100_connection.py b/tests/test_1100_connection.py
diff --git a/tests/test_2400_pool.py b/tests/test_2400_pool.py
diff --git a/utils/fields.cfg b/utils/fields.cfg
diff --git a/utils/templates/connection.py b/utils/templates/connection.py
