Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Spanner: partial key range and bug fix with single key #4618

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.

Sign up for GitHub

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

Merged
dhermes merged 10 commits into from
Dec 20, 2017
Merged

Spanner: partial key range and bug fix with single key #4618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
05d64d7
Spanner: partial key range and bug fix with single key
chemelnucfin Dec 6, 2017
7f98aeb
Review Change
chemelnucfin Dec 19, 2017
82db911
Spanner: Keyset change single key to be not allowed
chemelnucfin Dec 19, 2017
08d50b8
Review Change
chemelnucfin Dec 19, 2017
a5de006
Spanner: Review Changes
chemelnucfin Dec 19, 2017
ccbb29a
remove krange
chemelnucfin Dec 20, 2017
17406f9
Removing `KeyRange.to_pb()` tests that don't actually invoke `to_pb()`.
dhermes Dec 20, 2017
ad8e30e
Updating `KeyRange` docstring.
dhermes Dec 20, 2017
31b1201
Changing truthy checks to `not None` checks in `KeyRange.to_pb()`.
dhermes Dec 20, 2017
88ca5bb
Adding a unit test with the empty list case in `KeyRange.to_pb()`.
dhermes Dec 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 34 additions & 22 deletions spanner/google/cloud/spanner_v1/keyset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,28 +24,40 @@
class KeyRange(object):
"""Identify range of table rows via start / end points.

:type start_open: list of scalars
:param start_open: keys identifying start of range (this key excluded)

:type start_closed: list of scalars
:param start_closed: keys identifying start of range (this key included)

:type end_open: list of scalars
:param end_open: keys identifying end of range (this key excluded)

:type end_closed: list of scalars
:param end_closed: keys identifying end of range (this key included)
.. note::

Exactly one of ``start_open`` and ``start_closed`` must be
passed and exactly one of ``end_open`` and ``end_closed`` must be.
To "start at the beginning" (i.e. specify no start for the range)
pass ``start_closed=[]``. To "go to the end" (i.e. specify no end
for the range) pass ``end_closed=[]``.

Args:
start_open (List): Keys identifying start of range (this key
excluded).
start_closed (List): Keys identifying start of range (this key
included).
end_open (List): Keys identifying end of range (this key
excluded).
end_closed (List): Keys identifying end of range (this key
included).

Raises:
ValueError: If **neither** ``start_open`` or ``start_closed`` is
passed.
ValueError: If **both** ``start_open`` and ``start_closed`` are passed.
ValueError: If **neither** ``end_open`` or ``end_closed`` is passed.
ValueError: If **both** ``end_open`` and ``end_closed`` are passed.
"""
def __init__(self, start_open=None, start_closed=None,
end_open=None, end_closed=None):
if not any([start_open, start_closed, end_open, end_closed]):
raise ValueError("Must specify at least a start or end row.")

if start_open and start_closed:
raise ValueError("Specify one of 'start_open' / 'start_closed'.")
if ((start_open is None and start_closed is None)
or (start_open is not None and start_closed is not None)):
raise ValueError('Specify exactly one of start_closed or start_open')

if end_open and end_closed:
raise ValueError("Specify one of 'end_open' / 'end_closed'.")
if ((end_open is None and end_closed is None)
or (end_open is not None and end_closed is not None)):
raise ValueError('Specify exactly one of end_closed or end_open')

