google-cloud-spanner 3.55.0__py3-none-any.whl

google/cloud/spanner_dbapi/utils.py

@@ -0,0 +1,147 @@
+# Copyright 2020 Google LLC All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import re
+
+re_UNICODE_POINTS = re.compile(r"([^\s]*[\u0080-\uFFFF]+[^\s]*)")
+
+
+class PeekIterator:
+    """
+    Peek at the first element out of an iterator for the sake of operations
+    like auto-population of fields on reading the first element.
+    If next's result is an instance of list, it'll be converted into a tuple to
+    conform with DBAPI v2's sequence expectations.
+
+    :type source: list
+    :param source: A list of source for the Iterator.
+    """
+
+    def __init__(self, source):
+        itr_src = iter(source)
+
+        self.__iters = []
+        self.__index = 0
+
+        try:
+            head = next(itr_src)
+            # Restitch and prepare to read from multiple iterators.
+            self.__iters = [iter(itr) for itr in [[head], itr_src]]
+        except StopIteration:
+            pass
+
+    def __next__(self):
+        if self.__index >= len(self.__iters):
+            raise StopIteration
+
+        iterator = self.__iters[self.__index]
+        try:
+            head = next(iterator)
+        except StopIteration:
+            # That iterator has been exhausted, try with the next one.
+            self.__index += 1
+            return self.__next__()
+        else:
+            return tuple(head) if isinstance(head, list) else head
+
+    def __iter__(self):
+        return self
+
+
+class StreamedManyResultSets:
+    """Iterator to walk through several `StreamedResultsSet` iterators.
+    This type of iterator is used by `Cursor.executemany()`
+    method to iterate through several `StreamedResultsSet`
+    iterators like they all are merged into single iterator.
+    """
+
+    def __init__(self):
+        self._iterators = []
+        self._index = 0
+
+    def add_iter(self, iterator):
+        """Add new iterator into this one.
+        :type iterator: :class:`google.cloud.spanner_v1.streamed.StreamedResultSet`
+        :param iterator: Iterator to merge into this one.
+        """
+        self._iterators.append(iterator)
+
+    def __next__(self):
+        """Return the next value from the currently streamed iterator.
+        If the current iterator is streamed to the end,
+        start to stream the next one.
+        :rtype: list
+        :returns: The next result row.
+        """
+        try:
+            res = next(self._iterators[self._index])
+        except StopIteration:
+            self._index += 1
+            res = self.__next__()
+        except IndexError:
+            raise StopIteration
+
+        return res
+
+    def __iter__(self):
+        return self
+
+
+def backtick_unicode(sql):
+    """Check the SQL to be valid and split it by segments.
+
+    :type sql: str
+    :param sql: A SQL request.
+
+    :rtype: str
+    :returns: A SQL parsed by segments in unicode if initial SQL is valid,
+              initial string otherwise.
+    """
+    matches = list(re_UNICODE_POINTS.finditer(sql))
+    if not matches:
+        return sql
+
+    segments = []
+
+    last_end = 0
+    for match in matches:
+        start, end = match.span()
+        if sql[start] != "`" and sql[end - 1] != "`":
+            segments.append(sql[last_end:start] + "`" + sql[start:end] + "`")
+        else:
+            segments.append(sql[last_end:end])
+
+        last_end = end
+
+    return "".join(segments)
+
+
+def sanitize_literals_for_upload(s):
+    """Convert literals in s, to be fit for consumption by Cloud Spanner.
+
+    * Convert %% (escaped percent literals) to %. Percent signs must be escaped
+      when values like %s are used as SQL parameter placeholders but Spanner's
+      query language uses placeholders like @a0 and doesn't expect percent
+      signs to be escaped.
+    * Quote words containing non-ASCII, with backticks, for example föö to
+    `föö`.
+
+    :type s: str
+    :param s: A string with literals to escaped for consumption by Cloud
+              Spanner.
+
+    :rtype: str
+    :returns: A sanitized string for uploading.
+    """
+    return backtick_unicode(s.replace("%%", "%"))

google/cloud/spanner_dbapi/version.py

@@ -0,0 +1,20 @@
+# Copyright 2020 Google LLC All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import platform
+from google.cloud.spanner_v1 import gapic_version as package_version
+
+PY_VERSION = platform.python_version()
+VERSION = package_version.__version__
+DEFAULT_USER_AGENT = "gl-dbapi/" + VERSION

google/cloud/spanner_v1/__init__.py

