google-cloud-bigquery-storage 2.41.0__tar.gz → 2.43.0__tar.gz

{google_cloud_bigquery_storage-2.41.0/google_cloud_bigquery_storage.egg-info → google_cloud_bigquery_storage-2.43.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-cloud-bigquery-storage
-Version: 2.41.0
+Version: 2.43.0
 Summary: Google Cloud Bigquery Storage API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-bigquery-storage
 Author: Google LLC
@@ -17,11 +17,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Internet
 Requires-Python: >=3.10
 License-File: LICENSE
-Requires-Dist: google-api-core[grpc]<3.0.0,>=2.25.0
+Requires-Dist: google-api-core[grpc]<3.0.0,>=2.28.0
 Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
 Requires-Dist: grpcio<2.0.0,>=1.59.0
 Requires-Dist: grpcio<2.0.0,>=1.75.1; python_version >= "3.14"

{google_cloud_bigquery_storage-2.41.0 → google_cloud_bigquery_storage-2.43.0}/google/cloud/bigquery_storage/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.41.0"  # {x-release-please-version}
+__version__ = "2.43.0"  # {x-release-please-version}

google_cloud_bigquery_storage-2.43.0/google/cloud/bigquery_storage_v1/__init__.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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 google.api_core as api_core
+
+from google.cloud.bigquery_storage_v1 import gapic_version as package_version
+
+__version__ = package_version.__version__
+
+# PEP 0810: Explicit Lazy Imports
+# Python 3.15+ natively intercepts and defers these imports.
+# Developers can disable this behavior and force eager imports.
+# For more information, see:
+# https://docs.python.org/3.15/library/sys.html#sys.set_lazy_imports_filter
+# Older Python versions safely ignore this variable.
+__lazy_modules__ = {
+    "google.cloud.bigquery_storage_v1.services.big_query_read",
+    "google.cloud.bigquery_storage_v1.services.big_query_write",
+    "google.cloud.bigquery_storage_v1.types.annotations",
+    "google.cloud.bigquery_storage_v1.types.arrow",
+    "google.cloud.bigquery_storage_v1.types.avro",
+    "google.cloud.bigquery_storage_v1.types.protobuf",
+    "google.cloud.bigquery_storage_v1.types.storage",
+    "google.cloud.bigquery_storage_v1.types.stream",
+    "google.cloud.bigquery_storage_v1.types.table",
+}
+
+
+from google.cloud.bigquery_storage_v1 import client, types
+
+
+class BigQueryReadClient(client.BigQueryReadClient):
+    __doc__ = client.BigQueryReadClient.__doc__
+
+
+class BigQueryWriteClient(client.BigQueryWriteClient):
+    __doc__ = client.BigQueryWriteClient.__doc__
+
+
+__all__ = (
+    # google.cloud.bigquery_storage_v1
+    "__version__",
+    "types",
+    # google.cloud.bigquery_storage_v1.client
+    "BigQueryReadClient",
+    "BigQueryWriteClient",
+)
+
+api_core.check_python_version("google.cloud.bigquery_storage_v1")
+api_core.check_dependency_versions("google.cloud.bigquery_storage_v1")

google_cloud_bigquery_storage-2.43.0/google/cloud/bigquery_storage_v1/_compat.py

@@ -0,0 +1,262 @@
+# -*- coding: utf-8 -*-
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+#
+"""A compatibility module for older versions of google-api-core."""
+
+import json
+import os
+from typing import Any, Dict, List, Optional, Tuple
+from urllib.parse import urlparse, urlunparse
+
+from google.api_core import path_template
+from google.api_core.universe import EmptyUniverseError
+from google.auth.exceptions import MutualTLSChannelError
+from google.protobuf import json_format
+
+try:
+    # note: `#type: ignore` is added because the return type for `should_use_client_cert`
+    # is different than that of the fallback implementation below. This will be removed once
+    # we bump the minimum supported version of google-auth.
+    from google.auth.transport.mtls import should_use_client_cert  # type: ignore
+except ImportError:  # pragma: NO COVER
+
+    def should_use_client_cert():
+        """Returns whether client certificate should be used for mTLS."""
+        use_client_cert = os.getenv(
+            "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"
+        ).lower()
+        if use_client_cert not in ("true", "false"):
+            raise ValueError(
+                "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be"
+                " either `true` or `false`"
+            )
+        return use_client_cert == "true"
+
+
+def read_environment_variables():
+    """Returns the environment variables used by the client.
+
+    Returns:
+        Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE,
+        GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables.
+
+    Raises:
+        ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not
+            any of ["true", "false"].
+        google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
+            is not any of ["auto", "never", "always"].
+    """
+    use_client_cert = should_use_client_cert()
+    use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower()
+    universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
+    if use_mtls_endpoint not in ("auto", "never", "always"):
+        raise MutualTLSChannelError(
+            "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`,"
+            " `auto` or `always`"
+        )
+    return use_client_cert, use_mtls_endpoint, universe_domain_env
+
+
+DEFAULT_UNIVERSE = "googleapis.com"
+
+try:
+    from google.api_core.universe import get_default_mtls_endpoint
+except ImportError:  # pragma: NO COVER
+
+    def get_default_mtls_endpoint(api_endpoint: Optional[str]) -> Optional[str]:
+        """Converts api endpoint to mTLS endpoint.
+
+        Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to
+        "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively.
+        Other URLs (including those that do not match these domain suffixes or
+        already contain '.mtls.') are passed through as-is.
+
+        Args:
+            api_endpoint (Optional[str]): the api endpoint to convert.
+
+        Returns:
+            Optional[str]: converted mTLS api endpoint.
+        """
+        if not api_endpoint or ".mtls." in api_endpoint.lower():
+            return api_endpoint
+
+        has_scheme = "://" in api_endpoint
+        if not has_scheme:
+            parsed = urlparse("//" + api_endpoint)
+        else:
+            parsed = urlparse(api_endpoint)
+
+        host = parsed.hostname
+        if not host:
+            return api_endpoint
+
+        port = f":{parsed.port}" if parsed.port else ""
+
+        lowered_host = host.lower()
+        suffix_sandbox = ".sandbox.googleapis.com"
+        suffix_google = ".googleapis.com"
+        if lowered_host.endswith(suffix_sandbox):
+            new_host = host[: -len(suffix_sandbox)] + ".mtls.sandbox.googleapis.com"
+        elif lowered_host.endswith(suffix_google):
+            new_host = host[: -len(suffix_google)] + ".mtls.googleapis.com"
+        else:
+            return api_endpoint
+
+        netloc = new_host + port
+        new_parsed = parsed._replace(netloc=netloc)
+
+        if not has_scheme:
+            return urlunparse(new_parsed)[2:]
+        else:
+            return urlunparse(new_parsed)
+
+
+try:
+    from google.api_core.universe import get_api_endpoint
+except ImportError:  # pragma: NO COVER
+
+    def get_api_endpoint(
+        api_override: Optional[str],
+        universe_domain: str,
+        default_universe: str,
+        default_mtls_endpoint: Optional[str],
+        default_endpoint_template: str,
+        use_mtls: bool,
+    ) -> str:
+        """Return the API endpoint used by the client.
+
+        Args:
+            api_override (Optional[str]): The API endpoint override. If specified,
+                this is always returned.
+            universe_domain (str): The universe domain used by the client.
+            default_universe (str): The default universe domain.
+            default_mtls_endpoint (Optional[str]): The default mTLS endpoint.
+            default_endpoint_template (str): The default endpoint template containing
+                a placeholder `{UNIVERSE_DOMAIN}`.
+            use_mtls (bool): Whether to use the mTLS endpoint.
+
+        Returns:
+            str: The API endpoint to be used by the client.
+
+        Raises:
+            google.auth.exceptions.MutualTLSChannelError: If mTLS is requested but
+                not supported in the configured universe domain.
+            ValueError: If mTLS is requested but no mTLS endpoint is available.
+        """
+        if api_override is not None:
+            return api_override
+
+        if use_mtls:
+            if universe_domain.lower() != default_universe.lower():
+                raise MutualTLSChannelError(
+                    f"mTLS is not supported in any universe other than {default_universe}."
+                )
+            if not default_mtls_endpoint:
+                raise ValueError("mTLS endpoint is not available.")
+            return default_mtls_endpoint
+        else:
+            return default_endpoint_template.format(UNIVERSE_DOMAIN=universe_domain)
+
+
+try:
+    from google.api_core.universe import get_universe_domain
+except ImportError:  # pragma: NO COVER
+
+    def get_universe_domain(
+        *potential_universes: Optional[str],
+        default_universe: str,
+    ) -> str:
+        """Return the universe domain used by the client.
+
+        Args:
+            *potential_universes (Optional[str]): Potential universe domains in order of preference.
+            default_universe (str): The default universe domain.
+
+        Returns:
+            str: The universe domain to be used by the client.
+
+        Raises:
+            EmptyUniverseError: If the resolved universe domain is an empty string.
+        """
+        resolved = next(
+            (x.strip() for x in potential_universes if x is not None),
+            default_universe,
+        )
+
+        if not resolved:
+            raise EmptyUniverseError()
+        return resolved
+
+
+try:
+    from google.api_core.rest_helpers import transcode_request  # type: ignore
+except ImportError:  # pragma: NO COVER
+
+    def transcode_request(
+        http_options: List[Dict[str, str]],
+        request: Any,
+        required_fields_default_values: Optional[Dict[str, Any]] = None,
+        rest_numeric_enums: bool = False,
+    ) -> Tuple[Dict[str, Any], Optional[str], Dict[str, Any]]:
+        """Transcodes a request into HTTP method, URI, body, and query parameters.
+
+        Args:
+            http_options (List[Dict[str, str]]): List of HTTP transcoding rules.
+            request (Any): The protobuf or proto-plus request message.
+            required_fields_default_values (Optional[Dict[str, Any]]): Dictionary
+                of required fields default values to merge into query parameters if missing.
+            rest_numeric_enums (bool): Whether to encode enums as integers.
+
+        Returns:
+            Tuple[Dict[str, Any], Optional[str], Dict[str, Any]]: A tuple containing:
+                - The raw transcoded request dictionary (containing keys like 'uri', 'method').
+                - The serialized request body JSON string, or None if no body.
+                - The query parameters dictionary.
+        """
+        if request is None:
+            raise TypeError("request cannot be None")
+
+        # Convert proto-plus message to its underlying protobuf message if needed
+        pb_request = getattr(request, "_pb", request)
+
+        transcoded_request = path_template.transcode(http_options, pb_request)
+
+        body_json = None
+        if transcoded_request.get("body") is not None:
+            body_json = json_format.MessageToJson(
+                transcoded_request["body"],
+                use_integers_for_enums=rest_numeric_enums,
+            )
+
+        query_params_json = {}
+        if transcoded_request.get("query_params") is not None:
+            query_params_json = json.loads(
+                json_format.MessageToJson(
+                    transcoded_request["query_params"],
+                    use_integers_for_enums=rest_numeric_enums,
+                )
+            )
+
+        # If required_fields_default_values is provided, we merge default values for missing
+        # required fields into the query parameters.
+        if required_fields_default_values:
+            for k, v in required_fields_default_values.items():
+                if k not in query_params_json:
+                    query_params_json[k] = v
+
+        if rest_numeric_enums:
+            query_params_json["$alt"] = "json;enum-encoding=int"
+
+        return transcoded_request, body_json, query_params_json

{google_cloud_bigquery_storage-2.41.0 → google_cloud_bigquery_storage-2.43.0}/google/cloud/bigquery_storage_v1/client.py

@@ -57,6 +57,8 @@ class BigQueryReadClient(big_query_read.BigQueryReadClient):
         timeout=google.api_core.gapic_v1.method.DEFAULT,
         metadata=(),
         retry_delay_callback=None,
+        *,
+        arrow_serialization_options=None,
     ):
         """
         Reads rows from the table in the format prescribed by the read
@@ -124,6 +126,14 @@ class BigQueryReadClient(big_query_read.BigQueryReadClient):
                 BigQueryReadClient will call retry_delay_callback with the delay
                 duration (in seconds) before it starts sleeping until the next
                 attempt.
+            arrow_serialization_options (Optional[Union[dict, \
+                ~google.cloud.bigquery_storage_v1.types.ArrowSerializationOptions \
+            ]]):
+                Arrow serialization options, such as buffer compression, to
+                send on every ``ReadRows`` request, including after a
+                reconnect. Only job default streams
+                (``projects/{project}/locations/{location}/jobs/{job}/streams/_default``)
+                accept them.
 
         Returns:
             ~google.cloud.bigquery_storage_v1.reader.ReadRowsStream:
@@ -137,6 +147,11 @@ class BigQueryReadClient(big_query_read.BigQueryReadClient):
                     to a retryable error and retry attempts failed.
             ValueError: If the parameters are invalid.
         """
