(Optional) doctestを導入してみよう

[sotetsuk]

前回まで、ユニットテストを実現する方法として、Python標準の unittest ライブラリを用いた方法を紹介してきました。unittest ライブラリのユニットテストの書き方は、他の言語にあるユニットテストフレームワークと比べても一般的なものです。

今回は、Python特有の Doctest というユニットテストの書き方を紹介します。Doctestは、通常の unittest ライブラリと併用して（あるいは代替して）用いることができます。個人的には、Doctestだけでも十分な場面は少なくないと思っています。

1. Doctestを導入する

mainから新しいブランチを切り（ブランチを切るスクリーンショットは以下省略）、Doctestを実装します。
Doctestは、次のように、 """ で囲まれたコメントと、 >>> で実行するプログラムを指定することで実装できます。

2. DoctestをPyCharmで実行する

PyCharmから、Doctestを実行するための設定をしていきましょう。まず、Edit configuration をクリックします。

次に、+ => Add New Configuration => Doctests をクリックします。

fizzbuzz パッケージのディレクトリを指定します。

doctestが実行できるようになりました。

doctestが通ることを確認して、変更をコミットします（コミットのスクリーンショットは以下省略）。

3. PRを作り、mainにマージする

実際に作成されたPRは #8 になります。

目次

1. プロジェクトを初期化しよう
2. 仕様を決めて、ユニットテストを追加してみよう
3. ユニットテストが通るように本体を実装してみよう
4. [現在] (Optional) doctestを導入してみよう
5. [つぎ] 新しい機能を追加する前に、CIを導入してみよう
6. 新しい機能を追加してみよう
7. ライブラリとして使えるようにしてみよう
8. CLIツールとして使えるようにしてみよう
9. (Optional) 便利な外部ライブラリをインストールして使ってみよう (Pytest編)
10. (Optional) 便利な外部ライブラリをインストールして使ってみよう (Click編)
11. 型チェックを使ってみよう
12. しっかりとしたREADMEを書こう