Skip to content

Commit 03becfe

Browse files
committed
feat: add support for dataset.default_rounding_mode
1 parent 5ceed05 commit 03becfe

File tree

3 files changed

+70
-4
lines changed

3 files changed

+70
-4
lines changed

google/cloud/bigquery/dataset.py

+39
Original file line numberDiff line numberDiff line change
@@ -527,13 +527,52 @@ class Dataset(object):
527527
"friendly_name": "friendlyName",
528528
"default_encryption_configuration": "defaultEncryptionConfiguration",
529529
"storage_billing_model": "storageBillingModel",
530+
"default_rounding_mode": "defaultRoundingMode",
530531
}
531532

532533
def __init__(self, dataset_ref) -> None:
533534
if isinstance(dataset_ref, str):
534535
dataset_ref = DatasetReference.from_string(dataset_ref)
535536
self._properties = {"datasetReference": dataset_ref.to_api_repr(), "labels": {}}
536537

538+
@property
539+
def default_rounding_mode(self):
540+
"""Union[str, None]: defaultRoundingMode of the dataset as set by the user
541+
(defaults to :data:`None`).
542+
543+
Set the value to one of ``'ROUND_HALF_AWAY_FROM_ZERO'``, ``'ROUND_HALF_EVEN'``, or
544+
``'ROUNDING_MODE_UNSPECIFIED'``.
545+
546+
See `default rounding mode
547+
<https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#Dataset.FIELDS.default_rounding_mode>`_
548+
in REST API docs and `updating the default rounding model
549+
<https://cloud.google.com/bigquery/docs/updating-datasets#update_rounding_mode>`_
550+
guide.
551+
552+
Raises:
553+
ValueError: for invalid value types.
554+
555+
"""
556+
return self._properties.get("defaultRoundingMode")
557+
558+
@default_rounding_mode.setter
559+
def default_rounding_mode(self, value):
560+
possible_values = [
561+
"ROUNDING_MODE_UNSPECIFIED",
562+
"ROUND_HALF_AWAY_FROM_ZERO",
563+
"ROUND_HALF_EVEN",
564+
]
565+
if not isinstance(value, str) and value is not None:
566+
raise ValueError("Pass a string, or None")
567+
if value not in possible_values:
568+
raise ValueError(
569+
f'rounding mode needs to be one of {",".join(possible_values)}'
570+
)
571+
if value:
572+
self._properties["defaultRoundingMode"] = value
573+
else:
574+
self._properties["defaultRoundingMode"] = "ROUNDING_MODE_UNSPECIFIED"
575+
537576
@property
538577
def project(self):
539578
"""str: Project ID of the project bound to the dataset."""

tests/system/test_client.py

+15-3
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,13 @@ def test_get_dataset(self):
265265
self.assertEqual(got.friendly_name, "Friendly")
266266
self.assertEqual(got.description, "Description")
267267

268+
def test_create_dataset_with_default_rounding_mode(self):
269+
DATASET_ID = _make_dataset_id("create_dataset_rounding_mode")
270+
dataset = self.temp_dataset(DATASET_ID, default_rounding_mode="ROUND_HALF_EVEN")
271+
272+
self.assertTrue(_dataset_exists(dataset))
273+
self.assertEqual(dataset.default_rounding_mode, "ROUND_HALF_EVEN")
274+
268275
def test_update_dataset(self):
269276
dataset = self.temp_dataset(_make_dataset_id("update_dataset"))
270277
self.assertTrue(_dataset_exists(dataset))
@@ -2286,12 +2293,17 @@ def test_nested_table_to_arrow(self):
22862293
self.assertTrue(pyarrow.types.is_list(record_col[1].type))
22872294
self.assertTrue(pyarrow.types.is_int64(record_col[1].type.value_type))
22882295

