feat(v1p1beta1): support Model Adaptation (#104)

feat: add from_service_account_info factory docs: fix sphinx identifiers test: add 3.9 unit tests
googleapis · Feb 26, 2021 · 4005612 · 4005612
1 parent f40111a
commit 4005612
Show file tree

Hide file tree

Showing 52 changed files with 8,890 additions and 776 deletions.
diff --git a/packages/google-cloud-python-speech/.coveragerc b/packages/google-cloud-python-speech/.coveragerc
@@ -1,20 +1,3 @@
-# -*- 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
-#
-#     https://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.
-
-# Generated by synthtool. DO NOT EDIT!
 [run]
 branch = True
 
@@ -32,4 +15,4 @@ exclude_lines =
     # This is added at the module level as a safeguard for if someone
     # generates the code and tries to run it without pip installing. This
     # makes it virtually impossible to test properly.
-    except pkg_resources.DistributionNotFound
+    except pkg_resources.DistributionNotFound
diff --git a/packages/google-cloud-python-speech/.github/header-checker-lint.yml b/packages/google-cloud-python-speech/.github/header-checker-lint.yml
@@ -0,0 +1,15 @@
+{"allowedCopyrightHolders": ["Google LLC"],
+ "allowedLicenses": ["Apache-2.0", "MIT", "BSD-3"],
+ "ignoreFiles": ["**/requirements.txt", "**/requirements-test.txt"],
+ "sourceFileExtensions": [
+ 	"ts", 
+ 	"js", 
+ 	"java", 
+ 	"sh", 
+ 	"Dockerfile", 
+ 	"yaml", 
+ 	"py",
+ 	"html",
+ 	"txt"
+ ]
+}
diff --git a/packages/google-cloud-python-speech/.gitignore b/packages/google-cloud-python-speech/.gitignore
@@ -50,8 +50,10 @@ docs.metadata
 
 # Virtual environment
 env/
+
+# Test logs
 coverage.xml
-sponge_log.xml
+*sponge_log.xml
 
 # System test environment variables.
 system_tests/local_test_setup

diff --git a/packages/google-cloud-python-speech/.kokoro/build.sh b/packages/google-cloud-python-speech/.kokoro/build.sh
@@ -15,7 +15,11 @@
 
 set -eo pipefail
 
-cd github/python-speech
+if [[ -z "${PROJECT_ROOT:-}" ]]; then
+    PROJECT_ROOT="github/python-speech"
+fi
+
+cd "${PROJECT_ROOT}"
 
 # Disable buffering, so that the logs stream through.
 export PYTHONUNBUFFERED=1
@@ -30,16 +34,26 @@ export GOOGLE_APPLICATION_CREDENTIALS=${KOKORO_GFILE_DIR}/service-account.json
 export PROJECT_ID=$(cat "${KOKORO_GFILE_DIR}/project-id.json")
 
 # Remove old nox
-python3.6 -m pip uninstall --yes --quiet nox-automation
+python3 -m pip uninstall --yes --quiet nox-automation
 
 # Install nox
-python3.6 -m pip install --upgrade --quiet nox
-python3.6 -m nox --version
+python3 -m pip install --upgrade --quiet nox
+python3 -m nox --version
+
+# If this is a continuous build, send the test log to the FlakyBot.
+# See https://github.com/googleapis/repo-automation-bots/tree/master/packages/flakybot.
+if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"continuous"* ]]; then
+  cleanup() {
+    chmod +x $KOKORO_GFILE_DIR/linux_amd64/flakybot
+    $KOKORO_GFILE_DIR/linux_amd64/flakybot
+  }
+  trap cleanup EXIT HUP
+fi
 
 # If NOX_SESSION is set, it only runs the specified session,
 # otherwise run all the sessions.
 if [[ -n "${NOX_SESSION:-}" ]]; then
-    python3.6 -m nox -s "${NOX_SESSION:-}"
+    python3 -m nox -s ${NOX_SESSION:-}
 else
-    python3.6 -m nox
+    python3 -m nox
 fi
diff --git a/packages/google-cloud-python-speech/.kokoro/docs/docs-presubmit.cfg b/packages/google-cloud-python-speech/.kokoro/docs/docs-presubmit.cfg
@@ -15,3 +15,14 @@ env_vars: {
     key: "TRAMPOLINE_IMAGE_UPLOAD"
     value: "false"
 }
