"""Nox sessions.""" import tempfile from typing import Any import nox from nox.sessions import Session package = "text-recognizer" versions = ["3.9"] nox.options.sessions = "lint", "mypy", "safety", "tests" locations = ( "text_recognizer", "training", "tests", "noxfile.py", ) def install_with_constraints(session: Session, *args: str, **kwargs: Any) -> None: """Install packages constrained by Poetry's lock file. This function is a wrapper for nox.sessions.Session.install. It invokes pip to install packages inside of the session's virtualenv. Additionally, pip is passed a constraints file generated from Poetry's lock file, to ensure that the packages are pinned to the versions specified in poetry.lock. This allows you to manage the packages as Poetry development dependencies. Args: session: The Session object. args: Command-line arguments for pip. kwargs: Additional keyword arguments for Session.install. """ with tempfile.NamedTemporaryFile() as requirements: session.run( "poetry", "export", "--dev", "--format=requirements.txt", "--without-hashes", f"--output={requirements.name}", external=True, ) session.install(f"--constraint={requirements.name}", *args, **kwargs) @nox.session(python=versions) def black(session: Session) -> None: """Run black code formatter.""" args = session.posargs or locations install_with_constraints(session, "black") session.run("black", *args) @nox.session(python=versions) def lint(session: Session) -> None: """Lint using flake8.""" args = session.posargs or locations install_with_constraints( session, "flake8", "flake8-annotations", "flake8-bandit", "flake8-black", "flake8-bugbear", "flake8-docstrings", "flake8-import-order", "darglint", ) session.run("flake8", *args) @nox.session(python=versions) def safety(session: Session) -> None: """Scan dependencies for insecure packages.""" with tempfile.NamedTemporaryFile() as requirements: session.run( "poetry", "export", "--dev", "--format=requirements.txt", "--without-hashes", f"--output={requirements.name}", external=True, ) install_with_constraints(session, "safety") session.run("safety", "check", f"--file={requirements.name}", "--full-report") @nox.session(python=versions) def mypy(session: Session) -> None: """Type-check using mypy.""" args = session.posargs or locations install_with_constraints(session, "mypy") session.run("mypy", *args) @nox.session(python=versions) def tests(session: Session) -> None: """Run the test suite.""" args = session.posargs or ["--cov", "-m", "not e2e"] session.run("poetry", "install", "--no-dev", external=True) install_with_constraints( session, "coverage[toml]", "pytest", "pytest-cov", "pytest-mock" ) session.run("pytest", *args) @nox.session(python=versions) def typeguard(session: Session) -> None: """Runtime type checking using Typeguard.""" args = session.posargs or ["-m", "not e2e"] session.run("poetry", "install", "--no-dev", external=True) install_with_constraints(session, "pytest", "pytest-mock", "typeguard") session.run("pytest", f"--typeguard-packages={package}", *args) @nox.session(python="3.9") def coverage(session: Session) -> None: """Upload coverage data.""" install_with_constraints(session, "coverage[toml]", "codecov") session.run("coverage", "xml", "--fail-under=0") session.run("codecov", *session.posargs)