self.start_open = start_open
self.start_closed = start_closed
Expand All @@ -60,16 +72,16 @@ def to_pb(self):
"""
kwargs = {}

if self.start_open:
if self.start_open is not None:
kwargs['start_open'] = _make_list_value_pb(self.start_open)

if self.start_closed:
if self.start_closed is not None:
kwargs['start_closed'] = _make_list_value_pb(self.start_closed)

if self.end_open:
if self.end_open is not None:
kwargs['end_open'] = _make_list_value_pb(self.end_open)

if self.end_closed:
if self.end_closed is not None:
kwargs['end_closed'] = _make_list_value_pb(self.end_closed)

return KeyRangePB(**kwargs)
Expand Down
115 changes: 70 additions & 45 deletions spanner/tests/unit/test_keyset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,49 +30,47 @@ def test_ctor_no_start_no_end(self):
with self.assertRaises(ValueError):
self._make_one()

def test_ctor_w_start_open_and_start_closed(self):
def test_ctor_start_open_and_start_closed(self):

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

KEY_1 = [u'key_1']
KEY_2 = [u'key_2']
with self.assertRaises(ValueError):
self._make_one(start_open=KEY_1, start_closed=KEY_2)

def test_ctor_w_end_open_and_end_closed(self):
def test_ctor_end_open_and_end_closed(self):
KEY_1 = [u'key_1']
KEY_2 = [u'key_2']
with self.assertRaises(ValueError):
self._make_one(end_open=KEY_1, end_closed=KEY_2)

def test_ctor_w_only_start_open(self):
def test_ctor_conflicting_start(self):
KEY_1 = [u'key_1']
krange = self._make_one(start_open=KEY_1)
self.assertEqual(krange.start_open, KEY_1)
self.assertEqual(krange.start_closed, None)
self.assertEqual(krange.end_open, None)
self.assertEqual(krange.end_closed, None)
with self.assertRaises(ValueError):
self._make_one(start_open=[], start_closed=[], end_closed=KEY_1)

def test_ctor_w_only_start_closed(self):
def test_ctor_conflicting_end(self):
KEY_1 = [u'key_1']
krange = self._make_one(start_closed=KEY_1)
self.assertEqual(krange.start_open, None)
self.assertEqual(krange.start_closed, KEY_1)
self.assertEqual(krange.end_open, None)
self.assertEqual(krange.end_closed, None)
with self.assertRaises(ValueError):
self._make_one(start_open=KEY_1, end_open=[], end_closed=[])

def test_ctor_w_only_end_open(self):
def test_ctor_single_key_start_closed(self):
KEY_1 = [u'key_1']
krange = self._make_one(end_open=KEY_1)
self.assertEqual(krange.start_open, None)
self.assertEqual(krange.start_closed, None)
self.assertEqual(krange.end_open, KEY_1)
self.assertEqual(krange.end_closed, None)
with self.assertRaises(ValueError):
self._make_one(start_closed=KEY_1)

def test_ctor_w_only_end_closed(self):
def test_ctor_single_key_start_open(self):
KEY_1 = [u'key_1']
krange = self._make_one(end_closed=KEY_1)
self.assertEqual(krange.start_open, None)
self.assertEqual(krange.start_closed, None)
self.assertEqual(krange.end_open, None)
self.assertEqual(krange.end_closed, KEY_1)
with self.assertRaises(ValueError):
self._make_one(start_open=KEY_1)

def test_ctor_single_key_end_closed(self):
KEY_1 = [u'key_1']
with self.assertRaises(ValueError):
self._make_one(end_closed=KEY_1)

def test_ctor_single_key_end_open(self):
KEY_1 = [u'key_1']
with self.assertRaises(ValueError):
self._make_one(end_open=KEY_1)

def test_ctor_w_start_open_and_end_closed(self):
KEY_1 = [u'key_1']
Expand All @@ -93,31 +91,58 @@ def test_ctor_w_start_closed_and_end_open(self):
self.assertEqual(krange.end_closed, None)

def test_to_pb_w_start_closed_and_end_open(self):
from google.protobuf.struct_pb2 import ListValue
from google.protobuf.struct_pb2 import Value
from google.cloud.spanner_v1.proto.keys_pb2 import KeyRange

KEY_1 = [u'key_1']
KEY_2 = [u'key_2']
krange = self._make_one(start_closed=KEY_1, end_open=KEY_2)
krange_pb = krange.to_pb()
self.assertIsInstance(krange_pb, KeyRange)
self.assertEqual(len(krange_pb.start_closed), 1)
self.assertEqual(krange_pb.start_closed.values[0].string_value,
KEY_1[0])
self.assertEqual(len(krange_pb.end_open), 1)
self.assertEqual(krange_pb.end_open.values[0].string_value, KEY_2[0])
key1 = u'key_1'
key2 = u'key_2'
key_range = self._make_one(start_closed=[key1], end_open=[key2])
key_range_pb = key_range.to_pb()
expected = KeyRange(
start_closed=ListValue(values=[
Value(string_value=key1)
]),
end_open=ListValue(values=[
Value(string_value=key2)
]),
)
self.assertEqual(key_range_pb, expected)

def test_to_pb_w_start_open_and_end_closed(self):
from google.protobuf.struct_pb2 import ListValue
from google.protobuf.struct_pb2 import Value
from google.cloud.spanner_v1.proto.keys_pb2 import KeyRange

KEY_1 = [u'key_1']
KEY_2 = [u'key_2']
krange = self._make_one(start_open=KEY_1, end_closed=KEY_2)
krange_pb = krange.to_pb()
self.assertIsInstance(krange_pb, KeyRange)
self.assertEqual(len(krange_pb.start_open), 1)
self.assertEqual(krange_pb.start_open.values[0].string_value, KEY_1[0])
self.assertEqual(len(krange_pb.end_closed), 1)
self.assertEqual(krange_pb.end_closed.values[0].string_value, KEY_2[0])
key1 = u'key_1'
key2 = u'key_2'
key_range = self._make_one(start_open=[key1], end_closed=[key2])
key_range_pb = key_range.to_pb()
expected = KeyRange(
start_open=ListValue(values=[
Value(string_value=key1)
]),
end_closed=ListValue(values=[
Value(string_value=key2)
]),
)
self.assertEqual(key_range_pb, expected)

def test_to_pb_w_empty_list(self):
from google.protobuf.struct_pb2 import ListValue
from google.protobuf.struct_pb2 import Value
from google.cloud.spanner_v1.proto.keys_pb2 import KeyRange

key = u'key'
key_range = self._make_one(start_closed=[], end_closed=[key])
key_range_pb = key_range.to_pb()
expected = KeyRange(
start_closed=ListValue(values=[]),
end_closed=ListValue(values=[
Value(string_value=key)
]),
)
self.assertEqual(key_range_pb, expected)


class TestKeySet(unittest.TestCase):
Expand Down