pyprefab/noxfile.py at main · bsweger/pyprefab · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
import nox

nox.options.default_venv_backend = "uv"

PYPROJECT = nox.project.load_toml("pyproject.toml")
PYTHON_VERSIONS = nox.project.python_versions(PYPROJECT)
# assume that the programming version classifies in pyproject.toml are in ascending order
PYTHON_LATEST = PYTHON_VERSIONS[-1]
COVERAGE_THRESHOLD = 90


@nox.session(tags=["checks", "ci"])
def lint(session: nox.Session) -> None:
    """Run the linter."""
    session.install("ruff")
    session.run("ruff", "check", ".")


@nox.session(tags=["checks", "ci"])
def typecheck(session: nox.Session) -> None:
    """Run static type checking."""
    session.install("mypy")
    session.run("mypy", "src", "test")


@nox.session(python=PYTHON_VERSIONS, tags=["checks", "ci"])
def tests(session: nox.Session) -> None:
    """Install dependencies from lockfile and run tests."""
    session.run_install(
        "uv",
        "sync",
        "--active",
        "--group=dev",
        "--frozen",
        "--quiet",
        f"--python={session.virtualenv.location}",
    )
    session.run("pytest")


@nox.session(tags=["checks", "ci"], python=PYTHON_LATEST, requires=[f"tests-{PYTHON_LATEST}"])
def coverage(session) -> None:
    """Check test coverage."""
    session.run_install(
        "uv",
        "sync",
        "--active",
        "--group=dev",
        "--frozen",
        "--quiet",
        f"--python={session.virtualenv.location}",
    )
    session.run("coverage", "erase", silent=True)
    session.run("coverage", "run", "-m", "pytest", "--quiet", "--no-header", "--no-summary", silent=True)
    session.run("coverage", "html", "--skip-covered", "--skip-empty", silent=True)
    session.run(
        "coverage",
        "report",
        "--format",
        "markdown",
        f"--fail-under={COVERAGE_THRESHOLD}",
    )


@nox.session(python=PYTHON_VERSIONS)
def test_dev_install(session: nox.Session) -> None:
    """Install as a package and run tests."""
    session.run_install(
        "uv",
        "sync",
        "--active",
        "--group=dev",
    )
    session.run("pytest")


@nox.session(python=PYTHON_VERSIONS)
def test_pypi_install(session: nox.Session) -> None:
    """Install as a package and run tests."""
    session.run_install("uv", "pip", "install", "pyprefab")


@nox.session(python=PYTHON_LATEST, tags=["checks", "ci"])
def docs(session: nox.Session) -> None:
    """Build the documentation."""
    session.run_install(
        "uv",
        "sync",
        "--active",
        "--group=docs",
        "--frozen",
        "--quiet",
        f"--python={session.virtualenv.location}",
    )
    session.run("sphinx-build", "-W", "-b", "html", "docs/source", "docs/_build/html")


@nox.session(default=False)
def docs_serve(session: nox.Session) -> None:
    """Serve the documentation locally."""
    session.run_install(
        "uv",
        "sync",
        "--active",
        "--group=docs",
        "--frozen",
        "--quiet",
        f"--python={session.virtualenv.location}",
    )
    session.run("sphinx-autobuild", "docs/source", "docs/_build/html", external=True)