+
+env_vars: {
+    key: "TRAMPOLINE_BUILD_FILE"
+    value: "github/python-speech/.kokoro/build.sh"
+}
+
+# Only run this nox session.
+env_vars: {
+    key: "NOX_SESSION"
+    value: "docs docfx"
+}
diff --git a/packages/google-cloud-python-speech/.trampolinerc b/packages/google-cloud-python-speech/.trampolinerc
@@ -24,6 +24,7 @@ required_envvars+=(
 pass_down_envvars+=(
     "STAGING_BUCKET"
     "V2_STAGING_BUCKET"
+    "NOX_SESSION"
 )
 
 # Prevent unintentional override on the default image.

diff --git a/packages/google-cloud-python-speech/CONTRIBUTING.rst b/packages/google-cloud-python-speech/CONTRIBUTING.rst
@@ -70,9 +70,14 @@ We use `nox <https://nox.readthedocs.io/en/latest/>`__ to instrument our tests.
 - To test your changes, run unit tests with ``nox``::
 
     $ nox -s unit-2.7
-    $ nox -s unit-3.7
+    $ nox -s unit-3.8
     $ ...
 
+- Args to pytest can be passed through the nox command separated by a `--`. For
+  example, to run a single test::
+
+    $ nox -s unit-3.8 -- -k <name of test>
+
   .. note::
 
     The unit tests and system tests are described in the
@@ -93,8 +98,12 @@ On Debian/Ubuntu::
 ************
 Coding Style
 ************
+- We use the automatic code formatter ``black``. You can run it using
+  the nox session ``blacken``. This will eliminate many lint errors. Run via::
+
+   $ nox -s blacken
 
-- PEP8 compliance, with exceptions defined in the linter configuration.
+- PEP8 compliance is required, with exceptions defined in the linter configuration.
   If you have ``nox`` installed, you can test that you have not introduced
   any non-compliant code via::
 
@@ -133,13 +142,18 @@ Running System Tests
 
 - To run system tests, you can execute::
 
-   $ nox -s system-3.7
+   # Run all system tests
+   $ nox -s system-3.8
    $ nox -s system-2.7
 
+   # Run a single system test
+   $ nox -s system-3.8 -- -k <name of test>
+
+
   .. note::
 
       System tests are only configured to run under Python 2.7 and
-      Python 3.7. For expediency, we do not run them in older versions
+      Python 3.8. For expediency, we do not run them in older versions
       of Python 3.
 
   This alone will not run the tests. You'll need to change some local

diff --git a/packages/google-cloud-python-speech/LICENSE b/packages/google-cloud-python-speech/LICENSE
@@ -1,6 +1,7 @@
-                            Apache License
+
+                                 Apache License
                            Version 2.0, January 2004
-                        https://www.apache.org/licenses/
+                        http://www.apache.org/licenses/
 
    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
@@ -192,7 +193,7 @@
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
-       https://www.apache.org/licenses/LICENSE-2.0
+       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,

diff --git a/packages/google-cloud-python-speech/MANIFEST.in b/packages/google-cloud-python-speech/MANIFEST.in
@@ -16,10 +16,10 @@
 
 # Generated by synthtool. DO NOT EDIT!
 include README.rst LICENSE
-recursive-include google *.json *.proto
+recursive-include google *.json *.proto py.typed
 recursive-include tests *
 global-exclude *.py[co]
 global-exclude __pycache__
 
 # Exclude scripts for samples readmegen
-prune scripts/readme-gen
+prune scripts/readme-gen
diff --git a/packages/google-cloud-python-speech/docs/_static/custom.css b/packages/google-cloud-python-speech/docs/_static/custom.css
@@ -1,4 +1,9 @@
 div#python2-eol {
 	border-color: red;
 	border-width: medium;
-} 
+} 
+
+/* Ensure minimum width for 'Parameters' / 'Returns' column */
+dl.field-list > dt {
+    min-width: 100px
+}
diff --git a/packages/google-cloud-python-speech/docs/speech_v1/services.rst b/packages/google-cloud-python-speech/docs/speech_v1/services.rst
@@ -1,6 +1,6 @@
 Services for Google Cloud Speech v1 API
 =======================================
+.. toctree::
+    :maxdepth: 2
 
-.. automodule:: google.cloud.speech_v1.services.speech
-    :members:
-    :inherited-members:
+    speech
diff --git a/packages/google-cloud-python-speech/docs/speech_v1/speech.rst b/packages/google-cloud-python-speech/docs/speech_v1/speech.rst
@@ -0,0 +1,6 @@
+Speech
+------------------------
+
+.. automodule:: google.cloud.speech_v1.services.speech
+    :members:
+    :inherited-members:
diff --git a/packages/google-cloud-python-speech/docs/speech_v1/types.rst b/packages/google-cloud-python-speech/docs/speech_v1/types.rst
@@ -3,4 +3,5 @@ Types for Google Cloud Speech v1 API
 
 .. automodule:: google.cloud.speech_v1.types
     :members:
+    :undoc-members:
     :show-inheritance:
diff --git a/packages/google-cloud-python-speech/docs/speech_v1p1beta1/adaptation.rst b/packages/google-cloud-python-speech/docs/speech_v1p1beta1/adaptation.rst
@@ -0,0 +1,11 @@
+Adaptation
+----------------------------
+
+.. automodule:: google.cloud.speech_v1p1beta1.services.adaptation
+    :members:
+    :inherited-members:
+
+
+.. automodule:: google.cloud.speech_v1p1beta1.services.adaptation.pagers
+    :members:
+    :inherited-members:
diff --git a/packages/google-cloud-python-speech/docs/speech_v1p1beta1/services.rst b/packages/google-cloud-python-speech/docs/speech_v1p1beta1/services.rst
@@ -1,6 +1,7 @@
 Services for Google Cloud Speech v1p1beta1 API
 ==============================================
+.. toctree::
+    :maxdepth: 2
 
-.. automodule:: google.cloud.speech_v1p1beta1.services.speech
-    :members:
-    :inherited-members:
+    adaptation
+    speech
diff --git a/packages/google-cloud-python-speech/docs/speech_v1p1beta1/speech.rst b/packages/google-cloud-python-speech/docs/speech_v1p1beta1/speech.rst
@@ -0,0 +1,6 @@
+Speech
+------------------------
+
+.. automodule:: google.cloud.speech_v1p1beta1.services.speech
+    :members:
+    :inherited-members:
diff --git a/packages/google-cloud-python-speech/docs/speech_v1p1beta1/types.rst b/packages/google-cloud-python-speech/docs/speech_v1p1beta1/types.rst
@@ -3,4 +3,5 @@ Types for Google Cloud Speech v1p1beta1 API
 
 .. automodule:: google.cloud.speech_v1p1beta1.types
     :members:
+    :undoc-members:
     :show-inheritance: