Pythonのnoseを利用してユニットテストを書く方法を現役エンジニアが解説【初心者向け】

初心者向けにPythonのnoseを利用してユニットテストを書く方法について現役エンジニアが解説しています。ユニットテストとは、単体テストのことで関数やオブジェクトのメソッドを含んだモジュール単位で行うテストのことです。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

Pythonのnoseを利用してユニットテストを書く方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。

 

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

 

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

 

田島悠介

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

大石ゆかり

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

田島悠介

Pythonのnoseを利用してユニットテストを書く方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

目次

 

ユニットテストとは

ユニットテスト(単体テスト)とは、関数やオブジェクトのメソッドなど、モジュール単位で行うテスト(試験)のことです。

プログラム全体を作成してからテストに着手すると、バグや性能不足のあった場合に、プログラムのどの部分に問題があるのか特定が難しいです。

モジュール単位でテストを行っておくことで、モジュールの品質を確保しやすくなるというメリットがあります。

一般にはユニットテストに成功した後、複数のモジュールを連携させる結合テストに進みましょう。

 

[PR] Pythonで挫折しない学習方法を動画で公開中

noseとは

noseとは、Pythonのユニットテストのライブラリです。

Pythonには標準でユニットテスト用のライブラリunittestが付属しているものの、noseはよりテストの記述や実行を容易にしたり、プラグインで機能を拡張したりする工夫がほどこされています。

(注)
noseは現在活発に開発されておらず、新機能の追加には消極的です。

これからPythonのユニットテストライブラリを新規に採用する場合、noseは以下のようなライブラリの採用をすすめています。

  • 後継のnose2
  • pytest
  • 標準ライブラリのunittest

 

noseの使い方

インストール

pipコマンドを用いnoseをインストールしましょう。

ここでは環境管理を容易にするため、pipを拡張したpipenvを使用します。

pipenv install nose

以下コマンドでnoseがインストールされたか確認可能です。

pipenv run nosetests

コマンドの実行結果が以下のようになれば、インストールは成功しています。

----------------------------------------------------------------------
Ran 0 tests in 0.001s

OK

 

実際に書いてみよう

テスト対象モジュール

テスト対象モジュールcalc.pyを以下のとおり作成しました。

加算を行う関数addと偶数か判定する関数is_evenを定義しまています。

def add(x, y):
    return x + y

def is_even(x):
    return x % 2 == 0

 

テストコード

テストコードcalc_test.pyを以下のとおり作成しました。

unittest.TestCaseを継承したテストクラスを作成します。

nose.toolsでテストに便利なメソッドが提供されているため、これをインポートしておきましょう。

import unittest
from nose.tools import eq_, ok_
import calc

class TestCalc(unittest.TestCase):
    def test_add(self):
        eq_(3, calc.add(1, 2))

    def test_is_even(self):
        ok_(2, calc.is_even(2))

 

テスト実行とその結果

先と同様にテストを実行します。

pipenv run nosetests

test_add, test_is_evenのテスト2件が実行されました。

..
----------------------------------------------------------------------
Ran 2 tests in 0.007s

OK

 

まとめ

この記事ではPythonのユニットテストを支援するライブラリnoseの使い方を紹介しました。

noseの開発は進んでいないものの、使用する場合はその使い方をマスターしておくと知識の幅が広がるでしょう。

 

執筆してくれたメンター

橋本紘希(はしもとひろき)

システムインテグレータ企業勤務のシステムエンジニア。

開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。

 

大石ゆかり

Pythonのnoseを利用してユニットテストを書く方法がよく分かったので良かったです!

田島悠介

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

大石ゆかり

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

 

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

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。