【Python】pytestで単体テストを実装する方法

当ページのリンクには広告が含まれています。
この記事で解決できる悩み
いずみ

こんな悩みを解決できる記事を書きました!

僕は現役フリーランスエンジニア(歴年)で、資格は個保有しています。

pytestでPythonのテストを書く方法を知りたい」とお考えではありませんか?

Pythonでアプリケーションを開発していると、動作確認を毎回手動で行うのが大変だと感じる方は多いはずです。

pytestを使えば、シンプルな関数だけで自動テストの仕組みを構築することが可能です。

いずみ

セットアップも数分で終わるので、サクッと解説します。

ということで、本記事ではpytestでPythonのテストを実装する方法を解説します。

いずみ

すぐ読み終わるので、ぜひ最後まで読んでくださいませ。

スクロールできます
【当サイト】おすすめフリーランスエージェント3選
エージェント評価ポイント公式サイト
レバテックフリーランス

5.0
業界最大級のエージェント。
高単価案件が豊富。
公式
Midworks

4.8
満足度調査で
3年連続3冠を達成。
公式
ITプロパートナーズ

4.6
週2〜3向けの案件が豊富。公式
執筆者/監修者
  • フリーランスエンジニア(保有資格個、企業と直接契約
  • ブログ・アフィリエイト歴7年(2018年〜)
  • ブランドせどりで月利50万円⇨脱サラ
  • 投資(仮想通貨・FX)歴7年(2018年〜)
  • X(旧Twitter)フォロワー約1,900人
  • 運営者情報はこちら
いずみです
目次

【Python】pytestで単体テストを実装する方法

早速ですが、pytestを使ってPythonのテストを実装する方法を解説します。

pytestのインストール

まずは、pytestをインストールします。

STEP
pytestをインストールする

pipコマンドでpytestをインストールします。

pip install pytest
STEP
テスト対象のコードを用意する

テスト対象として、簡単な計算関数を用意します。

# calculator.py
def add(a, b):
    return a + b

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

基本的なテストの書き方(コード付き)

次に、pytestの基本的なテストコードを書いてみます。

STEP
テストファイルを作成する

ファイル名はtest_から始める必要があります。

今回はtest_calculator.pyというファイルを作成します。

STEP
assert文でテストを書く
# test_calculator.py
import pytest
from calculator import add, divide

def test_add():
    assert add(2, 3) == 5

def test_divide():
    assert divide(10, 2) == 5

def test_divide_by_zero():
    with pytest.raises(ValueError):
        divide(10, 0)

関数名をtest_から始め、assert文で期待する結果と比較するだけでテストになります。

例外の発生を確認したい場合は、pytest.raisesを使います。

STEP
テストを実行する

ターミナルで以下のコマンドを実行します。

pytest -v

テスト結果が一覧表示され、成功と失敗がひと目で分かります。

いずみ

assert文だけでテストが書けるので、覚えることが少なくて助かります。

フィクスチャで前処理・後処理を共通化する

テストごとに同じ準備処理を書くのは非効率です。

pytestのfixtureを使うと、共通の準備処理を関数として切り出せます。

# test_fixture.py
import pytest

@pytest.fixture
def sample_data():
    return {"a": 1, "b": 2}

def test_sum(sample_data):
    assert sample_data["a"] + sample_data["b"] == 3

fixture関数の名前をテスト関数の引数に指定するだけで、戻り値が自動的に渡されます。

parametrizeで複数パターンをまとめてテストする

入力値のパターンごとにテスト関数を書くと、コードが冗長になります。

@pytest.mark.parametrizeを使えば、複数の入力パターンを1つのテスト関数にまとめられます。

# test_parametrize.py
import pytest
from calculator import add

@pytest.mark.parametrize("a, b, expected", [
    (1, 2, 3),
    (0, 0, 0),
    (-1, 1, 0),
])
def test_add_parametrize(a, b, expected):
    assert add(a, b) == expected
いずみ

境界値やエッジケースを漏れなく網羅できるので、バグの早期発見にもつながります。

monkeypatchで環境変数や関数をモックする

外部APIや環境変数に依存する処理は、そのままだとテストが不安定になります。

monkeypatchフィクスチャを使えば、環境変数や関数を一時的に置き換えられます。

# test_monkeypatch.py
import os

def get_api_key():
    return os.environ["API_KEY"]

def test_get_api_key(monkeypatch):
    monkeypatch.setenv("API_KEY", "dummy-key")
    assert get_api_key() == "dummy-key"

テスト関数の実行が終わると、monkeypatchによる変更は自動的に元へ戻ります。

スクロールできます
【当サイト】おすすめフリーランスエージェント3選
エージェント評価ポイント公式サイト
レバテックフリーランス

5.0
業界最大級のエージェント。
高単価案件が豊富。
公式
Midworks

4.8
満足度調査で
3年連続3冠を達成。
公式
ITプロパートナーズ

4.6
週2〜3向けの案件が豊富。公式

【厳選】フリーランスエンジニアにおすすめなエージェント3選

フリーランスエンジニアになるにはエージェントから案件をもらう必要があります。

僕が実際に利用しているおすすめエージェントを紹介しますね。

いずみ

エージェントは必ず複数登録してください。

担当者によっては「全然案件紹介してくれない…」みたいなこともあるので…

僕は実際に5つのエージェントを使い回していますよ。

フリーランスを始めるなら「

案件数マージン率単価
約88,000件非公開
初心者福利厚生申し込み
無料
Good Point
  • 業界最大級の案件数。
  • 業界トップクラスの高単価報酬、低マージン(平均年収862万円)。
  • 案件参画中のフォローの充実。

※詳細は「【業界最大手】レバテックフリーランスとは?メリットや利用手順を解説!」を参照。

は業界最大手のフリーランスエージェントです。

とにかく案件数が多いので、とりあえず登録しておけば間違いないエージェントです!

いずみ

僕もはじめてフリーランスの案件を貰ったのはです。

保有している案件数が多いので、業務経験がなくても何かしらの案件は紹介してもらえますよ(僕はJavaの経験3年でも案件を貰えました)。

手厚い保障を重視したいなら「

案件数マージン率単価
約10,000件非公開
初心者福利厚生申し込み
無料
Good Point
  • 手厚い保障で正社員並みの安心感。
  • 還元率60%超え&単価公開でクリアな契約。
  • 給与保障制度(審査あり)。

は手厚い保障が特徴のフリーランスエージェントです。

フリーランスを目指しているけど不安な方や保障を重視したい方におすすめです。

いずみ

僕も何度か案件を紹介してもらいました。

自分のスキルに合った案件を紹介してもらえましたし、電話のやり取りも非常に丁寧でした。

週2〜3日の案件探しなら「

案件数マージン率単価
約5,000件非公開
初心者福利厚生申し込み
経験者向け無料
Good Point
  • IT案件に特化したフリーランスエージェント。
  • 週2〜3日の案件が豊富。
  • リモート案件が多く、直エンドなので単価も高い。

※詳細は「【週2・3案件】ITプロパートナーズとは?メリットや利用手順を解説!」を参照。

はIT案件に特化したフリーランスエージェントです。

週2〜3日から参画できる案件が豊富なので、起業したい人にもおすすめです。

いずみ

週2〜3日の案件はある程度スキルがないと紹介してもらえない印象です。

とはいえ、週5の案件ももちろんありますし、僕が利用した時は迅速・丁寧に対応していただきました!

よくある質問

unittestとpytestは何が違いますか?

unittestは標準ライブラリに含まれるフレームワークで、テストクラスを継承して書く必要があります。

pytestは通常の関数でテストを書けるうえ、assert文もシンプルに使えるため、記述量を減らせます。

テストのカバレッジを計測するにはどうすればいいですか?

pytest-covプラグインを使うと計測できます。

pip install pytest-cov
pytest --cov=calculator

非同期関数(async def)のテストはどう書けばいいですか?

pytest-asyncioプラグインを追加すると、非同期関数を直接テストできます。

import pytest

@pytest.mark.asyncio
async def test_async_add():
    result = await async_add(2, 3)
    assert result == 5

まとめ

今回は、pytestでPythonのテストを実装する方法について解説しました。

以下が本記事のまとめになります。

まとめ
  • pytestはtest_から始まる関数を書くだけでテストを実装できる。
  • fixtureを使えば、テストの前処理・後処理を共通化できる。
  • parametrizeを使えば、複数パターンのテストを1つの関数にまとめられる。
  • monkeypatchを使えば、環境変数や外部依存を安全にモックできる。
まとめ
  • おすすめ本
¥2,970 (2023/07/25 22:48時点 | Amazon調べ)
\楽天ポイント4倍セール!/
楽天市場

Pythonの勉強なら「」が体系的に学べるのでおすすめですよ♪

いずみ

最後までお読みいただき、ありがとうございました!

スクロールできます
【当サイト】おすすめフリーランスエージェント3選
エージェント評価ポイント公式サイト
レバテックフリーランス

5.0
業界最大級のエージェント。
高単価案件が豊富。
公式
Midworks

4.8
満足度調査で
3年連続3冠を達成。
公式
ITプロパートナーズ

4.6
週2〜3向けの案件が豊富。公式
  • クソおすすめ本
¥4,480 (2024/06/01 23:28時点 | Amazon調べ)
\楽天ポイント4倍セール!/
楽天市場
いずみ

海外のエンジニアがどういった思考で働いているかが理解できます。

海外に行く気はないけど海外エンジニアの動向が気になる雑魚エンジニアにおすすめです(本当におすすめな本しか紹介しないのでご安心を)。

この記事が気に入ったら
フォローしてね!

シェアしてね!
  • URLをコピーしました!
目次