+        request_template = None
+        if arrow_serialization_options is not None:
+            request_template = {
+                "arrow_serialization_options": arrow_serialization_options
+            }
         gapic_client = super(BigQueryReadClient, self)
         stream = reader.ReadRowsStream(
             gapic_client,
@@ -144,6 +159,7 @@ class BigQueryReadClient(big_query_read.BigQueryReadClient):
             offset,
             {"retry": retry, "timeout": timeout, "metadata": metadata},
             retry_delay_callback=retry_delay_callback,
+            request_template=request_template,
         )
         stream._reconnect()
         return stream

{google_cloud_bigquery_storage-2.41.0/google/cloud/bigquery_storage_v1alpha → google_cloud_bigquery_storage-2.43.0/google/cloud/bigquery_storage_v1}/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.41.0"  # {x-release-please-version}
+__version__ = "2.43.0"  # {x-release-please-version}

{google_cloud_bigquery_storage-2.41.0 → google_cloud_bigquery_storage-2.43.0}/google/cloud/bigquery_storage_v1/reader.py

@@ -27,6 +27,8 @@ except ImportError:  # pragma: NO COVER
 import google.api_core.exceptions
 import google.rpc.error_details_pb2  # type: ignore
 
+from google.cloud.bigquery_storage_v1 import types as gapic_types
+
 try:
     import pandas
 except ImportError:  # pragma: NO COVER
