Merge pull request google#171 from google/spanner-2

dseomn · web-flow · commit a189bfb7175b · 2022-03-15T18:04:02.000-04:00
Upgrade spanner-orm to work with google-cloud-spanner v2
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -43,7 +43,7 @@ jobs:
         pip install \
           absl-py \
           google-api-core \
-          'google-cloud-spanner >= 1.6, <2.0.0dev' \
+          'google-cloud-spanner >= 2, <4' \
           immutabledict \
           portpicker \
           pytest
diff --git a/setup.py b/setup.py
@@ -17,7 +17,7 @@
 
 setup(
     name='spanner-orm',
-    version='0.1.10',
+    version='0.2.0',
     description='Basic ORM for Spanner',
     maintainer='Python Spanner ORM developers',
     maintainer_email='python-spanner-orm@google.com',
@@ -26,7 +26,7 @@
     include_package_data=True,
     python_requires='~=3.7',
     install_requires=[
-        'google-cloud-spanner >= 1.6, <4',
+        'google-cloud-spanner >= 2, <4',
         'immutabledict',
     ],
     tests_require=['absl-py', 'google-api-core', 'portpicker'],
diff --git a/spanner_orm/condition.py b/spanner_orm/condition.py
@@ -30,7 +30,8 @@
 from spanner_orm import relationship
 
 from google.api_core import datetime_helpers
-from google.cloud.spanner_v1.proto import type_pb2
+from google.cloud import spanner
+from google.cloud import spanner_v1
 import immutabledict
 
 T = TypeVar('T')
@@ -105,7 +106,7 @@ def sql(self) -> str:
   def _sql(self) -> str:
     pass
 
-  def types(self) -> Dict[str, type_pb2.Type]:
+  def types(self) -> Dict[str, spanner_v1.Type]:
     """Returns parameter types to be used in the SQL query.
 
     Returns:
@@ -117,7 +118,7 @@ def types(self) -> Dict[str, type_pb2.Type]:
     return self._types()
 
   @abc.abstractmethod
-  def _types(self) -> Dict[str, type_pb2.Type]:
+  def _types(self) -> Dict[str, spanner_v1.Type]:
     raise NotImplementedError
 
   @abc.abstractmethod
@@ -158,7 +159,8 @@ def _validate(self, model_class: Type[Any]) -> None:
 ]
 
 
-def _spanner_type_of_python_object(value: GuessableParamType) -> type_pb2.Type:
+def _spanner_type_of_python_object(
+    value: GuessableParamType) -> spanner_v1.Type:
   """Returns the Cloud Spanner type of the given object.
 
   Args:
@@ -173,31 +175,27 @@ def _spanner_type_of_python_object(value: GuessableParamType) -> type_pb2.Type:
     raise TypeError(
         'Cannot infer type of None, because any SQL type can be NULL.')
   simple_type_code = {
-      bool: type_pb2.BOOL,
-      int: type_pb2.INT64,
-      float: type_pb2.FLOAT64,
-      datetime_helpers.DatetimeWithNanoseconds: type_pb2.TIMESTAMP,
-      datetime.datetime: type_pb2.TIMESTAMP,
-      datetime.date: type_pb2.DATE,
-      bytes: type_pb2.BYTES,
-      str: type_pb2.STRING,
-      decimal.Decimal: type_pb2.NUMERIC,
+      bool: spanner_v1.TypeCode.BOOL,
+      int: spanner_v1.TypeCode.INT64,
+      float: spanner_v1.TypeCode.FLOAT64,
+      datetime_helpers.DatetimeWithNanoseconds: spanner_v1.TypeCode.TIMESTAMP,
+      datetime.datetime: spanner_v1.TypeCode.TIMESTAMP,
+      datetime.date: spanner_v1.TypeCode.DATE,
+      bytes: spanner_v1.TypeCode.BYTES,
+      str: spanner_v1.TypeCode.STRING,
+      decimal.Decimal: spanner_v1.TypeCode.NUMERIC,
   }.get(type(value))
   if simple_type_code is not None:
-    return type_pb2.Type(code=simple_type_code)
+    return spanner_v1.Type(code=simple_type_code)
   elif isinstance(value, (list, tuple)):
     element_types = tuple(
         _spanner_type_of_python_object(item)
         for item in value
         if item is not None)
-    unique_element_type_count = len({
-        # Protos aren't hashable, so use their serializations.
-        element_type.SerializeToString(deterministic=True)
-        for element_type in element_types
-    })
-    if unique_element_type_count == 1:
-      return type_pb2.Type(
-          code=type_pb2.ARRAY,
+    if element_types and all(
+        a == b for a, b in zip(element_types, element_types[1:])):
+      return spanner_v1.Type(
+          code=spanner_v1.TypeCode.ARRAY,
           array_element_type=element_types[0],
       )
     else:
@@ -211,7 +209,7 @@ def _spanner_type_of_python_object(value: GuessableParamType) -> type_pb2.Type:
 class Param:
   """Parameter for substitution into a SQL query."""
   value: Any
-  type: type_pb2.Type
+  type: spanner_v1.Type
 
   @classmethod
   def from_value(cls: Type[T], value: GuessableParamType) -> T:
@@ -220,14 +218,13 @@ def from_value(cls: Type[T], value: GuessableParamType) -> T:
 
     # BYTES must be base64-encoded, see
     # https://github.com/googleapis/python-spanner/blob/87789c939990794bfd91f5300bedc449fd74bd7e/google/cloud/spanner_v1/proto/type.proto#L108-L110
-    if (isinstance(value, bytes) and
-        guessed_type == type_pb2.Type(code=type_pb2.BYTES)):
+    if (isinstance(value, bytes) and guessed_type == spanner.param_types.BYTES):
       encoded_value = base64.b64encode(value).decode()
     elif (isinstance(value, (list, tuple)) and
           all(isinstance(x, bytes) for x in value if x is not None) and
-          guessed_type == type_pb2.Type(
-              code=type_pb2.ARRAY,
-              array_element_type=type_pb2.Type(code=type_pb2.BYTES),
+          guessed_type == spanner_v1.Type(
+              code=spanner_v1.TypeCode.ARRAY,
+              array_element_type=spanner.param_types.BYTES,
           )):
       encoded_value = tuple(
           None if item is None else base64.b64encode(item).decode()
@@ -299,7 +296,7 @@ def _params(self) -> Dict[str, Any]:
         if isinstance(v, Param)
     }
 
-  def _types(self) -> Dict[str, type_pb2.Type]:
+  def _types(self) -> Dict[str, spanner_v1.Type]:
     """See base class."""
     return {
         self.key(k): v.type
@@ -345,7 +342,7 @@ def _sql(self) -> str:
         other_table=self.destination_model_class.table,
         other_column=self.destination_column)
 
-  def _types(self) -> Dict[str, type_pb2.Type]:
+  def _types(self) -> Dict[str, spanner_v1.Type]:
     return {}
 
   def _validate(self, model_class: Type[Any]) -> None:
@@ -411,7 +408,7 @@ def _sql(self) -> str:
     hints = (f'FORCE_INDEX={self.name}', *self._extra_hints)
     return f'@{{{",".join(hints)}}}'
 
-  def _types(self) -> Dict[str, type_pb2.Type]:
+  def _types(self) -> Dict[str, spanner_v1.Type]:
     return {}
 
   def _validate(self, model_class: Type[Any]) -> None:
@@ -433,7 +430,7 @@ def _sql(self) -> str:
     return '({})'.format(' AND '.join(
         f'{column} IS NOT NULL' for column in self.index.columns))
 
-  def _types(self) -> Dict[str, type_pb2.Type]:
+  def _types(self) -> Dict[str, spanner_v1.Type]:
     return {}
 
 
@@ -542,7 +539,7 @@ def segment(self) -> Segment:
   def _sql(self) -> str:
     return ''
 
-  def _types(self) -> Dict[str, type_pb2.Type]:
+  def _types(self) -> Dict[str, spanner_v1.Type]:
     return {}
 
   def _validate(self, model_class: Type[Any]) -> None:
@@ -601,10 +598,10 @@ def _sql(self) -> str:
           limit_key=self._limit_key, offset_key=self._offset_key)
     return 'LIMIT @{limit_key}'.format(limit_key=self._limit_key)
 
-  def _types(self) -> Dict[str, type_pb2.Type]:
-    types = {self._limit_key: type_pb2.Type(code=type_pb2.INT64)}
+  def _types(self) -> Dict[str, spanner_v1.Type]:
+    types = {self._limit_key: spanner.param_types.INT64}
     if self.offset:
-      types[self._offset_key] = type_pb2.Type(code=type_pb2.INT64)
+      types[self._offset_key] = spanner.param_types.INT64
     return types
 
   def _validate(self, model_class: Type[Any]) -> None:
@@ -657,7 +654,7 @@ def _sql(self) -> str:
   def segment(self) -> Segment:
     return Segment.WHERE
 
-  def _types(self) -> type_pb2.Type:
+  def _types(self) -> spanner_v1.Type:
     result = {}
     for condition in self.all_conditions:
       condition.suffix = str(int(self.suffix or 0) + len(result))
@@ -702,7 +699,7 @@ def _sql(self) -> str:
   def segment(self) -> Segment:
     return Segment.ORDER_BY
 
-  def _types(self) -> type_pb2.Type:
+  def _types(self) -> spanner_v1.Type:
     return {}
 
   def _validate(self, model_class: Type[Any]) -> None:
@@ -747,7 +744,7 @@ def _sql(self) -> str:
         operator=self.operator,
         column_key=self._column_key)
 
-  def _types(self) -> type_pb2.Type:
+  def _types(self) -> spanner_v1.Type:
     return {self._column_key: self.model_class.fields[self.column].grpc_type()}
 
   def _validate(self, model_class: Type[Any]) -> None:
@@ -773,9 +770,10 @@ def _sql(self) -> str:
         operator=self.operator,
         column_key=self._column_key)
 
