From 3df467d62a9e8d67cf9a24e8e98a8bc69eb9de1f Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Mon, 17 Jun 2019 17:21:10 -0700 Subject: [PATCH 1/4] Noxfile template update. --- containeranalysis/noxfile.py | 50 +++++++++++++++++------------------- containeranalysis/setup.py | 1 + 2 files changed, 25 insertions(+), 26 deletions(-) diff --git a/containeranalysis/noxfile.py b/containeranalysis/noxfile.py index cd57422e5961..99e11b3ab50f 100644 --- a/containeranalysis/noxfile.py +++ b/containeranalysis/noxfile.py @@ -23,6 +23,12 @@ LOCAL_DEPS = (os.path.join("..", "api_core"), os.path.join("..", "core")) +BLACK_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"] + +if os.path.exists("samples"): + BLACK_PATHS.append("samples") + + @nox.session(python="3.7") def lint(session): """Run linters. @@ -31,13 +37,7 @@ def lint(session): serious code quality issues. """ session.install("flake8", "black", *LOCAL_DEPS) - session.run( - "black", - "--check", - "google", - "tests", - "docs", - ) + session.run("black", "--check", *BLACK_PATHS) session.run("flake8", "google", "tests") @@ -46,18 +46,13 @@ def blacken(session): """Run black. Format code to uniform standard. - + This currently uses Python 3.6 due to the automated Kokoro run of synthtool. That run uses an image that doesn't have 3.6 installed. Before updating this check the state of the `gcp_ubuntu_config` we use for that Kokoro run. """ session.install("black") - session.run( - "black", - "google", - "tests", - "docs", - ) + session.run("black", *BLACK_PATHS) @nox.session(python="3.7") @@ -83,7 +78,7 @@ def default(session): "--cov-append", "--cov-config=.coveragerc", "--cov-report=", - "--cov-fail-under=51", + "--cov-fail-under=0", os.path.join("tests", "unit"), *session.posargs, ) @@ -140,21 +135,24 @@ def cover(session): session.run("coverage", "erase") + @nox.session(python="3.7") def docs(session): """Build the docs for this library.""" - session.install('-e', '.') - session.install('sphinx', 'alabaster', 'recommonmark') + session.install("-e", ".") + session.install("sphinx", "alabaster", "recommonmark") - shutil.rmtree(os.path.join('docs', '_build'), ignore_errors=True) + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) session.run( - 'sphinx-build', - '-W', # warnings as errors - '-T', # show full traceback on exception - '-N', # no colors - '-b', 'html', - '-d', os.path.join('docs', '_build', 'doctrees', ''), - os.path.join('docs', ''), - os.path.join('docs', '_build', 'html', ''), + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), ) diff --git a/containeranalysis/setup.py b/containeranalysis/setup.py index 4c1762ed599e..da5a1de42e60 100644 --- a/containeranalysis/setup.py +++ b/containeranalysis/setup.py @@ -29,6 +29,7 @@ 'google-api-core[grpc] >= 1.4.1, < 2.0.0dev', 'grpc-google-iam-v1 >= 0.11.1, < 0.12dev', 'enum34; python_version < "3.4"', + 'grafeas', ] From 20f0f4e7fac0d904ebe3008e0a39d292954078fe Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Mon, 17 Jun 2019 17:21:29 -0700 Subject: [PATCH 2/4] Blacken. --- containeranalysis/setup.py | 66 ++++++++++++++++++-------------------- 1 file changed, 32 insertions(+), 34 deletions(-) diff --git a/containeranalysis/setup.py b/containeranalysis/setup.py index da5a1de42e60..0d534a2e23fb 100644 --- a/containeranalysis/setup.py +++ b/containeranalysis/setup.py @@ -20,33 +20,31 @@ import setuptools - -name = 'google-cloud-containeranalysis' -description = 'Container Analysis API API client library' -version = '0.1.0' -release_status = '3 - Alpha' +name = "google-cloud-containeranalysis" +description = "Container Analysis API API client library" +version = "0.1.0" +release_status = "3 - Alpha" dependencies = [ - 'google-api-core[grpc] >= 1.4.1, < 2.0.0dev', - 'grpc-google-iam-v1 >= 0.11.1, < 0.12dev', - 'enum34; python_version < "3.4"', - 'grafeas', + "google-api-core[grpc] >= 1.4.1, < 2.0.0dev", + "grpc-google-iam-v1 >= 0.11.1, < 0.12dev", + 'enum34; python_version < "3.4"', + "grafeas", ] - package_root = os.path.abspath(os.path.dirname(__file__)) -readme_filename = os.path.join(package_root, 'README.rst') -with io.open(readme_filename, encoding='utf-8') as readme_file: +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: readme = readme_file.read() packages = [ - package for package in setuptools.find_packages() - if package.startswith('google')] + package for package in setuptools.find_packages() if package.startswith("google") +] -namespaces = ['google'] -if 'google.cloud' in packages: - namespaces.append('google.cloud') +namespaces = ["google"] +if "google.cloud" in packages: + namespaces.append("google.cloud") setuptools.setup( @@ -54,28 +52,28 @@ version=version, description=description, long_description=readme, - author='Google LLC', - author_email='googleapis-packages@google.com', - license='Apache 2.0', - url='https://github.com/googleapis/google-cloud-python', + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url="https://github.com/googleapis/google-cloud-python", classifiers=[ release_status, - 'Intended Audience :: Developers', - 'License :: OSI Approved :: Apache Software License', - 'Programming Language :: Python', - 'Programming Language :: Python :: 2', - 'Programming Language :: Python :: 2.7', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.4', - 'Programming Language :: Python :: 3.5', - 'Programming Language :: Python :: 3.6', - 'Operating System :: OS Independent', - 'Topic :: Internet', + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 2", + "Programming Language :: Python :: 2.7", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.4", + "Programming Language :: Python :: 3.5", + "Programming Language :: Python :: 3.6", + "Operating System :: OS Independent", + "Topic :: Internet", ], - platforms='Posix; MacOS X; Windows', + platforms="Posix; MacOS X; Windows", packages=packages, namespace_packages=namespaces, install_requires=dependencies, include_package_data=True, zip_safe=False, -) \ No newline at end of file +) From 427dae8cd03db0405af618dd13ad431b1acbc004 Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Mon, 17 Jun 2019 17:22:30 -0700 Subject: [PATCH 3/4] Add get_grafeas_client method. --- .../gapic/container_analysis_client.py | 15 +++++++++ .../proto/containeranalysis.proto | 1 + .../proto/containeranalysis_pb2.py | 5 +-- containeranalysis/synth.metadata | 10 +++--- containeranalysis/synth.py | 33 ++++++++++++++++++- 5 files changed, 56 insertions(+), 8 deletions(-) diff --git a/containeranalysis/google/cloud/devtools/containeranalysis_v1/gapic/container_analysis_client.py b/containeranalysis/google/cloud/devtools/containeranalysis_v1/gapic/container_analysis_client.py index 8a5ef9a7d15e..69e350405616 100644 --- a/containeranalysis/google/cloud/devtools/containeranalysis_v1/gapic/container_analysis_client.py +++ b/containeranalysis/google/cloud/devtools/containeranalysis_v1/gapic/container_analysis_client.py @@ -39,6 +39,9 @@ from google.iam.v1 import policy_pb2 +from grafeas import grafeas_v1 +from grafeas.grafeas_v1.gapic.transports import grafeas_grpc_transport + _GAPIC_LIBRARY_VERSION = pkg_resources.get_distribution( "google-cloud-containeranalysis" ).version @@ -194,6 +197,18 @@ def __init__( # timeout, and the like. self._inner_api_calls = {} + def get_grafeas_client(self): + """Returns an equivalent grafeas client. + + Returns: + A :class:`~grafeas.grafeas_v1\.GrafeasClient` instance. + """ + grafeas_transport = grafeas_grpc_transport.GrafeasGrpcTransport( + self.SERVICE_ADDRESS, self.transport._OAUTH_SCOPES + ) + + return grafeas_v1.GrafeasClient(grafeas_transport) + # Service calls def set_iam_policy( self, diff --git a/containeranalysis/google/cloud/devtools/containeranalysis_v1/proto/containeranalysis.proto b/containeranalysis/google/cloud/devtools/containeranalysis_v1/proto/containeranalysis.proto index 5c855acbd5ee..054d19797452 100644 --- a/containeranalysis/google/cloud/devtools/containeranalysis_v1/proto/containeranalysis.proto +++ b/containeranalysis/google/cloud/devtools/containeranalysis_v1/proto/containeranalysis.proto @@ -27,6 +27,7 @@ option go_package = "google.golang.org/genproto/googleapis/devtools/containerana option java_multiple_files = true; option java_package = "com.google.containeranalysis.v1"; option objc_class_prefix = "GCA"; +option ruby_package = "Google::Cloud::ContainerAnalysis::V1"; // Retrieves analysis results of Cloud components such as Docker container // images. The Container Analysis API is an implementation of the diff --git a/containeranalysis/google/cloud/devtools/containeranalysis_v1/proto/containeranalysis_pb2.py b/containeranalysis/google/cloud/devtools/containeranalysis_v1/proto/containeranalysis_pb2.py index 17d3b1845976..97ecb2b86f10 100644 --- a/containeranalysis/google/cloud/devtools/containeranalysis_v1/proto/containeranalysis_pb2.py +++ b/containeranalysis/google/cloud/devtools/containeranalysis_v1/proto/containeranalysis_pb2.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- # Generated by the protocol buffer compiler. DO NOT EDIT! # source: google/cloud/devtools/containeranalysis_v1/proto/containeranalysis.proto @@ -25,10 +26,10 @@ package="google.devtools.containeranalysis.v1", syntax="proto3", serialized_options=_b( - "\n\037com.google.containeranalysis.v1P\001ZUgoogle.golang.org/genproto/googleapis/devtools/containeranalysis/v1;containeranalysis\242\002\003GCA\252\002*Google.Cloud.DevTools.ContainerAnalysis.V1" + "\n\037com.google.containeranalysis.v1P\001ZUgoogle.golang.org/genproto/googleapis/devtools/containeranalysis/v1;containeranalysis\242\002\003GCA\252\002*Google.Cloud.DevTools.ContainerAnalysis.V1\352\002$Google::Cloud::ContainerAnalysis::V1" ), serialized_pb=_b( - '\nHgoogle/cloud/devtools/containeranalysis_v1/proto/containeranalysis.proto\x12$google.devtools.containeranalysis.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x1egoogle/iam/v1/iam_policy.proto\x1a\x1agoogle/iam/v1/policy.proto\x1a\x1fgoogle/protobuf/timestamp.proto2\x86\x05\n\x11\x43ontainerAnalysis\x12\xbf\x01\n\x0cSetIamPolicy\x12".google.iam.v1.SetIamPolicyRequest\x1a\x15.google.iam.v1.Policy"t\x82\xd3\xe4\x93\x02n"./v1/{resource=projects/*/notes/*}:setIamPolicy:\x01*Z9"4/v1/{resource=projects/*/occurrences/*}:setIamPolicy:\x01*\x12\xbf\x01\n\x0cGetIamPolicy\x12".google.iam.v1.GetIamPolicyRequest\x1a\x15.google.iam.v1.Policy"t\x82\xd3\xe4\x93\x02n"./v1/{resource=projects/*/notes/*}:getIamPolicy:\x01*Z9"4/v1/{resource=projects/*/occurrences/*}:getIamPolicy:\x01*\x12\xec\x01\n\x12TestIamPermissions\x12(.google.iam.v1.TestIamPermissionsRequest\x1a).google.iam.v1.TestIamPermissionsResponse"\x80\x01\x82\xd3\xe4\x93\x02z"4/v1/{resource=projects/*/notes/*}:testIamPermissions:\x01*Z?":/v1/{resource=projects/*/occurrences/*}:testIamPermissions:\x01*B\xad\x01\n\x1f\x63om.google.containeranalysis.v1P\x01ZUgoogle.golang.org/genproto/googleapis/devtools/containeranalysis/v1;containeranalysis\xa2\x02\x03GCA\xaa\x02*Google.Cloud.DevTools.ContainerAnalysis.V1b\x06proto3' + '\nHgoogle/cloud/devtools/containeranalysis_v1/proto/containeranalysis.proto\x12$google.devtools.containeranalysis.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x1egoogle/iam/v1/iam_policy.proto\x1a\x1agoogle/iam/v1/policy.proto\x1a\x1fgoogle/protobuf/timestamp.proto2\x86\x05\n\x11\x43ontainerAnalysis\x12\xbf\x01\n\x0cSetIamPolicy\x12".google.iam.v1.SetIamPolicyRequest\x1a\x15.google.iam.v1.Policy"t\x82\xd3\xe4\x93\x02n"./v1/{resource=projects/*/notes/*}:setIamPolicy:\x01*Z9"4/v1/{resource=projects/*/occurrences/*}:setIamPolicy:\x01*\x12\xbf\x01\n\x0cGetIamPolicy\x12".google.iam.v1.GetIamPolicyRequest\x1a\x15.google.iam.v1.Policy"t\x82\xd3\xe4\x93\x02n"./v1/{resource=projects/*/notes/*}:getIamPolicy:\x01*Z9"4/v1/{resource=projects/*/occurrences/*}:getIamPolicy:\x01*\x12\xec\x01\n\x12TestIamPermissions\x12(.google.iam.v1.TestIamPermissionsRequest\x1a).google.iam.v1.TestIamPermissionsResponse"\x80\x01\x82\xd3\xe4\x93\x02z"4/v1/{resource=projects/*/notes/*}:testIamPermissions:\x01*Z?":/v1/{resource=projects/*/occurrences/*}:testIamPermissions:\x01*B\xd4\x01\n\x1f\x63om.google.containeranalysis.v1P\x01ZUgoogle.golang.org/genproto/googleapis/devtools/containeranalysis/v1;containeranalysis\xa2\x02\x03GCA\xaa\x02*Google.Cloud.DevTools.ContainerAnalysis.V1\xea\x02$Google::Cloud::ContainerAnalysis::V1b\x06proto3' ), dependencies=[ google_dot_api_dot_annotations__pb2.DESCRIPTOR, diff --git a/containeranalysis/synth.metadata b/containeranalysis/synth.metadata index fbcbdd5fc932..e248942c0e23 100644 --- a/containeranalysis/synth.metadata +++ b/containeranalysis/synth.metadata @@ -1,19 +1,19 @@ { - "updateTime": "2019-06-05T22:45:41.734439Z", + "updateTime": "2019-06-18T00:20:52.669251Z", "sources": [ { "generator": { "name": "artman", - "version": "0.23.1", - "dockerImage": "googleapis/artman@sha256:9d5cae1454da64ac3a87028f8ef486b04889e351c83bb95e83b8fab3959faed0" + "version": "0.26.0", + "dockerImage": "googleapis/artman@sha256:6db0735b0d3beec5b887153a2a7c7411fc7bb53f73f6f389a822096bd14a3a15" } }, { "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "5487c78983f6bd5bbafa69166593826a90778a2f", - "internalRef": "251716150" + "sha": "384aa843867c4d17756d14a01f047b6368494d32", + "internalRef": "253675319" } }, { diff --git a/containeranalysis/synth.py b/containeranalysis/synth.py index f36e6426a345..3502c690ec76 100644 --- a/containeranalysis/synth.py +++ b/containeranalysis/synth.py @@ -33,12 +33,43 @@ include_protos=True, ) -excludes = ["nox.py", "setup.py", "google/cloud/containeranalysis_v1/proto"] +excludes = ["nox.py", "setup.py", "google/cloud/containeranalysis_v1/proto", "README.rst", "docs/index.rst"] s.move(library, excludes=excludes) # .proto files end up in the wrong place by default s.move(library / "google/cloud/containeranalysis_v1/proto", "google/cloud/devtools/containeranalysis_v1/proto") + +# Insert helper method to get grafeas client +s.replace("google/**/container_analysis_client.py", +r"""_GAPIC_LIBRARY_VERSION = pkg_resources\.get_distribution\( + 'google-cloud-containeranalysis', +\)\.version""", +r"""from grafeas import grafeas_v1 +from grafeas.grafeas_v1.gapic.transports import grafeas_grpc_transport + +_GAPIC_LIBRARY_VERSION = pkg_resources.get_distribution( + "google-cloud-containeranalysis" +).version +""") + +s.replace("google/**/container_analysis_client.py", +r''' \# Service calls + def set_iam_policy\(''', +r''' def get_grafeas_client(self): + """Returns an equivalent grafeas client. + + Returns: + A :class:`~grafeas.grafeas_v1\.GrafeasClient` instance. + """ + grafeas_transport = grafeas_grpc_transport.GrafeasGrpcTransport( + self.SERVICE_ADDRESS, + self.transport._OAUTH_SCOPES) + + return grafeas_v1.GrafeasClient(grafeas_transport) + + # Service calls + def set_iam_policy(''') # ---------------------------------------------------------------------------- # Add templated files # ---------------------------------------------------------------------------- From b8b94494f8e66e418a7f7ba73a41647b7d96f517 Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Mon, 17 Jun 2019 17:24:15 -0700 Subject: [PATCH 4/4] Fix docstring. --- .../containeranalysis_v1/gapic/container_analysis_client.py | 2 +- containeranalysis/synth.metadata | 2 +- containeranalysis/synth.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/containeranalysis/google/cloud/devtools/containeranalysis_v1/gapic/container_analysis_client.py b/containeranalysis/google/cloud/devtools/containeranalysis_v1/gapic/container_analysis_client.py index 69e350405616..1facd991581a 100644 --- a/containeranalysis/google/cloud/devtools/containeranalysis_v1/gapic/container_analysis_client.py +++ b/containeranalysis/google/cloud/devtools/containeranalysis_v1/gapic/container_analysis_client.py @@ -201,7 +201,7 @@ def get_grafeas_client(self): """Returns an equivalent grafeas client. Returns: - A :class:`~grafeas.grafeas_v1\.GrafeasClient` instance. + A :class:`~grafeas.grafeas_v1.GrafeasClient` instance. """ grafeas_transport = grafeas_grpc_transport.GrafeasGrpcTransport( self.SERVICE_ADDRESS, self.transport._OAUTH_SCOPES diff --git a/containeranalysis/synth.metadata b/containeranalysis/synth.metadata index e248942c0e23..fc04793771e5 100644 --- a/containeranalysis/synth.metadata +++ b/containeranalysis/synth.metadata @@ -1,5 +1,5 @@ { - "updateTime": "2019-06-18T00:20:52.669251Z", + "updateTime": "2019-06-18T00:23:56.692141Z", "sources": [ { "generator": { diff --git a/containeranalysis/synth.py b/containeranalysis/synth.py index 3502c690ec76..35c1978464f2 100644 --- a/containeranalysis/synth.py +++ b/containeranalysis/synth.py @@ -60,7 +60,7 @@ def set_iam_policy\(''', """Returns an equivalent grafeas client. Returns: - A :class:`~grafeas.grafeas_v1\.GrafeasClient` instance. + A :class:`~grafeas.grafeas_v1.GrafeasClient` instance. """ grafeas_transport = grafeas_grpc_transport.GrafeasGrpcTransport( self.SERVICE_ADDRESS,