Pythonにおけるassertの利用方法を現役エンジニアが解説【初心者向け】

初心者向けにPythonにおけるassertの利用方法について現役エンジニアが解説しています。assertは、プログラムが仕様に合致しているか確認するためのテストを記述するために用います。値によってAssertionError例外を発生させることが出来ます。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

Pythonにおけるassertの利用方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。

 

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

 

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

 

田島悠介

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

大石ゆかり

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

田島悠介

Pythonにおけるassertの利用方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

assertとは?

assert文は以下の書式で用います。

assert bool値

bool値がFalseの場合、AssertionError例外が発生します。Trueの場合には、何も起きません。

プログラムが仕様に合致しているか確認するためのテストを記述するために用います。
 

assertの使い方

一般にはテスト用途でassert文を用いるため、以下のような使い方をします。

assert <期待される値>==<実際の値>

テストを別のメソッドに分離し、以下のように記述することもできます。

def test_method():
  # テスト結果をbool値で返す。
  # 成功の場合はTrue、失敗の場合はFalse。

assert test_method()

 

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

assertを利用してテストコードを記述しよう

例1 テストに成功するケース

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

def test_is_even():
  assert is_even(2)

test_is_even()

この場合は、is_evenメソッドが正しく実装できていてテストを通過するので、例外は発生しません。
 

例2 テストに失敗するケース

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

def test_is_even():
  assert is_even(2)

test_is_even()

この場合は、is_evenメソッドの実装が間違っていてテストを通過せず、以下のような例外が発生します。
(テストを通過しなかったので、is_evenメソッドの実装に誤りがあったと気付けます)

---------------------------------------------------------------------------
AssertionError                            Traceback (most recent call last)
      5   assert is_even(2)
      6 
----> 7 test_is_even()

      3 
      4 def test_is_even():
----> 5   assert is_even(2)
      6 
      7 test_is_even()

AssertionError: 

 

監修してくれたメンター

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

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

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

 

大石ゆかり

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

田島悠介

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

大石ゆかり

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

 

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

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