(Optional) 便利な外部ライブラリをインストールして使ってみよう (Click編)

[sotetsuk]

ここでは、CLIツールの引数のパースに使うライブラリとして、Arpgarse の代わりに、Click を使ってみましょう。今回は使いませんが、同じ用途のライブラリとしては docopt や Fire も有名です。開発の規模や用途に応じて使い分けてみても良いかもしれません。

1. Clickを使ってCLIツールを書き直しましょう

Clickをインポートし、ない場合はインストールします。

Clickを使うと、次のように書き直すことができます。関数の引数をCLIツールの引数とすることができるので、補完が効くようになり、よりスムーズにコードを書くことができます。また、関数をサブコマンドと対応させることもできるので、サブコマンドが複数あるときにも書きやすくなります。

import sys
import click


def fizzbuzz(n: int, fizz: int = 3, buzz: int = 5) -> str:
    ...


@click.command()
@click.argument("nums", nargs=-1, type=int)
@click.option("--fizz", type=int, default=3, help="Number corresponds to Fizz.")
@click.option("--buzz", type=int, default=5, help="Number corresponds to Buzz.")
def main(nums, fizz, buzz):
    """Fizz Buzz program. If no arguments are passed, it reads numbers from stdin."""

    if nums:  # 数字の列が引数から渡された場合には、それらの数字にFizzBuzzを適用する
        sys.stderr.write("Reading numbers from arguments ...\n")
        for n in nums:
            sys.stdout.write(f"{fizzbuzz(n, fizz=fizz, buzz=buzz)}\n")
    else:  # 数字の列が引数から渡されなかった場合には、標準入力から数字を読み込む
        sys.stderr.write("Reading numbers from stdin ...\n")
        try:
            line = sys.stdin.readline()
            while line:
                sys.stdout.write(f"{fizzbuzz(int(line), fizz=fizz, buzz=buzz)}\n")
                line = sys.stdin.readline()
        except KeyboardInterrupt:
            return

2. clickの依存関係をsetup.pyに記述する

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

実際に作成したPRは #21 になります。

目次

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