Pythonでunittest.mockを利用してテストを書く方法を現役エンジニアが解説【初心者向け】
初心者向けにPythonでunittest.mockを利用してテストを書く方法について現役エンジニアが解説しています。unittestは、Pythonでユニットテスト(単体テスト)を行うためのモジュールです。今回はMagicMockクラスを使って、未実装のクラスがあってもユニットテストする方法を解説します。
テックアカデミーマガジンは受講者数No.1のプログラミングスクール「テックアカデミー」が運営。初心者向けにプロが解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。 ※ アンケートモニター提供元:GMOリサーチ株式会社 調査期間:2021年8月12日~8月16日 調査対象:2020年8月以降にプログラミングスクールを受講した18~80歳の男女1,000名 調査手法:インターネット調査
Pythonでunittest.mockを利用してテストを書く方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。
Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。
なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。

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

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

Pythonでunittest.mockを利用してテストを書く方法について詳しく説明していくね!

お願いします!
unittest.mockとは
unittestは、Pythonでユニットテスト(単体テスト)を行うためのモジュールです。ユニットテストを行うと、プログラムの品質を確保でき、コードの再利用性が向上します。
unittest.mockは、モックを用いたユニットテストを行うためのモジュールです。モック(mock)とは模型の意味です。ソフトウェアテストの分野では、本物と似た挙動を示すテスト用の部品を指します。
unittest.mockの使い方
以下のようにオブジェクトそのものや、オブジェクトの一部属性をモックに置き換えます。
メソッドを置き換える場合には、引数や戻り値など、モックの振る舞いも細かく制御できます。また、モックはモック自身に対する操作を記録しているので、操作内容が意図したものか検証(assert)するようなテストも実装できます。
import unittest.mock obj1 = unittest.mock.MagicMock() # オブジェクトそのものをモックに置き換える場合 obj2.method = unittest.mock.MagicMock() # オブジェクトのメンバ変数をモックに置き換える場合
実際に書いてみよう
サンプルコード
以下内容のbook.pyがあるとします。本と本棚を示すようなクラスです。BookShelfクラスは実装済ですが、Bookクラスは未実装です。
#class Book: # def __init__(self, title, author): # self._title = title # self._author = author # # def getTitle(self): # return self._title # # def getAuthor(self): # return self._author class BookShelf: def __init__(self): self._books = [] def addBook(self, book): self._books.append(book) def listBooks(self): for b in self._books: title = b.getTitle() author = b.getAuthor() print(f'Title:{title}, Author:{author}')
以下内容のbook_test.pyがあるとします。book.pyをテストするためのコードです。Bookクラスが未実装のため、そのままではテストを十分に行えません。
このようなケースでも、下記のようにBookクラスの代わりにMagicMockクラスを用いると、BookShelfクラスをテストできます。
import unittest import unittest.mock import book class TestBookShelf(unittest.TestCase): def testBookShelf(self): bookShelf = book.BookShelf() # 本来はBookクラスを使いたいが、まだ実装していない # book1 = book.Book(...) # book2 = book.Book(...) # 代わりにMagicMockクラスを使う book1 = unittest.mock.MagicMock() book2 = unittest.mock.MagicMock() bookShelf.addBook(book1) bookShelf.addBook(book2) bookShelf.listBooks() # book1, book2に対し、どのようなメソッド呼び出しがおこなわれたか確認する print(book1.method_calls) print(book2.method_calls) if __name__ == '__main__': unittest.main()
実行結果
Title:<MagicMock name='mock.getTitle()' id='2335218843832'>, Author:<MagicMock name='mock.getAuthor()' id='2335218868856'> Title:<MagicMock name='mock.getTitle()' id='2335218926984'>, Author:<MagicMock name='mock.getAuthor()' id='2335218956104'> [call.getTitle(), call.getAuthor()] [call.getTitle(), call.getAuthor()] . ---------------------------------------------------------------------- Ran 1 test in 0.003s OK
解説
Bookクラスを実装していない段階でも、BookShelfクラスの挙動をテストできました。MagicMockクラスが各種メソッドの呼び出しを記録するので、プログラムの実行履歴を追跡できました。
まとめ
実は私も!?独学で損する人の特徴
「スクールは高いから独学で成功する」という気持ちの方は多いと思います。
もちろんその方が金額は低く抑えられるでしょう。
ただ
独学には向き不向きがあり、実はスクールが向いている人も大勢います。
そんな方のために参考として、
テックアカデミー卒業生がスクールを選んだ理由
をご紹介します。
- ・困って挫折しそうなときに、質問や相談できる相手がいる環境で学んでいきたいなと思った
- ・わかった気になっているだけだったので、自分を追い込む環境に置いた方がいいと感じた
- ・スクールのカリキュラムで市場に求められるスキルを学ぶべきと思った

少しでも当てはまる部分があれば、
スクールが向いているかもしれません。
お試しのつもりで、まずは一度
無料相談
に参加してみませんか?
現役エンジニア・デザイナーに何でも気軽に相談できる30分
を
すべて無料で
できます。
無理な勧誘は一切ない
ので、お気軽にご参加ください。
監修してくれたメンター
橋本紘希(はしもとひろき)
システムインテグレータ企業勤務のシステムエンジニア。 開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。 |

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

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

分かりました。ありがとうございます!
TechAcademyでは、初心者でも、Pythonを使った人工知能(AI)や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。
また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。

プログラミングを独学していて、このように感じた経験はないでしょうか?
- ・調べてもほしい情報が見つからない
- ・独学のスキルが実際の業務で通用するのか不安
- ・目標への学習プランがわからず、迷子になりそう
テックアカデミーでは、このような
学習に不安を抱えている方へ、現役エンジニア講師とマンツーマンで相談できる機会を無料で提供
しています。
30分間、オンラインでどんなことでも質問し放題です。
「受けてよかった」と感じていただけるよう
厳しい試験を通過した講師
があなたの相談に真摯に向き合います。
「ただ気になることを相談したい」
「漠然としているがプロの話を聞いてみたい」
こんな気持ちでも大丈夫です。
無理な勧誘は一切ありません
ので、まずはお気軽にご参加ください。
※体験用のカリキュラムも無料で配布いたします。(1週間限定)