@@ -0,0 +1,154 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+from __future__ import absolute_import
+
+from google.cloud.spanner_v1 import gapic_version as package_version
+
+__version__: str = package_version.__version__
+
+from .services.spanner import SpannerClient
+from .services.spanner import SpannerAsyncClient
+from .types.commit_response import CommitResponse
+from .types.keys import KeyRange as KeyRangePB
+from .types.keys import KeySet as KeySetPB
+from .types.mutation import Mutation
+from .types.query_plan import PlanNode
+from .types.query_plan import QueryPlan
+from .types.result_set import PartialResultSet
+from .types import RequestOptions
+from .types.result_set import ResultSet
+from .types.result_set import ResultSetMetadata
+from .types.result_set import ResultSetStats
+from .types.spanner import BatchCreateSessionsRequest
+from .types.spanner import BatchCreateSessionsResponse
+from .types.spanner import BatchWriteRequest
+from .types.spanner import BatchWriteResponse
+from .types.spanner import BeginTransactionRequest
+from .types.spanner import CommitRequest
+from .types.spanner import CreateSessionRequest
+from .types.spanner import DeleteSessionRequest
+from .types.spanner import DirectedReadOptions
+from .types.spanner import ExecuteBatchDmlRequest
+from .types.spanner import ExecuteBatchDmlResponse
+from .types.spanner import ExecuteSqlRequest
+from .types.spanner import GetSessionRequest
+from .types.spanner import ListSessionsRequest
+from .types.spanner import ListSessionsResponse
+from .types.spanner import Partition
+from .types.spanner import PartitionOptions
+from .types.spanner import PartitionQueryRequest
+from .types.spanner import PartitionReadRequest
+from .types.spanner import PartitionResponse
+from .types.spanner import ReadRequest
+from .types.spanner import RollbackRequest
+from .types.spanner import Session
+from .types.transaction import Transaction
+from .types.transaction import TransactionOptions
+from .types.transaction import TransactionSelector
+from .types.type import StructType
+from .types.type import Type
+from .types.type import TypeAnnotationCode
+from .types.type import TypeCode
+from .data_types import JsonObject, Interval
+from .transaction import BatchTransactionId, DefaultTransactionOptions
+
+from google.cloud.spanner_v1 import param_types
+from google.cloud.spanner_v1.client import Client
+from google.cloud.spanner_v1.keyset import KeyRange
+from google.cloud.spanner_v1.keyset import KeySet
+from google.cloud.spanner_v1.pool import AbstractSessionPool
+from google.cloud.spanner_v1.pool import BurstyPool
+from google.cloud.spanner_v1.pool import FixedSizePool
+from google.cloud.spanner_v1.pool import PingingPool
+from google.cloud.spanner_v1.pool import TransactionPingingPool
+
+
+COMMIT_TIMESTAMP = "spanner.commit_timestamp()"
+"""Placeholder be used to store commit timestamp of a transaction in a column.
+This value can only be used for timestamp columns that have set the option
+``(allow_commit_timestamp=true)`` in the schema.
+"""
+
+
+__all__ = (
+    # google.cloud.spanner_v1
+    "__version__",
+    "param_types",
+    # google.cloud.spanner_v1.client
+    "Client",
+    # google.cloud.spanner_v1.keyset
+    "KeyRange",
+    "KeySet",
+    # google.cloud.spanner_v1.pool
+    "AbstractSessionPool",
+    "BurstyPool",
+    "FixedSizePool",
+    "PingingPool",
+    "TransactionPingingPool",
+    # local
+    "COMMIT_TIMESTAMP",
+    # google.cloud.spanner_v1.types
+    "BatchCreateSessionsRequest",
+    "BatchCreateSessionsResponse",
+    "BatchWriteRequest",
+    "BatchWriteResponse",
+    "BeginTransactionRequest",
+    "CommitRequest",
+    "CommitResponse",
+    "CreateSessionRequest",
+    "DeleteSessionRequest",
+    "DirectedReadOptions",
+    "ExecuteBatchDmlRequest",
+    "ExecuteBatchDmlResponse",
+    "ExecuteSqlRequest",
+    "GetSessionRequest",
+    "KeyRangePB",
+    "KeySetPB",
+    "ListSessionsRequest",
+    "ListSessionsResponse",
+    "Mutation",
+    "PartialResultSet",
+    "Partition",
+    "PartitionOptions",
+    "PartitionQueryRequest",
+    "PartitionReadRequest",
+    "PartitionResponse",
+    "PlanNode",
+    "QueryPlan",
+    "ReadRequest",
+    "RequestOptions",
+    "ResultSet",
+    "ResultSetMetadata",
+    "ResultSetStats",
+    "RollbackRequest",
+    "Session",
+    "StructType",
+    "Transaction",
+    "TransactionOptions",
+    "TransactionSelector",
+    "Type",
+    "TypeAnnotationCode",
+    "TypeCode",
+    # Custom spanner related data types
+    "JsonObject",
+    "Interval",
+    # google.cloud.spanner_v1.services
+    "SpannerClient",
+    "SpannerAsyncClient",
+    "BatchTransactionId",
+    "DefaultTransactionOptions",
+)