spanner-integration.yaml

# Copyright 2026 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.
description: Integrate Google Cloud Logging Spanner Handwritten code
url: https://github.com/googleapis/gapic-generator-python/issues/123
replacements:
  - paths: [packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/client.py]
    before: '(import google\.rpc\.status_pb2 as status_pb2  # type: ignore\n\n)(?!from google\.cloud\.spanner_v1\.metrics)'
    after: |
      \g<1>from google.cloud.spanner_v1.metrics.metrics_interceptor import MetricsInterceptor
    count: 1

  - paths: [packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/client.py]
    before: '(\s+api_audience=self\._client_options\.api_audience,\n)(?!\s+metrics_interceptor=MetricsInterceptor)'
    after: |
      \g<1>                metrics_interceptor=MetricsInterceptor(),
    count: 1

  - paths: [packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/base.py]
    before: '(from google\.cloud\.spanner_v1 import gapic_version as package_version\n)(?!from google\.cloud\.spanner_v1\.metrics)'
    after: |
      \g<1>from google.cloud.spanner_v1.metrics.metrics_interceptor import MetricsInterceptor
    count: 1

  - paths: [packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/rest.py]
    before: '(from requests import __version__ as requests_version\n\n)(?!from google\.cloud\.spanner_v1\.metrics)'
    after: |
      \g<1>from google.cloud.spanner_v1.metrics.metrics_interceptor import MetricsInterceptor
    count: 1
  
  - paths: [packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/grpc_asyncio.py]
    before: '(from grpc\.experimental import aio  # type: ignore\n\n)(?!from google\.cloud\.spanner_v1\.metrics)'
    after: |
      \g<1>from google.cloud.spanner_v1.metrics.metrics_interceptor import MetricsInterceptor
    count: 1
  
  - paths: [packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/grpc.py]
    before: '(from google\.protobuf\.json_format import MessageToJson\n\n)(?!from google\.cloud\.spanner_v1\.metrics)'
    after: |
      \g<1>from google.cloud.spanner_v1.metrics.metrics_interceptor import MetricsInterceptor
    count: 1
  
  - paths: [packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/rest_base.py]
    before: '(from google\.protobuf import json_format\n\n)(?!from google\.cloud\.spanner_v1\.metrics)'
    after: |
      \g<1>from google.cloud.spanner_v1.metrics.metrics_interceptor import MetricsInterceptor
    count: 1

  - paths:
      - packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/base.py
      - packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/grpc.py
      - packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/grpc_asyncio.py
      - packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/rest.py
      - packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/rest_base.py
    before: '(\s+api_audience: Optional\[str\] = None,\n)(?!\s+metrics_interceptor: Optional\[MetricsInterceptor\])'
    after: |
      \g<1>        metrics_interceptor: Optional[MetricsInterceptor] = None,
    count: 5

  - paths: 
      # Source Transports
      - packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/grpc.py
      - packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/grpc_asyncio.py
      - packages/google-cloud-spanner/google/cloud/spanner_admin_database_v1/services/database_admin/transports/grpc.py
      - packages/google-cloud-spanner/google/cloud/spanner_admin_database_v1/services/database_admin/transports/grpc_asyncio.py
      - packages/google-cloud-spanner/google/cloud/spanner_admin_instance_v1/services/instance_admin/transports/grpc.py
      - packages/google-cloud-spanner/google/cloud/spanner_admin_instance_v1/services/instance_admin/transports/grpc_asyncio.py
      # Test Files
      - packages/google-cloud-spanner/tests/unit/gapic/spanner_admin_database_v1/test_database_admin.py
      - packages/google-cloud-spanner/tests/unit/gapic/spanner_admin_instance_v1/test_instance_admin.py
      - packages/google-cloud-spanner/tests/unit/gapic/spanner_v1/test_spanner.py
    # Group 1 captures exactly the spaces/tabs on that line.
    # Group 2 captures the code up to the newline.
    before: '([ \t]+)(\("grpc\.max_receive_message_length", -1\),\n)(?![ \t]+\("grpc\.keepalive_time_ms")'
    after: |
      \g<1>\g<2>\g<1>("grpc.keepalive_time_ms", 120000),
    count: 21

  - paths: 
      - packages/google-cloud-spanner/tests/unit/gapic/spanner_v1/test_spanner.py
    before: '(\s+api_audience=\"https\:\/\/language\.googleapis\.com\",\n)(?!\s+metrics_interceptor=mock\.ANY,)'
    after: |
      \g<1>            metrics_interceptor=mock.ANY,
    count: 1
  
  - paths: 
      - packages/google-cloud-spanner/tests/unit/gapic/spanner_v1/test_spanner.py
    # Group 1: Captures ONLY the spaces/tabs before the text
    # Group 2: Captures the text itself and the newline
    before: '([ \t]+)(api_audience=None,\n)(?![ \t]+metrics_interceptor=mock\.ANY,)'
    after: |
      \g<1>\g<2>\g<1>metrics_interceptor=mock.ANY,
    count: 12

  - paths:
      - packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/grpc.py
    before: '(\s+self\._stubs: Dict\[str, Callable\] = \{\}\n)(?!\s+self\._metrics_interceptor = None)'
    after: |
      \g<1>        self._metrics_interceptor = None
    count: 1
  - paths: 
      - packages/google-cloud-spanner/google/cloud/spanner_v1/services/spanner/transports/grpc.py
    before: '([ \t]+)(\("grpc\.keepalive_time_ms", 120000\),\n[ \t]+\](?:,\n[ \t]*|\n[ \t]*)\)\n+)([ \t]+)(self\._interceptor = _LoggingClientInterceptor\(\)\n)'
    after: |
      \g<1>\g<2>\g<3># Wrap the gRPC channel with the metric interceptor
      \g<3>if metrics_interceptor is not None:
      \g<3>    self._metrics_interceptor = metrics_interceptor
      \g<3>    self._grpc_channel = grpc.intercept_channel(
      \g<3>        self._grpc_channel, metrics_interceptor
      \g<3>    )

      \g<3>\g<4>
    count: 1
  - paths: [packages/google-cloud-spanner/setup.py]
    before: '(?s)dependencies = \[.*?\]\nextras = \{\}'
    after: |
      dependencies = [
          "google-api-core[grpc] >= 1.34.0, <3.0.0,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*",
          "google-cloud-core >= 1.4.4, < 3.0.0",
          "grpc-google-iam-v1 >= 0.12.4, <1.0.0",
          "proto-plus >= 1.22.0, <2.0.0",
          "sqlparse >= 0.4.4",
          "proto-plus >= 1.22.2, <2.0.0; python_version>='3.11'",
          "protobuf>=3.20.2,<7.0.0,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5",
          "grpc-interceptor >= 0.15.4",
          # Make OpenTelemetry a core dependency
          "opentelemetry-api >= 1.22.0",
          "opentelemetry-sdk >= 1.22.0",
          "opentelemetry-semantic-conventions >= 0.43b0",
          "opentelemetry-resourcedetector-gcp >= 1.8.0a0",
          "google-cloud-monitoring >= 2.16.0",
          "mmh3 >= 4.1.0 ",
      ]
      extras = {"libcst": "libcst >= 0.2.5"}
    count: 1
  - paths: [packages/google-cloud-spanner/docs/index.rst]
    before: '(?s)API Reference\n-------------.*'
    after: |
      Usage Documentation
      -------------------
      .. toctree::
        :maxdepth: 2

        client-usage
        table-usage
        batch-usage
        snapshot-usage
        transaction-usage

        database-usage
        instance-usage

      API Documentation
      -----------------
      .. toctree::
        :maxdepth: 1
        :titlesonly:

        advanced-session-pool-topics
        opentelemetry-tracing

        spanner_v1/client
        spanner_v1/instance
        spanner_v1/database
        spanner_v1/table
        spanner_v1/session
        spanner_v1/keyset
        spanner_v1/snapshot
        spanner_v1/batch
        spanner_v1/transaction
        spanner_v1/streamed

        spanner_v1/services_
        spanner_v1/types_
        spanner_admin_database_v1/services_
        spanner_admin_database_v1/types_
        spanner_admin_database_v1/database_admin
        spanner_admin_instance_v1/services_
        spanner_admin_instance_v1/types_
        spanner_admin_instance_v1/instance_admin
      


      Changelog
      ---------

      For a list of all ``google-cloud-spanner`` releases:

      .. toctree::
        :maxdepth: 2

        CHANGELOG

      .. toctree::
        :hidden:

        summary_overview.md
    count: 1
  - paths: [packages/google-cloud-spanner/google/cloud/spanner_v1/__init__.py]
    before: '(?s)import sys\n\nimport google\.api_core as api_core.*'
    after: |
      from __future__ import absolute_import

      from google.cloud.spanner_v1 import gapic_version as package_version

      __version__: str = package_version.__version__

      from google.cloud.spanner_v1 import param_types
      from google.cloud.spanner_v1._async.client import Client as AsyncClient
      from google.cloud.spanner_v1._async.pool import (
          AbstractSessionPool as AsyncAbstractSessionPool,
      )
      from google.cloud.spanner_v1._async.pool import BurstyPool as AsyncBurstyPool
      from google.cloud.spanner_v1._async.pool import FixedSizePool as AsyncFixedSizePool
      from google.cloud.spanner_v1._async.pool import PingingPool as AsyncPingingPool
      from google.cloud.spanner_v1._async.pool import (
          TransactionPingingPool as AsyncTransactionPingingPool,
      )
      from google.cloud.spanner_v1.client import Client
      from google.cloud.spanner_v1.keyset import KeyRange, KeySet
      from google.cloud.spanner_v1.pool import (
          AbstractSessionPool,
          BurstyPool,
          FixedSizePool,
          PingingPool,
          TransactionPingingPool,
      )

      from .data_types import Interval, JsonObject
      from .exceptions import wrap_with_request_id
      from .services.spanner import SpannerAsyncClient, SpannerClient
      from .transaction import BatchTransactionId, DefaultTransactionOptions
      from .types import RequestOptions
      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, QueryPlan
      from .types.result_set import (
          PartialResultSet,
          ResultSet,
          ResultSetMetadata,
          ResultSetStats,
      )
      from .types.spanner import (
          BatchCreateSessionsRequest,
          BatchCreateSessionsResponse,
          BatchWriteRequest,
          BatchWriteResponse,
          BeginTransactionRequest,
          CommitRequest,
          CreateSessionRequest,
          DeleteSessionRequest,
          DirectedReadOptions,
          ExecuteBatchDmlRequest,
          ExecuteBatchDmlResponse,
          ExecuteSqlRequest,
          GetSessionRequest,
          ListSessionsRequest,
          ListSessionsResponse,
          Partition,
          PartitionOptions,
          PartitionQueryRequest,
          PartitionReadRequest,
          PartitionResponse,
          ReadRequest,
          RollbackRequest,
          Session,
      )
      from .types.transaction import Transaction, TransactionOptions, TransactionSelector
      from .types.type import StructType, Type, TypeAnnotationCode, TypeCode

      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.exceptions
          "wrap_with_request_id",
          # google.cloud.spanner_v1.client
          "Client",
          "AsyncClient",
          # google.cloud.spanner_v1.keyset
          "KeyRange",
          "KeySet",
          # google.cloud.spanner_v1.pool
          "AbstractSessionPool",
          "BurstyPool",
          "FixedSizePool",
          "PingingPool",
          "TransactionPingingPool",
          "AsyncAbstractSessionPool",
          "AsyncBurstyPool",
          "AsyncFixedSizePool",
          "AsyncPingingPool",
          "AsyncTransactionPingingPool",
          # 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",
      )
    count: 1