Spanner: make to_pb private in keyset (googleapis#4740)

chemelnucfin · web-flow · commit 8a1dc598f648 · 2018-02-05T14:18:23.000-08:00
diff --git a/spanner/google/cloud/spanner_v1/batch.py b/spanner/google/cloud/spanner_v1/batch.py
@@ -116,7 +116,7 @@ def delete(self, table, keyset):
         """
         delete = Mutation.Delete(
             table=table,
-            key_set=keyset.to_pb(),
+            key_set=keyset._to_pb(),
         )
         self._mutations.append(Mutation(
             delete=delete))
diff --git a/spanner/google/cloud/spanner_v1/keyset.py b/spanner/google/cloud/spanner_v1/keyset.py
@@ -63,7 +63,7 @@ def __init__(self, start_open=None, start_closed=None,
         self.end_open = end_open
         self.end_closed = end_closed
 
-    def to_pb(self):
+    def _to_pb(self):
         """Construct a KeyRange protobuf.
 
         :rtype: :class:`~google.cloud.spanner_v1.proto.keys_pb2.KeyRange`
@@ -105,7 +105,7 @@ def __init__(self, keys=(), ranges=(), all_=False):
         self.ranges = list(ranges)
         self.all_ = all_
 
-    def to_pb(self):
+    def _to_pb(self):
         """Construct a KeySet protobuf.
 
         :rtype: :class:`~google.cloud.spanner_v1.proto.keys_pb2.KeySet`
@@ -119,6 +119,6 @@ def to_pb(self):
             kwargs['keys'] = _make_list_value_pbs(self.keys)
 
         if self.ranges:
-            kwargs['ranges'] = [krange.to_pb() for krange in self.ranges]
+            kwargs['ranges'] = [krange._to_pb() for krange in self.ranges]
 
         return KeySetPB(**kwargs)
diff --git a/spanner/google/cloud/spanner_v1/snapshot.py b/spanner/google/cloud/spanner_v1/snapshot.py
@@ -120,7 +120,7 @@ def read(self, table, columns, keyset, index='', limit=0):
 
         restart = functools.partial(
             api.streaming_read,
-            self._session.name, table, columns, keyset.to_pb(),
+            self._session.name, table, columns, keyset._to_pb(),
             transaction=transaction, index=index, limit=limit,
             metadata=metadata)
 
diff --git a/spanner/tests/unit/test_keyset.py b/spanner/tests/unit/test_keyset.py
@@ -100,7 +100,7 @@ def test_to_pb_w_start_closed_and_end_open(self):
         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()
+        key_range_pb = key_range._to_pb()
         expected = KeyRange(
             start_closed=ListValue(values=[
                 Value(string_value=key1)
@@ -119,7 +119,7 @@ def test_to_pb_w_start_open_and_end_closed(self):
         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()
+        key_range_pb = key_range._to_pb()
         expected = KeyRange(
             start_open=ListValue(values=[
                 Value(string_value=key1)
@@ -137,7 +137,7 @@ def test_to_pb_w_empty_list(self):
 
         key = u'key'
         key_range = self._make_one(start_closed=[], end_closed=[key])
-        key_range_pb = key_range.to_pb()
+        key_range_pb = key_range._to_pb()
         expected = KeyRange(
             start_closed=ListValue(values=[]),
             end_closed=ListValue(values=[
@@ -204,7 +204,7 @@ def test_to_pb_w_all(self):
 
         keyset = self._make_one(all_=True)
 
-        result = keyset.to_pb()
+        result = keyset._to_pb()
 
         self.assertIsInstance(result, KeySet)
         self.assertTrue(result.all)
@@ -217,7 +217,7 @@ def test_to_pb_w_only_keys(self):
         KEYS = [[u'key1'], [u'key2']]
         keyset = self._make_one(keys=KEYS)
 
-        result = keyset.to_pb()
+        result = keyset._to_pb()
 
         self.assertIsInstance(result, KeySet)
         self.assertFalse(result.all)
@@ -243,12 +243,12 @@ def test_to_pb_w_only_ranges(self):
         ]
         keyset = self._make_one(ranges=RANGES)
 
-        result = keyset.to_pb()
+        result = keyset._to_pb()
 
         self.assertIsInstance(result, KeySet)
         self.assertFalse(result.all)
         self.assertEqual(len(result.keys), 0)
         self.assertEqual(len(result.ranges), len(RANGES))
 
         for found, expected in zip(result.ranges, RANGES):
-            self.assertEqual(found, expected.to_pb())
+            self.assertEqual(found, expected._to_pb())
diff --git a/spanner/tests/unit/test_snapshot.py b/spanner/tests/unit/test_snapshot.py
@@ -251,7 +251,7 @@ def _read_helper(self, multi_use, first=True, count=0):
         self.assertEqual(r_session, self.SESSION_NAME)
         self.assertEqual(table, TABLE_NAME)
         self.assertEqual(columns, COLUMNS)
-        self.assertEqual(key_set, KEYSET.to_pb())
+        self.assertEqual(key_set, KEYSET._to_pb())
         self.assertIsInstance(transaction, TransactionSelector)
         if multi_use:
             if first:

Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ def delete(self, table, keyset):`
`116`	`116`	`"""`
`117`	`117`	`delete = Mutation.Delete(`
`118`	`118`	`table=table,`
`119`		`- key_set=keyset.to_pb(),`
	`119`	`+ key_set=keyset._to_pb(),`
`120`	`120`	`)`
`121`	`121`	`self._mutations.append(Mutation(`
`122`	`122`	`delete=delete))`