Skip to content

Commit

Permalink
Add templates for flake8, coveragerc, noxfile, and black. (#6642)
Browse files Browse the repository at this point in the history
  • Loading branch information
@crwilcox
crwilcox authored Nov 28, 2018
1 parent ea46909 commit e169d5d
Show file tree
Hide file tree
Showing 4 changed files with 142 additions and 101 deletions.
8 changes: 6 additions & 2 deletions packages/google-cloud-vision/.coveragerc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ exclude_lines =
pragma: NO COVER
# Ignore debug-only repr
def __repr__
# Ignore abstract methods
raise NotImplementedError
omit =
google/cloud/vision_v1/gapic/*.py
google/cloud/vision_v1/proto/*.py
*/gapic/*.py
*/proto/*.py
*/google-cloud-python/core/*.py
*/site-packages/*.py
1 change: 1 addition & 0 deletions packages/google-cloud-vision/.flake8
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[flake8]
ignore = E203, E266, E501, W503
exclude =
# Exclude generated code.
**/proto/**
Expand Down
160 changes: 93 additions & 67 deletions packages/google-cloud-vision/noxfile.py
View file
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -13,103 +15,127 @@
# limitations under the License.

from __future__ import absolute_import

import os

import nox


LOCAL_DEPS = (
os.path.join('..', 'api_core'),
os.path.join('..', '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.
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.
Format code to uniform standard.
"""
# Install all test dependencies, then install this package in-place.
session.install('mock', 'pytest', 'pytest-cov', *LOCAL_DEPS)
session.install('-e', '.')

# Run py.test against the unit tests.
session.install("black")
session.run(
'py.test',
'--quiet',
'--cov=google.cloud.vision',
'--cov=google.cloud.vision_v1',
'--cov-append',
'--cov-config=.coveragerc',
'--cov-report=',
'tests',
*session.posargs
"black",
"google",
"tests",
"docs",
"--exclude",
".*/proto/.*|.*/gapic/.*|.*/.*_pb2.py",
)


@nox.session(python=['2.7', '3.5', '3.6', '3.7'])
def unit(session):
"""Run the unit test suite."""
default(session)
@nox.session(python="3.7")
def lint(session):
"""Run linters.
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=['2.7', '3.6'])
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.')
@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")

# Use pre-release gRPC for system tests.
session.install('--pre', 'grpcio')

def default(session):
# Install all test dependencies, then install this package in-place.
session.install('pytest', '../core/', '../storage/')
session.install('../test_utils/')
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',
os.path.join('tests', 'system.py'),
*session.posargs
"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='3.6')
def lint(session):
"""Run linters.
@nox.session(python=["2.7", "3.5", "3.6", "3.7"])
def unit(session):
"""Run the unit test suite."""
default(session)

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')

@nox.session(python=["2.7", "3.7"])
def system(session):
"""Run the system test suite."""
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")

@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')
# Use pre-release gRPC for system tests.
session.install("--pre", "grpcio")

# Install all test dependencies, then install this package into the
# virtualenv's dist-packages.
session.install("mock", "pytest")
for local_dep in LOCAL_DEPS:
session.install("-e", local_dep)
session.install("-e", "../test_utils/")
session.install("-e", "../storage")
session.install("-e", ".")

# Run py.test against the system 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')

@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')
session.run('coverage', 'erase')
session.install("coverage", "pytest-cov")
session.run("coverage", "report", "--show-missing", "--fail-under=100")

session.run("coverage", "erase")
74 changes: 42 additions & 32 deletions packages/google-cloud-vision/synth.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,55 +18,65 @@
from synthtool import gcp

gapic = gcp.GAPICGenerator()

versions = ['v1', 'v1p1beta1', 'v1p2beta1', 'v1p3beta1']
common = gcp.CommonTemplates()
versions = ["v1", "v1p1beta1", "v1p2beta1", "v1p3beta1"]


# ----------------------------------------------------------------------------
# Generate vision GAPIC layer
# ----------------------------------------------------------------------------
for version in versions:
library = gapic.py_library('vision', version)
library = gapic.py_library("vision", version)

s.move(library / f'google/cloud/vision_{version}/gapic')
s.move(library / f'google/cloud/vision_{version}/__init__.py')
s.move(library / f'google/cloud/vision_{version}/types.py')
s.move(library / f'google/cloud/vision_{version}/proto')
s.move(library / f'tests/unit/gapic/{version}')
s.move(library / f"google/cloud/vision_{version}/gapic")
s.move(library / f"google/cloud/vision_{version}/__init__.py")
s.move(library / f"google/cloud/vision_{version}/types.py")
s.move(library / f"google/cloud/vision_{version}/proto")
s.move(library / f"tests/unit/gapic/{version}")
# don't publish docs for these versions
if version not in ['v1p1beta1']:
s.move(library / f'docs/gapic/{version}')
if version not in ["v1p1beta1"]:
s.move(library / f"docs/gapic/{version}")

# Add vision helpers to each version
s.replace(
f'google/cloud/vision_{version}/__init__.py',
f'from __future__ import absolute_import', f'\g<0>\n\n'
f'from google.cloud.vision_helpers.decorators import '
f'add_single_feature_methods\n'
f'from google.cloud.vision_helpers import VisionHelpers')
f"google/cloud/vision_{version}/__init__.py",
f"from __future__ import absolute_import",
f"\g<0>\n\n"
f"from google.cloud.vision_helpers.decorators import "
f"add_single_feature_methods\n"
f"from google.cloud.vision_helpers import VisionHelpers",
)

s.replace(
f'google/cloud/vision_{version}/__init__.py',
f'image_annotator_client',
f'iac')
f"google/cloud/vision_{version}/__init__.py", f"image_annotator_client", f"iac"
)

s.replace(
f'google/cloud/vision_{version}/__init__.py',
f'from google.cloud.vision_{version}.gapic import iac',
f'from google.cloud.vision_{version}.gapic import '
f'image_annotator_client as iac')
f"google/cloud/vision_{version}/__init__.py",
f"from google.cloud.vision_{version}.gapic import iac",
f"from google.cloud.vision_{version}.gapic import "
f"image_annotator_client as iac",
)

s.replace(
f'google/cloud/vision_{version}/__init__.py',
f'class ImageAnnotatorClient\(iac.ImageAnnotatorClient\):',
f'@add_single_feature_methods\n'
f'class ImageAnnotatorClient(VisionHelpers, iac.ImageAnnotatorClient):'
f"google/cloud/vision_{version}/__init__.py",
f"class ImageAnnotatorClient\(iac.ImageAnnotatorClient\):",
f"@add_single_feature_methods\n"
f"class ImageAnnotatorClient(VisionHelpers, iac.ImageAnnotatorClient):",
)

# Fix import of operations
targets = [
'google/cloud/vision_*/**/*.py',
'tests/system/gapic/*/**/*.py',
]
targets = ["google/cloud/vision_*/**/*.py", "tests/system/gapic/*/**/*.py"]
s.replace(
targets,
'import google.api_core.operations_v1',
'from google.api_core import operations_v1',
"import google.api_core.operations_v1",
"from google.api_core import operations_v1",
)

# ----------------------------------------------------------------------------
# Add templated files
# ----------------------------------------------------------------------------
templated_files = common.py_library(
unit_cov_level=97, cov_level=100, system_test_dependencies=["../storage"]
)
s.move(templated_files)

0 comments on commit e169d5d

Please sign in to comment.