Nox: Python自動化タスクランナーの徹底解説

pipx install nox
      

python3 -m pip install --user pipx
python3 -m pipx ensurepath
      

python3 -m pip install --user nox
      

nox --version
      

pip show nox
      

import nox

# @nox.sessionデコレータを使ってセッションを定義
@nox.session
def lint(session):
    """コードの静的解析を実行するセッション"""
    # セッション内で使用するライブラリをインストール
    session.install("flake8")
    # インストールしたコマンドを実行
    session.run("flake8", ".", "--count", "--select=E9,F63,F7,F82", "--show-source", "--statistics")

@nox.session(python=["3.9", "3.10", "3.11", "3.12"]) # 複数のPythonバージョンを指定
def tests(session):
    """pytestを使ってテストを実行するセッション"""
    # 現在のプロジェクトとテスト用依存ライブラリをインストール
    # requirements.txt や pyproject.toml (Poetry, PDMなど) があればそれらも利用可能
    session.install(".[test]") # もし `.[test]` のようなextraがあれば
    # session.install("pytest", "pytest-cov") # 個別に指定も可能
    # pytestを実行。 session.posargs を使うと、noxコマンド経由で引数を渡せる
    session.run("pytest", *session.posargs)
      

nox -l
# または
nox --list
      

nox
      

nox -s lint
# または
nox --session lint
      

nox -s lint tests-3.10
      

nox -p 3.11
# または
nox --python 3.11
      

# pytestに `-k "特定のテスト名"` と `-v` オプションを渡す
nox -s tests -- -k "特定のテスト名" -v
      

import nox

@nox.session
@nox.parametrize(
    "django_version",
    ["3.2", "4.0", "4.1"]
)
def tests(session, django_version):
    session.install(f"django=={django_version}", "pytest", ".")
    session.run("pytest")

# 実行されるセッション:
# tests(django_version='3.2')
# tests(django_version='4.0')
# tests(django_version='4.1')
      

import nox

@nox.session(python=["3.10", "3.11"])
@nox.parametrize(
    "db_backend",
    ["sqlite", "postgres"]
)
def tests(session, db_backend):
    session.install(f".[{db_backend}]", "pytest")
    # 環境変数を使ってDBバックエンドを指定する例
    env = {"DATABASE_URL": f"{db_backend}://..."}
    session.run("pytest", env=env)

# 実行されるセッション例:
# tests-3.10(db_backend='sqlite')
# tests-3.10(db_backend='postgres')
# tests-3.11(db_backend='sqlite')
# tests-3.11(db_backend='postgres')
      

import nox

@nox.session(tags=["test"])
def unit_tests(session):
    session.install(".[test]", "pytest")
    session.run("pytest", "tests/unit")

@nox.session(tags=["test", "integration"])
def integration_tests(session):
    session.install(".[test]", "pytest", "docker")
    # Dockerコンテナ起動などの前処理
    session.run("pytest", "tests/integration")

@nox.session(tags=["lint"])
def linting(session):
    session.install("flake8", "black", "isort")
    session.run("flake8", ".")
    session.run("black", "--check", ".")
    session.run("isort", "--check-only", ".")

@nox.session(tags=["docs"])
def build_docs(session):
    session.install(".[docs]", "sphinx")
    session.run("sphinx-build", "docs/", "docs/_build/html")
      

import nox

# 共通の設定
nox.options.sessions = ["lint", "tests"] # noxコマンドでデフォルト実行されるセッションを指定
nox.options.stop_on_first_error = True # 最初のセッション失敗で停止

# Pythonバージョンのリストを共通化
SUPPORTED_PYTHONS = ["3.9", "3.10", "3.11", "3.12"]

# 共通のインストール処理を関数化
def install_dev_deps(session):
    session.install("-r", "requirements-dev.txt")
    session.install(".")

@nox.session(python=SUPPORTED_PYTHONS)
def tests(session):
    install_dev_deps(session)
    session.run("pytest", *session.posargs)

@nox.session
def lint(session):
    install_dev_deps(session)
    session.run("flake8", ".")
    session.run("black", "--check", ".")

