icon
icon

Pythonのテストフレームワークunittestとpytestの違いを現役エンジニアが解説【初心者向け】

初心者向けにPythonのテストフレームワークunittestとpytestの違いについて現役エンジニアが解説しています。テストフレームワークとは、ソフトウェアのテストを行うフレームワークのことです。Python標準のunittestとサードパーティーのpytestのインストール方法や使い方について解説します。

テックアカデミーマガジンは受講者数No.1のプログラミングスクール「テックアカデミー」が運営。初心者向けにプロが解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。 ※ アンケートモニター提供元:GMOリサーチ株式会社 調査期間:2021年8月12日~8月16日  調査対象:2020年8月以降にプログラミングスクールを受講した18~80歳の男女1,000名  調査手法:インターネット調査

監修してくれたメンター

平野 勝靖

製造業のエンジニア兼DX推進リーダー。プログラミング歴は20年。テックアカデミーではPythonコース、データサイエンスコースを担当。

Pythonのテストフレームワークunittestとpytestの違いについて、テックアカデミーのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

目次

そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Pythonのテストフレームワークunittestとpytestの違いについて、詳しく説明していくね!

大石ゆかり

お願いします!

 

テストフレームワークとは

テストフレームワークとは、ソフトウェアのテストを支援してくれる機能群のことをいいます。

この機能を使用してテスト用コードを作成し、テスト用コードから開発したコードを呼び出して、期待通りの結果が出力されるのかをテストします。

このテスト用コードは再利用できるため、テストを手動で行うよりも効率的にテストできます。

このようなメリットがあるため、開発現場でもテストフレームワークを使用したテストが行われています。

 

unittestについて

まず、Pythonの標準モジュールで提供されているテストフレームワーク unittestについて紹介します。

unittestは、Javaでテストを行う際に使われるJUnitに触発されて開発されています。

そのため、他の言語で標準で取り入れられているテストフレームワークと同様の方法でテストできます。

つまり、unittestを使ったテストが分かれば、他言語のフレームワークを使ったテストもしやすくなります。

 

今回は、以下の引数の数を2倍にする関数のテストにおいて、unittestを使用してみましょう。

# 引数の数を2倍する
def num_double(num):
    return 2 * num

まず、こちらのコードをnum_double.pyというファイル名で保存しましょう。

 

続いて、以下のテスト用コードをtest.pyというファイル名で保存しましょう。

import unittest
from num_double import num_double

class Test_num_double(unittest.TestCase):
    def test_num_double(self):
        num = 3
        expected = 6
        actual = num_double(num)
        self.assertEqual(expected, actual)

if __name__ == "__main__":
    unittest.main()

前述の通り、テストフレームワークではテスト用コードから開発したコードを呼び出して、期待通りの結果が出力されるのかをテストします。

unittestでは、このテストのためにassertEqualメソッドを実行します。

引数に開発したコードの出力の「期待値」と「結果」を渡すことで、それらが一致するか比較してくれます。

 

コードとテスト用コードができましたので、以下のコマンドをターミナルで実行し、テストしてみましょう。

python test.py

実行結果

Ran 1 test in 0.000s

OK

OKが表示され、num_doubleの引数に3を与えた結果が、期待値 6と一致したことが確認できましたね。

 

[PR] 未経験からWebエンジニアを目指す方法とは

pytestについて

続いて、サードパーティーのPythonのテストフレームワークであるpytestについて紹介します。

pytestの機能はunittestと大差はないですが、よりPythonらしい記述でテスト用コードを作成できます。

 

pytestは、以下のpipコマンドでライブラリをインストールして使用します。

pip install pytest

 

unittestに続き、num_double.pyをテストするためのテスト用コードを書いてみましょう。

pytestによるテストはシンプルで、テスト用コード内の関数名の頭にtestがつく関数が、自動的にテストの対象として認識されます。

そして、各テストで期待する結果をassert文で定義します。

以下がpytestにおけるnum_double.pyのテスト用コードです。

from num_double import num_double

def test_func():
    num = 3
    expected = 6
    assert num_double(num) == expected

本テスト用コードをtest_pytest.pyというファイル名で保存しましょう。

 

pytestでテストを実行するときは、pytestコマンドを使用します。

以下のコマンドをターミナルで実行し、テストしてみましょう。

pytest test_pytest.py

実行結果

collected 1 item

test_pytest.py .                                               [100%]

 ========================= 1 passed in 0.02s =========================

 

1 passed が表示され、こちらもnum_doubleの引数に3を与えた結果が、期待値 6と一致したことが確認できました。

 

 

unittestとpytestの比較

さて、2種類のPythonのテストフレームワークを紹介してきました。

ここからは、この2種類のフレームワークを比較します。

 

インストール

まずはインストールの有無です。

unittestは標準モジュールのため、当然インストールは必要ありません。

一方で、pytestはインストールが必要になります。

そのため、導入するためにpytestのほうが多少手間がかかります

 

記法

先程紹介した2つのコードは、テストの内容は同じですが、テスト用コードの書き方に違いがありました。

unittestはオブジェクト指向で書くため、クラスを使用してテスト用コードを書きました。

assert文についてもメソッドを呼び出す形で実行しました。

 

一方、pytestはテストを関数で定義しました。

また、assert文についても比較演算子で実行結果を比較しました。

このように、pytestではPythonらしい書き方で、シンプルにテスト用コードを書くことができます。

 

unittestは学習コストが高いですが、先程述べたように他の言語で標準で使われているテストフレームワークに近い記法になっています。

そのため、Python以外の言語でもテストする方は、unittestを覚えておくといいでしょう。

 

実行結果

unittestは、テストを実行したときに結果、及びテストが通らなかったときは、どこのテストが通らなかったのかを行番号で示す仕組みです。

一方、pytestはテストに失敗したときに失敗した箇所を細かく表示するため、テストに失敗した原因を特定しやすいです。

加えて、テストを実行しているPythonやpytestのバージョン、ディレクトリなどの実行環境も出力します。

そのため、テストに失敗したときの原因を実行環境から推測もできます。

このようなメリットの反面、pytestのほうが実行時間が遅いというデメリットがあります。

 

まとめ

今回はPythonで使われるテストフレームワークについて紹介しました。

テストフレームワークは、現場で開発をしているエンジニアであれば必ず覚えておきたいスキルの1つです。

現役エンジニアのみなさんはもちろんのこと、これからエンジニアとしてのキャリアをスタートされようとしているみなさんは要チェックです!

 

大石ゆかり

内容が分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

Pythonを学習中の方へ

これで解説は終了です、お疲れさまでした。

  • つまずかず「効率的に」学びたい
  • 副業や転職後の「現場で使える」知識やスキルを身につけたい

プログラミングを学習していて、このように思ったことはありませんか?

テックアカデミーのPythonコースでは、第一線で活躍する「プロのエンジニア」が教えているので、効率的に実践的なスキルを完全オンラインでしっかり習得できます。

合格率10%の選考を通過した、選ばれたエンジニアの手厚いサポートを受けながら、人工知能(AI)や機械学習の基礎を学べます。

まずは一度、無料体験で学習の悩みや今後のキャリアについて話してみて、「現役エンジニアから教わること」を実感してみてください。

時間がない方、深く知ってから体験してみたい方は、今スグ見られる説明動画から先に視聴することをおすすめします!