From 1a0e24dc7703a45c0f01e04329f4d877e33c0220 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Wed, 20 May 2020 16:24:17 -0700 Subject: [PATCH] docs: updates docstrings (#15) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This PR was generated using Autosynth. :rainbow:
Log from Synthtool ``` 2020-05-13 05:35:34,671 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/python-recommender/synth.py. On branch autosynth nothing to commit, working tree clean 2020-05-13 05:35:34,804 synthtool [DEBUG] > Ensuring dependencies. 2020-05-13 05:35:35,137 synthtool [DEBUG] > Cloning googleapis. 2020-05-13 05:35:35,489 synthtool [DEBUG] > Generating code for: //google/cloud/recommender/v1beta1:recommender-v1beta1-py. 2020-05-13 05:35:39,221 synthtool [SUCCESS] > Generated code into /tmpfs/tmp/tmp0pu_p_ra. 2020-05-13 05:35:39,237 synthtool [DEBUG] > Generating code for: //google/cloud/recommender/v1:recommender-v1-py. 2020-05-13 05:35:42,549 synthtool [SUCCESS] > Generated code into /tmpfs/tmp/tmpym59ylcy. 2020-05-13 05:35:42,567 synthtool [INFO] > Replaced '(/\\^.*\\$/)' in google/cloud/recommender_v1/gapic/recommender_client.py. 2020-05-13 05:35:42,567 synthtool [INFO] > Replaced '(/\\^.*\\$/)' in google/cloud/recommender_v1beta1/gapic/recommender_client.py. 2020-05-13 05:35:42,569 synthtool [INFO] > Replaced ':math:`(/)' in google/cloud/recommender_v1/proto/recommender_service_pb2.py. 2020-05-13 05:35:42,570 synthtool [INFO] > Replaced ':math:`(/)' in google/cloud/recommender_v1beta1/proto/recommender_service_pb2.py. 2020-05-13 05:35:42,570 synthtool [INFO] > Replaced '`/\\.' in google/cloud/recommender_v1/proto/recommender_service_pb2.py. 2020-05-13 05:35:42,571 synthtool [INFO] > Replaced '`/\\.' in google/cloud/recommender_v1beta1/proto/recommender_service_pb2.py. 2020-05-13 05:35:42,573 synthtool [INFO] > Replaced '(regex\\s+)(/.*?/)\\.' in google/cloud/recommender_v1/proto/recommender_service_pb2.py. 2020-05-13 05:35:42,574 synthtool [INFO] > Replaced '(regex\\s+)(/.*?/)\\.' in google/cloud/recommender_v1beta1/proto/recommender_service_pb2.py. 2020-05-13 05:35:42,575 synthtool [INFO] > Replaced '( - Example: )(\\{.*?\\})' in google/cloud/recommender_v1/proto/recommendation_pb2.py. 2020-05-13 05:35:42,575 synthtool [INFO] > Replaced '( - Example: )(\\{.*?\\})' in google/cloud/recommender_v1beta1/proto/recommendation_pb2.py. 2020-05-13 05:35:42,577 synthtool [INFO] > Replaced 'projects/\\[PROJECT_NUMBER\\]/location\n s/\\[LOCATION\\]/insightTypes/\\[INSIGHT\\_TYPE\\_ID\\]/insights/\\[INSIGHT_\n ID\\]' in google/cloud/recommender_v1beta1/proto/recommendation_pb2.py. 2020-05-13 05:35:42,580 synthtool [INFO] > Replaced '(\\# -\\*- coding: utf-8 -\\*-\\n)(\\# Generated by the protocol buffer compiler\\. DO NOT EDIT!.*?# source: .*?\\.proto)' in google/cloud/recommender_v1/proto/recommendation_pb2.py. 2020-05-13 05:35:42,580 synthtool [INFO] > Replaced '(\\# -\\*- coding: utf-8 -\\*-\\n)(\\# Generated by the protocol buffer compiler\\. DO NOT EDIT!.*?# source: .*?\\.proto)' in google/cloud/recommender_v1/proto/recommender_service_pb2.py. 2020-05-13 05:35:42,581 synthtool [INFO] > Replaced '(\\# -\\*- coding: utf-8 -\\*-\\n)(\\# Generated by the protocol buffer compiler\\. DO NOT EDIT!.*?# source: .*?\\.proto)' in google/cloud/recommender_v1beta1/proto/recommendation_pb2.py. 2020-05-13 05:35:42,581 synthtool [INFO] > Replaced '(\\# -\\*- coding: utf-8 -\\*-\\n)(\\# Generated by the protocol buffer compiler\\. DO NOT EDIT!.*?# source: .*?\\.proto)' in google/cloud/recommender_v1beta1/proto/insight_pb2.py. 2020-05-13 05:35:42,582 synthtool [INFO] > Replaced '(\\# -\\*- coding: utf-8 -\\*-\\n)(\\# Generated by the protocol buffer compiler\\. DO NOT EDIT!.*?# source: .*?\\.proto)' in google/cloud/recommender_v1beta1/proto/recommender_service_pb2.py. 2020-05-13 05:35:42,584 synthtool [INFO] > Replaced '(\\# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!)\n(import grpc)' in google/cloud/recommender_v1/proto/recommendation_pb2_grpc.py. 2020-05-13 05:35:42,584 synthtool [INFO] > Replaced '(\\# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!)\n(import grpc)' in google/cloud/recommender_v1/proto/recommender_service_pb2_grpc.py. 2020-05-13 05:35:42,585 synthtool [INFO] > Replaced '(\\# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!)\n(import grpc)' in google/cloud/recommender_v1beta1/proto/insight_pb2_grpc.py. 2020-05-13 05:35:42,585 synthtool [INFO] > Replaced '(\\# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!)\n(import grpc)' in google/cloud/recommender_v1beta1/proto/recommendation_pb2_grpc.py. 2020-05-13 05:35:42,585 synthtool [INFO] > Replaced '(\\# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!)\n(import grpc)' in google/cloud/recommender_v1beta1/proto/recommender_service_pb2_grpc.py. .coveragerc .flake8 .github/CONTRIBUTING.md .github/ISSUE_TEMPLATE/bug_report.md .github/ISSUE_TEMPLATE/feature_request.md .github/ISSUE_TEMPLATE/support_request.md .github/PULL_REQUEST_TEMPLATE.md .github/release-please.yml .gitignore .kokoro/build.sh .kokoro/continuous/common.cfg .kokoro/continuous/continuous.cfg .kokoro/docs/common.cfg .kokoro/docs/docs.cfg .kokoro/presubmit/common.cfg .kokoro/presubmit/presubmit.cfg .kokoro/publish-docs.sh .kokoro/release.sh .kokoro/release/common.cfg .kokoro/release/release.cfg .kokoro/trampoline.sh CODE_OF_CONDUCT.md CONTRIBUTING.rst LICENSE MANIFEST.in docs/_static/custom.css docs/_templates/layout.html docs/conf.py.j2 docs/multiprocessing.rst noxfile.py.j2 renovate.json setup.cfg 2020-05-13 05:35:42,669 synthtool [INFO] > Replaced '\\["2\\.7", ' in noxfile.py. Running session blacken Creating virtual environment (virtualenv) using python3.6 in .nox/blacken pip install black==19.3b0 black docs google tests noxfile.py setup.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/__init__.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/__init__.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1/__init__.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1/gapic/enums.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1/gapic/recommender_client_config.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/docs/conf.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1/proto/recommendation_pb2_grpc.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1/gapic/transports/recommender_grpc_transport.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1/proto/recommender_service_pb2_grpc.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1/types.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1beta1/__init__.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1beta1/gapic/enums.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1/gapic/recommender_client.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1beta1/gapic/recommender_client_config.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1beta1/gapic/transports/recommender_grpc_transport.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1beta1/gapic/recommender_client.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1beta1/proto/insight_pb2_grpc.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1/proto/recommender_service_pb2.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1beta1/proto/recommendation_pb2_grpc.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1beta1/proto/insight_pb2.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1beta1/proto/recommender_service_pb2_grpc.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1beta1/types.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1/proto/recommendation_pb2.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/noxfile.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/tests/unit/gapic/v1/test_recommender_client_v1.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/tests/unit/gapic/v1beta1/test_recommender_client_v1beta1.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1beta1/proto/recommendation_pb2.py reformatted /home/kbuilder/.cache/synthtool/python-recommender/google/cloud/recommender_v1beta1/proto/recommender_service_pb2.py All done! ✨ 🍰 ✨ 29 files reformatted, 7 files left unchanged. Session blacken was successful. 2020-05-13 05:35:48,472 synthtool [DEBUG] > Wrote metadata to synth.metadata. ```
--- .kokoro/publish-docs.sh | 2 -- docs/index.rst | 2 ++ docs/multiprocessing.rst | 7 +++++++ .../cloud/recommender_v1/proto/recommendation_pb2.py | 3 +-- google/cloud/recommender_v1beta1/proto/insight_pb2.py | 4 ++-- .../proto/recommender_service_pb2.py | 8 ++++---- synth.metadata | 10 +++++----- 7 files changed, 21 insertions(+), 15 deletions(-) create mode 100644 docs/multiprocessing.rst diff --git a/.kokoro/publish-docs.sh b/.kokoro/publish-docs.sh index cb40bd1..7ae6f44 100755 --- a/.kokoro/publish-docs.sh +++ b/.kokoro/publish-docs.sh @@ -13,8 +13,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -#!/bin/bash - set -eo pipefail # Disable buffering, so that the logs stream through. diff --git a/docs/index.rst b/docs/index.rst index 81e561c..378b403 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,7 @@ .. include:: README.rst +.. include:: multiprocessing.rst + Api Reference ------------- diff --git a/docs/multiprocessing.rst b/docs/multiprocessing.rst new file mode 100644 index 0000000..1cb29d4 --- /dev/null +++ b/docs/multiprocessing.rst @@ -0,0 +1,7 @@ +.. note:: + + Because this client uses :mod:`grpcio` library, it is safe to + share instances across threads. In multiprocessing scenarios, the best + practice is to create client instances *after* the invocation of + :func:`os.fork` by :class:`multiprocessing.Pool` or + :class:`multiprocessing.Process`. diff --git a/google/cloud/recommender_v1/proto/recommendation_pb2.py b/google/cloud/recommender_v1/proto/recommendation_pb2.py index ffbee49..64f2547 100644 --- a/google/cloud/recommender_v1/proto/recommendation_pb2.py +++ b/google/cloud/recommender_v1/proto/recommendation_pb2.py @@ -1258,8 +1258,7 @@ { "DESCRIPTOR": _VALUEMATCHER, "__module__": "google.cloud.recommender_v1.proto.recommendation_pb2", - "__doc__": """Contains various matching options for values for a GCP - resource field. + "__doc__": """Contains various matching options for values for a GCP resource field. Attributes: diff --git a/google/cloud/recommender_v1beta1/proto/insight_pb2.py b/google/cloud/recommender_v1beta1/proto/insight_pb2.py index dd91c49..85588ae 100644 --- a/google/cloud/recommender_v1beta1/proto/insight_pb2.py +++ b/google/cloud/recommender_v1beta1/proto/insight_pb2.py @@ -531,8 +531,8 @@ ), "DESCRIPTOR": _INSIGHT, "__module__": "google.cloud.recommender_v1beta1.proto.insight_pb2", - "__doc__": """An insight along with the information used to derive the insight. The - insight may have associated recomendations as well. + "__doc__": """An insight along with the information used to derive the + insight. The insight may have associated recomendations as well. Attributes: diff --git a/google/cloud/recommender_v1beta1/proto/recommender_service_pb2.py b/google/cloud/recommender_v1beta1/proto/recommender_service_pb2.py index d27c31e..e2df9fa 100644 --- a/google/cloud/recommender_v1beta1/proto/recommender_service_pb2.py +++ b/google/cloud/recommender_v1beta1/proto/recommender_service_pb2.py @@ -1083,8 +1083,7 @@ Attributes: name: - Required. Name of the insight. .. [1] a-z0-9 .. [2] - a-z0-9 .. [3] a-z0-9 + Required. Name of the insight. """, # @@protoc_insertion_point(class_scope:google.cloud.recommender.v1beta1.GetInsightRequest) }, @@ -1155,6 +1154,7 @@ Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: \`state_info.state:“DISMISSED” or state_info.state:“FAILED” + .. [1] a-z0-9 .. [2] a-z0-9 .. [3] a-z0-9 """, # @@protoc_insertion_point(class_scope:google.cloud.recommender.v1beta1.ListRecommendationsRequest) }, @@ -1260,7 +1260,7 @@ state_metadata: State properties to include with this state. Overwrites any existing ``state_metadata``. Keys must match the regex ``/ - [3]_[a-z0-9_.-]{0,62}/``. Values must match the regex + [2]_[a-z0-9_.-]{0,62}/``. Values must match the regex ``/^[a-zA-Z0-9_./-]{0,255}/``. etag: Required. Fingerprint of the Recommendation. Provides @@ -1296,7 +1296,7 @@ state_metadata: State properties to include with this state. Overwrites any existing ``state_metadata``. Keys must match the regex ``/ - [2]_[a-z0-9_.-]{0,62}/``. Values must match the regex + [3]_[a-z0-9_.-]{0,62}/``. Values must match the regex ``/^[a-zA-Z0-9_./-]{0,255}/``. etag: Required. Fingerprint of the Recommendation. Provides diff --git a/synth.metadata b/synth.metadata index f8b8c2a..df0d409 100644 --- a/synth.metadata +++ b/synth.metadata @@ -3,23 +3,23 @@ { "git": { "name": ".", - "remote": "git@github.com:googleapis/python-recommender.git", - "sha": "b42c8a8b81666c14ae19d8487748788eae27326c" + "remote": "https://github.com/googleapis/python-recommender.git", + "sha": "754b32927208eb775c9d3774fc3c389e22039910" } }, { "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "756b174de4a122461993c1c583345533d819936d", - "internalRef": "308824110" + "sha": "89e89786896d256c70f43e68a975470c4f4f220e", + "internalRef": "311239362" } }, { "git": { "name": "synthtool", "remote": "https://github.com/googleapis/synthtool.git", - "sha": "01b6f23d24b27878b48667ce597876d66b59780e" + "sha": "84c4156c49be9dcabacc8fd7b0585b6fd789ae47" } } ],