feat: add uuid support (#1310)

Signed-off-by: Sri Harsha CH <sriharshach@google.com>
Co-authored-by: Subham Sinha <suvham@google.com>

Author: harshachinta

google/cloud/spanner_v1/_helpers.py

@@ -21,6 +21,7 @@
 import base64
 import threading
 import logging
+import uuid
 
 from google.protobuf.struct_pb2 import ListValue
 from google.protobuf.struct_pb2 import Value
@@ -298,6 +299,8 @@ def _make_value_pb(value):
             return Value(string_value=base64.b64encode(value))
     if isinstance(value, Interval):
         return Value(string_value=str(value))
+    if isinstance(value, uuid.UUID):
+        return Value(string_value=str(value))
 
     raise ValueError("Unknown type: %s" % (value,))
 
@@ -399,6 +402,8 @@ def _get_type_decoder(field_type, field_name, column_info=None):
         return _parse_numeric
     elif type_code == TypeCode.JSON:
         return _parse_json
+    elif type_code == TypeCode.UUID:
+        return _parse_uuid
     elif type_code == TypeCode.PROTO:
         return lambda value_pb: _parse_proto(value_pb, column_info, field_name)
     elif type_code == TypeCode.ENUM:
@@ -481,6 +486,10 @@ def _parse_json(value_pb):
     return JsonObject.from_str(value_pb.string_value)
 
 
+def _parse_uuid(value_pb):
+    return uuid.UUID(value_pb.string_value)
+
+
 def _parse_proto(value_pb, column_info, field_name):
     bytes_value = base64.b64decode(value_pb.string_value)
     if column_info is not None and column_info.get(field_name) is not None:

google/cloud/spanner_v1/param_types.py

@@ -33,6 +33,7 @@
 TIMESTAMP = Type(code=TypeCode.TIMESTAMP)
 NUMERIC = Type(code=TypeCode.NUMERIC)
 JSON = Type(code=TypeCode.JSON)
+UUID = Type(code=TypeCode.UUID)
 PG_NUMERIC = Type(code=TypeCode.NUMERIC, type_annotation=TypeAnnotationCode.PG_NUMERIC)
 PG_JSONB = Type(code=TypeCode.JSON, type_annotation=TypeAnnotationCode.PG_JSONB)
 PG_OID = Type(code=TypeCode.INT64, type_annotation=TypeAnnotationCode.PG_OID)

google/cloud/spanner_v1/streamed.py

@@ -394,6 +394,7 @@ def _merge_struct(lhs, rhs, type_):
     TypeCode.PROTO: _merge_string,
     TypeCode.INTERVAL: _merge_string,
     TypeCode.ENUM: _merge_string,
+    TypeCode.UUID: _merge_string,
 }
 
 

tests/system/test_session_api.py

@@ -20,6 +20,7 @@
 import struct
 import threading
 import time
+import uuid
 import pytest
 
 import grpc
@@ -3056,6 +3057,18 @@ def test_execute_sql_returning_transfinite_floats(sessions_database, not_postgre
         assert math.isnan(float_array[2])
 
 
+def test_execute_sql_w_uuid_bindings(sessions_database, database_dialect):
+    if database_dialect == DatabaseDialect.POSTGRESQL:
+        pytest.skip("UUID parameter type is not yet supported in PostgreSQL dialect.")
+    _bind_test_helper(
+        sessions_database,
+        database_dialect,
+        spanner_v1.param_types.UUID,
+        uuid.uuid4(),
+        [uuid.uuid4(), uuid.uuid4()],
+    )
+
+
 def test_partition_query(sessions_database, not_emulator, not_experimental_host):
     row_count = 40
     sql = f"SELECT * FROM {_sample_data.TABLE}"

tests/unit/test__helpers.py

@@ -14,6 +14,7 @@
 
 
 import unittest
+import uuid
 import mock
 
 from opentelemetry.sdk.resources import Resource
@@ -786,6 +787,18 @@ def test_w_proto_enum(self):
             self._callFUT(value_pb, field_type, field_name, column_info), VALUE
         )
 
+    def test_w_uuid(self):
+        from google.protobuf.struct_pb2 import Value
+        from google.cloud.spanner_v1 import Type
+        from google.cloud.spanner_v1 import TypeCode
+
+        VALUE = uuid.uuid4()
+        field_type = Type(code=TypeCode.UUID)
+        field_name = "uuid_column"
+        value_pb = Value(string_value=str(VALUE))
+
+        self.assertEqual(self._callFUT(value_pb, field_type, field_name), VALUE)
+
 
 class Test_parse_list_value_pbs(unittest.TestCase):
     def _callFUT(self, *args, **kw):