クリックをご利用ください

_images/click-logo.png

Clickは、できるだけ少ないコードを使用して組み合わせ可能な方法できれいなコマンドラインインタフェースを作成するためのPythonパッケージです。これは“コマンドラインインタフェース作成キット”です。これは高さで構成可能ですが、ボックスを開けると合理的なデフォルト設定があります。

コマンドラインツールを作成するプロセスを迅速かつ面白くするとともに,期待されるCLI APIを実現できないことによるいかなる挫折も防ぐことを目的としている.

3つのポイントをクリックします:

  • 任意入れ子命令

  • ヘルプページの自動生成

  • サポートは、実行時のサブコマンドの遅延

これは何に見えますか。次は簡単なClickプログラムの例です

import click

@click.command()
@click.option('--count', default=1, help='Number of greetings.')
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def hello(count, name):
    """Simple program that greets NAME for a total of COUNT times."""
    for x in range(count):
        click.echo(f"Hello {name}!")

if __name__ == '__main__':
    hello()

走っている時の様子です

$ python hello.py --count=3
Your name: John
Hello John!
Hello John!
Hello John!

フォーマットの良いヘルプページを自動的に生成します

$ python hello.py --help
Usage: hello.py [OPTIONS]

  Simple program that greets NAME for a total of COUNT times.

Options:
  --count INTEGER  Number of greetings.
  --name TEXT      The person to greet.
  --help           Show this message and exit.

PyPIから直接取得することができます:ライブラリを取得します

pip install click

書類

文書のこの部分はあなたにライブラリのすべての使用モードを理解するように指示するだろう。

API参照

特定の関数、クラス、または方法に関する情報を探している場合、文書のこの部分はあなたのために用意されています。