google-cloud-bigquery 3.27.0__tar.gz → 3.28.0__tar.gz

{google_cloud_bigquery-3.27.0/google_cloud_bigquery.egg-info → google_cloud_bigquery-3.28.0}/PKG-INFO

@@ -1,12 +1,10 @@
 Metadata-Version: 2.1
 Name: google-cloud-bigquery
-Version: 3.27.0
+Version: 3.28.0
 Summary: Google BigQuery API client library
-Home-page: https://github.com/googleapis/python-bigquery
-Author: Google LLC
-Author-email: googleapis-packages@google.com
+Author-email: Google LLC <googleapis-packages@google.com>
 License: Apache 2.0
-Platform: Posix; MacOS X; Windows
+Project-URL: Repository, https://github.com/googleapis/python-bigquery
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -21,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Internet
 Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: google-api-core[grpc]<3.0.0dev,>=2.11.1
 Requires-Dist: google-auth<3.0.0dev,>=2.14.1
@@ -43,7 +42,7 @@ Provides-Extra: ipywidgets
 Requires-Dist: ipywidgets>=7.7.0; extra == "ipywidgets"
 Requires-Dist: ipykernel>=6.0.0; extra == "ipywidgets"
 Provides-Extra: geopandas
-Requires-Dist: geopandas<1.0dev,>=0.9.0; extra == "geopandas"
+Requires-Dist: geopandas<2.0dev,>=0.9.0; extra == "geopandas"
 Requires-Dist: Shapely<3.0.0dev,>=1.8.4; extra == "geopandas"
 Provides-Extra: ipython
 Requires-Dist: bigquery-magics>=0.1.0; extra == "ipython"
@@ -57,25 +56,7 @@ Provides-Extra: bigquery-v2
 Requires-Dist: proto-plus<2.0.0dev,>=1.22.3; extra == "bigquery-v2"
 Requires-Dist: protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<6.0.0dev,>=3.20.2; extra == "bigquery-v2"
 Provides-Extra: all
-Requires-Dist: google-cloud-bigquery-storage<3.0.0dev,>=2.6.0; extra == "all"
-Requires-Dist: grpcio<2.0dev,>=1.47.0; extra == "all"
-Requires-Dist: grpcio<2.0dev,>=1.49.1; python_version >= "3.11" and extra == "all"
-Requires-Dist: pyarrow>=3.0.0; extra == "all"
-Requires-Dist: pandas>=1.1.0; extra == "all"
-Requires-Dist: pyarrow>=3.0.0; extra == "all"
-Requires-Dist: db-dtypes<2.0.0dev,>=0.3.0; extra == "all"
-Requires-Dist: importlib_metadata>=1.0.0; python_version < "3.8" and extra == "all"
-Requires-Dist: ipywidgets>=7.7.0; extra == "all"
-Requires-Dist: ipykernel>=6.0.0; extra == "all"
-Requires-Dist: geopandas<1.0dev,>=0.9.0; extra == "all"
-Requires-Dist: Shapely<3.0.0dev,>=1.8.4; extra == "all"
-Requires-Dist: bigquery-magics>=0.1.0; extra == "all"
-Requires-Dist: tqdm<5.0.0dev,>=4.7.4; extra == "all"
-Requires-Dist: opentelemetry-api>=1.1.0; extra == "all"
-Requires-Dist: opentelemetry-sdk>=1.1.0; extra == "all"
-Requires-Dist: opentelemetry-instrumentation>=0.20b0; extra == "all"
-Requires-Dist: proto-plus<2.0.0dev,>=1.22.3; extra == "all"
-Requires-Dist: protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<6.0.0dev,>=3.20.2; extra == "all"
+Requires-Dist: google-cloud-bigquery[bigquery_v2,bqstorage,geopandas,ipython,ipywidgets,opentelemetry,pandas,tqdm]; extra == "all"
 
 Python Client for Google BigQuery
 =================================

{google_cloud_bigquery-3.27.0 → google_cloud_bigquery-3.28.0}/google/cloud/bigquery/_helpers.py

