diff --git a/packages/google-cloud-python-speech/.coveragerc b/packages/google-cloud-python-speech/.coveragerc index c6b0df122747..51fec440cebf 100644 --- a/packages/google-cloud-python-speech/.coveragerc +++ b/packages/google-cloud-python-speech/.coveragerc @@ -9,6 +9,10 @@ exclude_lines = pragma: NO COVER # Ignore debug-only repr def __repr__ + # Ignore abstract methods + raise NotImplementedError omit = - */gapic/* - */proto/* + */gapic/*.py + */proto/*.py + */google-cloud-python/core/*.py + */site-packages/*.py \ No newline at end of file diff --git a/packages/google-cloud-python-speech/.flake8 b/packages/google-cloud-python-speech/.flake8 index 1f44a90f8195..61766fa84d02 100644 --- a/packages/google-cloud-python-speech/.flake8 +++ b/packages/google-cloud-python-speech/.flake8 @@ -1,4 +1,5 @@ [flake8] +ignore = E203, E266, E501, W503 exclude = # Exclude generated code. **/proto/** diff --git a/packages/google-cloud-python-speech/noxfile.py b/packages/google-cloud-python-speech/noxfile.py index 264c617cb39b..a9efc0e344ce 100644 --- a/packages/google-cloud-python-speech/noxfile.py +++ b/packages/google-cloud-python-speech/noxfile.py @@ -1,10 +1,12 @@ -# Copyright 2016 Google LLC +# -*- coding: utf-8 -*- +# +# 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 +# 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, @@ -13,98 +15,126 @@ # limitations under the License. from __future__ import absolute_import - import os import nox -LOCAL_DEPS = ( - os.path.join('..', 'api_core'), -) +LOCAL_DEPS = (os.path.join("..", "api_core"), os.path.join("..", "core")) +@nox.session(python="3.7") +def blacken(session): + """Run black. -def default(session): - """Default unit test session. + Format code to uniform standard. + """ + session.install("black") + session.run( + "black", + "google", + "tests", + "docs", + "--exclude", + ".*/proto/.*|.*/gapic/.*|.*/.*_pb2.py", + ) + + +@nox.session(python="3.7") +def lint(session): + """Run linters. - This is intended to be run **without** an interpreter set, so - that the current ``python`` (on the ``PATH``) or the version of - Python corresponding to the ``nox`` binary the ``PATH`` can - run the tests. + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. """ + session.install("flake8", "black", *LOCAL_DEPS) + session.run( + "black", + "--check", + "google", + "tests", + "docs", + "--exclude", + ".*/proto/.*|.*/gapic/.*|.*/.*_pb2.py", + ) + session.run("flake8", "google", "tests") + + +@nox.session(python="3.7") +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") + + +def default(session): # Install all test dependencies, then install this package in-place. - session.install('mock', 'pytest', 'pytest-cov', *LOCAL_DEPS) - session.install('-e', '.') + session.install("mock", "pytest", "pytest-cov") + for local_dep in LOCAL_DEPS: + session.install("-e", local_dep) + session.install("-e", ".") # Run py.test against the unit tests. session.run( - 'py.test', '--quiet', - '--cov=google.cloud.speech_v1', - '--cov=tests.unit', - '--cov-append', - '--cov-config=.coveragerc', - '--cov-report=', - '--cov-fail-under=0', - os.path.join('tests', 'unit'), + "py.test", + "--quiet", + "--cov=google.cloud", + "--cov=tests.unit", + "--cov-append", + "--cov-config=.coveragerc", + "--cov-report=", + "--cov-fail-under=97", + os.path.join("tests", "unit"), + *session.posargs, ) -@nox.session(python=['2.7', '3.5', '3.6', '3.7']) +@nox.session(python=["2.7", "3.5", "3.6", "3.7"]) def unit(session): """Run the unit test suite.""" default(session) -@nox.session(python=['2.7', '3.6']) +@nox.session(python=["2.7", "3.7"]) def system(session): """Run the system test suite.""" - - # Sanity check: Only run system tests if the environment variable is set. - if not os.environ.get('GOOGLE_APPLICATION_CREDENTIALS', ''): - session.skip('Credentials must be set via environment variable.') + system_test_path = os.path.join("tests", "system.py") + system_test_folder_path = os.path.join("tests", "system") + # Sanity check: Only run tests if the environment variable is set. + if not os.environ.get("GOOGLE_APPLICATION_CREDENTIALS", ""): + session.skip("Credentials must be set via environment variable") + + system_test_exists = os.path.exists(system_test_path) + system_test_folder_exists = os.path.exists(system_test_folder_path) + # Sanity check: only run tests if found. + if not system_test_exists and not system_test_folder_exists: + session.skip("System tests were not found") # Use pre-release gRPC for system tests. - session.install('--pre', 'grpcio') + session.install("--pre", "grpcio") # Install all test dependencies, then install this package into the # virtualenv's dist-packages. - session.install('mock', 'pytest', *LOCAL_DEPS) - session.install('../test_utils/', '../storage/') - session.install('.') + session.install("mock", "pytest") + for local_dep in LOCAL_DEPS: + session.install("-e", local_dep) + session.install("-e", "../test_utils/") + session.install("-e", ".") # Run py.test against the system tests. - session.run('py.test', '--quiet', os.path.join('tests', 'system')) - - -@nox.session(python='3.6') -def lint(session): - """Run linters. - - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install('flake8', *LOCAL_DEPS) - session.install('.') - session.run('flake8', 'google', 'tests') - + if system_test_exists: + session.run("py.test", "--quiet", system_test_path, *session.posargs) + if system_test_folder_exists: + session.run("py.test", "--quiet", system_test_folder_path, *session.posargs) -@nox.session(python='3.6') -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install('docutils', 'Pygments') - session.run( - 'python', 'setup.py', 'check', '--restructuredtext', '--strict') - - -@nox.session(python='3.6') +@nox.session(python="3.7") def cover(session): """Run the final coverage report. This outputs the coverage report aggregating coverage from the unit test runs (not system test runs), and then erases coverage data. """ - session.chdir(os.path.dirname(__file__)) - session.install('coverage', 'pytest-cov') - session.run('coverage', 'report', '--show-missing', '--fail-under=100') - session.run('coverage', 'erase') + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") diff --git a/packages/google-cloud-python-speech/synth.py b/packages/google-cloud-python-speech/synth.py index 8940d0f42c0c..ffc94a7ad780 100644 --- a/packages/google-cloud-python-speech/synth.py +++ b/packages/google-cloud-python-speech/synth.py @@ -20,37 +20,43 @@ from synthtool import gcp gapic = gcp.GAPICGenerator() - -versions = ['v1p1beta1', 'v1'] +common = gcp.CommonTemplates() +versions = ["v1p1beta1", "v1"] +# ---------------------------------------------------------------------------- +# Generate speech GAPIC layer +# ---------------------------------------------------------------------------- for version in versions: - library = gapic.py_library('speech', version) + library = gapic.py_library("speech", version) # Don't move over __init__.py, as we modify it to make the generated client # use helpers.py. - s.move(library / f'google/cloud/speech_{version}/types.py') - s.move(library / f'google/cloud/speech_{version}/gapic') - s.move(library / f'google/cloud/speech_{version}/proto') - s.move(library / f'tests/unit/gapic/{version}') - s.move(library / f'docs/gapic/{version}') + s.move(library / f"google/cloud/speech_{version}/types.py") + s.move(library / f"google/cloud/speech_{version}/gapic") + s.move(library / f"google/cloud/speech_{version}/proto") + s.move(library / f"tests/unit/gapic/{version}") + s.move(library / f"docs/gapic/{version}") # Use the highest version library to generate documentation import alias. -s.move(library / 'google/cloud/speech.py') - +s.move(library / "google/cloud/speech.py") # Issues exist where python files should define the source encoding # https://github.com/googleapis/gapic-generator/issues/2097 -s.replace( - '**/proto/*_pb2.py', - r"(^.*$\n)*", - r"# -*- coding: utf-8 -*-\n\g<0>") +s.replace("**/proto/*_pb2.py", r"(^.*$\n)*", r"# -*- coding: utf-8 -*-\n\g<0>") # Fix tests to use the direct gapic client instead of the wrapped helper # client. s.replace( - 'tests/unit/**/test*client*.py', - r'from google\.cloud import speech_(.+?)$', - r'from google.cloud.speech_\1.gapic import speech_client as speech_\1') + "tests/unit/**/test*client*.py", + r"from google\.cloud import speech_(.+?)$", + r"from google.cloud.speech_\1.gapic import speech_client as speech_\1", +) + +# ---------------------------------------------------------------------------- +# Add templated files +# ---------------------------------------------------------------------------- +templated_files = common.py_library(unit_cov_level=97, cov_level=100) +s.move(templated_files)