Skip to content

fix: include amended user agent in read client #17592

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

Draft
tswast wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

fix: include amended user agent in read client #17592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
121ad42
fix: include amended user agent in read client
tswast Jun 29, 2026
737f695
add unit tests
tswast Jun 29, 2026
264008d
Update packages/google-cloud-bigquery/google/cloud/bigquery/client.py
tswast Jun 29, 2026
e9cc092
fix test and mypy
tswast Jun 29, 2026
4f6b612
Merge remote-tracking branch 'origin/main' into b526614511-tswast-pan…
tswast Jun 30, 2026
8e27378
update google-api-core
tswast Jun 30, 2026
8001c7a
ignore unused import skip
tswast Jun 30, 2026
5649e6e
Update packages/google-cloud-bigquery/tests/unit/test_legacy_types.py
tswast Jul 1, 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
138 changes: 86 additions & 52 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 @@ -14,11 +14,8 @@

"""Client for interacting with the Google BigQuery API."""

from __future__ import absolute_import
from __future__ import annotations
from __future__ import division
from __future__ import absolute_import, annotations, division

from collections import abc as collections_abc
import copy
import datetime
import functools
Expand All @@ -30,36 +27,39 @@
import os
import tempfile
import typing
import uuid
import warnings
from collections import abc as collections_abc
from typing import (
IO,
Any,
Callable,
Dict,
IO,
Iterable,
Mapping,
List,
Mapping,
Optional,
Sequence,
Tuple,
Union,
)
import uuid
import warnings

import requests

from google import resumable_media # type: ignore
from google.resumable_media.requests import MultipartUpload # type: ignore
from google.resumable_media.requests import ResumableUpload

import google.api_core.client_options
import google.api_core.exceptions as core_exceptions
from google.api_core.iam import Policy
import google.cloud._helpers # type: ignore
import requests
from google import resumable_media # type: ignore
from google.api_core import page_iterator
from google.api_core import retry as retries
import google.cloud._helpers # type: ignore
from google.api_core.iam import Policy
from google.cloud import exceptions # pytype: disable=import-error
from google.cloud.client import ClientWithProject # type: ignore # pytype: disable=import-error
from google.cloud.client import (
ClientWithProject, # type: ignore # pytype: disable=import-error
)
from google.resumable_media.requests import (
MultipartUpload, # type: ignore
ResumableUpload,
)