@@ -22,7 +22,7 @@ import math
 import re
 import os
 import warnings
-from typing import Optional, Union
+from typing import Optional, Union, Any, Tuple, Type
 
 from dateutil import relativedelta
 from google.cloud._helpers import UTC  # type: ignore
@@ -1004,3 +1004,33 @@ def _verify_job_config_type(job_config, expected_type, param_name="job_config"):
                 job_config=job_config,
             )
         )
+
+
+def _isinstance_or_raise(
+    value: Any,
+    dtype: Union[Type, Tuple[Type, ...]],
+    none_allowed: Optional[bool] = False,
+) -> Any:
+    """Determine whether a value type matches a given datatype or None.
+    Args:
+        value (Any): Value to be checked.
+        dtype (type): Expected data type or tuple of data types.
+        none_allowed Optional(bool): whether value is allowed to be None. Default
+           is False.
+    Returns:
+        Any: Returns the input value if the type check is successful.
+    Raises:
+        TypeError: If the input value's type does not match the expected data type(s).
+    """
+    if none_allowed and value is None:
+        return value
+
+    if isinstance(value, dtype):
+        return value
+
+    or_none = ""
+    if none_allowed:
+        or_none = " (or None)"
+
+    msg = f"Pass {value} as a '{dtype}'{or_none}. Got {type(value)}."
+    raise TypeError(msg)

{google_cloud_bigquery-3.27.0 → google_cloud_bigquery-3.28.0}/google/cloud/bigquery/client.py

