プロジェクトの準備

任意の場所にpython-testingフォルダを作成し、Visual Studio Codeの「ファイル」→「フォルダーを開く」から、作成したpython-testingフォルダを開きます。

1. フォルダの作成

任意の場所にpython-testingフォルダを作成し、Visual Studio Codeの「ファイル」→「フォルダーを開く」から、作成したpython-testingフォルダを開きます。

python-testing  ← このフォルダを作成

さらに、python-testingフォルダの中にsrcフォルダとtestsフォルダを作成します。Visual Studio Codeのエクスプローラーでpython-testingフォルダを右クリックし、「新しいフォルダー」を選択してそれぞれ作成してください。

python-testing
├── src/  ← このフォルダを作成
└── tests/  ← このフォルダを作成
💡 ポイント
srcフォルダにはテスト対象となるアプリケーションのソースコードを、testsフォルダにはテストコードを配置します。ソースコードとテストコードを分けることで、プロジェクトの構成が整理されます。

2. requirements.txtの作成

requirements.txtを作成します。Visual Studio Codeのエクスプローラーでpython-testingフォルダを右クリックし、「新しいファイル」を選択してrequirements.txtという名前で作成してください。

python-testing
├── src/
├── tests/
└── requirements.txt  ← このファイルを作成

作成したファイルに以下の内容を記述して保存します。

pytest==8.3.3
pytest-cov==6.0.0

各パッケージの役割は以下のとおりです。

パッケージ 役割
pytest Pythonで最も広く使われているテストフレームワーク。テストの記述と実行を行う
pytest-cov pytestのプラグインで、テストカバレッジ(コードの網羅率)を計測する
💡 ポイント
requirements.txtは、Pythonプロジェクトで使用するライブラリとそのバージョンを記載するファイルです。このファイルを用意しておくことで、pip install -r requirements.txtコマンドで必要なライブラリをまとめてインストールできます。

3. パッケージのインストール

requirements.txtに記載したパッケージをまとめてインストールします。Visual Studio Codeのターミナルで以下のコマンドを実行してください。

Windowsの場合:

pip install -r requirements.txt

Macの場合:

pip3 install -r requirements.txt

-r requirements.txtオプションにより、ファイルに記載されたすべてのパッケージが一括でインストールされます。

以下のようにSuccessfully installedと表示されれば、インストールは完了です。

Successfully installed pytest-8.3.3 pytest-cov-6.0.0 ...
⚠️ インストールに失敗する場合
pip3: command not foundやpip: command not foundと表示される場合は、Pythonが正しくインストールされていない可能性があります。事前準備のPythonインストール手順を確認してください。

4. テスト対象コードの作成

src/init.pyの作成

src/__init__.pyを作成します。Visual Studio Codeのエクスプローラーでsrcフォルダを右クリックし、「新しいファイル」を選択して__init__.pyという名前で作成してください。このファイルは空ファイルとして作成します。

python-testing
├── src/
│   └── __init__.py  ← このファイルを作成(空ファイル)
├── tests/
└── requirements.txt
💡 ポイント
__init__.pyは、そのフォルダがPythonのパッケージ(モジュールのまとまり)であることを示すファイルです。このファイルがないと、テストコードからfrom src.calculator import addのようにインポートできない場合があります。

4.1 src/calculator.pyの作成

src/calculator.pyを作成します。Visual Studio Codeのエクスプローラーでsrcフォルダを右クリックし、「新しいファイル」を選択してcalculator.pyという名前で作成してください。

python-testing
├── src/
│   ├── __init__.py
│   └── calculator.py  ← このファイルを作成
├── tests/
└── requirements.txt

作成したファイルに以下の内容を記述して保存します。

def add(a: int, b: int) -> int:
    return a + b

def subtract(a: int, b: int) -> int:
    return a - b

def multiply(a: int, b: int) -> int:
    return a * b

def divide(a: int, b: int) -> float:
    if b == 0:
        raise ValueError("0で割ることはできません")
    return a / b

四則演算を行う4つの関数を定義しています。divide関数では、0で割ろうとした場合にValueError例外を発生させています。この例外処理が正しく動作するかも、後ほどテストで検証します。

4.2 src/user_service.pyの作成

src/user_service.pyを作成します。Visual Studio Codeのエクスプローラーでsrcフォルダを右クリックし、「新しいファイル」を選択してuser_service.pyという名前で作成してください。

python-testing
├── src/
│   ├── __init__.py
│   ├── calculator.py
│   └── user_service.py  ← このファイルを作成
├── tests/
└── requirements.txt

作成したファイルに以下の内容を記述して保存します。

class UserService:
    def __init__(self):
        self.users = {}

    def add_user(self, user_id: int, name: str) -> dict:
        if user_id in self.users:
            raise ValueError(f"ユーザID {user_id} は既に存在します")
        self.users[user_id] = {"id": user_id, "name": name}
        return self.users[user_id]

    def get_user(self, user_id: int) -> dict:
        if user_id not in self.users:
            raise KeyError(f"ユーザID {user_id} が見つかりません")
        return self.users[user_id]

    def get_all_users(self) -> list:
        return list(self.users.values())

    def delete_user(self, user_id: int) -> None:
        if user_id not in self.users:
            raise KeyError(f"ユーザID {user_id} が見つかりません")
        del self.users[user_id]

ユーザ情報を管理するUserServiceクラスを定義しています。ユーザの追加、取得、一覧表示、削除の機能を持ち、存在しないユーザの操作や重複登録に対して例外を発生させます。テストでは、これらの各操作が正しく動作するか、またエラーケースで適切な例外が発生するかを検証します。

4.3 src/weather_client.pyの作成

src/weather_client.pyを作成します。Visual Studio Codeのエクスプローラーでsrcフォルダを右クリックし、「新しいファイル」を選択してweather_client.pyという名前で作成してください。

python-testing
├── src/
│   ├── __init__.py
│   ├── calculator.py
│   ├── user_service.py
│   └── weather_client.py  ← このファイルを作成
├── tests/
└── requirements.txt

作成したファイルに以下の内容を記述して保存します。

import urllib.request
import json

def fetch_weather(city: str) -> dict:
    try:
        url = f"https://api.example.com/weather?city={city}"
        req = urllib.request.Request(url)
        with urllib.request.urlopen(req, timeout=5) as response:
            data = json.loads(response.read().decode())
            return {"city": city, "status": "success", "temperature": data["temperature"]}
    except Exception as e:
        return {"city": city, "status": "error", "message": str(e)}

def get_weather_summary(cities: list) -> dict:
    results = []
    for city in cities:
        result = fetch_weather(city)
        results.append(result)

    success_count = sum(1 for r in results if r["status"] == "success")
    return {
        "total": len(cities),
        "success": success_count,
        "error": len(cities) - success_count,
        "details": results,
    }

外部APIを呼び出して天気情報を取得する関数を定義しています。fetch_weather関数は指定した都市の天気を取得し、get_weather_summary関数は複数の都市の結果をまとめます。このコードは外部APIに依存しているため、テストではモックを使って実際のHTTPリクエストを送らずにロジックを検証します。