@nox.session
def format(session):
    """コードフォーマットを実行する (デフォルトでは実行されない)"""
    install_dev_deps(session)
    session.run("black", ".")
    session.run("isort", ".")
      

# PoetryやPDMプロジェクトでのテストセッション例
import nox

@nox.session(python=["3.10", "3.11"])
def tests(session):
    # Poetry/PDMが管理する依存関係を含めてインストール
    session.install(".[test]") # Poetryの extras や PDM の dev-dependencies グループなど
    session.run("pytest")

@nox.session
def lint(session):
    # Poetry/PDMでdev依存として管理されているリンターをインストール
    session.install(".[lint]") # 例: [tool.poetry.group.lint.dependencies] や [tool.pdm.dev-dependencies]
    session.run("flake8")
    session.run("mypy")
      

import nox

# uv が利用可能であればデフォルトのバックエンドとして設定 (Nox 2024.3.2以降が必要)
nox.needs_version = ">=2024.3.2"
nox.options.default_venv_backend = "uv|virtualenv" # uvがあればuvを、なければvirtualenvを使う

@nox.session
def tests(session):
    # uvを使って高速にインストールされる
    session.install("pytest", ".")
    session.run("pytest")
      

import nox
import tempfile
import os

# デフォルトセッションの設定
nox.options.sessions = ["lint", "mypy", "tests"]
# 使用するPythonバージョン
PYTHON_VERSIONS = ["3.9", "3.10", "3.11", "3.12"]


def install_with_constraints(session, *args, **kwargs):
    # Poetryを使用している場合、exportして制約ファイルとして使う例
    # requirements.txt がある場合はそれを使うなど、プロジェクトに合わせて調整
    with tempfile.NamedTemporaryFile(delete=False) as requirements:
        session.run(
            "poetry",
            "export",
            "--dev",
            "--format=requirements.txt",
            f"--output={requirements.name}",
            external=True, # poetryは通常仮想環境外にあるため
        )
        session.install(f"--constraint={requirements.name}", *args, **kwargs)
    os.unlink(requirements.name)


@nox.session(python=PYTHON_VERSIONS)
def tests(session):
    """Pytestでテストを実行し、カバレッジレポートを生成する"""
    args = session.posargs or ["--cov=src", "--cov-report=term-missing", "--cov-report=xml"]
    session.run("poetry", "install", "--no-dev", external=True) # プロジェクト本体をインストール
    install_with_constraints(session, "pytest", "pytest-cov")
    session.run("pytest", *args)


@nox.session(python=PYTHON_VERSIONS[-1]) # 最新のPythonでLintを実行
def lint(session):
    """Flake8, Black, isortでリンティングを実行する"""
    args = session.posargs or ["src", "tests", "noxfile.py"]
    install_with_constraints(
        session,
        "flake8",
        "flake8-black",
        "flake8-isort",
        "flake8-bugbear",
        "flake8-bandit",
        "flake8-docstrings",
    )
    session.run("flake8", *args)


@nox.session(python=PYTHON_VERSIONS[-1])
def black(session):
    """Blackでコードフォーマットをチェックする"""
    args = session.posargs or ["--check", "."]
    install_with_constraints(session, "black")
    session.run("black", *args)


@nox.session(python=PYTHON_VERSIONS[-1])
def isort(session):
    """isortでimport順をチェックする"""
    args = session.posargs or ["--check-only", "."]
    install_with_constraints(session, "isort")
    session.run("isort", *args)


@nox.session(python=PYTHON_VERSIONS)
def mypy(session):
    """MyPyで型チェックを実行する"""
    args = session.posargs or ["src"]
    install_with_constraints(session, "mypy")
    session.run("mypy", *args)


@nox.session(python=PYTHON_VERSIONS[-1])
def docs(session):
    """Sphinxでドキュメントをビルドする"""
    session.run("poetry", "install", "--only=docs", external=True)
    install_with_constraints(session, "sphinx", "sphinx-rtd-theme")
    session.run("sphinx-build", "docs", "docs/_build/html")


@nox.session(python=PYTHON_VERSIONS[-1])
def build(session):
    """ホイールとsdistをビルドする"""
    install_with_constraints(session, "build")
    session.run("python", "-m", "build")