xrtpy/noxfile.py at main · HinodeXRT/xrtpy · 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
import sys

import nox

nox.options.default_venv_backend = "uv"

supported_python_versions = ("3.11", "3.12", "3.13")

maxpython = max(supported_python_versions)
minpython = min(supported_python_versions)
docpython = "3.13"

current_python = f"{sys.version_info.major}.{sys.version_info.minor}"

nox.options.sessions = [f"tests-{current_python}(all)"]

pytest_command: tuple[str, ...] = (
    "pytest",
    "--pyargs",
    "--durations=5",
    "--tb=short",
    "-n=auto",
    "--dist=loadfile",
)

with_coverage: tuple[str, ...] = (
    "--cov=plasmapy",
    "--cov-report=xml",
    "--cov-config=pyproject.toml",
    "--cov-append",
    "--cov-report",
    "xml:coverage.xml",
)

test_specifiers: list = [
    nox.param("run all tests", id="all"),
    nox.param("with code coverage", id="cov"),
    nox.param("lowest-direct", id="lowest-direct"),
]


@nox.session(python=supported_python_versions)
@nox.parametrize("test_specifier", test_specifiers)
def tests(session, test_specifier: nox._parametrize.Param) -> None:
    """Run tests with pytest."""

    install_options = (
        ["--resolution=lowest-direct"] if test_specifier == "lowest-direct" else []
    )

    pytest_options: list[str] = (
        with_coverage if test_specifier == "with code coverage" else []
    )

    session.install("uv")
    session.install(".[tests]", *install_options)

    session.run("pytest", *pytest_options, *session.posargs)


@nox.session
def lint(session: nox.Session) -> None:
    """Run all pre-commit hooks on all files."""
    session.install("pre-commit")
    session.run(
        "pre-commit",
        "run",
        "--all-files",
        "--show-diff-on-failure",
        *session.posargs,
    )


@nox.session
def build(session: nox.Session) -> None:
    """Build & verify the source distribution and wheel."""
    session.install("twine", "build")
    build_command = ("python", "-m", "build")
    session.run(*build_command, "--sdist")
    session.run(*build_command, "--wheel")
    session.run("twine", "check", "dist/*", *session.posargs)


@nox.session(python=docpython)
def docs(session):
    """
    Build documentation with Sphinx.

    This session may require installation of pandoc and graphviz.
    """
    sphinx_paths = ["docs", "docs/_build/html"]
    sphinx_fail_on_warnings = ["-W", "--keep-going"]
    sphinx_builder = ["-b", "html"]
    sphinx_nitpicky = ["-n"]
    sphinx_opts = (
        sphinx_paths + sphinx_fail_on_warnings + sphinx_builder + sphinx_nitpicky
    )
    session.install(".[docs]")
    session.run(
        "sphinx-build",
        *sphinx_opts,
        *sphinx_nitpicky,
        *session.posargs,
    )