Skip to content
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.

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

feat: add with_name() to ScalarQueryParameterType #644

Merged
merged 2 commits into from May 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions google/cloud/bigquery/query.py
Expand Up @@ -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
Expand Down Expand Up @@ -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 = (
Expand Down
20 changes: 20 additions & 0 deletions tests/unit/test_query.py
Expand Up @@ -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
Expand Down