Python unittestフレームワーク：テストの説明

Question

Pythonでテストスクリプトの説明を与えるのにベストプラクティスは何ですか？

明らかに私はコメントをテストケースの下に置くことができますが、テストケースの説明を提供するための標準的なプラクティス（私が書くべき方法）があるかどうかを知りたがっています行う）？

は、あなたが任意の提案/参照が認識されるテストの説明？：

Class TestFoo: 
    def testfoo1(): 
    """ 
    test description: 
    step1: 
    step2: 
    """ 

を置くだろうか、このです。 unittestフレームワークで

Answer 1

、あなたは shortDecription方法があります。

shortDescription()

を何ら説明が提供されていない場合Noneテストの説明を返し、または。このメソッドのデフォルト実装では、テストメソッドのdocstringの最初の行が利用可能であれば返します。

実際、docstringメソッドを使用するのは良い場所です。あなたはクラスの宣言でTestCaseから継承しなければならないかもしれませんが、ランナーはそのように動作します。 については

のベストプラクティス：開発者は、何かが間違っている場合のハイレベルのアイデアを持っているため、テストケース（クラス）と十分です簡潔かつ便利ファッションのテストメソッドに名前を付け、その特定すべきですテストは失敗します。これの前提条件は、それぞれのテストメソッドは、異なるものの全体の束を主張するのではなく、1つのことをテストするだけでよいということです。

分かりやすいテスト名では、通常、「テストケースが何をするべきかに関する詳細な情報」を持つドキュメントストリングは必要ありません。多くのことをチェックする既存の大規模なテストがある場合は、それぞれを1つの個別のものだけを主張する小さなテストの束に分割することができます。

Answer 2

テストメソッドdocstringは、Pythonのunittestモジュールを使用している場合、その情報を格納する標準的な場所です。 unittestは、その書類文字列を使用して出力などの書式を設定します。

Answer 3

クラスの名前は説明が必要でないほど記述的であることが最善の方法です。

これを除いて、docstringは最善の方法です。