google-cloud-bigquery 3.44.0__tar.gz → 3.45.0__tar.gz

{google_cloud_bigquery-3.44.0/google_cloud_bigquery.egg-info → google_cloud_bigquery-3.45.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-cloud-bigquery
-Version: 3.44.0
+Version: 3.45.0
 Summary: Google BigQuery API client library
 Author-email: Google LLC <googleapis-packages@google.com>
 License: Apache 2.0

{google_cloud_bigquery-3.44.0 → google_cloud_bigquery-3.45.0}/google/cloud/bigquery/table.py

@@ -20,6 +20,7 @@ import base64
 import copy
 import datetime
 import functools
+import logging
 import operator
 import typing
 import warnings
@@ -86,6 +87,7 @@ if typing.TYPE_CHECKING:  # pragma: NO COVER
     from google.cloud import bigquery_storage  # type: ignore
     from google.cloud.bigquery.dataset import DatasetReference
 
+_LOGGER = logging.getLogger(__name__)
 
 _NO_GEOPANDAS_ERROR = (
     "The geopandas library is not installed, please install "
@@ -2991,6 +2993,21 @@ class RowIterator(HTTPIterator):
             create_bqstorage_client = False
             bqstorage_client = None
 
+        if _versions_helpers.PANDAS_GBQ_VERSIONS.is_delegation_supported:
+            try:
+                client_info = getattr(
+                    getattr(self.client, "_connection", None), "_client_info", None
+                )
+                if client_info:
+                    ua = getattr(client_info, "user_agent", None) or ""
+                    if "pandas-gbq" not in ua:
+                        version = (
+                            _versions_helpers.PANDAS_GBQ_VERSIONS.installed_version
+                        )
+                        client_info.user_agent = f"{ua} pandas-gbq/{version}".strip()
+            except Exception as exc:
+                _LOGGER.debug("Failed to update telemetry user-agent: %s", exc)
+
         with warnings.catch_warnings():
             warnings.filterwarnings(
                 "ignore",

{google_cloud_bigquery-3.44.0 → google_cloud_bigquery-3.45.0}/google/cloud/bigquery/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "3.44.0"
+__version__ = "3.45.0"

{google_cloud_bigquery-3.44.0 → google_cloud_bigquery-3.45.0/google_cloud_bigquery.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-cloud-bigquery
-Version: 3.44.0
+Version: 3.45.0
 Summary: Google BigQuery API client library
 Author-email: Google LLC <googleapis-packages@google.com>
 License: Apache 2.0

{google_cloud_bigquery-3.44.0 → google_cloud_bigquery-3.45.0}/tests/unit/test_client.py

@@ -1798,14 +1798,20 @@ class TestClient(unittest.TestCase):
         http.request.assert_called_once_with(
             url=mock.ANY,
             method="GET",
-            headers={
-                "X-Goog-API-Client": expected_user_agent,
-                "Accept-Encoding": "gzip",
-                "User-Agent": expected_user_agent,
-            },
+            headers=mock.ANY,
             data=mock.ANY,
             timeout=DEFAULT_TIMEOUT,
         )
+        _, kwargs = http.request.call_args
+        actual_headers = {k.lower(): v for k, v in kwargs["headers"].items()}
+        self.assertEqual(
+            actual_headers,
+            {
+                "x-goog-api-client": expected_user_agent,
+                "accept-encoding": "gzip",
+                "user-agent": expected_user_agent,
+            },
+        )
         self.assertIn("my-application/1.2.3", expected_user_agent)
 
     def test_get_iam_policy(self):

{google_cloud_bigquery-3.44.0 → google_cloud_bigquery-3.45.0}/tests/unit/test_table.py

@@ -16,6 +16,7 @@ import copy
 import datetime
 import logging
 import re
+import sys
 import time
 import types
 import unittest
@@ -5795,6 +5796,269 @@ class TestRowIterator(unittest.TestCase):
         ]
         self.assertEqual(len(deprecation_warnings), 0)
 
+    def test_to_dataframe_delegated_updates_user_agent(self):
+        pytest.importorskip("db_dtypes")
+        pandas = pytest.importorskip("pandas")
+        mock_pandas_gbq = mock.Mock()
+        mock_pandas_gbq.__version__ = "1.0.0"
+
+        mock_client_info = mock.Mock()
+        mock_client_info.user_agent = "gl-python/3.10.0"
+
+        mock_client = _mock_client()
+        mock_client._connection = mock.Mock(_client_info=mock_client_info)
+
+        with (
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.PandasGBQVersions.is_delegation_supported",
+                new_callable=mock.PropertyMock,
+                return_value=True,
+            ),
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.SUPPORTS_RANGE_PYARROW",
+                False,
+            ),
+            mock.patch.dict(sys.modules, {"pandas_gbq": mock_pandas_gbq}),
+        ):
+            row_iterator = self._make_one_from_data((("name", "STRING"),), (("foo",),))
+            row_iterator.client = mock_client
+
+            df = row_iterator.to_dataframe(progress_bar_type="tqdm", timeout=5.0)
+
+            self.assertIsInstance(df, pandas.DataFrame)
+            self.assertEqual(
+                mock_client_info.user_agent,
+                "gl-python/3.10.0 pandas-gbq/1.0.0",
+            )
+
+    def test_to_dataframe_delegated_does_not_duplicate_user_agent(self):
+        pytest.importorskip("db_dtypes")
+        pandas = pytest.importorskip("pandas")
+        mock_pandas_gbq = mock.Mock()
+        mock_pandas_gbq.__version__ = "1.0.0"
+
+        mock_client_info = mock.Mock()
+        mock_client_info.user_agent = "gl-python/3.10.0 pandas-gbq/1.0.0"
+
+        mock_client = _mock_client()
+        mock_client._connection = mock.Mock(_client_info=mock_client_info)
+
+        with (
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.PandasGBQVersions.is_delegation_supported",
+                new_callable=mock.PropertyMock,
+                return_value=True,
+            ),
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.SUPPORTS_RANGE_PYARROW",
+                False,
+            ),
+            mock.patch.dict(sys.modules, {"pandas_gbq": mock_pandas_gbq}),
+        ):
+            row_iterator = self._make_one_from_data((("name", "STRING"),), (("foo",),))
+            row_iterator.client = mock_client
+
+            df = row_iterator.to_dataframe(progress_bar_type="tqdm", timeout=5.0)
+
+            self.assertIsInstance(df, pandas.DataFrame)
+            self.assertEqual(
+                mock_client_info.user_agent,
+                "gl-python/3.10.0 pandas-gbq/1.0.0",
+            )
+
+    def test_to_dataframe_delegated_when_client_info_is_none(self):
+        pytest.importorskip("db_dtypes")
+        pandas = pytest.importorskip("pandas")
+        mock_pandas_gbq = mock.Mock()
+        mock_pandas_gbq.__version__ = "1.0.0"
+
+        mock_client = _mock_client()
+        mock_client._connection = mock.Mock(_client_info=None)
+
+        with (
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.PandasGBQVersions.is_delegation_supported",
+                new_callable=mock.PropertyMock,
+                return_value=True,
+            ),
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.SUPPORTS_RANGE_PYARROW",
+                False,
+            ),
+            mock.patch.dict(sys.modules, {"pandas_gbq": mock_pandas_gbq}),
+        ):
+            row_iterator = self._make_one_from_data((("name", "STRING"),), (("foo",),))
+            row_iterator.client = mock_client
+
+            df = row_iterator.to_dataframe(progress_bar_type="tqdm", timeout=5.0)
+
+            self.assertIsInstance(df, pandas.DataFrame)
+
+    def test_to_dataframe_delegated_when_user_agent_is_none(self):
+        pytest.importorskip("db_dtypes")
+        pandas = pytest.importorskip("pandas")
+        mock_pandas_gbq = mock.Mock()
+        mock_pandas_gbq.__version__ = "1.0.0"
+
+        mock_client_info = mock.Mock()
+        mock_client_info.user_agent = None
+
+        mock_client = _mock_client()
+        mock_client._connection = mock.Mock(_client_info=mock_client_info)
+
+        with (
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.PandasGBQVersions.is_delegation_supported",
+                new_callable=mock.PropertyMock,
+                return_value=True,
+            ),
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.SUPPORTS_RANGE_PYARROW",
+                False,
+            ),
+            mock.patch.dict(sys.modules, {"pandas_gbq": mock_pandas_gbq}),
+        ):
+            row_iterator = self._make_one_from_data((("name", "STRING"),), (("foo",),))
+            row_iterator.client = mock_client
+
+            df = row_iterator.to_dataframe(progress_bar_type="tqdm", timeout=5.0)
+
+            self.assertIsInstance(df, pandas.DataFrame)
+            self.assertEqual(
+                mock_client_info.user_agent,
+                "pandas-gbq/1.0.0",
+            )
+
+    def test_to_dataframe_delegated_false_does_not_update_user_agent(self):
+        pytest.importorskip("db_dtypes")
+        pandas = pytest.importorskip("pandas")
+
+        mock_client_info = mock.Mock()
+        mock_client_info.user_agent = "gl-python/3.10.0"
+
+        mock_client = _mock_client()
+        mock_client._connection = mock.Mock(_client_info=mock_client_info)
+
+        with (
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.PandasGBQVersions.is_delegation_supported",
+                new_callable=mock.PropertyMock,
+                return_value=False,
+            ),
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.SUPPORTS_RANGE_PYARROW",
+                False,
+            ),
+        ):
+            row_iterator = self._make_one_from_data((("name", "STRING"),), (("foo",),))
+            row_iterator.client = mock_client
+
+            df = row_iterator.to_dataframe(progress_bar_type="tqdm", timeout=5.0)
+
+            self.assertIsInstance(df, pandas.DataFrame)
+            self.assertEqual(
+                mock_client_info.user_agent,
+                "gl-python/3.10.0",
+            )
+
+    def test_to_dataframe_delegated_when_user_agent_update_fails_logs_debug(self):
+        pytest.importorskip("db_dtypes")
+        pandas = pytest.importorskip("pandas")
+        mock_pandas_gbq = mock.Mock()
+        mock_pandas_gbq.__version__ = "1.0.0"
+
+        class ReadOnlyClientInfo:
+            @property
+            def user_agent(self):
+                return "gl-python/3.10.0"
+
+            @user_agent.setter
+            def user_agent(self, value):
+                raise AttributeError("user_agent is read-only")
+
+        mock_client = _mock_client()
+        mock_client._connection = mock.Mock(_client_info=ReadOnlyClientInfo())
+
+        with (
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.PandasGBQVersions.is_delegation_supported",
+                new_callable=mock.PropertyMock,
+                return_value=True,
+            ),
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.SUPPORTS_RANGE_PYARROW",
+                False,
+            ),
+            mock.patch.dict(sys.modules, {"pandas_gbq": mock_pandas_gbq}),
+            self.assertLogs("google.cloud.bigquery.table", level="DEBUG") as cm,
+        ):
+            row_iterator = self._make_one_from_data((("name", "STRING"),), (("foo",),))
+            row_iterator.client = mock_client
+
+            df = row_iterator.to_dataframe(progress_bar_type="tqdm", timeout=5.0)
+
+            self.assertIsInstance(df, pandas.DataFrame)
+            self.assertTrue(
+                any("Failed to update telemetry user-agent" in msg for msg in cm.output)
+            )
+
+    def test_to_geodataframe_updates_user_agent(self):
+        pytest.importorskip("geopandas")
+        pyarrow = pytest.importorskip("pyarrow")
+        row_iterator = self._make_one_from_data(
+            (("name", "STRING"), ("geog", "GEOGRAPHY")),
+            (("foo", "Point(0 0)"),),
+        )
+        mock_client_info = mock.Mock(user_agent="test-agent")
+        row_iterator.client._connection = mock.Mock(_client_info=mock_client_info)
+        batch = pyarrow.RecordBatch.from_arrays(
+            [pyarrow.array(["foo"]), pyarrow.array(["Point(0 0)"])],
+            names=["name", "geog"],
+        )
+
+        with (
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.PandasGBQVersions.is_delegation_supported",
+                new_callable=mock.PropertyMock,
+                return_value=True,
+            ),
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.PandasGBQVersions.installed_version",
+                new_callable=mock.PropertyMock,
+                return_value="1.0.0",
+            ),
+            mock.patch.object(row_iterator, "to_arrow", return_value=batch),
+        ):
+            _ = row_iterator.to_geodataframe(create_bqstorage_client=False)
+
+            self.assertIn("pandas-gbq/", mock_client_info.user_agent)
+
+    def test_to_geodataframe_delegated_false_does_not_update_user_agent(self):
+        pytest.importorskip("geopandas")
+        pyarrow = pytest.importorskip("pyarrow")
+        row_iterator = self._make_one_from_data(
+            (("name", "STRING"), ("geog", "GEOGRAPHY")),
+            (("foo", "Point(0 0)"),),
+        )
+        mock_client_info = mock.Mock(user_agent="test-agent")
+        row_iterator.client._connection = mock.Mock(_client_info=mock_client_info)
+        batch = pyarrow.RecordBatch.from_arrays(
+            [pyarrow.array(["foo"]), pyarrow.array(["Point(0 0)"])],
+            names=["name", "geog"],
+        )
+
+        with (
+            mock.patch(
+                "google.cloud.bigquery._versions_helpers.PandasGBQVersions.is_delegation_supported",
+                new_callable=mock.PropertyMock,
+                return_value=False,
+            ),
+            mock.patch.object(row_iterator, "to_arrow", return_value=batch),
+        ):
+            _ = row_iterator.to_geodataframe(create_bqstorage_client=False)
+
+            self.assertEqual(mock_client_info.user_agent, "test-agent")
+
 
 class TestPartitionRange(unittest.TestCase):
     def _get_target_class(self):