Added attribute proxy_user on connections, as requested (#250).

Author: anthony-tuininga

doc/src/api_manual/connection.rst

@@ -822,6 +822,15 @@ Connection Attributes
 
         This attribute is an extension to the DB API definition.
 
+.. attribute:: Connection.proxy_user
+
+    This read-only attribute returns the name of the user which was used as a
+    proxy when creating the connection to the database.
+
+    .. note::
+
+        This attribute is an extension to the DB API definition.
+
 .. attribute:: Connection.service_name
 
     This read-only attribute specifies the Oracle Database service name

doc/src/release_notes.rst

@@ -44,6 +44,8 @@ Common Changes
     associated with columns that are being fetched. SQL domains and annotations
     require Oracle Database 23c. If using python-oracledb Thick mode, Oracle
     Client 23c is also required.
+#)  Added attribute :data:`Connection.proxy_user` as requested
+    (`issue 250 <https://github.com/oracle/python-oracledb/issues/250>`__).
 #)  Added type :data:`~oracledb.DB_TYPE_XMLTYPE` to represent data of type
     ``SYS.XMLTYPE`` in the database. Previously the value of
     :data:`FetchInfo.type_code` for data of this type was

src/oracledb/base_impl.pxd

@@ -237,6 +237,7 @@ cdef class BaseConnImpl:
     cdef:
         readonly str username
         readonly str dsn
+        readonly str proxy_user
         public object inputtypehandler
         public object outputtypehandler
         public bint autocommit

src/oracledb/connection.py

@@ -656,6 +656,14 @@ def prepare(self) -> bool:
         """
         return self.tpc_prepare()
 
+    @property
+    def proxy_user(self) -> Union[str, None]:
+        """
+        Returns the name of the proxy user, if applicable.
+        """
+        self._verify_connected()
+        return self._impl.proxy_user
+
     def queue(
         self,
         name: str,

src/oracledb/impl/base/connection.pyx

@@ -34,6 +34,7 @@ cdef class BaseConnImpl:
     def __init__(self, str dsn, ConnectParamsImpl params):
         self.dsn = dsn
         self.username = params.user
+        self.proxy_user = params.proxy_user
 
     cdef object _check_value(self, DbType dbtype, BaseDbObjectTypeImpl objtype,
                              object value, bint* is_ok):

tests/test_1100_connection.py

@@ -827,6 +827,13 @@ def test_1142_db_domain(self):
         (db_domain,) = cursor.fetchone()
         self.assertEqual(conn.db_domain, db_domain)
 
+    def test_1143_proxy_user(self):
+        "1143 - test connecting with a proxy user"
+        proxy_user = test_env.get_proxy_user()
+        conn = test_env.get_connection(proxy_user=proxy_user)
+        self.assertEqual(conn.username, test_env.get_main_user())
+        self.assertEqual(conn.proxy_user, proxy_user)
+
 
 if __name__ == "__main__":
     test_env.run_test_cases()

tests/test_2400_pool.py

@@ -367,6 +367,8 @@ def test_2407_heterogeneous(self):
         conn.close()
         user_str = f"{test_env.get_main_user()}[{test_env.get_proxy_user()}]"
         conn = pool.acquire(user_str, test_env.get_main_password())
+        self.assertEqual(conn.username, test_env.get_main_user())
+        self.assertEqual(conn.proxy_user, test_env.get_proxy_user())
         self.__verify_connection(
             conn, test_env.get_proxy_user(), test_env.get_main_user()
         )

utils/templates/connection.py

@@ -654,6 +654,14 @@ def prepare(self) -> bool:
         """
         return self.tpc_prepare()
 
+    @property
+    def proxy_user(self) -> Union[str, None]:
+        """
+        Returns the name of the proxy user, if applicable.
+        """
+        self._verify_connected()
+        return self._impl.proxy_user
+
     def queue(
         self,
         name: str,