-  def _types(self) -> type_pb2.Type:
+  def _types(self) -> spanner_v1.Type:
     grpc_type = self.model_class.fields[self.column].grpc_type()
-    list_type = type_pb2.Type(code=type_pb2.ARRAY, array_element_type=grpc_type)
+    list_type = spanner_v1.Type(
+        code=spanner_v1.TypeCode.ARRAY, array_element_type=grpc_type)
     return {self._column_key: list_type}
 
   def _validate(self, model_class: Type[Any]) -> None:
@@ -815,7 +813,7 @@ def _sql(self) -> str:
           operator=self.nullable_operator)
     return super()._sql()
 
-  def _types(self) -> type_pb2.Type:
+  def _types(self) -> spanner_v1.Type:
     if self.is_null():
       return {}
     return super()._types()
diff --git a/spanner_orm/field.py b/spanner_orm/field.py
@@ -20,7 +20,8 @@
 import datetime
 from typing import Any, Type
 
-from google.cloud.spanner_v1.proto import type_pb2
+from google.cloud import spanner
+from google.cloud import spanner_v1
 from spanner_orm import error
 
 
@@ -34,7 +35,7 @@ def ddl() -> str:
 
   @staticmethod
   @abc.abstractmethod
-  def grpc_type() -> type_pb2.Type:
+  def grpc_type() -> spanner_v1.Type:
     raise NotImplementedError
 
   @staticmethod
