Skip to content

chore: user agent to include 'legacy-gcb' for pandas-related API requests #18183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tswast wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore: user agent to include 'legacy-gcb' for pandas-related API requests #18183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6e10935
chore: user agent to include 'legacy-gcb' for pandas-related API requ…
tswast Aug 20, 2026
f30d112
update user-agent in unit tests
tswast Aug 20, 2026
2902043
blacken
tswast Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/google-cloud-bigquery/google/cloud/bigquery/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -641,9 +641,9 @@ def _ensure_bqstorage_client(
pandas_gbq = None # type: ignore

if pandas_gbq is None:
user_agent = "pandas-gbq/0.0.0"
user_agent = "pandas-gbq/0.0.0 legacy-gcb"
else:
user_agent = f"pandas-gbq/{pandas_gbq.__version__}"
user_agent = f"pandas-gbq/{pandas_gbq.__version__} legacy-gcb"

if client_info is None:
amended_client_info = google.api_core.gapic_v1.client_info.ClientInfo(
Expand Down
14 changes: 10 additions & 4 deletions packages/google-cloud-bigquery/tests/unit/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -865,7 +865,7 @@ def test_ensure_bqstorage_client_pandas_gbq_installed(self):
mock_client.assert_called_once()
_, kwargs = mock_client.call_args
self.assertEqual(
kwargs["client_info"].user_agent, "app-agent pandas-gbq/0.13.0"
kwargs["client_info"].user_agent, "app-agent pandas-gbq/0.13.0 legacy-gcb"
)

def test_ensure_bqstorage_client_pandas_gbq_not_installed(self):
Expand All @@ -888,7 +888,9 @@ def test_ensure_bqstorage_client_pandas_gbq_not_installed(self):

mock_client.assert_called_once()
_, kwargs = mock_client.call_args
self.assertEqual(kwargs["client_info"].user_agent, "app-agent pandas-gbq/0.0.0")
self.assertEqual(
kwargs["client_info"].user_agent, "app-agent pandas-gbq/0.0.0 legacy-gcb"
)

def test_ensure_bqstorage_client_client_info_none(self):
bigquery_storage = pytest.importorskip("google.cloud.bigquery_storage")
Expand All @@ -905,7 +907,9 @@ def test_ensure_bqstorage_client_client_info_none(self):

mock_client.assert_called_once()
_, kwargs = mock_client.call_args
self.assertEqual(kwargs["client_info"].user_agent, "pandas-gbq/0.0.0")
self.assertEqual(
kwargs["client_info"].user_agent, "pandas-gbq/0.0.0 legacy-gcb"
)

def test_ensure_bqstorage_client_client_info_user_agent_none(self):
bigquery_storage = pytest.importorskip("google.cloud.bigquery_storage")
Expand All @@ -926,7 +930,9 @@ def test_ensure_bqstorage_client_client_info_user_agent_none(self):

mock_client.assert_called_once()
_, kwargs = mock_client.call_args
self.assertEqual(kwargs["client_info"].user_agent, "pandas-gbq/0.0.0")
self.assertEqual(
kwargs["client_info"].user_agent, "pandas-gbq/0.0.0 legacy-gcb"
)

def test_ensure_bqstorage_client_missing_dependency(self):
creds = _make_credentials()
Expand Down
Loading