Add templates for flake8, coveragerc, noxfile, and black. (#6642)

Author: crwilcox

.coveragerc

@@ -9,3 +9,10 @@ exclude_lines =
     pragma: NO COVER
     # Ignore debug-only repr
     def __repr__
+    # Ignore abstract methods
+    raise NotImplementedError
+omit =
+  */gapic/*.py
+  */proto/*.py
+  */google-cloud-python/core/*.py
+  */site-packages/*.py

.flake8

@@ -1,4 +1,5 @@
 [flake8]
+ignore = E203, E266, E501, W503
 exclude =
   # Exclude generated code.
   **/proto/**

MANIFEST.in

@@ -1,4 +1,5 @@
 include README.rst LICENSE
 recursive-include google *.json *.proto
 recursive-include tests *
-global-exclude *.pyc __pycache__
+global-exclude *.py[co]
+global-exclude __pycache__

noxfile.py

@@ -33,11 +33,54 @@
     'webob',
 )
 
+@nox.session(python="3.7")
+def blacken(session):
+    """Run black.
+
+    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.
+
+    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, django_dep=('django',)):
     """Default unit test session.
     """
-  
+
     # Install all test dependencies, then install this package in-place.
     deps = UNIT_TEST_DEPS
     deps += django_dep
@@ -114,34 +157,14 @@ def system(session):
         *session.posargs)
 
 
-@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')
-
-
-@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.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")

synth.py

@@ -17,24 +17,29 @@
 from synthtool import gcp
 
 gapic = gcp.GAPICGenerator()
+common = gcp.CommonTemplates()
 
-
-#----------------------------------------------------------------------------
-# Generate logging client
-#----------------------------------------------------------------------------
+# ----------------------------------------------------------------------------
+# Generate logging GAPIC layer
+# ----------------------------------------------------------------------------
 library = gapic.py_library(
-    'logging',
-    'v2',
-    config_path='/google/logging/artman_logging.yaml',
-    artman_output_name='logging-v2')
+    "logging",
+    "v2",
+    config_path="/google/logging/artman_logging.yaml",
+    artman_output_name="logging-v2",
+)
 
-s.move(library / 'google/cloud/logging_v2/proto')
-s.move(library / 'google/cloud/logging_v2/gapic')
-s.move(library / 'tests/unit/gapic/v2')
+s.move(library / "google/cloud/logging_v2/proto")
+s.move(library / "google/cloud/logging_v2/gapic")
+s.move(library / "tests/unit/gapic/v2")
 
 # Issues exist where python files should define the source encoding
 # https://github.com/googleapis/gapic-generator/issues/2097
-s.replace(
-    'google/**/proto/*_pb2.py',
-    r"(^.*$\n)*",
-    r"# -*- coding: utf-8 -*-\n\g<0>")
+s.replace("google/**/proto/*_pb2.py", r"(^.*$\n)*", r"# -*- coding: utf-8 -*-\n\g<0>")
+
+# ----------------------------------------------------------------------------
+# Add templated files
+# ----------------------------------------------------------------------------
+templated_files = common.py_library(unit_cov_level=95, cov_level=100)
+# Don't move noxfile. logging has special testing setups for django, etc
+s.move(templated_files, exclude="noxfile.py")