diff --git a/google/cloud/bigquery/query.py b/google/cloud/bigquery/query.py index 3751eb124..d1e9a45a5 100644 --- a/google/cloud/bigquery/query.py +++ b/google/cloud/bigquery/query.py @@ -16,6 +16,7 @@ from collections import OrderedDict import copy +from typing import Union from google.cloud.bigquery.table import _parse_schema_resource from google.cloud.bigquery._helpers import _rows_from_json @@ -119,6 +120,20 @@ def to_api_repr(self): # attributes in the API representation when needed. Here we omit them. return {"type": self._type} + def with_name(self, new_name: Union[str, None]): + """Return a copy of the instance with ``name`` set to ``new_name``. + + Args: + name (Union[str, None]): + The new name of the query parameter type. If ``None``, the existing + name is cleared. + + Returns: + google.cloud.bigquery.query.ScalarQueryParameterType: + A new instance with updated name. + """ + return type(self)(self._type, name=new_name, description=self.description) + def __repr__(self): name = f", name={self.name!r}" if self.name is not None else "" description = ( diff --git a/tests/unit/test_query.py b/tests/unit/test_query.py index c8be2911f..90fc30b20 100644 --- a/tests/unit/test_query.py +++ b/tests/unit/test_query.py @@ -98,6 +98,26 @@ def test_repr_all_optional_attrs(self): "ScalarQueryParameterType('BYTES', name='foo', description='this is foo')", ) + def test_with_name_returns_copy_w_changed_name(self): + param_type = self._make_one("BOOLEAN", name=None, description="Some checkbox.") + modified_type = param_type.with_name("allow_emails") + + self.assertIsNot(modified_type, param_type) # Result is a copy. + self.assertEqual(modified_type.name, "allow_emails") + + # The rest of the The rest of the fields should have been preserved. + self.assertEqual(modified_type._type, param_type._type) + self.assertEqual(modified_type.description, param_type.description) + + def test_with_name_clearing_the_value(self): + param_type = self._make_one( + "BOOLEAN", name="allow_emails", description="Some checkbox." + ) + modified_type = param_type.with_name(None) + + self.assertIsNone(modified_type.name) + self.assertEqual(param_type.name, "allow_emails") # original unchanged + class Test_ArrayQueryParameterType(unittest.TestCase): @staticmethod