@@ -88,8 +89,8 @@ def ddl() -> str:
     return 'BOOL'
 
   @staticmethod
-  def grpc_type() -> type_pb2.Type:
-    return type_pb2.Type(code=type_pb2.BOOL)
+  def grpc_type() -> spanner_v1.Type:
+    return spanner.param_types.BOOL
 
   @staticmethod
   def validate_type(value: Any) -> None:
@@ -105,8 +106,8 @@ def ddl() -> str:
     return 'INT64'
 
   @staticmethod
-  def grpc_type() -> type_pb2.Type:
-    return type_pb2.Type(code=type_pb2.INT64)
+  def grpc_type() -> spanner_v1.Type:
+    return spanner.param_types.INT64
 
   @staticmethod
   def validate_type(value: Any) -> None:
@@ -122,8 +123,8 @@ def ddl() -> str:
     return 'FLOAT64'
 
   @staticmethod
-  def grpc_type() -> type_pb2.Type:
-    return type_pb2.Type(code=type_pb2.FLOAT64)
+  def grpc_type() -> spanner_v1.Type:
+    return spanner.param_types.FLOAT64
 
   @staticmethod
   def validate_type(value: Any) -> None:
@@ -139,8 +140,8 @@ def ddl() -> str:
     return 'STRING(MAX)'
 
   @staticmethod