@@ -44,6 +44,8 @@ from typing import (
 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
@@ -65,6 +67,7 @@ except ImportError:
     DEFAULT_BQSTORAGE_CLIENT_INFO = None  # type: ignore
 
 
+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
@@ -126,6 +129,7 @@ pandas = (
     _versions_helpers.PANDAS_VERSIONS.try_import()
 )  # mypy check fails because pandas import is outside module, there are type: ignore comments related to this
 
+
 ResumableTimeoutType = Union[
     None, float, Tuple[float, float]
 ]  # for resumable media methods
@@ -133,8 +137,6 @@ ResumableTimeoutType = Union[
 if typing.TYPE_CHECKING:  # pragma: NO COVER
     # os.PathLike is only subscriptable in Python 3.9+, thus shielding with a condition.
     PathType = Union[str, bytes, os.PathLike[str], os.PathLike[bytes]]
-    import requests  # required by api-core
-
 _DEFAULT_CHUNKSIZE = 100 * 1024 * 1024  # 100 MB
 _MAX_MULTIPART_SIZE = 5 * 1024 * 1024
 _DEFAULT_NUM_RETRIES = 6
@@ -231,15 +233,23 @@ class Client(ClientWithProject):
 
     def __init__(
         self,
-        project=None,
-        credentials=None,
-        _http=None,
-        location=None,
-        default_query_job_config=None,
-        default_load_job_config=None,
-        client_info=None,
-        client_options=None,
+        project: Optional[str] = None,
+        credentials: Optional[Credentials] = None,
+        _http: Optional[requests.Session] = None,
+        location: Optional[str] = None,
+        default_query_job_config: Optional[QueryJobConfig] = None,
+        default_load_job_config: Optional[LoadJobConfig] = None,
+        client_info: Optional[google.api_core.client_info.ClientInfo] = None,
+        client_options: Optional[
+            Union[google.api_core.client_options.ClientOptions, Dict[str, Any]]
+        ] = None,
     ) -> None:
+        if client_options is None:
+            client_options = {}
+        if isinstance(client_options, dict):
+            client_options = google.api_core.client_options.from_dict(client_options)
+        # assert isinstance(client_options, google.api_core.client_options.ClientOptions)
+
         super(Client, self).__init__(
             project=project,
             credentials=credentials,
@@ -247,14 +257,10 @@ class Client(ClientWithProject):
             _http=_http,
         )
 
-        kw_args = {"client_info": client_info}
+        kw_args: Dict[str, Any] = {"client_info": client_info}
         bq_host = _get_bigquery_host()
         kw_args["api_endpoint"] = bq_host if bq_host != _DEFAULT_HOST else None
         client_universe = None
-        if client_options is None:
-            client_options = {}
-        if isinstance(client_options, dict):
-            client_options = google.api_core.client_options.from_dict(client_options)
         if client_options.api_endpoint:
             api_endpoint = client_options.api_endpoint
             kw_args["api_endpoint"] = api_endpoint
@@ -1184,6 +1190,19 @@ class Client(ClientWithProject):
         must be provided. If a field is listed in ``fields`` and is ``None`` in
         ``dataset``, it will be deleted.
 
+        For example, to update the default expiration times, specify
+        both properties in the ``fields`` argument:
+
+        .. code-block:: python
+
+            bigquery_client.update_dataset(
+                dataset,
+                [
+                    "default_partition_expiration_ms",
+                    "default_table_expiration_ms",
+                ]
+            )
+
         If ``dataset.etag`` is not ``None``, the update will only
         succeed if the dataset on the server has the same ETag. Thus
         reading a dataset with ``get_dataset``, changing its fields,
@@ -1198,19 +1217,6 @@ class Client(ClientWithProject):
                 The properties of ``dataset`` to change. These are strings
                 corresponding to the properties of
                 :class:`~google.cloud.bigquery.dataset.Dataset`.
-
-                For example, to update the default expiration times, specify
-                both properties in the ``fields`` argument:
-
-                .. code-block:: python
-
-                    bigquery_client.update_dataset(
-                        dataset,
-                        [
-                            "default_partition_expiration_ms",
-                            "default_table_expiration_ms",
-                        ]
-                    )
             retry (Optional[google.api_core.retry.Retry]):
                 How to retry the RPC.
             timeout (Optional[float]):
@@ -1254,6 +1260,15 @@ class Client(ClientWithProject):
         must be provided. If a field is listed in ``fields`` and is ``None``
         in ``model``, the field value will be deleted.
 
+        For example, to update the descriptive properties of the model,
+        specify them in the ``fields`` argument:
+
+        .. code-block:: python
+
+            bigquery_client.update_model(
+                model, ["description", "friendly_name"]
+            )
+
         If ``model.etag`` is not ``None``, the update will only succeed if
         the model on the server has the same ETag. Thus reading a model with
         ``get_model``, changing its fields, and then passing it to
@@ -1266,15 +1281,6 @@ class Client(ClientWithProject):
                 The properties of ``model`` to change. These are strings
                 corresponding to the properties of
                 :class:`~google.cloud.bigquery.model.Model`.
-
-                For example, to update the descriptive properties of the model,
-                specify them in the ``fields`` argument:
-
-                .. code-block:: python
-
-                    bigquery_client.update_model(
-                        model, ["description", "friendly_name"]
-                    )
             retry (Optional[google.api_core.retry.Retry]):
                 A description of how to retry the API call.
             timeout (Optional[float]):
@@ -1318,6 +1324,15 @@ class Client(ClientWithProject):
         must be provided. If a field is listed in ``fields`` and is ``None``
         in ``routine``, the field value will be deleted.
 
+        For example, to update the description property of the routine,
+        specify it in the ``fields`` argument:
+
+        .. code-block:: python
+
+            bigquery_client.update_routine(
+                routine, ["description"]
+            )
+
         .. warning::
            During beta, partial updates are not supported. You must provide
            all fields in the resource.
@@ -1336,15 +1351,6 @@ class Client(ClientWithProject):
             fields (Sequence[str]):
                 The fields of ``routine`` to change, spelled as the
                 :class:`~google.cloud.bigquery.routine.Routine` properties.
-
-                For example, to update the description property of the routine,
-                specify it in the ``fields`` argument:
-
-                .. code-block:: python
-
-                    bigquery_client.update_routine(
-                        routine, ["description"]
-                    )
             retry (Optional[google.api_core.retry.Retry]):
                 A description of how to retry the API call.
             timeout (Optional[float]):
@@ -1392,6 +1398,16 @@ class Client(ClientWithProject):
         must be provided. If a field is listed in ``fields`` and is ``None``
         in ``table``, the field value will be deleted.
 
+        For example, to update the descriptive properties of the table,
+        specify them in the ``fields`` argument:
+
+        .. code-block:: python
+
+            bigquery_client.update_table(
+                table,
+                ["description", "friendly_name"]
+            )
+
         If ``table.etag`` is not ``None``, the update will only succeed if
         the table on the server has the same ETag. Thus reading a table with
         ``get_table``, changing its fields, and then passing it to
@@ -1403,16 +1419,6 @@ class Client(ClientWithProject):
             fields (Sequence[str]):
                 The fields of ``table`` to change, spelled as the
                 :class:`~google.cloud.bigquery.table.Table` properties.
-
-                For example, to update the descriptive properties of the table,
-                specify them in the ``fields`` argument:
-
-                .. code-block:: python
-
-                    bigquery_client.update_table(
-                        table,
-                        ["description", "friendly_name"]
-                    )
             retry (Optional[google.api_core.retry.Retry]):
                 A description of how to retry the API call.
             timeout (Optional[float]):

{google_cloud_bigquery-3.27.0 → google_cloud_bigquery-3.28.0}/google/cloud/bigquery/dataset.py

@@ -27,6 +27,7 @@ from google.cloud.bigquery.model import ModelReference
 from google.cloud.bigquery.routine import Routine, RoutineReference
 from google.cloud.bigquery.table import Table, TableReference
 from google.cloud.bigquery.encryption_configuration import EncryptionConfiguration
+from google.cloud.bigquery import external_config
 
 from typing import Optional, List, Dict, Any, Union
 
@@ -530,6 +531,8 @@ class Dataset(object):
         "storage_billing_model": "storageBillingModel",
         "max_time_travel_hours": "maxTimeTravelHours",
         "default_rounding_mode": "defaultRoundingMode",
+        "resource_tags": "resourceTags",
+        "external_catalog_dataset_options": "externalCatalogDatasetOptions",
     }
 
     def __init__(self, dataset_ref) -> None:
@@ -801,6 +804,28 @@ class Dataset(object):
             raise ValueError("Pass a dict")
         self._properties["labels"] = value
 
+    @property
+    def resource_tags(self):
+        """Dict[str, str]: Resource tags of the dataset.
+
+        Optional. The tags attached to this dataset. Tag keys are globally
+        unique. Tag key is expected to be in the namespaced format, for
+        example "123456789012/environment" where 123456789012 is
+        the ID of the parent organization or project resource for this tag
+        key. Tag value is expected to be the short name, for example
+        "Production".
+
+        Raises:
+            ValueError: for invalid value types.
+        """
+        return self._properties.setdefault("resourceTags", {})
+
+    @resource_tags.setter
+    def resource_tags(self, value):
+        if not isinstance(value, dict) and value is not None:
+            raise ValueError("Pass a dict")
+        self._properties["resourceTags"] = value
+
     @property
     def default_encryption_configuration(self):
         """google.cloud.bigquery.encryption_configuration.EncryptionConfiguration: Custom
@@ -875,6 +900,29 @@ class Dataset(object):
             )
         self._properties["storageBillingModel"] = value
 
+    @property
+    def external_catalog_dataset_options(self):
+        """Options defining open source compatible datasets living in the
+        BigQuery catalog. Contains metadata of open source database, schema
+        or namespace represented by the current dataset."""
+
+        prop = _helpers._get_sub_prop(
+            self._properties, ["externalCatalogDatasetOptions"]
+        )
+
+        if prop is not None:
+            prop = external_config.ExternalCatalogDatasetOptions.from_api_repr(prop)
+        return prop
+
+    @external_catalog_dataset_options.setter
+    def external_catalog_dataset_options(self, value):
+        value = _helpers._isinstance_or_raise(
+            value, external_config.ExternalCatalogDatasetOptions, none_allowed=True
+        )
+        self._properties[
+            self._PROPERTY_TO_API_FIELD["external_catalog_dataset_options"]
+        ] = (value.to_api_repr() if value is not None else None)
+
     @classmethod
     def from_string(cls, full_dataset_id: str) -> "Dataset":
         """Construct a dataset from fully-qualified dataset ID.

{google_cloud_bigquery-3.27.0 → google_cloud_bigquery-3.28.0}/google/cloud/bigquery/external_config.py

@@ -18,7 +18,7 @@
    Job.configuration.query.tableDefinitions.
 """
 
-from __future__ import absolute_import
+from __future__ import absolute_import, annotations
 
 import base64
 import copy
@@ -28,6 +28,7 @@ from google.cloud.bigquery._helpers import _to_bytes
 from google.cloud.bigquery._helpers import _bytes_to_json
 from google.cloud.bigquery._helpers import _int_or_none
 from google.cloud.bigquery._helpers import _str_or_none
+from google.cloud.bigquery import _helpers
 from google.cloud.bigquery.format_options import AvroOptions, ParquetOptions
 from google.cloud.bigquery.schema import SchemaField
 
@@ -1003,3 +1004,76 @@ class ExternalConfig(object):
         config = cls(resource["sourceFormat"])
         config._properties = copy.deepcopy(resource)
         return config
+
+
+class ExternalCatalogDatasetOptions:
+    """Options defining open source compatible datasets living in the BigQuery catalog.
+    Contains metadata of open source database, schema or namespace represented
+    by the current dataset.
+
+    Args:
+        default_storage_location_uri (Optional[str]): The storage location URI for all
+            tables in the dataset. Equivalent to hive metastore's database
+            locationUri. Maximum length of 1024 characters. (str)
+        parameters (Optional[dict[str, Any]]): A map of key value pairs defining the parameters
+            and properties of the open source schema. Maximum size of 2Mib.
+    """
+
+    def __init__(
+        self,
+        default_storage_location_uri: Optional[str] = None,
+        parameters: Optional[Dict[str, Any]] = None,
+    ):
+        self._properties: Dict[str, Any] = {}
+        self.default_storage_location_uri = default_storage_location_uri
+        self.parameters = parameters
+
+    @property
+    def default_storage_location_uri(self) -> Optional[str]:
+        """Optional. The storage location URI for all tables in the dataset.
+        Equivalent to hive metastore's database locationUri. Maximum length of
+        1024 characters."""
+
+        return self._properties.get("defaultStorageLocationUri")
+
+    @default_storage_location_uri.setter
+    def default_storage_location_uri(self, value: Optional[str]):
+        value = _helpers._isinstance_or_raise(value, str, none_allowed=True)
+        self._properties["defaultStorageLocationUri"] = value
+
+    @property
+    def parameters(self) -> Optional[Dict[str, Any]]:
+        """Optional. A map of key value pairs defining the parameters and
+        properties of the open source schema. Maximum size of 2Mib."""
+
+        return self._properties.get("parameters")
+
+    @parameters.setter
+    def parameters(self, value: Optional[Dict[str, Any]]):
+        value = _helpers._isinstance_or_raise(value, dict, none_allowed=True)
+        self._properties["parameters"] = value
+
+    def to_api_repr(self) -> dict:
+        """Build an API representation of this object.
+
+        Returns:
+            Dict[str, Any]:
+                A dictionary in the format used by the BigQuery API.
+        """
+        return self._properties
+
+    @classmethod
+    def from_api_repr(cls, api_repr: dict) -> ExternalCatalogDatasetOptions:
+        """Factory: constructs an instance of the class (cls)
+        given its API representation.
+
+        Args:
+            api_repr (Dict[str, Any]):
+                API representation of the object to be instantiated.
+
+        Returns:
+            An instance of the class initialized with data from 'resource'.
+        """
+        config = cls()
+        config._properties = api_repr
+        return config