Always raise "DPY-6005: cannot connect to database" and remove the

phrase "cannot connect to database from all other errors".

Author: anthony-tuininga

doc/src/release_notes.rst

@@ -23,6 +23,11 @@ Thin Mode Changes
 #)  Removed internally set fixed size for database collections. Collections of
     any size supported by the database can now be created.
 #)  Improved BOOLEAN handling.
+#)  Error ``DPY-6005: cannot connect to database`` is now raised for all
+    failures to connect to the database and the phrase ``cannot connect to
+    database`` is removed from all other error messages (since this can be
+    confusing when these errors are raised from
+    :meth:`ConnectParams.parse_connect_string()`).
 #)  Fixed bug when calling :meth:`Cursor.executemany()` with PL/SQL when the
     size of the bound data increases on subsequent calls
     (`issue 132 <https://github.com/oracle/python-oracledb/issues/132>`__).

src/oracledb/errors.py

@@ -110,6 +110,8 @@ def _raise_err(error_num: int, context_error_message: str=None,
     supplied arguments.
     """
     message = _get_error_text(error_num, **args)
+    if context_error_message is None and cause is not None:
+        context_error_message = str(cause)
     if context_error_message is not None:
         message = f"{message}\n{context_error_message}"
     exc_type = ERR_EXCEPTION_TYPES[error_num // 1000]
@@ -307,7 +309,7 @@ def _raise_from_string(exc_type: Exception, message: str) -> None:
             'column truncated to {col_value_len} {unit}. '
             'Untruncated was {actual_len}',
     ERR_CONNECTION_FAILED:
-            'cannot connect to database. Connection failed with "{exception}"',
+            'cannot connect to database.',
     ERR_CONTENT_INVALID_AFTER_NUMBER:
             'invalid number (content after number)',
     ERR_CURSOR_NOT_OPEN:
@@ -386,25 +388,22 @@ def _raise_from_string(exc_type: Exception, message: str) -> None:
     ERR_INVALID_REF_CURSOR:
             'invalid REF CURSOR: never opened in PL/SQL',
     ERR_INVALID_SERVER_CERT_DN:
-            'cannot connect to database. The distinguished name (DN) on '
-            'the server certificate does not match the expected value',
+            'The distinguished name (DN) on the server certificate does not '
+            'match the expected value',
     ERR_INVALID_SERVER_TYPE:
             'invalid server_type: {server_type}',
     ERR_INVALID_SERVICE_NAME:
-            'cannot connect to database. Service "{service_name}" is not '
-            'registered with the listener at host "{host}" port {port}. '
-            '(Similar to ORA-12514)',
+            'Service "{service_name}" is not registered with the listener at '
+            'host "{host}" port {port}. (Similar to ORA-12514)',
     ERR_INVALID_SID:
-            'cannot connect to database. SID "{sid}" is not registered '
-            'with the listener at host "{host}" port {port}. '
-            '(Similar to ORA-12505)',
+            'SID "{sid}" is not registered with the listener at host "{host}" '
+            'port {port}. (Similar to ORA-12505)',
     ERR_KEYWORD_ARGS_MUST_BE_DICT:
             '"keyword_parameters" argument must be a dict',
     ERR_LIBRARY_ALREADY_INITIALIZED:
             'init_oracle_client() was already called with different arguments',
     ERR_LISTENER_REFUSED_CONNECTION:
-            'cannot connect to database. Listener refused connection. '
-            '(Similar to ORA-{error_code})',
+            'Listener refused connection. (Similar to ORA-{error_code})',
     ERR_LOB_OF_WRONG_TYPE:
             'LOB is of type {actual_type_name} but must be of type '
             '{expected_type_name}',
@@ -488,11 +487,9 @@ def _raise_from_string(exc_type: Exception, message: str) -> None:
     ERR_TIME_NOT_SUPPORTED:
             'Oracle Database does not support time only variables',
     ERR_TNS_ENTRY_NOT_FOUND:
-            'cannot connect to database. Unable to find "{name}" in '
-            '{file_name}',
+            'unable to find "{name}" in {file_name}',
     ERR_TNS_NAMES_FILE_MISSING:
-            'cannot connect to database. File tnsnames.ora not found in '
-            '{config_dir}',
+            'file tnsnames.ora not found in {config_dir}',
     ERR_UNEXPECTED_DATA:
             'unexpected data received: {data}',
     ERR_UNEXPECTED_END_OF_DATA:
@@ -517,7 +514,7 @@ def _raise_from_string(exc_type: Exception, message: str) -> None:
             'password verifier type 0x{verifier_type:x} is not supported by '
             'python-oracledb in thin mode',
     ERR_WALLET_FILE_MISSING:
-            'cannot connect to database. Wallet file {name} was not found',
+            'wallet file {name} was not found',
     ERR_WRONG_ARRAY_DEFINITION:
             'expecting a list of two elements [type, numelems]',
     ERR_WRONG_EXECUTE_PARAMETERS_TYPE:

src/oracledb/impl/thin/connection.pyx

@@ -101,18 +101,13 @@ cdef class ThinConnImpl(BaseConnImpl):
         try:
             self._protocol._connect_phase_one(self, params, description,
                                               address, connect_string)
-        except exceptions.DatabaseError:
+        except (exceptions.DatabaseError, socket.gaierror,
+                ConnectionRefusedError) as e:
             if raise_exception:
-                raise
-            return 0
-        except (socket.gaierror, ConnectionRefusedError) as e:
-            if raise_exception:
-                errors._raise_err(errors.ERR_CONNECTION_FAILED, cause=e,
-                                  exception=str(e))
+                errors._raise_err(errors.ERR_CONNECTION_FAILED, cause=e)
             return 0
         except Exception as e:
-            errors._raise_err(errors.ERR_CONNECTION_FAILED, cause=e,
-                              exception=str(e))
+            errors._raise_err(errors.ERR_CONNECTION_FAILED, cause=e)
         self._drcp_enabled = description.server_type == "pooled"
         if self._cclass is None:
             self._cclass = description.cclass