Enhance error message with error help portal URL.

Author: anthony-tuininga

doc/src/release_notes.rst

@@ -29,6 +29,8 @@ Thin Mode Changes
 #)  Added support for growing the pool back to the minimum number of
     connections allowed in the pool when connections are killed or otherwise
     made unusable.
+#)  Added URL to the Oracle Database Error Help Portal in Oracle Database
+    error messages similar to when Thick mode uses Oracle Client 23c.
 #)  A default connection class is now generated when DRCP is used with a
     connection pool and no connection class was specified when the pool was
     created. The default connection class will be of the form ``DPY:`` followed

src/oracledb/errors.py

@@ -33,6 +33,7 @@
 
 import re
 
+from .driver_mode import is_thin_mode
 from . import exceptions
 
 class _Error:
@@ -62,6 +63,14 @@ def _make_adjustments(self):
             pos = self.message.find(":")
             if pos > 0:
                 self.full_code = self.message[:pos]
+
+                # add Oracle Database Error Help Portal URL for database error
+                # messages, but only in thin mode since this is done
+                # automatically in thick mode with Oracle Client 23c and higher
+                if self.code != 0 and is_thin_mode():
+                    self.message = self.message + "\n" + \
+                        "Help: https://docs.oracle.com/error-help/db/ora-" + \
+                        f"{self.code:05}/"
         if self.code != 0 or self.full_code.startswith("DPI-"):
             args = {}
             if self.code != 0:

tests/test_1700_error.py

@@ -27,6 +27,7 @@
 """
 
 import pickle
+import unittest
 
 import oracledb
 import test_env
@@ -83,5 +84,16 @@ def test_1702_error_full_code(self):
             error_obj, = cm.exception.args
             self.assertEqual(error_obj.full_code, "DPI-1037")
 
+    @unittest.skipIf(test_env.get_client_version() < (23, 1),
+                     "unsupported client")
+    def test_1703_error_help_url(self):
+        "1703 - test generation of error help portal URL"
+        cursor = self.connection.cursor()
+        with self.assertRaises(oracledb.Error) as cm:
+            cursor.execute("select 1 / 0 from dual")
+        error_obj, = cm.exception.args
+        to_check = "Help: https://docs.oracle.com/error-help/db/ora-01476/"
+        self.assertIn(to_check, error_obj.message)
+
 if __name__ == "__main__":
     test_env.run_test_cases()