feat: support configuring logger in dbapi kwargs (#1400)

olavloite · web-flow · commit ffa5c9e62758 · 2025-08-12T17:46:25.000Z
Allow the kwargs for dbapi connections to inlcude a logger, and use this as the logger for the database that is used.

Also set a default logger that only logs at WARN level for the mock server tests to stop them from spamming the test log with a bunch of "Created multiplexed session." messages that are logged at INFO level.

Also removes some additional log spamming from the request-id tests.
diff --git a/google/cloud/spanner_dbapi/connection.py b/google/cloud/spanner_dbapi/connection.py
@@ -819,8 +819,9 @@ def connect(
     instance = client.instance(instance_id)
     database = None
     if database_id:
+        logger = kwargs.get("logger")
         database = instance.database(
-            database_id, pool=pool, database_role=database_role
+            database_id, pool=pool, database_role=database_role, logger=logger
         )
     conn = Connection(instance, database, **kwargs)
     if pool is not None:
diff --git a/tests/mockserver_tests/mock_server_test_base.py b/tests/mockserver_tests/mock_server_test_base.py
@@ -11,7 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+import logging
 import unittest
 
 import grpc
@@ -170,12 +170,15 @@ class MockServerTestBase(unittest.TestCase):
     spanner_service: SpannerServicer = None
     database_admin_service: DatabaseAdminServicer = None
     port: int = None
+    logger: logging.Logger = None
 
     def __init__(self, *args, **kwargs):
         super(MockServerTestBase, self).__init__(*args, **kwargs)
         self._client = None
         self._instance = None
         self._database = None
+        self.logger = logging.getLogger("MockServerTestBase")
+        self.logger.setLevel(logging.WARN)
 
     @classmethod
     def setup_class(cls):
@@ -227,6 +230,7 @@ def database(self) -> Database:
                 "test-database",
                 pool=FixedSizePool(size=10),
                 enable_interceptors_in_tests=True,
+                logger=self.logger,
             )
         return self._database
 
diff --git a/tests/mockserver_tests/test_request_id_header.py b/tests/mockserver_tests/test_request_id_header.py
@@ -227,10 +227,6 @@ def test_database_execute_partitioned_dml_request_id(self):
                 (1, REQ_RAND_PROCESS_ID, NTH_CLIENT, CHANNEL_ID, exec_sql_seq, 1),
             )
         ]
-        print(f"Filtered unary segments: {filtered_unary_segments}")
-        print(f"Want unary segments: {want_unary_segments}")
-        print(f"Got stream segments: {got_stream_segments}")
-        print(f"Want stream segments: {want_stream_segments}")
         assert all(seg in filtered_unary_segments for seg in want_unary_segments)
         assert got_stream_segments == want_stream_segments
 
@@ -269,8 +265,6 @@ def test_unary_retryable_error(self):
                 (1, REQ_RAND_PROCESS_ID, NTH_CLIENT, CHANNEL_ID, exec_sql_seq, 1),
             )
         ]
-        print(f"Got stream segments: {got_stream_segments}")
-        print(f"Want stream segments: {want_stream_segments}")
         assert got_stream_segments == want_stream_segments
 
     def test_streaming_retryable_error(self):
diff --git a/tests/unit/spanner_dbapi/test_connect.py b/tests/unit/spanner_dbapi/test_connect.py
@@ -59,7 +59,7 @@ def test_w_implicit(self, mock_client):
 
         self.assertIs(connection.database, database)
         instance.database.assert_called_once_with(
-            DATABASE, pool=None, database_role=None
+            DATABASE, pool=None, database_role=None, logger=None
         )
         # Database constructs its own pool
         self.assertIsNotNone(connection.database._pool)
@@ -107,7 +107,7 @@ def test_w_explicit(self, mock_client):
 
         self.assertIs(connection.database, database)
         instance.database.assert_called_once_with(
-            DATABASE, pool=pool, database_role=role
+            DATABASE, pool=pool, database_role=role, logger=None
         )
 
     def test_w_credential_file_path(self, mock_client):
diff --git a/tests/unit/spanner_dbapi/test_connection.py b/tests/unit/spanner_dbapi/test_connection.py
@@ -888,8 +888,9 @@ def database(
         pool=None,
         database_dialect=DatabaseDialect.GOOGLE_STANDARD_SQL,
         database_role=None,
+        logger=None,
     ):
-        return _Database(database_id, pool, database_dialect, database_role)
+        return _Database(database_id, pool, database_dialect, database_role, logger)
 
 
 class _Database(object):
@@ -899,8 +900,10 @@ def __init__(
         pool=None,
         database_dialect=DatabaseDialect.GOOGLE_STANDARD_SQL,
         database_role=None,
+        logger=None,
     ):
         self.name = database_id
         self.pool = pool
         self.database_dialect = database_dialect
         self.database_role = database_role
+        self.logger = logger

Original file line number	Diff line number	Diff line change
`@@ -227,10 +227,6 @@ def test_database_execute_partitioned_dml_request_id(self):`
`227`	`227`	`(1, REQ_RAND_PROCESS_ID, NTH_CLIENT, CHANNEL_ID, exec_sql_seq, 1),`
`228`	`228`	`)`
`229`	`229`	`]`
`230`		`- print(f"Filtered unary segments: {filtered_unary_segments}")`
`231`		`- print(f"Want unary segments: {want_unary_segments}")`
`232`		`- print(f"Got stream segments: {got_stream_segments}")`
`233`		`- print(f"Want stream segments: {want_stream_segments}")`
`234`	`230`	`assert all(seg in filtered_unary_segments for seg in want_unary_segments)`
`235`	`231`	`assert got_stream_segments == want_stream_segments`
`236`	`232`
`@@ -269,8 +265,6 @@ def test_unary_retryable_error(self):`
`269`	`265`	`(1, REQ_RAND_PROCESS_ID, NTH_CLIENT, CHANNEL_ID, exec_sql_seq, 1),`
`270`	`266`	`)`
`271`	`267`	`]`
`272`		`- print(f"Got stream segments: {got_stream_segments}")`
`273`		`- print(f"Want stream segments: {want_stream_segments}")`
`274`	`268`	`assert got_stream_segments == want_stream_segments`
`275`	`269`
`276`	`270`	`def test_streaming_retryable_error(self):`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ def test_w_implicit(self, mock_client):`
`59`	`59`
`60`	`60`	`self.assertIs(connection.database, database)`
`61`	`61`	`instance.database.assert_called_once_with(`
`62`		`- DATABASE, pool=None, database_role=None`
	`62`	`+ DATABASE, pool=None, database_role=None, logger=None`
`63`	`63`	`)`
`64`	`64`	`# Database constructs its own pool`
`65`	`65`	`self.assertIsNotNone(connection.database._pool)`
`@@ -107,7 +107,7 @@ def test_w_explicit(self, mock_client):`
`107`	`107`
`108`	`108`	`self.assertIs(connection.database, database)`
`109`	`109`	`instance.database.assert_called_once_with(`
`110`		`- DATABASE, pool=pool, database_role=role`
	`110`	`+ DATABASE, pool=pool, database_role=role, logger=None`
`111`	`111`	`)`
`112`	`112`
`113`	`113`	`def test_w_credential_file_path(self, mock_client):`