-  def grpc_type() -> type_pb2.Type:
-    return type_pb2.Type(code=type_pb2.STRING)
+  def grpc_type() -> spanner_v1.Type:
+    return spanner.param_types.STRING
 
   @staticmethod
   def validate_type(value) -> None:
@@ -156,8 +157,8 @@ def ddl() -> str:
     return 'ARRAY<STRING(MAX)>'
 
   @staticmethod
-  def grpc_type() -> type_pb2.Type:
-    return type_pb2.Type(code=type_pb2.ARRAY)
+  def grpc_type() -> spanner_v1.Type:
+    return spanner.param_types.Array(spanner.param_types.STRING)
 
   @staticmethod
   def validate_type(value: Any) -> None:
@@ -176,8 +177,8 @@ def ddl() -> str:
     return 'TIMESTAMP'
 
   @staticmethod
-  def grpc_type() -> type_pb2.Type:
-    return type_pb2.Type(code=type_pb2.TIMESTAMP)
+  def grpc_type() -> spanner_v1.Type:
+    return spanner.param_types.TIMESTAMP
 
   @staticmethod
   def validate_type(value: Any) -> None:
@@ -193,8 +194,8 @@ def ddl() -> str:
     return 'BYTES(MAX)'
 
   @staticmethod
-  def grpc_type() -> type_pb2.Type:
-    return type_pb2.Type(code=type_pb2.BYTES)
+  def grpc_type() -> spanner_v1.Type:
+    return spanner.param_types.BYTES
 
   @staticmethod
   def validate_type(value) -> None:
diff --git a/spanner_orm/table_apis.py b/spanner_orm/table_apis.py
@@ -18,8 +18,8 @@
 from typing import Any, Dict, Iterable, List, Sequence
 
 from google.cloud import spanner
+from google.cloud import spanner_v1
 from google.cloud.spanner_v1 import transaction as spanner_transaction
-from google.cloud.spanner_v1.proto import type_pb2
 
 _logger = logging.getLogger(__name__)
 
@@ -49,9 +49,10 @@ def find(transaction: spanner_transaction.Transaction, table_name: str,
   return list(stream_results)
 
 
-def sql_query(transaction: spanner_transaction.Transaction, query: str,
-              parameters: Dict[str, Any],
-              parameter_types: Dict[str, type_pb2.Type]) -> List[Sequence[Any]]:
+def sql_query(
+    transaction: spanner_transaction.Transaction, query: str,
+    parameters: Dict[str, Any],
+    parameter_types: Dict[str, spanner_v1.Type]) -> List[Sequence[Any]]:
   """Executes a given SQL query against the Spanner database.
 
   This isn't technically read-only, but it's necessary to implement the read-
diff --git a/spanner_orm/testlib/spanner_emulator/testlib.py b/spanner_orm/testlib/spanner_emulator/testlib.py
@@ -55,9 +55,9 @@ def _get_instance(spanner_client: client.Client) -> instance.Instance:
   Args:
     spanner_client: An initialized spanner client.
   """
-  existing_instances = list(spanner_client.list_instances())
-  if existing_instances:
-    return existing_instances[0]
+  existing_instances_pb = list(spanner_client.list_instances())
+  if existing_instances_pb:
+    return instance.Instance.from_pb(existing_instances_pb[0], spanner_client)
 
   # The emulator has one default config.
   config = list(spanner_client.list_instance_configs())[0]
diff --git a/spanner_orm/tests/condition_test.py b/spanner_orm/tests/condition_test.py
diff --git a/spanner_orm/tests/query_test.py b/spanner_orm/tests/query_test.py
