Wonders with Click: CLI エクスペリエンスを合理化

導入

このブログでは、CLI のパフォーマンスとリーチを効率化できる Python ライブラリである Click の魅力的な側面を詳しく掘り下げていきます。基本的でコンパクトな CLI を作成するために必要な概念について説明します。このブログは、制作と整理に役立ちますか?クライアントにとってより良い CLI はありますか?

そもそもクリックって何？？

クリックは Python パッケージ ですか?これは、CLI ユーティリティの開発を迅速化するのに役立ちます。このパッケージは、コマンド ライン インターフェイスを開発するための他の Python パッケージと比較して、より簡単なオプション ✅ として機能します。 最小限のコーディングが必要であり、開発機能を合理化する多くの組み込み機能が付属しているため、これはより良いオプションです。

クリックの基本をマスターする

インストール:

インストールするには、次のコマンドをクリックして実行します。

pip install click

コーディング：

まず、main.py という名前のファイルを作成し、好みのコード エディタ/IDE でファイルを開きます。次に、次のコード スニペットを導入して、基本的な cli ツールを作成しますか? main.py
内

import click

@click.command()
def say_hello():
  click.echo("Hello Bob")

# runs when the file is run directly and not imported
if __name__ == "__main__": 
  say_hello()

ここでは @click.command デコレータを使用して、関数に cli コマンド (Git の commit、merge、init など) に適した機能を追加します。 click.echo は、クリックのニーズに合わせてカスタマイズされた Python 印刷関数です。

複数のコマンドがある

import click

@click.group()
def cli():
  pass

@click.command()
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def say_hello(name):
  click.echo(f'Hello {name}!')

@click.command()
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def say_bye(name):
  click.echo(f'Goodbye {name}!')

@click.command()
@click.option('--num', prompt='Enter a number',type=int ,
              help='The person to greet.')
def give_square(num):
  click.echo(num*num)


# Registering the commands with the CLI
cli.add_command(say_hello)
cli.add_command(say_bye)
cli.add_command(give_square)


if __name__ == "__main__": 
  cli()

@click.option デコレータは、関数をオプションの値を取得できるコマンドに変換します。

この スニペット を使用するには、ターミナルで次のコマンドを実行します。

python main.py Say_hello --name=Kris

引数を扱う

import click

@click.command()
@click.argument('name')
def say_hello(name):
  click.echo(f"Hello {name}")

# runs when the file is run directly and not imported
if __name__ == "__main__": 
  say_hello()

@click.argument デコレーターは、関数を、提供され、cli によって必要とされる引数を取る機能を持つコマンドに変換します。

このコード スニペットを使用するには、ターミナルで次のコマンドを実行します。

python main.py bob

結論

Click を使用すると、Python で コマンドライン インターフェイス を構築することが簡単かつ直感的になります。複数のコマンド、オプション、引数をサポートしているため、単純なユースケースから複雑なユースケースまで拡張できる強力なツールです。

一言で言えば:

• コマンド グループを使用すると、複数のコマンドを整理できます。
• コマンドは、CLI が実行するアクションを定義します。
• オプションと引数 を使用すると、ユーザー入力でコマンドの動作をカスタマイズできます。

次の Python のために Click を試してみましょう
プロジェクトを実行して、ユーザーフレンドリーな CLI ツールをいかに簡単に構築できるかを確認してください!

以上がWonders with Click: CLI エクスペリエンスを合理化の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。