mirror of
https://github.com/OMGeeky/flucto-heisskleber.git
synced 2026-01-04 10:40:34 +01:00
137 lines
3.7 KiB
Python
137 lines
3.7 KiB
Python
"""Nox sessions."""
|
|
import os
|
|
import shutil
|
|
import sys
|
|
from pathlib import Path
|
|
from textwrap import dedent
|
|
|
|
import nox
|
|
|
|
try:
|
|
from nox_poetry import Session, session
|
|
except ImportError:
|
|
message = f"""\
|
|
Nox failed to import the 'nox-poetry' package.
|
|
|
|
Please install it using the following command:
|
|
|
|
{sys.executable} -m pip install nox-poetry"""
|
|
raise SystemExit(dedent(message)) from None
|
|
|
|
|
|
package = "heisskleber"
|
|
locations = package, "tests", "docs/conf.py"
|
|
|
|
python_versions = ["3.9"] # ["3.10", "3.9", "3.11"]
|
|
nox.needs_version = ">= 2021.6.6"
|
|
nox.options.sessions = (
|
|
"mypy",
|
|
"tests",
|
|
"lint",
|
|
"typeguard",
|
|
"xdoctest",
|
|
"docs-build",
|
|
)
|
|
|
|
|
|
@session(python=python_versions[0])
|
|
def lint(session: Session) -> None:
|
|
"""Lint using ruff."""
|
|
args = session.posargs or locations
|
|
session.install("ruff")
|
|
session.run("ruff", *args)
|
|
|
|
|
|
@session(python=python_versions)
|
|
def mypy(session: Session) -> None:
|
|
"""Type-check using mypy."""
|
|
args = session.posargs or locations
|
|
session.install(".")
|
|
session.install("mypy", "pytest")
|
|
session.run("mypy", *args)
|
|
if not session.posargs:
|
|
session.run("mypy", f"--python-executable={sys.executable}", "noxfile.py")
|
|
|
|
|
|
@session(python=python_versions)
|
|
def tests(session: Session) -> None:
|
|
"""Run the test suite."""
|
|
session.install(".")
|
|
session.install("coverage[toml]", "pytest", "pygments")
|
|
try:
|
|
session.run("coverage", "run", "--parallel", "-m", "pytest", *session.posargs)
|
|
finally:
|
|
if session.interactive:
|
|
session.notify("coverage", posargs=[])
|
|
|
|
|
|
@session(python=python_versions[0])
|
|
def coverage(session: Session) -> None:
|
|
"""Produce the coverage report."""
|
|
args = session.posargs or ["report"]
|
|
|
|
session.install("coverage[toml]")
|
|
|
|
if not session.posargs and any(Path().glob(".coverage.*")):
|
|
session.run("coverage", "combine")
|
|
|
|
session.run("coverage", *args)
|
|
|
|
|
|
@session(python=python_versions[0])
|
|
def typeguard(session: Session) -> None:
|
|
"""Runtime type checking using Typeguard."""
|
|
session.install(".")
|
|
session.install("pytest", "typeguard", "pygments")
|
|
session.run("pytest", f"--typeguard-packages={package}", *session.posargs)
|
|
|
|
|
|
@session(python=python_versions)
|
|
def xdoctest(session: Session) -> None:
|
|
"""Run examples with xdoctest."""
|
|
if session.posargs:
|
|
args = [package, *session.posargs]
|
|
else:
|
|
args = [f"--modname={package}", "--command=all"]
|
|
if "FORCE_COLOR" in os.environ:
|
|
args.append("--colored=1")
|
|
|
|
session.install(".")
|
|
session.install("xdoctest[colors]")
|
|
session.run("python", "-m", "xdoctest", *args)
|
|
|
|
|
|
@session(name="docs-build", python=python_versions[0])
|
|
def docs_build(session: Session) -> None:
|
|
"""Build the documentation."""
|
|
args = session.posargs or ["docs", "docs/_build"]
|
|
if not session.posargs and "FORCE_COLOR" in os.environ:
|
|
args.insert(0, "--color")
|
|
|
|
session.install(".")
|
|
session.install(
|
|
"sphinx", "sphinx-autodoc-typehints", "sphinx-rtd-theme", "myst-parser"
|
|
)
|
|
|
|
build_dir = Path("docs", "_build")
|
|
if build_dir.exists():
|
|
shutil.rmtree(build_dir)
|
|
|
|
session.run("sphinx-build", *args)
|
|
|
|
|
|
@session(python=python_versions[0])
|
|
def docs(session: Session) -> None:
|
|
"""Build and serve the documentation with live reloading on file changes."""
|
|
args = session.posargs or ["--open-browser", "docs", "docs/_build"]
|
|
session.install(".")
|
|
session.install(
|
|
"sphinx", "sphinx-autodoc-typehints", "sphinx-rtd-theme", "myst-parser"
|
|
)
|
|
|
|
build_dir = Path("docs", "_build")
|
|
if build_dir.exists():
|
|
shutil.rmtree(build_dir)
|
|
|
|
session.run("sphinx-autobuild", *args)
|