googleapis · daniel-sanche · Dec 12, 2020 · Dec 10, 2020 · Dec 10, 2020 · Dec 10, 2020
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,17 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.3.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+-   repo: https://github.com/psf/black
+    rev: 19.10b0
+    hooks:
+    - id: black
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.4
+    hooks:
+    - id: flake8
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -111,6 +111,16 @@ Coding Style
  should point to the official ``googleapis`` checkout and the
  the branch should be the main branch on that remote (``master``).

+- This repository contains configuration for the
+  `pre-commit <https://pre-commit.com/>`__ tool, which automates checking
+  our linters during a commit.  If you have it installed on your ``$PATH``,
+  you can enable enforcing those checks via:
+
+.. code-block:: bash
+
+   $ pre-commit install
+   pre-commit installed at .git/hooks/pre-commit
+
 Exceptions to PEP8:

 - Many unit tests use a helper method, ``_call_fut`` ("FUT" is short for

diff --git a/noxfile.py b/noxfile.py
@@ -79,9 +79,8 @@ def default(session):
    session.run(
        "py.test",
        "--quiet",
-        "--cov=google.cloud.logging",
-        "--cov=google.cloud",
-        "--cov=tests.unit",
+        "--cov=google/cloud",
+        "--cov=tests/unit",
        "--cov-append",
        "--cov-config=.coveragerc",
        "--cov-report=",

diff --git a/samples/snippets/README.rst b/samples/snippets/README.rst
diff --git a/samples/snippets/noxfile.py b/samples/snippets/noxfile.py
@@ -17,6 +17,7 @@
 import os
 from pathlib import Path
 import sys
+from typing import Callable, Dict, List, Optional

 import nox

@@ -68,7 +69,7 @@
 TEST_CONFIG.update(TEST_CONFIG_OVERRIDE)


-def get_pytest_env_vars():
+def get_pytest_env_vars() -> Dict[str, str]:
    """Returns a dict for pytest invocation."""
    ret = {}

@@ -97,7 +98,7 @@ def get_pytest_env_vars():
 #


-def _determine_local_import_names(start_dir):
+def _determine_local_import_names(start_dir: str) -> List[str]:
    """Determines all import names that should be considered "local".

    This is used when running the linter to insure that import order is
@@ -135,7 +136,7 @@ def _determine_local_import_names(start_dir):


 @nox.session
-def lint(session):
+def lint(session: nox.sessions.Session) -> None:
    if not TEST_CONFIG['enforce_type_hints']:
        session.install("flake8", "flake8-import-order")
    else:
@@ -148,15 +149,13 @@ def lint(session):
        "."
    ]
    session.run("flake8", *args)
-
-
 #
 # Black
 #


 @nox.session
-def blacken(session):
+def blacken(session: nox.sessions.Session) -> None:
    session.install("black")
    python_files = [path for path in os.listdir(".") if path.endswith(".py")]

@@ -170,7 +169,7 @@ def blacken(session):
 PYTEST_COMMON_ARGS = ["--junitxml=sponge_log.xml"]


-def _session_tests(session, post_install=None):
+def _session_tests(session: nox.sessions.Session, post_install: Callable = None) -> None:
    """Runs py.test for a particular project."""
    if os.path.exists("requirements.txt"):
        session.install("-r", "requirements.txt")
@@ -196,7 +195,7 @@ def _session_tests(session, post_install=None):


 @nox.session(python=ALL_VERSIONS)
-def py(session):
+def py(session: nox.sessions.Session) -> None:
    """Runs py.test for a sample using the specified version of Python."""
    if session.python in TESTED_VERSIONS:
        _session_tests(session)
@@ -211,7 +210,7 @@ def py(session):
 #


-def _get_repo_root():
+def _get_repo_root() -> Optional[str]:
    """ Returns the root folder of the project. """
    # Get root of this repository. Assume we don't have directories nested deeper than 10 items.
    p = Path(os.getcwd())
@@ -234,7 +233,7 @@ def _get_repo_root():

 @nox.session
 @nox.parametrize("path", GENERATED_READMES)
-def readmegen(session, path):
+def readmegen(session: nox.sessions.Session, path: str) -> None:
    """(Re-)generates the readme for a sample."""
    session.install("jinja2", "pyyaml")
    dir_ = os.path.dirname(path)

diff --git a/synth.metadata b/synth.metadata
@@ -4,7 +4,7 @@
      "git": {
        "name": ".",
        "remote": "https://github.com/googleapis/python-logging.git",
-        "sha": "4e24b3c360adef8d7761573d789867857586337d"
+        "sha": "7eaa5853f3a45e3db015a09841b98aeab461e6f3"
      }
    },
    {
@@ -19,14 +19,14 @@
      "git": {
        "name": "synthtool",
        "remote": "https://github.com/googleapis/synthtool.git",
-        "sha": "a073c873f3928c561bdf87fdfbf1d081d1998984"
+        "sha": "18c5dbdb4ac8cf75d4d8174e7b4558f48e76f8a1"
      }
    },
    {
      "git": {
        "name": "synthtool",
        "remote": "https://github.com/googleapis/synthtool.git",
-        "sha": "a073c873f3928c561bdf87fdfbf1d081d1998984"
+        "sha": "18c5dbdb4ac8cf75d4d8174e7b4558f48e76f8a1"
      }
    }
  ],
@@ -85,6 +85,7 @@
    ".kokoro/test-samples.sh",
    ".kokoro/trampoline.sh",
    ".kokoro/trampoline_v2.sh",
+    ".pre-commit-config.yaml",
    ".trampolinerc",
    "CODE_OF_CONDUCT.md",
    "CONTRIBUTING.rst",
@@ -134,7 +135,6 @@
    "renovate.json",
    "samples/AUTHORING_GUIDE.md",
    "samples/CONTRIBUTING.md",
-    "samples/snippets/README.rst",
    "samples/snippets/noxfile.py",
    "scripts/decrypt-secrets.sh",
    "scripts/readme-gen/readme_gen.py",