Skip to content

Commit

Permalink
Rename PartitionRange to RangeDefinition
Browse files Browse the repository at this point in the history
  • Loading branch information
tswast committed Oct 17, 2019
1 parent f04153f commit 9bb5d8b
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 30 deletions.
2 changes: 1 addition & 1 deletion bigquery/docs/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Table
.. autosummary::
:toctree: generated

table.PartitionRange
table.RangeDefinition
table.RangePartitioning
table.Row
table.RowIterator
Expand Down
4 changes: 2 additions & 2 deletions bigquery/google/cloud/bigquery/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
from google.cloud.bigquery.routine import RoutineArgument
from google.cloud.bigquery.routine import RoutineReference
from google.cloud.bigquery.schema import SchemaField
from google.cloud.bigquery.table import PartitionRange
from google.cloud.bigquery.table import RangeDefinition
from google.cloud.bigquery.table import RangePartitioning
from google.cloud.bigquery.table import Row
from google.cloud.bigquery.table import Table
Expand All @@ -98,7 +98,7 @@
# Tables
"Table",
"TableReference",
"PartitionRange",
"RangeDefinition",
"RangePartitioning",
"Row",
"TimePartitioning",
Expand Down
22 changes: 11 additions & 11 deletions bigquery/google/cloud/bigquery/table.py
Original file line number Diff line number Diff line change
Expand Up @@ -1681,21 +1681,21 @@ def __iter__(self):
return iter(())


