Python×pytest入門｜書き方・実行方法・便利機能を最速でマスター

# (任意) 仮想環境の作成
python -m venv .venv

# 仮想環境の有効化 (Windows)
.venv\Scripts\activate

# 仮想環境の有効化 (macOS / Linux)
source .venv/bin/activate

# pytestのインストール
pip install pytest

# インストール確認
pytest --version

# ファイル名: calculator.py

def add(a: int, b: int) -> int:
    """2つの整数を足し合わせて結果を返します。"""
    return a + b


def divide(a: int, b: int) -> float:
    """a を b で割った結果を返します。0割りの場合は ZeroDivisionError が発生します。"""
    return a / b

# ファイル名: test_calculator.py

# calculatorモジュールからテスト対象の関数をインポートします
from calculator import add, divide


def test_add_simple():
    """add関数の基本的な動作をテストします。"""
    # 期待値と実際の結果が一致するかをassertで検証します
    assert add(1, 2) == 3
    assert add(-1, 5) == 4


def test_divide_simple():
    """divide関数の基本的な動作をテストします。"""
    # 浮動小数点の結果もそのまま比較できます
    assert divide(6, 3) == 2
    assert divide(5, 2) == 2.5

# プロジェクトルート (test_*.py が置かれているディレクトリ) で実行
pytest

# 特定ファイルのみ
pytest test_calculator.py

# 特定ファイル内の特定のテスト関数のみ
pytest test_calculator.py::test_add_simple

pytest test_calculator.py

# ファイル名: calculator.py

def add(a: int, b: int) -> int:
    """2つの整数を足し合わせて結果を返します。"""
    # バグ: 誤って引き算してしまっている
    return a - b

pytest test_calculator.py

# ファイル名: test_fixture_basic.py

import pytest


class User:
    def __init__(self, name: str):
        self.name = name


# fixtureを定義します。テスト関数に user という引数名で渡されます。
@pytest.fixture
def user():
    """テスト用のUserオブジェクトを1つ作成して返すfixtureです。"""
    return User(name="test-user")


def test_user_name_is_test_user(user):
    """fixtureで受け取ったUserオブジェクトのname属性を確認します。"""
    assert user.name == "test-user"


def test_user_is_instance_of_user(user):
    """fixtureで受け取ったオブジェクトの型を確認します。"""
    assert isinstance(user, User)

pytest test_fixture_basic.py

# ファイル名: test_fixture_cleanup.py

import pytest


@pytest.fixture
def resource():
    """テスト前後でセットアップ・クリーンアップを行うfixtureです。"""
    # セットアップ処理 (テスト前)
    print("setup resource")
    res = {"value": 42}

    # yieldの前までが「前処理」
    yield res

    # yield以降が「後処理」
    print("teardown resource")
    res.clear()


def test_using_resource(resource):
    """resourceを使ったテスト例です。"""
    assert resource["value"] == 42

pytest -s test_fixture_cleanup.py

# ファイル名: test_fixture_scope.py

import pytest


class DummyDB:
    """テスト用のダミーDBクラスです。"""
    def __init__(self):
        self.connected = True

    def close(self):
        self.connected = False


@pytest.fixture(scope="module")
def db():
    """モジュール単位で1回だけDB接続を作成するfixtureです。"""
    print("connect DB")
    db = DummyDB()
    yield db
    print("close DB")
    db.close()


def test_db_connection_1(db):
    assert db.connected is True


def test_db_connection_2(db):
    assert db.connected is True

pytest -s test_fixture_scope.py

# ファイル名: test_parametrize_basic.py

import pytest
from calculator import add


@pytest.mark.parametrize(
    "a, b, expected",
    [
        (1, 2, 3),
        (0, 0, 0),
        (-1, 1, 0),
        (100, 200, 300),
    ],
)
def test_add_various_patterns(a, b, expected):
    """add関数を複数の入力パターンでテストします。"""
    assert add(a, b) == expected

pytest -v test_parametrize_basic.py