@@ -86,7 +88,14 @@ class ReadRowsStream(object):
     """
 
     def __init__(
-        self, client, name, offset, read_rows_kwargs, retry_delay_callback=None
+        self,
+        client,
+        name,
+        offset,
+        read_rows_kwargs,
+        retry_delay_callback=None,
+        *,
+        request_template=None,
     ):
         """Construct a ReadRowsStream.
 
@@ -114,6 +123,13 @@ class ReadRowsStream(object):
                 ReadRowsStream will call retry_delay_callback with the delay
                 duration (in seconds) before it starts sleeping until the next
                 attempt.
+            request_template (Optional[Union[dict, \
+                ~google.cloud.bigquery_storage_v1.types.ReadRowsRequest \
+            ]]):
+                Request fields, such as ``arrow_serialization_options``, to
+                send on every ``ReadRows`` request, including after a
+                reconnect. ``read_stream`` and ``offset`` are set from
+                ``name`` and the current stream offset.
 
         Returns:
             Iterable[ \
@@ -129,6 +145,8 @@ class ReadRowsStream(object):
         self._offset = offset
         self._read_rows_kwargs = read_rows_kwargs
         self._retry_delay_callback = retry_delay_callback
+        self._request_template = request_template
+        self._cancelled = False
         self._wrapped = None
 
     def __iter__(self):
@@ -140,19 +158,20 @@ class ReadRowsStream(object):
             ]:
                 A sequence of row messages.
         """
-        # Infinite loop to reconnect on reconnectable errors while processing
-        # the row stream.
+        # Loop to reconnect on reconnectable errors while processing the row
+        # stream, until the stream ends or is cancelled.
 
         if self._wrapped is None:
             self._reconnect()
 
-        while True:
+        while not self._cancelled:
             try:
                 for message in self._wrapped:
                     rowcount = message.row_count
                     self._offset += rowcount
                     yield message
 
+                self._wrapped = None
                 return  # Made it through the whole stream.
             except google.api_core.exceptions.InternalServerError as exc:
                 resumable_error = any(
@@ -165,22 +184,60 @@ class ReadRowsStream(object):
                 # Transient error, so reconnect to the stream.
                 pass
             except Exception as exc:
+                # cancel() makes the call fail, which isn't an error here.
+                if self._cancelled:
+                    return
                 if not self._resource_exhausted_exception_is_retryable(exc):
                     raise
 
             self._reconnect()
 
+    def cancel(self):
+        """Cancel the ``ReadRows`` call.
+
+        Use this to stop reading before the end of the stream. After
+        ``cancel()``, iterating the stream yields no more messages, and the
+        stream doesn't reconnect. The client stays open for other calls.
+        """
+        self._cancelled = True
+        cancel = getattr(self._wrapped, "cancel", None)
+        if cancel is not None:
+            cancel()
+
+    def __del__(self):
+        if not getattr(self, "_cancelled", True):
+            self.cancel()
+
     def _reconnect(self):
         """Reconnect to the ReadRows stream using the most recent offset."""
-        while True:
+        while not self._cancelled:
             try:
-                self._wrapped = self._client.read_rows(
-                    read_stream=self._name,
-                    offset=self._offset,
-                    **self._read_rows_kwargs,
-                )
+                if self._request_template is None:
+                    wrapped = self._client.read_rows(
+                        read_stream=self._name,
+                        offset=self._offset,
+                        **self._read_rows_kwargs,
+                    )
+                else:
+                    # The flattened read_rows() arguments only include
+                    # read_stream and offset, so send a full request copy.
+                    request = gapic_types.ReadRowsRequest(self._request_template)
+                    request.read_stream = self._name
+                    request.offset = self._offset
+                    wrapped = self._client.read_rows(
+                        request=request,
+                        **self._read_rows_kwargs,
+                    )
+                # Store the new call before checking for cancel(), so a
+                # concurrent cancel() either cancels it or is seen here.
+                self._wrapped = wrapped
+                if self._cancelled:
+                    self.cancel()
+                    return
                 break
             except Exception as exc:
+                if self._cancelled:
+                    return
                 if not self._resource_exhausted_exception_is_retryable(exc):
                     raise