synth.py

# Copyright 2018 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.

"""This script is used to synthesize generated parts of this library."""

import re
import textwrap

import synthtool as s
from synthtool import gcp
from synthtool.languages import python

gapic = gcp.GAPICBazel()
common = gcp.CommonTemplates()
version = "v1"

# ----------------------------------------------------------------------------
# Generate pubsub GAPIC layer
# ----------------------------------------------------------------------------
library = gapic.py_library(
    service="pubsub",
    version=version,
    bazel_target="//google/pubsub/v1:pubsub-v1-py",
    include_protos=True,
)
s.move(
    library,
    excludes=[
        "docs/**/*",
        "nox.py",
        "README.rst",
        "setup.py",
        "google/cloud/pubsub_v1/__init__.py",
        "google/cloud/pubsub_v1/types.py",
    ],
)

# DEFAULT SCOPES and SERVICE_ADDRESS are being used. so let's force them in.
s.replace(
    "google/pubsub_v1/services/*er/*client.py",
    r"DEFAULT_ENDPOINT = 'pubsub\.googleapis\.com'",
    """
    # The scopes needed to make gRPC calls to all of the methods defined in
    # this service
    _DEFAULT_SCOPES = (
        'https://www.googleapis.com/auth/cloud-platform',
        'https://www.googleapis.com/auth/pubsub',
    )

    SERVICE_ADDRESS = "pubsub.googleapis.com:443"
    \"""The default address of the service.\"""

    \g<0>""",
)

# Modify GRPC options in transports.
count = s.replace(
    ["google/pubsub_v1/services/*/transports/grpc*", "tests/unit/gapic/pubsub_v1/*"],
    "options=\[.*?\]",
    """options=[
                    ("grpc.max_send_message_length", -1),
                    ("grpc.max_receive_message_length", -1),
                    ("grpc.keepalive_time_ms", 30000),
                ]""",
    flags=re.MULTILINE | re.DOTALL,
)

if count < 18:
    raise Exception("Expected replacements for gRPC channel options not made.")

# Monkey patch the streaming_pull() GAPIC method to disable pre-fetching stream
# results.
s.replace(
    "google/pubsub_v1/services/subscriber/client.py",
    (
        r"# Wrap the RPC method.*\n"
        r"\s+# and friendly error.*\n"
        r"\s+rpc = self\._transport\._wrapped_methods\[self\._transport\.streaming_pull\]"
    ),
    """
        # Wrappers in api-core should not automatically pre-fetch the first
        # stream result, as this breaks the stream when re-opening it.
        # https://github.com/googleapis/python-pubsub/issues/93#issuecomment-630762257
        self._transport.streaming_pull._prefetch_first_result_ = False

        \g<0>""",
)

# Make sure that client library version is present in user agent header.
s.replace(
    [
        "google/pubsub_v1/services/publisher/async_client.py",
        "google/pubsub_v1/services/publisher/client.py",
        "google/pubsub_v1/services/publisher/transports/base.py",
        "google/pubsub_v1/services/schema_service/async_client.py",
        "google/pubsub_v1/services/schema_service/client.py",
        "google/pubsub_v1/services/schema_service/transports/base.py",
        "google/pubsub_v1/services/subscriber/async_client.py",
        "google/pubsub_v1/services/subscriber/client.py",
        "google/pubsub_v1/services/subscriber/transports/base.py",
    ],
    r"""gapic_version=(pkg_resources\.get_distribution\(\s+)['"]google-pubsub['"]""",
    "client_library_version=\g<1>'google-cloud-pubsub'",
)

# Docstrings of *_iam_policy() methods are formatted poorly and must be fixed
# in order to avoid docstring format warnings in docs.
s.replace("google/pubsub_v1/services/*er/client.py", r"(\s+)Args:", "\n\g<1>Args:")
s.replace(
    "google/pubsub_v1/services/*er/client.py",
    r"(\s+)\*\*JSON Example\*\*\s+::",
    "\n\g<1>**JSON Example**::\n",
)
s.replace(
    "google/pubsub_v1/services/*er/client.py",
    r"(\s+)\*\*YAML Example\*\*\s+::",
    "\n\g<1>**YAML Example**::\n",
)
s.replace(
    "google/pubsub_v1/services/*er/client.py",
    r"(\s+)For a description of IAM and its features, see",
    "\n\g<0>",
)

# ----------------------------------------------------------------------------
# Add templated files
# ----------------------------------------------------------------------------
templated_files = gcp.CommonTemplates().py_library(
    microgenerator=True,
    samples=True,
    cov_level=99,
    system_test_external_dependencies=["psutil"],
)
s.move(templated_files, excludes=[".coveragerc"])

# ----------------------------------------------------------------------------
# Samples templates
# ----------------------------------------------------------------------------
python.py_samples()

s.shell.run(["nox", "-s", "blacken"], hide_output=False)