fix(clickhouse): Guard against module shadowing

Author: alexander-alderman-webb

sentry_sdk/integrations/clickhouse_driver.py

@@ -31,6 +31,7 @@ def __getitem__(self, _):
 
 try:
     import clickhouse_driver  # type: ignore[import-not-found]
+    from clickhouse_driver.client import Client
 
 except ImportError:
     raise DidNotEnable("clickhouse-driver not installed.")
@@ -54,17 +55,13 @@ def setup_once() -> None:
 
         # Every query ends either with the Client's `receive_end_of_query` (no result expected)
         # or its `receive_result` (result expected)
-        clickhouse_driver.client.Client.receive_end_of_query = _wrap_end(
-            clickhouse_driver.client.Client.receive_end_of_query
-        )
-        if hasattr(clickhouse_driver.client.Client, "receive_end_of_insert_query"):
+        Client.receive_end_of_query = _wrap_end(Client.receive_end_of_query)
+        if hasattr(Client, "receive_end_of_insert_query"):
             # In 0.2.7, insert queries are handled separately via `receive_end_of_insert_query`
-            clickhouse_driver.client.Client.receive_end_of_insert_query = _wrap_end(
-                clickhouse_driver.client.Client.receive_end_of_insert_query
+            Client.receive_end_of_insert_query = _wrap_end(
+                Client.receive_end_of_insert_query
             )
-        clickhouse_driver.client.Client.receive_result = _wrap_end(
-            clickhouse_driver.client.Client.receive_result
-        )
+        Client.receive_result = _wrap_end(Client.receive_result)
 
 
 P = ParamSpec("P")
@@ -128,7 +125,7 @@ def _inner_end(*args: "P.args", **kwargs: "P.kwargs") -> "T":
 
 
 def _wrap_send_data() -> None:
-    original_send_data = clickhouse_driver.client.Client.send_data
+    original_send_data = Client.send_data
 
     def _inner_send_data(  # type: ignore[no-untyped-def] # clickhouse-driver does not type send_data
         self, sample_block, data, types_check=False, columnar=False, *args, **kwargs
@@ -164,7 +161,7 @@ def wrapped_generator() -> "Iterator[Any]":
             self, sample_block, data, types_check, columnar, *args, **kwargs
         )
 
-    clickhouse_driver.client.Client.send_data = _inner_send_data
+    Client.send_data = _inner_send_data
 
 
 def _set_db_data(

tests/test_shadowed_module.py

@@ -29,7 +29,6 @@ def pytest_generate_tests(metafunc):
             # Temporarily skip some integrations
             submodule_names
             - {
-                "clickhouse_driver",
                 "grpc",
                 "litellm",
                 "opentelemetry",