# ファイル名: test_marker_basic.py

import time
import pytest
from calculator import add


def test_add_fast():
    """高速に終わるテストです。"""
    assert add(1, 2) == 3


@pytest.mark.slow
def test_add_slow():
    """時間のかかるテストにslowマーカーを付けています。"""
    time.sleep(2)
    assert add(10, 20) == 30

# slowマーカーが付いていないテストだけを実行
pytest -m "not slow" test_marker_basic.py

# slowマーカーが付いているテストだけを実行
pytest -m "slow" test_marker_basic.py

# ファイル名: test_exception.py

import pytest
from calculator import divide


def test_divide_by_zero_raises():
    """0で割ったときにZeroDivisionErrorが発生することを確認します。"""
    with pytest.raises(ZeroDivisionError):
        divide(1, 0)


def test_divide_by_zero_message():
    """例外メッセージの内容も確認したい場合のテストです。"""
    with pytest.raises(ZeroDivisionError) as exc_info:
        divide(1, 0)

    # 発生した例外オブジェクトを取り出せます
    assert "division by zero" in str(exc_info.value)

# ファイル名: test_warning.py

import warnings
import pytest


def deprecated_function():
    """非推奨関数の例です。呼び出し時にWarningを発生させます。"""
    warnings.warn("this function is deprecated", DeprecationWarning)


def test_deprecated_function_warns():
    """指定したWarningが出ることを確認します。"""
    with pytest.warns(DeprecationWarning) as record:
        deprecated_function()

    # 発生したwarningのメッセージを検証
    assert "deprecated" in str(record[0].message)

# ファイル名: pytest.ini

[pytest]
# テストを探索するディレクトリを指定
testpaths = tests

# マーカーの定義 (未登録マーカーの警告を抑制)
markers =
    slow: tests that are slow
    api: tests that access external APIs

# デフォルトで付けたいオプション
addopts = -ra -q

# 関数名に "add" を含むテストだけ実行
pytest -k "add"

# "slow"マーカーのテストを除外しつつ、"api"を含むテストだけ実行
pytest -k "api" -m "not slow"

# ファイル名: api_client.py

import requests


def get_user_name(user_id: int) -> str:
    """外部APIからユーザー名を取得する関数の例です。"""
    url = f"https://example.com/users/{user_id}"
    resp = requests.get(url, timeout=5)
    resp.raise_for_status()
    data = resp.json()
    return data["name"]

# ファイル名: test_api_client.py

from unittest.mock import patch, MagicMock
from api_client import get_user_name


def test_get_user_name_uses_api_response():
    """requests.getをモック化して、外部APIを呼ばずにテストします。"""
    # モックのレスポンスオブジェクトを作成します。
    mock_response = MagicMock()
    mock_response.json.return_value = {"name": "mock-user"}
    mock_response.raise_for_status.return_value = None

    # requests.get をパッチして、上で定義したモックレスポンスを返すようにします。
    with patch("api_client.requests.get", return_value=mock_response) as mock_get:
        name = get_user_name(123)

    # 戻り値がモックのjsonに基づいていることを確認します。
    assert name == "mock-user"

    # requests.get が正しいURLで呼び出されたことも検証できます。
    mock_get.assert_called_once_with("https://example.com/users/123", timeout=5)

# ファイル名: tests/conftest.py

import pytest


@pytest.fixture
def sample_user_id():
    """複数のテストで使い回すサンプルユーザーIDです。"""
    return 123

# ファイル名: tests/unit/test_example.py

def test_use_sample_user_id(sample_user_id):
    """conftest.pyで定義したfixtureをそのまま利用できます。"""
    assert sample_user_id == 123

# ファイル名: .github/workflows/tests.yml

name: Run tests

on:
  push:
    branches: [ main, develop ]
  pull_request:

jobs:
  test:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        python-version: ["3.10", "3.11"]

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
          # 必要であれば開発用依存もインストール
          # pip install -r requirements-dev.txt

      - name: Run pytest
        run: |
          pytest