try:
from google.cloud.bigquery_storage_v1.services.big_query_read.client import (
Expand All @@ -70,29 +70,30 @@


from google.auth.credentials import Credentials
from google.cloud.bigquery._http import Connection
from google.cloud.bigquery import _job_helpers
from google.cloud.bigquery import _pandas_helpers
from google.cloud.bigquery import _versions_helpers
from google.cloud.bigquery import enums
from google.cloud.bigquery import (
_job_helpers,
_pandas_helpers,
_versions_helpers,
enums,
job,
)
from google.cloud.bigquery import exceptions as bq_exceptions
from google.cloud.bigquery import job
from google.cloud.bigquery._helpers import _get_sub_prop
from google.cloud.bigquery._helpers import _record_field_to_json
from google.cloud.bigquery._helpers import _str_or_none
from google.cloud.bigquery._helpers import _verify_job_config_type
from google.cloud.bigquery._helpers import _get_bigquery_host
from google.cloud.bigquery._helpers import _DEFAULT_HOST
from google.cloud.bigquery._helpers import _DEFAULT_HOST_TEMPLATE
from google.cloud.bigquery._helpers import _DEFAULT_UNIVERSE
from google.cloud.bigquery._helpers import _validate_universe
from google.cloud.bigquery._helpers import _get_client_universe
from google.cloud.bigquery._helpers import TimeoutType
from google.cloud.bigquery._helpers import (
_DEFAULT_HOST,
_DEFAULT_HOST_TEMPLATE,
_DEFAULT_UNIVERSE,
TimeoutType,
_get_bigquery_host,
_get_client_universe,
_get_sub_prop,
_record_field_to_json,
_str_or_none,
_validate_universe,
_verify_job_config_type,
)
from google.cloud.bigquery._http import Connection
from google.cloud.bigquery._job_helpers import make_job_id as _make_job_id
from google.cloud.bigquery.dataset import Dataset
from google.cloud.bigquery.dataset import DatasetListItem
from google.cloud.bigquery.dataset import DatasetReference

from google.cloud.bigquery.dataset import Dataset, DatasetListItem, DatasetReference
from google.cloud.bigquery.enums import AutoRowIDs, DatasetView, UpdateMode
from google.cloud.bigquery.format_options import ParquetOptions
from google.cloud.bigquery.job import (
Expand All @@ -105,27 +106,26 @@
QueryJob,
QueryJobConfig,
)
from google.cloud.bigquery.model import Model
from google.cloud.bigquery.model import ModelReference
from google.cloud.bigquery.model import _model_arg_to_model_ref
from google.cloud.bigquery.model import Model, ModelReference, _model_arg_to_model_ref
from google.cloud.bigquery.opentelemetry_tracing import create_span
from google.cloud.bigquery.query import _QueryResults
from google.cloud.bigquery.retry import (
DEFAULT_GET_JOB_TIMEOUT,
DEFAULT_JOB_RETRY,
DEFAULT_RETRY,
DEFAULT_TIMEOUT,
DEFAULT_GET_JOB_TIMEOUT,
POLLING_DEFAULT_VALUE,
)
from google.cloud.bigquery.routine import Routine
from google.cloud.bigquery.routine import RoutineReference
from google.cloud.bigquery.routine import Routine, RoutineReference
from google.cloud.bigquery.schema import SchemaField
from google.cloud.bigquery.table import _table_arg_to_table
from google.cloud.bigquery.table import _table_arg_to_table_ref
from google.cloud.bigquery.table import Table
from google.cloud.bigquery.table import TableListItem
from google.cloud.bigquery.table import TableReference
from google.cloud.bigquery.table import RowIterator
from google.cloud.bigquery.table import (
RowIterator,
Table,
TableListItem,
TableReference,
_table_arg_to_table,
_table_arg_to_table_ref,
)

pyarrow = _versions_helpers.PYARROW_VERSIONS.try_import()
pandas = (
Expand Down Expand Up @@ -621,11 +621,45 @@ def _ensure_bqstorage_client(
)
return None

if bqstorage_client is None: # pragma: NO COVER
# Import here since it should be installed if the BQ Storage client is
# also installed.
import google.api_core.gapic_v1.client_info

try:
import pandas_gbq # type: ignore
except ImportError:
pandas_gbq = None # type: ignore

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

if client_info is None:
amended_client_info = google.api_core.gapic_v1.client_info.ClientInfo(
user_agent=user_agent,
)
else:
if client_info.user_agent is None:
amended_user_agent = user_agent
else:
amended_user_agent = client_info.user_agent + " " + user_agent

amended_client_info = google.api_core.gapic_v1.client_info.ClientInfo(
python_version=client_info.python_version,
grpc_version=client_info.grpc_version,
api_core_version=client_info.api_core_version,
gapic_version=client_info.gapic_version,
user_agent=amended_user_agent,
rest_version=client_info.rest_version,
protobuf_runtime_version=client_info.protobuf_runtime_version,

@parthea parthea Jun 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From https://github.com/googleapis/google-cloud-python/actions/runs/28405657720/job/84167435143?pr=17592,

E           AttributeError: 'ClientInfo' object has no attribute 'protobuf_runtime_version'

protobuf_runtime_version requires google-api-core 2.25 or newer: https://github.com/googleapis/python-api-core/releases/tag/v2.25.0

>>> import google.api_core.gapic_v1.client_info as client_info
>>> hasattr(client_info.ClientInfo(), 'protobuf_runtime_version')
True

See similar code in google-cloud-language:

google-cloud-python/packages/google-cloud-language/google/cloud/language_v1/services/language_service/client.py

Lines 1513 to 1518 in 0dfdf44

DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
gapic_version=package_version.__version__
)
if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__

Alternatively, we could bump the minimum version of google-api-core since we currently have 2.24.2. Bumping to 2.25 seems reasonable

google-cloud-python/packages/gapic-generator/gapic/templates/setup.py.j2

Line 39 in 0dfdf44

"google-api-core[grpc] >= 2.24.2, <3.0.0",

@parthea parthea Jun 30, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See WIP PR #17599 to bump google-api-core for generated libraries. You can also bump google-api-core in this PR for google-cloud-bigquery since it's not automatically generated .

@tswast tswast Jun 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for investigating @parthea ! Yes, I'll bump the minimum here too.

)

if bqstorage_client is None:
bqstorage_client = bigquery_storage.BigQueryReadClient(
credentials=self._credentials,
client_options=client_options,
client_info=client_info, # type: ignore # (None is also accepted)
client_info=amended_client_info,
)

return bqstorage_client
Expand Down
4 changes: 2 additions & 2 deletions packages/google-cloud-bigquery/noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@
from __future__ import absolute_import

import contextlib
from functools import wraps
import os
import pathlib
from typing import Generator
import re
import shutil
import time
from functools import wraps
from typing import Generator

import nox

Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-bigquery/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ classifiers = [
"Topic :: Internet",
]
dependencies = [
"google-api-core[grpc] >= 2.11.1, < 3.0.0",
"google-api-core[grpc] >= 2.25.0, < 3.0.0",
"google-auth[pyopenssl] >= 2.14.1, < 3.0.0",
"google-cloud-core >= 2.4.1, < 3.0.0",
"google-resumable-media >= 2.0.0, < 3.0.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-bigquery/testing/constraints-3.10.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
google-api-core==2.11.1
google-api-core==2.25.0
google-auth==2.14.1
google-cloud-core==2.4.1
google-resumable-media==2.0.0
Expand Down
Loading
Loading