Pythonのテストカバレッジを測る方法(pytest-cov)とHTML出力

# (任意) 仮想環境を作成して有効化
python -m venv .venv
# Windows
.venv\Scripts\activate
# macOS / Linux
source .venv/bin/activate

# pytest と pytest-cov をインストール
pip install pytest pytest-cov

your_project/
├─ app/
│  ├─ __init__.py # 中身は空でOK
│  └─ calculator.py
└─ tests/
   └─ test_calculator.py

# app/calculator.py
# シンプルな関数をいくつか定義します。条件分岐を入れて、分岐カバレッジの例にも使います。

def add(a, b):
    """2つの数値を足し合わせます。"""
    return a + b

def divide(a, b):
    """0除算を考慮しながら割り算を行います。"""
    if b == 0:
        # ここは例外を発生させる分岐です
        raise ZeroDivisionError("b must not be zero")
    return a / b

def safe_divide(a, b, default=None):
    """0除算時にデフォルト値を返す安全な割り算。default未指定ならNoneを返します。"""
    if b == 0:
        # 条件に応じて2通りの経路があります
        return default if default is not None else None
    return a / b

def greet(name):
    """名前付きの挨拶。nameが空なら 'world' になります。"""
    return f"Hello, {name or 'world'}!"

# tests/test_calculator.py
# いくつかの関数だけテストして、あえて未実行の行を残します。

import pytest
from app.calculator import add, divide, safe_divide, greet

def test_add():
    # 基本的な加算
    assert add(2, 3) == 5

def test_divide_ok():
    # 通常の割り算
    assert divide(10, 2) == 5

def test_divide_zero():
    # 0除算で例外が発生することを確認
    with pytest.raises(ZeroDivisionError):
        divide(1, 0)

def test_safe_divide_default_is_none():
    # default未指定の場合の0除算はNone
    assert safe_divide(1, 0) is None

# greetのデフォルト分岐や safe_divide の default 指定分岐はあえて未テストにしておきます

pytest --cov

pytest --cov=app

============================= test session starts =============================
collected 4 items

tests/test_calculator.py ....                                           [100%]

---------- coverage: platform linux, python 3.11.9-final-0 -----------
Name                  Stmts   Miss  Cover
-----------------------------------------
app/calculator.py        20      3    85%
-----------------------------------------
TOTAL                    20      3    85%

============================== 4 passed in 0.10s =============================

# 単一パッケージ
pytest --cov=app

# 複数パッケージ(例: app と utils の両方)
pytest --cov=app --cov=utils

pytest --cov=app --cov-report=term-missing

pytest --cov=app --cov-branch --cov-report=term-missing

# ターミナル出力とHTMLレポートを同時に生成
pytest --cov=app --cov-report=term-missing --cov-report=html

# プロジェクトルートで実行
python -m http.server 8000
# ブラウザで http://localhost:8000/htmlcov/index.html を開く

pytest --cov=app --cov-report=term-missing --cov-fail-under=90

---------- coverage: platform linux, python 3.11.9-final-0 -----------
Name                  Stmts   Miss  Cover   Missing
---------------------------------------------------
app/calculator.py        20      3    85%   16, 20-21
---------------------------------------------------
TOTAL                    20      3    85%

FAILED Required test coverage of 90% not reached. Total coverage: 85.00%

# アプリケーション本体とユーティリティを測る
pytest --cov=app --cov=utils --cov-report=term-missing

# .coveragerc の例
[run]
# 必要に応じて src レイアウトなどのパスを明示
# source = app

[report]
# レポートから tests 配下を除外
omit =
    tests/*
    */site-packages/*

# 欲しければ分岐カバレッジを常に有効化
# precision などの出力調整も可能
# show_missing = True

[html]
# HTMLの出力先やタイトル
directory = htmlcov
title = Project Coverage Report

your_project/
├─ src/
│  └─ app/
│     ├─ __init__.py
│     └─ calculator.py
└─ tests/
   └─ test_calculator.py

# tests/test_calculator_more.py
# 未実行だった分岐を補う例です。

from app.calculator import greet, safe_divide

def test_greet_default():
    # name が falsy の場合の分岐を実行
    assert greet("") == "Hello, world!"

def test_safe_divide_with_default():
    # default を指定した 0 除算の分岐を実行
    assert safe_divide(1, 0, default=0) == 0

# .coveragerc の例(サブプロセス対応を強化)
[run]
concurrency = multiprocessing
parallel = True