2289-
def temp_dataset(self, dataset_id, location=None):
2296+
def temp_dataset(self, dataset_id, *args, **kwargs):
22902297
project = Config.CLIENT.project
22912298
dataset_ref = bigquery.DatasetReference(project, dataset_id)
22922299
dataset = Dataset(dataset_ref)
2293-
if location:
2294-
dataset.location = location
2300+
if kwargs.get("location"):
2301+
dataset.location = kwargs.get("location")
2302+
if kwargs.get("max_time_travel_hours"):
2303+
dataset.max_time_travel_hours = kwargs.get("max_time_travel_hours")
2304+
if kwargs.get("default_rounding_mode"):
2305+
dataset.default_rounding_mode = kwargs.get("default_rounding_mode")
2306+
22952307
dataset = helpers.retry_403(Config.CLIENT.create_dataset)(dataset)
22962308
self.to_delete.append(dataset)
22972309
return dataset

tests/unit/test_create_dataset.py

+16-1
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ def test_create_dataset_w_attrs(client, PROJECT, DS_ID):
6363
"datasetId": "starry-skies",
6464
"tableId": "northern-hemisphere",
6565
}
66+
DEFAULT_ROUNDING_MODE = "ROUND_HALF_EVEN"
6667
RESOURCE = {
6768
"datasetReference": {"projectId": PROJECT, "datasetId": DS_ID},
6869
"etag": "etag",
@@ -73,6 +74,7 @@ def test_create_dataset_w_attrs(client, PROJECT, DS_ID):
7374
"defaultTableExpirationMs": "3600",
7475
"labels": LABELS,
7576
"access": [{"role": "OWNER", "userByEmail": USER_EMAIL}, {"view": VIEW}],
77+
"defaultRoundingMode": DEFAULT_ROUNDING_MODE
7678
}
7779
conn = client._connection = make_connection(RESOURCE)
7880
entries = [
@@ -88,8 +90,9 @@ def test_create_dataset_w_attrs(client, PROJECT, DS_ID):
8890
before.default_table_expiration_ms = 3600
8991
before.location = LOCATION
9092
before.labels = LABELS
93+
before.default_rounding_mode = DEFAULT_ROUNDING_MODE
9194
after = client.create_dataset(before)
92-
95+
print(after)
9396
assert after.dataset_id == DS_ID
9497
assert after.project == PROJECT
9598
assert after.etag == RESOURCE["etag"]
@@ -99,6 +102,7 @@ def test_create_dataset_w_attrs(client, PROJECT, DS_ID):
99102
assert after.location == LOCATION
100103
assert after.default_table_expiration_ms == 3600
101104
assert after.labels == LABELS
105+
assert after.default_rounding_mode == DEFAULT_ROUNDING_MODE
102106

103107
conn.api_request.assert_called_once_with(
104108
method="POST",
@@ -109,6 +113,7 @@ def test_create_dataset_w_attrs(client, PROJECT, DS_ID):
109113
"friendlyName": FRIENDLY_NAME,
110114
"location": LOCATION,
111115
"defaultTableExpirationMs": "3600",
116+
"defaultRoundingMode": DEFAULT_ROUNDING_MODE,
112117
"access": [
113118
{"role": "OWNER", "userByEmail": USER_EMAIL},
114119
{"view": VIEW, "role": None},
@@ -365,3 +370,13 @@ def test_create_dataset_alreadyexists_w_exists_ok_true(PROJECT, DS_ID, LOCATION)
365370
mock.call(method="GET", path=get_path, timeout=DEFAULT_TIMEOUT),
366371
]
367372
)
373+
374+
375+
def test_create_dataset_with_default_rounding_mode(PROJECT, DS_ID, LOCATION):
376+
client = make_client(location=LOCATION)
377+
client._connection = make_connection(
378+
google.api_core.exceptions.AlreadyExists("dataset already exists")
379+
)
380+
381+
with pytest.raises(google.api_core.exceptions.AlreadyExists):
382+
client.create_dataset(DS_ID)

0 commit comments

Comments
 (0)