class PartitionRange(object):
class RangeDefinition(object):
"""Definition of the ranges for range partitioning.
Args:
start (Optional[int]):
Sets the
:attr:`~google.cloud.bigquery.table.PartitionRange.start`
:attr:`~google.cloud.bigquery.table.RangeDefinition.start`
property.
end (Optional[int]):
Sets the
:attr:`~google.cloud.bigquery.table.PartitionRange.end`
:attr:`~google.cloud.bigquery.table.RangeDefinition.end`
property.
interval (Optional[int]):
Sets the
:attr:`~google.cloud.bigquery.table.PartitionRange.interval`
:attr:`~google.cloud.bigquery.table.RangeDefinition.interval`
property.
_properties (Optional[dict]):
Private. Used to construct object from API resource.
Expand Down Expand Up @@ -1745,14 +1745,14 @@ def _key(self):

def __repr__(self):
key_vals = ["{}={}".format(key, val) for key, val in self._key()]
return "PartitionRange({})".format(", ".join(key_vals))
return "RangeDefinition({})".format(", ".join(key_vals))


class RangePartitioning(object):
"""Range-based partitioning configuration for a table.
Args:
range_ (Optional[google.cloud.bigquery.table.PartitionRange]):
range_ (Optional[google.cloud.bigquery.table.RangeDefinition]):
Sets the
:attr:`google.cloud.bigquery.table.RangePartitioning.range_`
property.
Expand All @@ -1777,20 +1777,20 @@ def __init__(self, range_=None, field=None, _properties=None):
# Trailing underscore to prevent conflict with built-in range() function.
@property
def range_(self):
"""google.cloud.bigquery.table.PartitionRange: Defines the
"""google.cloud.bigquery.table.RangeDefinition: Defines the
ranges for range partitioning.
Raises:
ValueError:
If the value is not a :class:`PartitionRange`.
If the value is not a :class:`RangeDefinition`.
"""
range_properties = self._properties.setdefault("range", {})
return PartitionRange(_properties=range_properties)
return RangeDefinition(_properties=range_properties)

@range_.setter
def range_(self, value):
if not isinstance(value, PartitionRange):
raise ValueError("Expected a PartitionRange, but got {}.".format(value))
if not isinstance(value, RangeDefinition):
raise ValueError("Expected a RangeDefinition, but got {}.".format(value))
self._properties["range"] = value._properties

@property
Expand Down
8 changes: 4 additions & 4 deletions bigquery/tests/unit/test_job.py
Original file line number Diff line number Diff line change
Expand Up @@ -1654,12 +1654,12 @@ def test_range_partitioning_w_value(self):
object_under_test.range_partitioning.range_.interval == 10

def test_range_partitioning_setter(self):
from google.cloud.bigquery.table import PartitionRange
from google.cloud.bigquery.table import RangeDefinition
from google.cloud.bigquery.table import RangePartitioning

object_under_test = self._get_target_class()()
object_under_test.range_partitioning = RangePartitioning(
field="column_one", range_=PartitionRange(start=1, end=1000, interval=10)
field="column_one", range_=RangeDefinition(start=1, end=1000, interval=10)
)
object_under_test.range_partitioning.field == "column_one"
object_under_test.range_partitioning.range_.start == 1
Expand Down Expand Up @@ -3383,12 +3383,12 @@ def test_range_partitioning_w_value(self):
object_under_test.range_partitioning.range_.interval == 10

def test_range_partitioning_setter(self):
from google.cloud.bigquery.table import PartitionRange
from google.cloud.bigquery.table import RangeDefinition
from google.cloud.bigquery.table import RangePartitioning

object_under_test = self._get_target_class()()
object_under_test.range_partitioning = RangePartitioning(
field="column_one", range_=PartitionRange(start=1, end=1000, interval=10)
field="column_one", range_=RangeDefinition(start=1, end=1000, interval=10)
)
object_under_test.range_partitioning.field == "column_one"
object_under_test.range_partitioning.range_.start == 1
Expand Down
24 changes: 12 additions & 12 deletions bigquery/tests/unit/test_table.py
Original file line number Diff line number Diff line change
Expand Up @@ -858,13 +858,13 @@ def test__build_resource_w_custom_field_not_in__properties(self):

def test_range_partitioning(self):
from google.cloud.bigquery.table import RangePartitioning
from google.cloud.bigquery.table import PartitionRange
from google.cloud.bigquery.table import RangeDefinition

table = self._make_one("proj.dset.tbl")
assert table.range_partitioning is None

table.range_partitioning = RangePartitioning(
field="col1", range_=PartitionRange(start=-512, end=1024, interval=128)
field="col1", range_=RangeDefinition(start=-512, end=1024, interval=128)
)
assert table.range_partitioning.field == "col1"
assert table.range_partitioning.range_.start == -512
Expand Down Expand Up @@ -2800,11 +2800,11 @@ def test_to_dataframe_w_bqstorage_snapshot(self):
row_iterator.to_dataframe(bqstorage_client)


class TestPartitionRange(unittest.TestCase):
class TestRangeDefinition(unittest.TestCase):
def _get_target_class(self):
from google.cloud.bigquery.table import PartitionRange
from google.cloud.bigquery.table import RangeDefinition

return PartitionRange
return RangeDefinition

def _make_one(self, *args, **kw):
return self._get_target_class()(*args, **kw)
Expand All @@ -2831,7 +2831,7 @@ def test_constructor_w_resource(self):

def test_repr(self):
object_under_test = self._make_one(start=1, end=10, interval=2)
assert repr(object_under_test) == "PartitionRange(end=10, interval=2, start=1)"
assert repr(object_under_test) == "RangeDefinition(end=10, interval=2, start=1)"


class TestRangePartitioning(unittest.TestCase):
Expand All @@ -2851,10 +2851,10 @@ def test_constructor_defaults(self):
assert object_under_test.range_.interval is None

def test_constructor_w_properties(self):
from google.cloud.bigquery.table import PartitionRange
from google.cloud.bigquery.table import RangeDefinition

object_under_test = self._make_one(
range_=PartitionRange(start=1, end=10, interval=2), field="integer_col"
range_=RangeDefinition(start=1, end=10, interval=2), field="integer_col"
)
assert object_under_test.field == "integer_col"
assert object_under_test.range_.start == 1
Expand All @@ -2875,18 +2875,18 @@ def test_constructor_w_resource(self):

def test_range_w_wrong_type(self):
object_under_test = self._make_one()
with pytest.raises(ValueError, match="PartitionRange"):
with pytest.raises(ValueError, match="RangeDefinition"):
object_under_test.range_ = object()

def test_repr(self):
from google.cloud.bigquery.table import PartitionRange
from google.cloud.bigquery.table import RangeDefinition

object_under_test = self._make_one(
range_=PartitionRange(start=1, end=10, interval=2), field="integer_col"
range_=RangeDefinition(start=1, end=10, interval=2), field="integer_col"
)
assert (
repr(object_under_test)
== "RangePartitioning(field='integer_col', range_=PartitionRange(end=10, interval=2, start=1))"
== "RangePartitioning(field='integer_col', range_=RangeDefinition(end=10, interval=2, start=1))"
)


Expand Down

0 comments on commit 9bb5d8b

Please sign in to comment.