ユニットテストの書き方！Pythonのunittestを使う方法【初心者向け】

Pythonのunittestの使い方について解説します。

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

 

なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。

 

 

unittestとは

unittestとは、Python に標準で用意されているテスト用のライブラリ（ツール）です。プログラムを書いたら、正しく動作するか、テストを行います。プログラムの規模が大きくなったり、ユーザー定義関数が多くなったりすると、それらを一つ一つテストしていくのは大変です。unittestを使うと、複数のテストをまとめて実行することができます。

unittestは「テストを行うプログラム」を書きます。一見、面倒に思いますが、テストを行う際の入力誤りを低減できる、何度も同じ条件でテストを実行できる、といったメリットがあります。

unittest文については、Python の公式ドキュメントも確認しておくと良いでしょう。

https://docs.Python.jp/3/library/unittest.html

 

unittestの書き方

unittestを書く前に、テストする対象の関数を用意しましょう。今回はcalcという四則演算を行うモジュールを作成しました。

以下のようなプログラムを作成し、「calc.py」というファイル名で保存します。

# calc:四則演算を行うモジュール

def add_num(num1, num2):
  return num1 + num2 
 
def sub_num(num1, num2):
  return num1 - num2

def mul_num(num1, num2):
  return num1 * num2

def div_num(num1, num2):
  return num1 / num2

この calcモジュール に対してunittestを使ったテストプログラムを書いていきます。書き方は以下のとおりです。

1. ファイル名は「test_対象のモジュール名.py」とする
2. テストクラス名は「Testテスト対象のクラス名」とする
3. テストクラスはunittest.TestCaseを継承する
4. テストメソッド名は「test_テスト対象のメソッド名」とする

少し分かりづらいですね。実際に書いてみましょう。

 

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

実際に書いてみよう

以下のようなテストプログラムを作成し、 calc.py と同じフォルダに 「test_calc.py」というファイル名で保存します。上記の書き方に該当する部分にコメントを記載しています。

# 1.ファイル名は「test_対象のモジュール名.py」とする
import unittest
import calc
 
# 2.テストクラス名は「Testテスト対象のクラス名」とする
# 3.テストクラスはunittest.TestCaseを継承する
class TestCalc(unittest.TestCase):
 
  # 4.テストメソッド名は「test_テスト対象のメソッド名」とする(以下同)
  def test_add_num(self):
    self.assertEqual(10, calc.add_num(6, 4)) 
 
  def test_sub_num(self):
    self.assertEqual(2, calc.sub_num(6, 4))

  def test_mul_num(self):
    self.assertEqual(24, calc.mul_num(6, 4))

  def test_div_num(self):
    self.assertEqual(10, calc.div_num(6, 4))

それでは、実行してみましょう。実行するには以下のように入力します。

Python -m unittest

実行するには以下のようになります。

.F..
======================================================================
FAIL: test_div_num (test_calc.TestCalc)
----------------------------------------------------------------------
Traceback (most recent call last):
 File "/home/ubuntu/workspace/Test/test_calc.py", line 20, in test_div_num
 self.assertEqual(10, calc.div_num(6, 4))
AssertionError: 10 != 1.5

----------------------------------------------------------------------
Ran 4 tests in 0.001s

FAILED (failures=1)

「FAILED」と表示されていますね。内容を見てみると、以下の記載があります。

self.assertEqual(10, calc.div_num(6, 4))
AssertionError: 10 != 1.5

どうやら、割り算の評価を間違えたようです。test_calc.py の 20行目を以下のように修正し、再度実行してみましょう。

self.assertEqual(1.5, calc.div_num(6, 4))

実行結果は以下のようになります。

....
----------------------------------------------------------------------
Ran 4 tests in 0.000s

OK

無事テストに成功しました。

unittestには、この他にも多くの機能があります。また今回はテスト用の関数で「assertEqual」を使いましたが、他にも多くのテスト用の関数があります。

この記事を監修してくれた方 太田和樹（おおたかずき） ITベンチャー企業のPM兼エンジニア 普段は主に、Web系アプリケーション開発のプロジェクトマネージャーとプログラミング講師を行っている。守備範囲はフロントエンド、モバイル、サーバサイド、データサイエンティストと幅広い。その幅広い知見を生かして、複数の領域を組み合わせた新しい提案をするのが得意。 開発実績：画像認識技術を活用した駐車場混雑状況把握（実証実験）、音声認識を活用したヘルプデスク支援システム、Pepperを遠隔操作するアプリの開発、大規模基幹系システムの開発・導入マネジメント 地方在住。仕事のほとんどをリモートオフィスで行う。通勤で消耗する代わりに趣味のDIYや家庭菜園、家族との時間を楽しんでいる。

 

 

TechAcademyでは、初心者でもPythonを使った人工知能（AI）や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。