API —ドキュメントをクリックします

API

ドキュメントのこの部分には、すべてのパブリッククラスと関数の完全なAPIリファレンスがリストされています。

デコレータ

click.command(name=None, cls=None, **attrs)

新しいコマンドを作成し、装飾された関数をコールバックとして使用します。 これにより、装飾されたすべての option（）と arguments（）がパラメーターとしてコマンドに自動的にアタッチされます。

コマンドの名前は、デフォルトで関数の名前になり、アンダースコアがダッシュに置き換えられます。 これを変更したい場合は、最初の引数として目的の名前を渡すことができます。

すべてのキーワード引数は、基になるコマンドクラスに転送されます。

装飾されると、関数は Command インスタンスに変わり、コマンドラインユーティリティとして呼び出すか、コマンド Group にアタッチできます。

パラメーター

• name （オプション [ str ] ）–コマンドの名前。 これはデフォルトで関数名になり、アンダースコアがダッシュに置き換えられます。

• cls （オプション [ タイプ [ click.core.Command ] ] ）–インスタンス化するコマンドクラス。 これはデフォルトでコマンドになります。

• attrs （ Any ）–

リターンタイプ

Callable [[click.decorators.F]、 click.core.Command ]

click.group(name=None, **attrs)

コールバックとしての関数を使用して、新しい Group を作成します。 これは、 cls パラメーターが Group に設定されていることを除けば、 command（）と同じように機能します。

パラメーター

;;* 名前（オプション [ str ] ）–

• attrs （ Any ）–

リターンタイプ

Callable [[click.decorators.F]、 click.core.Group ]

click.argument(*param_decls, **attrs)

コマンドに引数を付加します。 すべての位置引数は、パラメーター宣言として引数に渡されます。 すべてのキーワード引数は変更されずに転送されます（clsを除く）。 これは、 Argument インスタンスを手動で作成し、それを Command.params リストに添付するのと同じです。

パラメーター

;;* cls –インスタンス化する引数クラス。 これはデフォルトで引数になります。

• param_decls （ str ）–
• attrs （ Any ）–

リターンタイプ

Callable [[click.decorators.FC]、click.decorators.FC]

click.option(*param_decls, **attrs)

コマンドにオプションを付加します。 すべての位置引数は、パラメーター宣言として Option に渡されます。 すべてのキーワード引数は変更されずに転送されます（clsを除く）。 これは、 Option インスタンスを手動で作成し、それを Command.params リストに添付するのと同じです。

パラメーター

;;* cls –インスタンス化するオプションクラス。 これはデフォルトで Option になります。

• param_decls （ str ）–
• attrs （ Any ）–

リターンタイプ

Callable [[click.decorators.FC]、click.decorators.FC]

click.password_option(*param_decls, **kwargs)

--passwordオプションを追加して、パスワードの入力を求め、入力を非表示にして、確認のために値をもう一度入力するように求めます。

パラメーター

;;* param_decls （ str ）– 1つ以上のオプション名。 デフォルトは単一の値"--password"です。

• kwargs （ Any ）–追加の引数が option（）に渡されます。

リターンタイプ

Callable [[click.decorators.FC]、click.decorators.FC]

click.confirmation_option(*param_decls, **kwargs)

--yesオプションを追加して、渡されなかった場合に続行する前にプロンプトを表示します。 プロンプトが拒否された場合、プログラムは終了します。

パラメーター

;;* param_decls （ str ）– 1つ以上のオプション名。 デフォルトは単一の値"--yes"です。

• kwargs （ Any ）–追加の引数が option（）に渡されます。

リターンタイプ

Callable [[click.decorators.FC]、click.decorators.FC]

click.version_option(version=None, *param_decls, package_name=None, prog_name=None, message=None, **kwargs)

--versionオプションを追加すると、バージョン番号がすぐに出力され、プログラムが終了します。

versionが提供されていない場合、Clickはimportlib.metadata.version()を使用してそれを検出し、package_nameのバージョンを取得しようとします。 Python <3.8では、importlib_metadata バックポートをインストールする必要があります。

package_nameが指定されていない場合、Clickはスタックフレームを検査して検出を試みます。 これはバージョンの検出に使用されるため、インストールされているパッケージの名前と一致する必要があります。

パラメーター

• バージョン（オプション [ str ] ）–表示するバージョン番号。 指定されていない場合、Clickはそれを検出しようとします。

• param_decls （ str ）– 1つ以上のオプション名。 デフォルトは単一の値"--version"です。

• package_name （オプション [ str ] ）–バージョンを検出するパッケージ名。 指定されていない場合、Clickはそれを検出しようとします。

• prog_name （オプション [ str ] ）–メッセージに表示するCLIの名前。 指定しない場合は、コマンドから検出されます。

• メッセージ（オプション [ str ] ）–表示するメッセージ。 値%(prog)s、%(package)s、および%(version)sが使用可能です。 デフォルトは"%(prog)s, version %(version)s"です。

• kwargs （ Any ）–追加の引数が option（）に渡されます。

上げる

RuntimeError – versionを検出できませんでした。

リターンタイプ

Callable [[click.decorators.FC]、click.decorators.FC]

バージョン8.0で変更：メッセージのpackage_nameパラメーターと%(package)s値を追加します。

バージョン8.0で変更： pkg_resourcesの代わりにimportlib.metadataを使用します。 バージョンは、エントリポイント名ではなく、パッケージ名に基づいて検出されます。 Pythonパッケージ名は、インストールされているパッケージ名と一致するか、package_name=で渡される必要があります。

click.help_option(*param_decls, **kwargs)

--helpオプションを追加すると、ヘルプページがすぐに印刷され、プログラムが終了します。

add_help_option=Falseが渡されない限り、--helpオプションが各コマンドに自動的に追加されるため、これは通常不要です。

パラメーター

• param_decls （ str ）– 1つ以上のオプション名。 デフォルトは単一の値"--help"です。

• kwargs （ Any ）–追加の引数が option（）に渡されます。

リターンタイプ

Callable [[click.decorators.FC]、click.decorators.FC]

click.pass_context(f)

現在のコンテキストオブジェクトを最初の引数として受け取りたいとしてコールバックをマークします。

パラメーター

f （ click.decorators.F ）–

リターンタイプ

click.decorators.F

click.pass_obj(f)

pass_context（）に似ていますが、コンテキスト以降のオブジェクト（ Context.obj ）のみを渡します。 これは、そのオブジェクトがネストされたシステムの状態を表す場合に役立ちます。

パラメーター

f （ click.decorators.F ）–

リターンタイプ

click.decorators.F

click.make_pass_decorator(object_type, ensure=False)

オブジェクトタイプが与えられると、これは pass_obj（）と同様に機能するデコレータを作成しますが、現在のコンテキストのオブジェクトを渡す代わりに、タイプobject_type()の最も内側のコンテキストを見つけます。

これにより、おおよそ次のように機能するデコレータが生成されます。

from functools import update_wrapper

def decorator(f):
    @pass_context
    def new_func(ctx, *args, **kwargs):
        obj = ctx.find_object(object_type)
        return ctx.invoke(f, obj, *args, **kwargs)
    return update_wrapper(new_func, f)
return decorator

パラメーター

• object_type （ Type ）–渡すオブジェクトのタイプ。

• sure （ bool ）– True に設定すると、新しいオブジェクトが作成され、コンテキストにまだ存在しない場合は記憶されます。

リターンタイプ

Callable [[click.decorators.F]、click.decorators.F]

click.decorators.pass_meta_key(key, *, doc_description=None)

click.Context.meta からのキーをデコレートされた関数への最初の引数として渡すデコレータを作成します。

パラメーター

• key （ str ）– Context.metaを入力して渡します。

• doc_description （オプション [ str ] ）–渡され、デコレータのdocstringに挿入されるオブジェクトの説明。 デフォルトは「Context.metaの「キー」キー」です。

リターンタイプ

Callable [[click.decorators.F]、click.decorators.F]

バージョン8.0の新機能。

ユーティリティ

click.echo(message=None, file=None, nl=True, err=False, color=None)

メッセージと改行をstdoutまたはファイルに出力します。 これは、print()の代わりに使用する必要があります。これは、さまざまなデータ、ファイル、および環境に対するサポートが向上するためです。

print()と比較すると、これは次のことを行います。

• Linuxで出力エンコーディングが誤って構成されていないことを確認します。

• WindowsコンソールでUnicodeをサポートします。

• バイナリ出力への書き込みをサポートし、テキスト出力へのバイトの書き込みをサポートします。

• Windowsで色とスタイルをサポートします。

• 出力がインタラクティブ端末のように見えない場合は、ANSIカラーコードとスタイルコードを削除します。

• 常に出力をフラッシュします。

パラメーター

• メッセージ（オプション [ Any ] ）–出力する文字列またはバイト。 他のオブジェクトは文字列に変換されます。

• ファイル（オプション [ IO ] ）–書き込むファイル。 デフォルトはstdoutです。

• err （ bool ）– stdoutの代わりにstderrに書き込みます。

• nl （ bool ）–メッセージの後に改行を出力します。 デフォルトで有効になっています。

• color （オプション [ bool ] ）–色やその他のスタイルを強制的に表示または非表示にします。 デフォルトでは、出力がインタラクティブ端末のように見えない場合、Clickは色を削除します。

リターンタイプ

なし

バージョン6.0で変更： WindowsコンソールでUnicode出力をサポートします。 Clickはsys.stdoutを変更しないため、sys.stdout.write()およびprint()は引き続きUnicodeをサポートしません。

バージョン4.0で変更： colorパラメーターが追加されました。

バージョン3.0の新機能： errパラメーターが追加されました。

バージョン2.0で変更： coloramaがインストールされている場合、Windowsで色をサポートします。

click.echo_via_pager(text_or_generator, color=None)

この関数はテキストを受け取り、stdoutの環境固有のページャーを介して表示します。

バージョン3.0で変更： color フラグが追加されました。

パラメーター

• text_or_generator （ Union [ Iterable [ str ] 、 呼び出し可能 [ [ ] 、 反復可能 [ X195X] [ str ] ] 、 str ] ）–テキストからページへ、またはテキストからページへの出力を生成するジェネレーター。

• color （オプション [ bool ] ）–ポケットベルがANSIカラーをサポートするかどうかを制御します。 デフォルトは自動検出です。

リターンタイプ

なし

click.prompt(text, default=None, hide_input=False, confirmation_prompt=False, type=None, value_proc=None, prompt_suffix=': ', show_default=True, err=False, show_choices=True)

ユーザーに入力を求めます。 これは、後でユーザーに入力を求めるために使用できる便利な機能です。

ユーザーが割り込み信号を送信して入力を中止すると、この関数は入力をキャッチして Abort 例外を発生させます。

パラメーター

• text （ str ）–プロンプトに表示するテキスト。

• default （オプション [ Any ] ）–入力がない場合に使用するデフォルト値。 これが指定されていない場合は、中止されるまでプロンプトが表示されます。

• hide_input （ bool ）–これがtrueに設定されている場合、入力値は非表示になります。

• commentation_prompt （ Union [ bool 、 str ] ）–値を確認するためにもう一度プロンプトを表示します。 Trueの代わりに文字列に設定して、メッセージをカスタマイズできます。

• type （オプション [ click.types.ParamType ] ）–値の確認に使用するタイプに対して。

• value_proc （オプション [ 呼び出し可能 [ [ str ] 、 Any ] ] ）–このパラメーターが指定されている場合、代わりに呼び出される関数です値を変換するための型変換。

• prompt_suffix （ str ）–プロンプトに追加する必要のあるサフィックス。

• show_default （ bool ）–プロンプトのデフォルト値を表示または非表示にします。

• err （ bool ）– trueに設定すると、ファイルは、echoの場合と同じように、stdoutではなくstderrにデフォルト設定されます。

• show_choices （ bool ）–渡されたタイプがChoiceの場合、選択肢を表示または非表示にします。 たとえば、typeがdayまたはweekのいずれかの選択肢であり、show_choicesがtrueで、テキストが「Group by」の場合、プロンプトは「Group by（day、week）：」になります。

リターンタイプ

どれでも

バージョン8.0の新機能： confirmation_promptはカスタム文字列にすることができます。

バージョン7.0の新機能： show_choicesパラメーターが追加されました。

バージョン6.0の新機能： Windowsでのcmd.exeのUnicodeサポートが追加されました。

バージョン4.0の新機能： err パラメーターが追加されました。

click.confirm(text, default=False, abort=False, prompt_suffix=': ', show_default=True, err=False)

確認のプロンプト（はい/質問なし）。

ユーザーが割り込み信号を送信して入力を中止すると、この関数は入力をキャッチして Abort 例外を発生させます。

パラメーター

• text （ str ）–尋ねる質問。

• default （オプション [ bool ] ）–入力が指定されていない場合に使用するデフォルト値。 Noneの場合は、入力が行われるまで繰り返します。

• abort （ bool ）–これが True に設定されている場合、否定的な回答は Abort を発生させて例外を中止します。

• prompt_suffix （ str ）–プロンプトに追加する必要のあるサフィックス。

• show_default （ bool ）–プロンプトのデフォルト値を表示または非表示にします。

• err （ bool ）– trueに設定すると、ファイルは、echoの場合と同じように、stdoutではなくstderrにデフォルト設定されます。

リターンタイプ

ブール

バージョン8.0で変更： defaultがNoneの場合、入力が行われるまで繰り返します。

バージョン4.0の新機能： errパラメーターが追加されました。

click.progressbar(iterable=None, length=None, label=None, show_eta=True, show_percent=None, show_pos=False, item_show_func=None, fill_char='#', empty_char='-', bar_template='%(label)s  [%(bar)s]  %(info)s', info_sep='  ', width=36, file=None, color=None, update_min_steps=1)

この関数は、プログレスバーを表示しながら何かを反復処理するために使用できる反復可能なコンテキストマネージャーを作成します。 iterable または length アイテム（カウントアップされている）を繰り返し処理します。 反復が発生している間、この関数はレンダリングされたプログレスバーを指定されたファイル（デフォルトはstdout）に出力し、残り時間などの計算を試みます。 デフォルトでは、ファイルがターミナルでない場合、このプログレスバーは表示されません。

コンテキストマネージャーはプログレスバーを作成します。 コンテキストマネージャーに入ると、プログレスバーがすでに作成されています。 プログレスバーを反復するたびに、バーに渡された反復可能オブジェクトが進められ、バーが更新されます。 コンテキストマネージャが終了すると、改行が出力され、進行状況バーが画面に表示されます。

注：プログレスバーは現在、全体の進行に少なくとも数秒かかると予想されるユースケース向けに設計されています。 このため、ProgressBarクラスオブジェクトは、速すぎると見なされる進行状況と、ステップ間の時間が1秒未満の進行状況を表示しません。

印刷を行わないでください。そうしないと、プログレスバーが意図せずに破壊されます。

使用例：

with progressbar(items) as bar:
    for item in bar:
        do_something_with(item)

または、反復可能オブジェクトが指定されていない場合は、プログレスバーを直接反復する代わりに、 update（）メソッドを使用してプログレスバーを手動で更新できます。 updateメソッドは、次のようにバーをインクリメントするためのステップ数を受け入れます。

with progressbar(length=chunks.total_bytes) as bar:
    for chunk in chunks:
        process_chunk(chunk)
        bar.update(chunks.bytes)

update()メソッドも、新しい位置でcurrent_itemを指定するオプションの値を取ります。 これは、item_show_funcと一緒に使用して、各手動ステップの出力をカスタマイズする場合に役立ちます。

with click.progressbar(
    length=total_size,
    label='Unzipping archive',
    item_show_func=lambda a: a.filename
) as bar:
    for archive in zip_file:
        archive.extract()
        bar.update(archive.size, archive)

パラメーター

• 反復可能（オプション [ 反復可能 [ click.termui.V ] ] ）–反復可能です。 指定されていない場合、長さが必要です。

• length （オプション [ int ] ）–反復するアイテムの数。 デフォルトでは、プログレスバーはイテレータにその長さを尋ねようとしますが、これは機能する場合と機能しない場合があります。 iterableも提供されている場合は、このパラメーターを使用して長さをオーバーライドできます。 反復可能が提供されていない場合、プログレスバーはその長さの範囲で反復します。

• label （オプション [ str ] ）–プログレスバーの横に表示されるラベル。

• show_eta （ bool ）–推定時間の表示を有効または無効にします。 長さが決定できない場合、これは自動的に無効になります。

• show_percent （オプション [ bool ] ）–パーセンテージ表示を有効または無効にします。 デフォルトは、イテラブルの長さが True の場合は True 、そうでない場合は False です。

• show_pos （ bool ）–絶対位置の表示を有効または無効にします。 デフォルトは False です。

• item_show_func （オプション [ 呼び出し可能 [ [ オプション [ click.termui.V ] ] 、 オプション [ str ] ] ] ）–現在のアイテムで呼び出される関数。プログレスバー。 関数がNoneを返す場合、何も表示されません。 現在のアイテムは、バーに出入りするときなど、Noneにすることができます。

• fill_char （ str ）–プログレスバーの塗りつぶされた部分を表示するために使用する文字。

• empty_char （ str ）–プログレスバーの塗りつぶされていない部分を表示するために使用する文字。

• bar_template （ str ）–バーのテンプレートとして使用するフォーマット文字列。 その中のパラメータは、ラベルの場合はlabel、プログレスバーの場合はbar、情報セクションの場合はinfoです。

• info_sep （ str ）–複数の情報アイテム（etaなど）間の区切り文字

• width （ int ）–プログレスバーの幅（文字数）。0は端末の全幅を意味します

• ファイル（オプション [ TextIO ] ）–書き込むファイル。 これが端末でない場合は、ラベルのみが印刷されます。

• color （オプション [ bool ] ）–端末がANSIカラーをサポートするかどうかを制御します。 デフォルトは自動検出です。 これは、ANSIコードがプログレスバー出力のどこかに含まれている場合にのみ必要ですが、デフォルトではそうではありません。

• update_min_steps （ int ）–この数の更新が完了した場合にのみレンダリングします。 これにより、非常に高速なイテレータのチューニングが可能になります。

リターンタイプ

ProgressBar [V]

バージョン8.0で変更：実行時間が0.5秒未満の場合でも出力が表示されます。

バージョン8.0で変更： item_show_funcは、前のアイテムではなく、現在のアイテムを表示します。

バージョン8.0で変更：出力がTTYでない場合、ラベルがエコーされます。 すべての出力を削除した7.0での変更を元に戻します。

バージョン8.0の新機能： update_min_stepsパラメーターが追加されました。

バージョン4.0で変更： colorパラメーターが追加されました。 updateメソッドをオブジェクトに追加しました。

バージョン2.0の新機能。

click.clear()

ターミナル画面をクリアします。 これにより、端末の表示スペース全体がクリアされ、カーソルが左上に移動します。 端末に接続されていない場合、これは何もしません。

バージョン2.0の新機能。

リターンタイプ

なし

click.style(text, fg=None, bg=None, bold=None, dim=None, underline=None, overline=None, italic=None, blink=None, reverse=None, strikethrough=None, reset=True)

ANSIスタイルでテキストのスタイルを設定し、新しい文字列を返します。 デフォルトでは、スタイリングは自己完結型です。つまり、文字列の最後にリセットコードが発行されます。 これは、reset=Falseを渡すことで防ぐことができます。

例：

click.echo(click.style('Hello World!', fg='green'))
click.echo(click.style('ATTENTION!', blink=True))
click.echo(click.style('Some things', reverse=True, fg='cyan'))
click.echo(click.style('More colors', fg=(255, 12, 128), bg=117))

サポートされている色の名前：

• black（灰色の場合があります）

• red

• green

• yellow（オレンジ色の場合があります）

• blue

• magenta

• cyan

• white（薄い灰色の場合があります）

• bright_black

• bright_red

• bright_green

• bright_yellow

• bright_blue

• bright_magenta

• bright_cyan

• bright_white

• reset（カラーコードのみをリセット）

端末がそれをサポートしている場合、色は次のように指定することもできます。

• 間隔[0、255]の整数。 端末は8ビット/ 256色モードをサポートする必要があります。

• [0、255]の3つの整数のRGBタプル。 端末は24ビット/トゥルーカラーモードをサポートしている必要があります。

詳細については、 https://en.wikipedia.org/wiki/ANSI_colorおよび https://gist.github.com/XVilka/8346728 を参照してください。

パラメーター

• text （ Any ）– ANSIコードでスタイルを設定する文字列。

• fg （オプション [ ユニオン [ int 、 タプル [ int 、 int 、 int [ X177X]] 、 str ] ] ）–指定されている場合、これは前景色になります。

• bg （オプション [ Union [ int 、 タプル [ int 、 int 、 int [ X177X]] 、 str ] ] ）–指定されている場合、これが背景色になります。

• 太字（オプション [ bool ] ）–指定すると、太字モードが有効または無効になります。

• dim （オプション [ bool ] ）–指定すると、dimモードが有効または無効になります。 これは十分にサポートされていません。

• 下線（オプション [ bool ] ）–指定されている場合、下線が有効または無効になります。

• overline （オプション [ bool ] ）–指定されている場合、オーバーラインが有効または無効になります。

• 斜体（オプション [ bool ] ）–指定すると、斜体が有効または無効になります。

• 点滅（オプション [ bool ] ）–指定すると、点滅が有効または無効になります。

• reverse （ Optional [ bool ] ）–指定されている場合、これにより逆レンダリングが有効または無効になります（フォアグラウンドは背景とその逆）。

• 取り消し線（オプション [ bool ] ）–指定すると、テキストの取り消し線が有効または無効になります。

• reset （ bool ）–デフォルトでは、すべてリセットコードが文字列の最後に追加されます。これは、スタイルが引き継がれないことを意味します。 これを無効にして、スタイルを作成できます。

リターンタイプ

str

バージョン8.0で変更：非文字列messageは文字列に変換されます。

バージョン8.0で変更： 256およびRGBカラーコードのサポートが追加されました。

バージョン8.0で変更： strikethrough、italic、およびoverlineパラメーターが追加されました。

バージョン7.0で変更：明るい色のサポートが追加されました。

バージョン2.0の新機能。

click.unstyle(text)

文字列からANSIスタイリング情報を削除します。 Clickのエコー機能は必要に応じて自動的にスタイリングを削除するため、通常はこの機能を使用する必要はありません。

バージョン2.0の新機能。

パラメーター

text （ str ）–スタイル情報を削除するテキスト。

リターンタイプ

str

click.secho(message=None, file=None, nl=True, err=False, color=None, **styles)

この関数は、 echo（）と style（）を1つの呼び出しに結合します。 そのため、次の2つの呼び出しは同じです。

click.secho('Hello World!', fg='green')
click.echo(click.style('Hello World!', fg='green'))

すべてのキーワード引数は、使用する関数に応じて、基になる関数に転送されます。

文字列以外のタイプはstrに変換されます。 ただし、bytesは、スタイルを適用せずに echo（）に直接渡されます。 テキストを表すバイトのスタイルを設定する場合は、最初にbytes.decode()を呼び出します。

バージョン8.0で変更：非文字列messageは文字列に変換されます。 バイトはスタイルを適用せずに渡されます。

バージョン2.0の新機能。

パラメーター

• メッセージ（オプション [ 任意 ] ）–

• ファイル（オプション [ IO ] ）–

• nl （ bool ）–

• err （ bool ）–

• color （オプション [ bool ] ）–

• スタイル（任意）–

リターンタイプ

なし

click.edit(text=None, editor=None, env=None, require_save=True, extension='.txt', filename=None)

定義されたエディターで指定されたテキストを編集します。 エディターが指定されている場合（実行可能ファイルへのフルパスである必要がありますが、実行可能ファイルの検索には通常のオペレーティングシステム検索パスが使用されます）、検出されたエディターをオーバーライドします。 オプションで、いくつかの環境変数を使用できます。 エディターを変更せずに閉じると、 None が返されます。 ファイルを直接編集する場合、戻り値は常に None であり、 require_save および extension は無視されます。

エディタを開くことができない場合、 UsageError が発生します。

Windowsに関する注意：クロスプラットフォームの使用を簡素化するために、改行はPOSIXからWindowsに、またはその逆に自動的に変換されます。 そのため、ここでのメッセージには、改行マーカーとして\nが含まれます。

パラメーター

• text （オプション [ AnyStr ] ）–編集するテキスト。

• エディター（オプション [ str ] ）–オプションで使用するエディター。 デフォルトは自動検出です。

• env （オプション [ マッピング [ str 、 str ] ] ）–エディターに転送する環境変数。

• require_save （ bool ）–これがtrueの場合、エディターに保存しないと、戻り値は None になります。

• extension （ str ）–編集者に通知する拡張子。 これはデフォルトで .txt になりますが、これを変更すると構文の強調表示が変わる可能性があります。

• ファイル名（オプション [ str ] ）–指定されている場合、提供されたテキストの代わりにこのファイルを編集しますコンテンツ。 その場合、一時ファイルを間接参照として使用しません。

リターンタイプ

オプション[AnyStr]

click.launch(url, wait=False, locate=False)

この関数は、このファイルタイプのデフォルトのビューアアプリケーションで指定されたURL（またはファイル名）を起動します。 これが実行可能ファイルの場合、新しいセッションで実行可能ファイルを起動する可能性があります。 戻り値は、起動されたアプリケーションの終了コードです。 通常、0は成功を示します。

例：

click.launch('https://click.palletsprojects.com/')
click.launch('/my/downloaded/file', locate=True)

バージョン2.0の新機能。

パラメーター

• url （ str ）–起動するもののURLまたはファイル名。

• wait （ bool ）–プログラムが終了するのを待ってから戻ります。 これは、起動されたプログラムがブロックされた場合にのみ機能します。 特に、Linux上のxdg-openはブロックしません。

• Locate （ bool ）–これが True に設定されている場合、URLに関連付けられたアプリケーションを起動する代わりに、ファイルを使用してファイルマネージャーを起動しようとします。位置した。 URLがファイルシステムを指していない場合、これは奇妙な影響を与える可能性があります。

リターンタイプ

int

click.getchar(echo=False)

端末から1文字をフェッチして返します。 これは常にUnicode文字を返し、特定のまれな状況では、これは複数の文字を返す場合があります。 複数の文字が返される状況は、何らかの理由で複数の文字が端末バッファーに格納されるか、標準入力が実際には端末ではなかった場合です。

何かが標準入力にパイプされている場合でも、これは常に端末から読み取られることに注意してください。

Windowsに関する注意：まれに、ASCII以外の文字を入力するときに、この関数は2番目の文字を待ってから、両方を同時に返す場合があります。 これは、特定のUnicode文字が特殊キーマーカーのように見えるためです。

バージョン2.0の新機能。

パラメーター

echo （ bool ）– True に設定すると、読み取った文字も端末に表示されます。 デフォルトでは表示されません。

リターンタイプ

str

click.pause(info=None, err=False)

このコマンドは実行を停止し、ユーザーがいずれかのキーを押して続行するのを待ちます。 これは、Windowsのバッチ「一時停止」コマンドに似ています。 プログラムが端末を介して実行されていない場合、このコマンドは代わりに何もしません。

バージョン2.0の新機能。

バージョン4.0の新機能： err パラメーターが追加されました。

パラメーター

• info （オプション [ str ] ）–一時停止する前に印刷するメッセージ。 デフォルトは"Press any key to continue..."です。

• err （ bool ）–メッセージに設定されている場合、エコーの場合と同じように、stdoutではなくstderrに移動します。

リターンタイプ

なし

click.get_terminal_size()

端末の現在のサイズをタプルとして(width, height)の形式で列と行に返します。

バージョン8.0以降非推奨： Click8.1で削除されます。 代わりにshutil.get_terminal_size()を使用してください。

リターンタイプ

os.terminal_size

click.get_binary_stream(name)

バイト処理用のシステムストリームを返します。

パラメーター

名前（ te.Literal [ stdin 、 stdout 、 stderr ] ）–開くストリームの名前。 有効な名前は、'stdin'、'stdout'、および'stderr'です。

リターンタイプ

BinaryIO

click.get_text_stream(name, encoding=None, errors='strict')

テキスト処理用のシステムストリームを返します。 これは通常、 get_binary_stream（）から返されたバイナリストリームの周りにラップされたストリームを返しますが、すでに正しく構成されているストリームへのショートカットを取ることもできます。

パラメーター

;;* 名前（ te.Literal [ stdin 、 stdout 、 stderr ] ）–開くストリームの名前。 有効な名前は、'stdin'、'stdout'、および'stderr'です。

• encoding （オプション [ str ] ）–検出されたデフォルトのエンコーディングを上書きします。
• エラー（オプション [ str ] ）–デフォルトのエラーモードをオーバーライドします。

リターンタイプ

TextIO

click.open_file(filename, mode='r', encoding=None, errors='strict', lazy=False, atomic=False)

これは、ファイルの動作と似ていますが、手動で使用します。 デフォルトでは、ファイルは遅延なしで開かれます。 これにより、'-'が渡された場合、stdin / stdoutだけでなく通常のファイルも開くことができます。

stdin / stdoutが返されると、コンテキストマネージャーが誤ってストリームを閉じないように、ストリームがラップされます。 これにより、標準ストリームを誤って閉じることを心配することなく、常に次のような関数を使用できます。

with open_file(filename) as f:
    ...

バージョン3.0の新機能。

パラメーター

• filename （ str ）–開くファイルの名前（またはstdin / stdoutの場合は'-'）。

• mode （ str ）–ファイルを開くモード。

• encoding （オプション [ str ] ）–使用するエンコーディング。

• エラー（オプション [ str ] ）–このファイルのエラー処理。

• lazy （ bool ）– trueに反転して、ファイルを遅延で開くことができます。

• atomic （ bool ）–アトミックモードでは、書き込みは一時ファイルに送られ、閉じるときに移動されます。

リターンタイプ

IO

click.get_app_dir(app_name, roaming=True, force_posix=False)

アプリケーションのconfigフォルダーを返します。 デフォルトの動作では、オペレーティングシステムに最も適切なものを返します。

アイデアを与えるために、"Foo Bar"というアプリの場合、次のフォルダーのようなものが返される可能性があります。

Mac OS X：

~/Library/Application Support/Foo Bar

Mac OS X（POSIX）：

~/.foo-bar

Unix：

~/.config/foo-bar

Unix（POSIX）：

~/.foo-bar

Windows（ローミング）：

C:\Users\<user>\AppData\Roaming\Foo Bar

Windows（ローミングではない）：

C:\Users\<user>\AppData\Local\Foo Bar

バージョン2.0の新機能。

パラメーター

• app_name （ str ）–アプリケーション名。 これは適切に大文字にする必要があり、空白を含めることができます。

• ローミング（ bool ）– Windowsでフォルダーをローミングするかどうかを制御します。 それ以外の影響はありません。

• force_posix （ bool ）–これが True に設定されている場合、どのPOSIXシステムでも、フォルダーはホームフォルダーに保存されます。 XDG構成ホームまたはdarwinのアプリケーションサポートフォルダー。

リターンタイプ

str

click.format_filename(filename, shorten=False)

ユーザーが表示できるようにファイル名をフォーマットします。 この関数の主な目的は、ファイル名を表示できるようにすることです。 これにより、失敗しないように、必要に応じてファイル名がUnicodeにデコードされます。 オプションで、ファイル名を短くして、ファイル名へのフルパスを含めないようにすることができます。

パラメーター

;;* ファイル名（ユニオン [ str 、 バイト 、 os.PathLike ] ）– UI表示用のファイル名をフォーマットします。 これにより、ファイル名が失敗することなくユニコードに変換されます。

• shorten （ bool ）–これは、オプションで、ファイル名を、それにつながるパスのストリップに短縮します。

リターンタイプ

str

コマンド

class click.BaseCommand(name, context_settings=None)

基本コマンドは、コマンドの最小限のAPIコントラクトを実装します。 ほとんどのコードは、多くの便利な機能を実装していないため、これを使用することはありませんが、クリックパーサーに依存しない代替の解析メソッドの直接のサブクラスとして機能できます。

たとえば、これを使用して、Clickとargparseやdocoptなどの他のシステムをブリッジできます。

基本コマンドは、Clickの他の部分が当然と考える多くのAPIを実装していないため、すべての操作でサポートされているわけではありません。 たとえば、通常はデコレータと一緒に使用することはできず、コールバックシステムが組み込まれていません。

バージョン2.0で変更： context_settings パラメーターが追加されました。

パラメーター

• name （オプション [ str ] ）–グループがオーバーライドしない限り使用するコマンドの名前。

• context_settings （オプション [ Dict [ str 、 Any ] ] ）–コンテキストオブジェクトに渡されるデフォルトのオプションの辞書。

リターンタイプ

なし

allow_extra_args = False

Context.allow_extra_args フラグのデフォルト。

allow_interspersed_args = True

Context.allow_interspersed_args フラグのデフォルト。

context_class

make_context（）で作成するコンテキストクラス。

バージョン8.0の新機能。

click.core.Context のエイリアス

context_settings: Dict[str, Any]

デフォルトがコンテキストに渡されるオプションの辞書。

ignore_unknown_options = False

Context.ignore_unknown_options フラグのデフォルト。

invoke(ctx)

コンテキストが与えられると、これはコマンドを呼び出します。 デフォルトの実装では、実装されていないエラーが発生します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

どれでも

main(args=None, prog_name=None, complete_var=None, standalone_mode=True, windows_expand_args=True, **extra)

これは、コマンドラインアプリケーションとしてすべてのベルとホイッスルを使用してスクリプトを呼び出す方法です。 これにより、呼び出し後に常にアプリケーションが終了します。 これが望ましくない場合は、SystemExitをキャッチする必要があります。

このメソッドは、コマンドのインスタンスを直接呼び出すことによっても使用できます。

パラメーター

• args （オプション [ シーケンス [ str ] ] ）–解析に使用する必要のある引数。 指定しない場合は、sys.argv[1:]が使用されます。

• prog_name （オプション [ str ] ）–使用するプログラム名。 デフォルトでは、プログラム名はsys.argv[0]からファイル名を取得して作成されます。

• complete_var （オプション [ str ] ）– bash完了サポートを制御する環境変数。 デフォルトは"_<prog_name>_COMPLETE"で、prog_nameは大文字です。

• Standalone_mode （ bool ）–デフォルトの動作では、スタンドアロンモードでスクリプトを呼び出します。 Clickは例外を処理し、それらをエラーメッセージに変換します。関数は決して戻りませんが、インタープリターをシャットダウンします。 これが False に設定されている場合、それらは呼び出し元に伝播され、この関数の戻り値は invoke（）の戻り値になります。

• windows_expand_args （ bool ）– Windowsのコマンドライン引数でglobパターン、ユーザーdir、およびenv変数を展開します。

• extra （ Any ）–追加のキーワード引数がコンテキストコンストラクターに転送されます。 詳細については、コンテキストを参照してください。

リターンタイプ

どれでも

バージョン8.0.1で変更： windows_expand_argsパラメーターを追加して、Windowsでコマンドライン引数の拡張を無効にできるようにしました。

バージョン8.0で変更： Windowsでsys.argvから引数を取得すると、globパターン、ユーザーdir、およびenv変数が展開されます。

バージョン3.0で変更： standalone_modeパラメーターが追加されました。

make_context(info_name, args, parent=None, **extra)

この関数に情報名と引数を指定すると、解析が開始され、新しいコンテキストが作成されます。 ただし、実際のコマンドコールバックは呼び出されません。

このメソッドをオーバーライドせずに使用されるコンテキストクラスをすばやくカスタマイズするには、 context_class 属性を設定します。

パラメーター

• info_name （オプション [ str ] ）–この呼び出しの情報名。 通常、これはスクリプトまたはコマンドの最もわかりやすい名前です。 トップレベルのスクリプトの場合、通常はスクリプトの名前であり、その下のコマンドの場合はコマンドの名前です。

• args （ List [ str ] ）–文字列のリストとして解析する引数。

• 親（オプション [ click.core.Context ] ）–使用可能な場合は親コンテキスト。

• extra （ Any ）–コンテキストコンストラクターに転送される追加のキーワード引数。

リターンタイプ

click.core.Context

バージョン8.0で変更： context_class 属性が追加されました。

name

コマンドが持つと考える名前。 グループにコマンドを登録すると、グループはこの情報を使用してコマンド名をデフォルトにします。 代わりに、 Context ' s info_name 属性を使用する必要があります。

parse_args(ctx, args)

コンテキストと引数のリストが与えられると、これはパーサーを作成して引数を解析し、必要に応じてコンテキストを変更します。 これは、 make_context（）によって自動的に呼び出されます。

パラメーター

• ctx （ click.core.Context ）–

• args （ List [ str ] ）–

リターンタイプ

リスト[str]

shell_complete(ctx, incomplete)

不完全な値の完了のリストを返します。 チェーンされたマルチコマンドの名前を調べます。

どのコマンドも連鎖マルチコマンドの一部である可能性があるため、兄弟コマンドはコマンド補完中の任意の時点で有効です。 他のコマンドクラスは、より多くの補完を返します。

パラメーター

• ctx （ click.core.Context ）–このコマンドの呼び出しコンテキスト。

• 不完全（ str ）–値が完了しています。 空の可能性があります。

リターンタイプ

リスト[完了アイテム]

バージョン8.0の新機能。

to_info_dict(ctx)

ユーザー向けのドキュメントを生成するツールに役立つ可能性のある情報を収集します。 これは、このコマンドの下の構造全体をトラバースします。

click.Context.to_info_dict（）を使用して、CLI構造全体をトラバースします。

パラメーター

ctx （ click.core.Context ）–このコマンドを表す Context 。

リターンタイプ

Dict [str、Any]

バージョン8.0の新機能。

class click.Command(name, context_settings=None, callback=None, params=None, help=None, epilog=None, short_help=None, options_metavar='[OPTIONS]', add_help_option=True, no_args_is_help=False, hidden=False, deprecated=False)

コマンドは、Clickのコマンドラインインターフェイスの基本的な構成要素です。 基本的なコマンドはコマンドライン解析を処理し、その下にネストされたコマンドにより多くの解析をディスパッチする場合があります。

バージョン2.0で変更： context_settings パラメーターが追加されました。

バージョン8.0で変更：コマンド名を示すreprを追加

バージョン7.1で変更： no_args_is_help パラメーターが追加されました。

パラメーター

• name （オプション [ str ] ）–グループがオーバーライドしない限り使用するコマンドの名前。

• context_settings （ Dict [ str 、 Any ] ）–コンテキストオブジェクトに渡されるデフォルトのオプションの辞書。

• コールバック（オプション [ 呼び出し可能 [ [ ... [ X90X] ] 、 Any ] ] ）–呼び出すコールバック。 これはオプションです。

• params （オプション [ リスト [ パラメーター ] ] ）–このコマンドに登録するパラメーター。 これは、 Option または Argument オブジェクトのいずれかです。

• help （オプション [ str ] ）–このコマンドに使用するヘルプ文字列。

• epilog （オプション [ str ] ）–ヘルプ文字列と同様ですが、何よりもヘルプページ。

• short_help （オプション [ str ] ）–このコマンドに使用する短いヘルプ。 これは、親コマンドのコマンドリストに表示されます。

• add_help_option （ bool ）–デフォルトでは、各コマンドは--helpオプションを登録します。 これは、このパラメーターによって無効にできます。

• no_args_is_help （ bool ）–これは、引数が指定されていない場合に何が起こるかを制御します。 このオプションはデフォルトで無効になっています。 有効にすると、引数が渡されない場合、引数として--helpが追加されます

• hidden （ bool ）–このコマンドをヘルプ出力から非表示にします。

• deprecated （ bool ）–コマンドが非推奨であることを示すメッセージを発行します。

• options_metavar （オプション [ str ] ）–

リターンタイプ

なし

callback

コマンドが起動したときに実行するコールバック。 これはなしである可能性があり、その場合は何も起こりません。

collect_usage_pieces(ctx)

使用ラインに入るすべての部分を返し、それを文字列のリストとして返します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

リスト[str]

format_epilog(ctx, formatter)

エピローグが存在する場合は、フォーマッターに書き込みます。

パラメーター

• ctx （ click.core.Context ）–

• フォーマッター（ click.formatting.HelpFormatter ）–

リターンタイプ

なし

format_help(ctx, formatter)

ヘルプが存在する場合は、フォーマッタに書き込みます。

これは、 get_help（）によって呼び出される低レベルのメソッドです。

これにより、次のメソッドが呼び出されます。

• format_usage()

• format_help_text()

• format_options()

• format_epilog()

パラメーター

• ctx （ click.core.Context ）–

• フォーマッター（ click.formatting.HelpFormatter ）–

リターンタイプ

なし

format_help_text(ctx, formatter)

ヘルプテキストが存在する場合は、フォーマッタに書き込みます。

パラメーター

• ctx （ click.core.Context ）–

• フォーマッター（ click.formatting.HelpFormatter ）–

リターンタイプ

なし

format_options(ctx, formatter)

すべてのオプションが存在する場合は、フォーマッターに書き込みます。

パラメーター

• ctx （ click.core.Context ）–

• フォーマッター（ click.formatting.HelpFormatter ）–

リターンタイプ

なし

format_usage(ctx, formatter)

使用ラインをフォーマッタに書き込みます。

これは、 get_usage（）によって呼び出される低レベルのメソッドです。

パラメーター

• ctx （ click.core.Context ）–

• フォーマッター（ click.formatting.HelpFormatter ）–

リターンタイプ

なし

get_help(ctx)

ヘルプを文字列にフォーマットして返します。

内部で format_help（）を呼び出します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

str

get_help_option(ctx)

ヘルプオプションオブジェクトを返します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

オプション[ click.core.Option ]

get_help_option_names(ctx)

ヘルプオプションの名前を返します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

リスト[str]

get_short_help_str(limit=45)

コマンドの短いヘルプを取得するか、長いヘルプ文字列を短くして作成します。

パラメーター

limit （ int ）–

リターンタイプ

str

get_usage(ctx)

使用ラインを文字列にフォーマットして返します。

内部で format_usage（）を呼び出します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

str

invoke(ctx)

コンテキストが与えられると、これは添付されたコールバック（存在する場合）を正しい方法で呼び出します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

どれでも

make_parser(ctx)

このコマンドの基礎となるオプションパーサーを作成します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

click.parser.OptionParser

params: List[click.core.Parameter]

ヘルプページに表示されて実行される順序でのこのコマンドのパラメーターのリスト。 熱心なパラメータは、熱心でないパラメータよりも先に自動的に処理されます。

parse_args(ctx, args)

コンテキストと引数のリストが与えられると、これはパーサーを作成して引数を解析し、必要に応じてコンテキストを変更します。 これはmake_context()によって自動的に呼び出されます。

パラメーター

• ctx （ click.core.Context ）–

• args （ List [ str ] ）–

リターンタイプ

リスト[str]

shell_complete(ctx, incomplete)

不完全な値の完了のリストを返します。 オプションとチェーンされたマルチコマンドの名前を調べます。

パラメーター

• ctx （ click.core.Context ）–このコマンドの呼び出しコンテキスト。

• 不完全（ str ）–値が完了しています。 空の可能性があります。

リターンタイプ

リスト[完了アイテム]

バージョン8.0の新機能。

to_info_dict(ctx)

ユーザー向けのドキュメントを生成するツールに役立つ可能性のある情報を収集します。 これは、このコマンドの下の構造全体をトラバースします。

click.Context.to_info_dict（）を使用して、CLI構造全体をトラバースします。

パラメーター

ctx （ click.core.Context ）–このコマンドを表す Context 。

リターンタイプ

Dict [str、Any]

バージョン8.0の新機能。

class click.MultiCommand(name=None, invoke_without_command=False, no_args_is_help=None, subcommand_metavar=None, chain=False, result_callback=None, **attrs)

マルチコマンドは、サブコマンドにディスパッチするコマンドの基本的な実装です。 最も一般的なバージョンはグループです。

パラメーター

• invoke_without_command （ bool ）–これはマルチコマンド自体の呼び出し方法を制御します。 デフォルトでは、サブコマンドが指定されている場合にのみ呼び出されます。

• no_args_is_help （オプション [ bool ] ）–引数が指定されていない場合の動作を制御します。 このオプションは、 invoke_without_command が無効になっている場合はデフォルトで有効になっており、有効になっている場合は無効になっています。 有効にすると、引数が渡されない場合、引数として--helpが追加されます。

• subcommand_metavar （オプション [ str ] ）–ドキュメントでサブコマンドを示すために使用される文字列場所。

• chain （ bool ）–これが True に設定されている場合、複数のサブコマンドのチェーンが有効になります。 これにより、オプションの引数を持つことができないという点でコマンドの形式が制限されますが、複数のコマンドをチェーン化することはできます。

• result_callback （オプション [ Callable [ [ ... [ X97X] ] 、 Any ] ] ）–このマルチコマンドにアタッチする結果コールバック。 これは、後で result_callback（）デコレータを使用して設定または変更できます。

• 名前（オプション [ str ] ）–

• attrs （ Any ）–

リターンタイプ

なし

collect_usage_pieces(ctx)

使用ラインに入るすべての部分を返し、それを文字列のリストとして返します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

リスト[str]

format_commands(ctx, formatter)

オプションの後にすべてのコマンドを追加するマルチメソッドの追加フォーマットメソッド。

パラメーター

• ctx （ click.core.Context ）–

• フォーマッター（ click.formatting.HelpFormatter ）–

リターンタイプ

なし

format_options(ctx, formatter)

すべてのオプションが存在する場合は、フォーマッターに書き込みます。

パラメーター

• ctx （ click.core.Context ）–

• フォーマッター（ click.formatting.HelpFormatter ）–

リターンタイプ

なし

get_command(ctx, cmd_name)

コンテキストとコマンド名を指定すると、 Command オブジェクトが存在する場合はそれを返すか、 None を返します。

パラメーター

• ctx （ click.core.Context ）–

• cmd_name （ str ）–

リターンタイプ

オプション[ click.core.Command ]

invoke(ctx)

コンテキストが与えられると、これは添付されたコールバック（存在する場合）を正しい方法で呼び出します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

どれでも

list_commands(ctx)

表示される順序でサブコマンド名のリストを返します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

リスト[str]

parse_args(ctx, args)

コンテキストと引数のリストが与えられると、これはパーサーを作成して引数を解析し、必要に応じてコンテキストを変更します。 これはmake_context()によって自動的に呼び出されます。

パラメーター

• ctx （ click.core.Context ）–

• args （ List [ str ] ）–

リターンタイプ

リスト[str]

result_callback(replace=False)

コマンドに結果コールバックを追加します。 デフォルトでは、結果コールバックがすでに登録されている場合、これはそれらをチェーンしますが、これは replace パラメーターで無効にできます。 結果のコールバックは、サブコマンドの戻り値（または、チェーンが有効になっている場合はすべてのサブコマンドからの戻り値のリスト）と、メインのコールバックに渡されるパラメーターを使用して呼び出されます。

例：

@click.group()
@click.option('-i', '--input', default=23)
def cli(input):
    return 42

@cli.result_callback()
def process_result(result, input):
    return result + input

パラメーター

replace （ bool ）– True に設定すると、既存の結果コールバックが削除されます。

リターンタイプ

Callable [[click.core.F]、click.core.F]

バージョン8.0で変更： resultcallbackから名前が変更されました。

バージョン3.0の新機能。

shell_complete(ctx, incomplete)

不完全な値の完了のリストを返します。 オプション、サブコマンド、および連鎖マルチコマンドの名前を確認します。

パラメーター

• ctx （ click.core.Context ）–このコマンドの呼び出しコンテキスト。

• 不完全（ str ）–値が完了しています。 空の可能性があります。

リターンタイプ

リスト[完了アイテム]

バージョン8.0の新機能。

to_info_dict(ctx)

ユーザー向けのドキュメントを生成するツールに役立つ可能性のある情報を収集します。 これは、このコマンドの下の構造全体をトラバースします。

click.Context.to_info_dict（）を使用して、CLI構造全体をトラバースします。

パラメーター

ctx （ click.core.Context ）–このコマンドを表す Context 。

リターンタイプ

Dict [str、Any]

バージョン8.0の新機能。

class click.Group(name=None, commands=None, **attrs)

グループを使用すると、コマンドにサブコマンドを添付できます。 これは、Clickでネストを実装するための最も一般的な方法です。

パラメーター

• name （オプション [ str ] ）–グループコマンドの名前。

• コマンド（オプション [ ユニオン [ ディクト [ str 、 click.core.Command ] 、 シーケンス [ click.core.Command ] ] ] ）–名前を Command オブジェクトにマッピングするdict 。 コマンドのリストにすることもできます。これは、Command.nameを使用してdictを作成します。

• attrs （ Any ）– MultiCommand 、 Command 、および BaseCommand で説明されているその他のコマンド引数。

リターンタイプ

なし

バージョン8.0で変更： commmands引数は、コマンドオブジェクトのリストにすることができます。

add_command(cmd, name=None)

このグループに別のコマンドを登録します。 名前が指定されていない場合は、コマンドの名前が使用されます。

パラメーター

• cmd （ click.core.Command ）–

• 名前（オプション [ str ] ）–

リターンタイプ

なし

command(*args, **kwargs)

コマンドを宣言してグループにアタッチするためのショートカットデコレータ。 これは command（）と同じ引数を取り、 add_command（）を呼び出すことにより、作成されたコマンドをこのグループにすぐに登録します。

使用するコマンドクラスをカスタマイズするには、 command_class 属性を設定します。

バージョン8.0で変更： command_class 属性が追加されました。

パラメーター

• args （ Any ）–

• kwargs （ Any ）–

リターンタイプ

Callable [[Callable [[…]、Any]]、 click.core.Command ]

command_class: Optional[Type[click.core.Command]] = None

設定されている場合、これはグループの command（）デコレータによってデフォルトの Command クラスとして使用されます。 これは、すべてのサブコマンドでカスタムコマンドクラスを使用する場合に役立ちます。

バージョン8.0の新機能。

commands: Dict[str, click.core.Command]

エクスポートされた名前で登録されたサブコマンド。

get_command(ctx, cmd_name)

コンテキストとコマンド名を指定すると、 Command オブジェクトが存在する場合はそれを返すか、 None を返します。

パラメーター

• ctx （ click.core.Context ）–

• cmd_name （ str ）–

リターンタイプ

オプション[ click.core.Command ]

group(*args, **kwargs)

グループを宣言してグループにアタッチするためのショートカットデコレータ。 これは group（）と同じ引数を取り、 add_command（）を呼び出すことにより、作成されたグループをこのグループにすぐに登録します。

使用するグループクラスをカスタマイズするには、 group_class 属性を設定します。

バージョン8.0で変更： group_class 属性が追加されました。

パラメーター

• args （ Any ）–

• kwargs （ Any ）–

リターンタイプ

Callable [[Callable [[…]、Any]]、 click.core.Group ]

group_class: Optional[Union[Type[click.core.Group], Type[type]]] = None

設定されている場合、これはグループの group（）デコレータによってデフォルトの Group クラスとして使用されます。 これは、すべてのサブグループにカスタムグループクラスを使用させるのに役立ちます。

特別な値type（文字通りgroup_class = type）に設定すると、このグループのクラスがデフォルトのクラスとして使用されます。 これにより、カスタムグループクラスは引き続きカスタムグループを作成します。

バージョン8.0の新機能。

list_commands(ctx)

表示される順序でサブコマンド名のリストを返します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

リスト[str]

class click.CommandCollection(name=None, sources=None, **attrs)

コマンドコレクションは、複数のマルチコマンドを1つにマージするマルチコマンドです。 これは、さまざまなマルチコマンドのリストをソースとして受け入れ、それぞれにすべてのコマンドを提供する簡単な実装です。

パラメーター

• 名前（オプション [ str ] ）–

• ソース（オプション [ リスト [ click.core.MultiCommand ] ] ）–

• attrs （ Any ）–

リターンタイプ

なし

add_source(multi_cmd)

チェーンディスパッチャに新しいマルチコマンドを追加します。

パラメーター

multi_cmd （ click.core.MultiCommand ）–

リターンタイプ

なし

get_command(ctx, cmd_name)

コンテキストとコマンド名を指定すると、 Command オブジェクトが存在する場合はそれを返すか、 None を返します。

パラメーター

• ctx （ click.core.Context ）–

• cmd_name （ str ）–

リターンタイプ

オプション[ click.core.Command ]

list_commands(ctx)

表示される順序でサブコマンド名のリストを返します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

リスト[str]

sources: List[click.core.MultiCommand]

登録されているマルチコマンドのリスト。

パラメーター

class click.Parameter(param_decls=None, type=None, required=False, default=None, callback=None, nargs=None, multiple=False, metavar=None, expose_value=True, is_eager=False, envvar=None, shell_complete=None, autocompletion=None)

コマンドのパラメーターには、 Option または Argument の2つのバージョンがあります。 他のサブクラスは、解析の内部の一部が意図的に確定されていないため、現在、設計ではサポートされていません。

一部の設定は、オプションと引数の両方でサポートされています。

パラメーター

• param_decls （オプション [ シーケンス [ str ] ] ）–このオプションまたは引数のパラメーター宣言。 これは、フラグまたは引数名のリストです。

• type （オプション [ Union [ click.types.ParamType 、 Any ] ] ）–使用するタイプ。 ParamType またはPythonタイプのいずれか。 サポートされている場合、後者は自動的に前者に変換されます。

• required （ bool ）–これがオプションかどうかを制御します。

• デフォルト（オプション [ ユニオン [ 任意 、 呼び出し可能 [ [ ] 、 任意 ] [ X180X]] ] ）–省略した場合のデフォルト値。 これは呼び出し可能にすることもできます。その場合、引数なしでデフォルトが必要なときに呼び出されます。

• コールバック（オプション [ 呼び出し可能 [ [ click.core。コンテキスト 、 パラメータ 、 任意 ] 、 任意 ] ] ）–型変換後に値をさらに処理または検証する関数。 f(ctx, param, value)と呼ばれ、値を返す必要があります。 プロンプトを含むすべてのソースに対して呼び出されます。

• nargs （オプション [ int ] ）–一致する引数の数。 1でない場合、戻り値は単一の値ではなくタプルになります。 nargsのデフォルトは1です（タイプがタプルの場合を除いて、それはタプルのアリティです）。 nargs=-1の場合、残りのすべてのパラメーターが収集されます。

• metavar （オプション [ str ] ）–ヘルプページでの値の表示方法。

• expose_value （ bool ）–これが True の場合、値はコマンドコールバックに渡され、コンテキストに保存されます。それ以外の場合はスキップされます。

• is_eager （ bool ）–熱心な値は非熱心な値の前に処理されます。 これは引数に設定しないでください。設定しないと、処理の順序が逆になります。

• envvar （オプション [ ユニオン [ シーケンス [ str ] 、 str ] ] ）–文字列または文字列のリストこれは、チェックする必要のある環境変数です。

• shell_complete （オプション [ Callable [ [ click.core。コンテキスト 、 パラメータ 、 str ] 、 ユニオン [ リスト [ CompletionItem ] 、 リスト[ X309X] [ str ] ] ] ] ）–を返す関数カスタムシェル補完。 指定されている場合、paramの型補完の代わりに使用されます。 ctx, param, incompleteを取り、 CompletionItem のリストまたは文字列のリストを返す必要があります。

• 複数（ bool ）–

• オートコンプリート（オプション [ 呼び出し可能 [ [ click.core。コンテキスト 、 リスト [ str ] 、 str ] 、 リスト [ ユニオン [ タプル[ X293X] [ str 、 str ] 、 str [X385X ] ] ] ] ] ）–

リターンタイプ

なし

バージョン8.0で変更： process_valueは、必要なパラメーターと境界nargsを検証し、値を返す前にパラメーターコールバックを呼び出します。 これにより、コールバックでプロンプトを検証できます。 full_process_valueが削除されました。

バージョン8.0で変更： autocompletionはshell_completeに名前が変更され、上記の新しいセマンティクスが追加されました。 古い名前は非推奨になり、8.1で削除されます。それまでは、新しい要件に一致するようにラップされます。

バージョン8.0で変更： multiple=True, nargs>1の場合、デフォルトはタプルのリストである必要があります。

バージョン8.0で変更： nargs>1のデフォルトを設定する必要がなくなり、デフォルトでNoneになります。 multiple=Trueまたはnargs=-1は、デフォルトで()になります。

バージョン7.1で変更：空の文字列値を取得するのではなく、空の環境変数が無視されます。 これにより、スクリプトで変数の設定を解除できない場合でも、変数をクリアすることができます。

バージョン2.0で変更：パラメーターコールバックのシグネチャも変更され、パラメーターも渡されるようになりました。 古いコールバック形式は引き続き機能しますが、コードを簡単に移行する機会を与える警告が表示されます。

get_default(ctx, call=True)

パラメータのデフォルトを取得します。 最初にContext.lookup_value()を試行し、次にローカルデフォルトを試行します。

パラメーター

• ctx （ click.core.Context ）–現在のコンテキスト。

• call （ bool ）–デフォルトが呼び出し可能である場合は、それを呼び出します。 代わりに呼び出し可能オブジェクトを返す場合は無効にします。

リターンタイプ

オプション[Union [Any、Callable [[]、Any]]]

バージョン8.0.1で変更：型キャストは復元力のある解析モードで失敗する可能性があります。 デフォルトが無効な場合でも、ヘルプテキストの表示が妨げられることはありません。

バージョン8.0で変更：最初にctx.default_mapを確認します。

バージョン8.0で変更： callパラメーターが追加されました。

get_error_hint(ctx)

エラーメッセージで使用するパラメータの文字列バージョンを取得して、エラーの原因となったパラメータを示します。

パラメーター

ctx （ click.core.Context ）–

リターンタイプ

str

property human_readable_name: str

このパラメータの人間が読める形式の名前を返します。 これはオプションの名前と同じですが、引数のメタ変数です。

shell_complete(ctx, incomplete)

不完全な値の完了のリストを返します。 初期化中にshell_complete関数が指定された場合は、それが使用されます。 それ以外の場合は、type shell_complete()機能が使用されます。

パラメーター

• ctx （ click.core.Context ）–このコマンドの呼び出しコンテキスト。

• 不完全（ str ）–値が完了しています。 空の可能性があります。

リターンタイプ

リスト[完了アイテム]

バージョン8.0の新機能。

to_info_dict()

ユーザー向けのドキュメントを生成するツールに役立つ可能性のある情報を収集します。

click.Context.to_info_dict（）を使用して、CLI構造全体をトラバースします。

バージョン8.0の新機能。

リターンタイプ

Dict [str、Any]

type_cast_value(ctx, value)

オプションのtype、multiple、およびnargsに対して値を変換して検証します。

パラメーター

• ctx （ click.core.Context ）–

• 値（任意）–

リターンタイプ

どれでも

class click.Option(param_decls=None, show_default=False, prompt=False, confirmation_prompt=False, prompt_required=True, hide_input=False, is_flag=None, flag_value=None, multiple=False, count=False, allow_from_autoenv=True, type=None, help=None, hidden=False, show_choices=True, show_envvar=False, **attrs)

オプションは通常、コマンドラインのオプション値であり、引数にはない追加機能がいくつかあります。

他のすべてのパラメーターは、パラメーターコンストラクターに渡されます。

パラメーター

• show_default （ bool ）–ヘルプページにデフォルト値を表示するかどうかを制御します。 通常、デフォルトは表示されません。 この値が文字列の場合、値の代わりに文字列が表示されます。 これは、動的オプションで特に役立ちます。

• show_envvar （ bool ）–ヘルプページに環境変数を表示するかどうかを制御します。 通常、環境変数は表示されません。

• プロンプト（ユニオン [ bool 、 str ] ）– True または空でない文字列に設定されている場合、ユーザーは入力を求められます。 True に設定すると、プロンプトは大文字のオプション名になります。

• commentation_prompt （ Union [ bool 、 str ] ）–プロンプトが表示された場合は、値を確認するためにもう一度プロンプトを表示します。 Trueの代わりに文字列に設定して、メッセージをカスタマイズできます。

• prompt_required （ bool ）– Falseに設定すると、オプションが値のないフラグとして指定された場合にのみ、ユーザーは入力を求められます。

• hide_input （ bool ）–これが True の場合、プロンプトの入力はユーザーから非表示になります。 これはパスワード入力に役立ちます。

• is_flag （オプション [ bool ] ）–このオプションを強制的にフラグとして機能させます。 デフォルトは自動検出です。

• flag_value （オプション [ Any ] ）–このフラグが有効になっている場合は、この値を使用する必要があります。 オプション文字列に2つのオプションをマークするスラッシュが含まれている場合、これは自動的にブール値に設定されます。

• multiple （ bool ）–これが True に設定されている場合、引数は複数回受け入れられ、記録されます。 これは、動作方法がnargsに似ていますが、任意の数の引数をサポートします。

• count （ bool ）–このフラグは、オプションの増分を整数にします。

• allow_from_autoenv （ bool ）–これが有効になっている場合、コンテキストでプレフィックスが定義されていると、このパラメーターの値が環境変数から取得されます。

• help （オプション [ str ] ）–ヘルプ文字列。

• hidden （ bool ）–このオプションをヘルプ出力から非表示にします。

• param_decls （オプション [ シーケンス [ str ] ] ）–

• type （オプション [ Union [ click.types.ParamType 、 Any ] ] ）–

• show_choices （ bool ）–

• attrs （ Any ）–

リターンタイプ

なし

バージョン8.0.1で変更： typeは、指定されている場合、flag_valueから検出されます。

class click.Argument(param_decls, required=None, **attrs)

引数は、コマンドの定位置パラメーターです。 これらは通常、オプションよりも少ない機能を提供しますが、無限のnargsを持つことができ、デフォルトで必要です。

すべてのパラメーターは、パラメーターコンストラクターに渡されます。

パラメーター

• param_decls （ Sequence [ str ] ）–

• 必須（オプション [ bool ] ）–

• attrs （ Any ）–

リターンタイプ

なし

コンテクスト

class click.Context(command, parent=None, info_name=None, obj=None, auto_envvar_prefix=None, default_map=None, terminal_width=None, max_content_width=None, resilient_parsing=False, allow_extra_args=None, allow_interspersed_args=None, ignore_unknown_options=None, help_option_names=None, token_normalize_func=None, color=None, show_default=None)

コンテキストは、すべての単一レベルでのスクリプト実行に関連する状態を保持する特別な内部オブジェクトです。 コマンドへのアクセスをオプトインしない限り、通常はコマンドからは見えません。

コンテキストは、内部オブジェクトを渡したり、環境変数からのデータの読み取りなどの特別な実行機能を制御したりできるので便利です。

コンテキストはコンテキストマネージャーとして使用できます。その場合、ティアダウン時に close（）が呼び出されます。

パラメーター

• コマンド（コマンド）–このコンテキストのコマンドクラス。

• 親（オプション [ コンテキスト ] ）–親コンテキスト。

• info_name （オプション [ str ] ）–この呼び出しの情報名。 通常、これはスクリプトまたはコマンドの最もわかりやすい名前です。 トップレベルのスクリプトの場合、通常はスクリプトの名前であり、その下のコマンドの場合はスクリプトの名前です。

• obj （オプション [ Any ] ）–ユーザーデータの任意のオブジェクト。

• auto_envvar_prefix （オプション [ str ] ）–自動環境変数に使用するプレフィックス。 これが None の場合、環境変数からの読み取りは無効になります。 これは、常に読み取られる手動で設定された環境変数には影響しません。

• default_map （オプション [ Dict [ str 、 Any ] ] ）–パラメーターのデフォルト値を持つ辞書（オブジェクトなど）。

• terminal_width （オプション [ int ] ）–端末の幅。 デフォルトは、親コンテキストから継承します。 端子幅を定義するコンテキストがない場合は、自動検出が適用されます。

• max_content_width （オプション [ int ] ）–クリックによってレンダリングされるコンテンツの最大幅（これは現在のみヘルプページに影響します）。 オーバーライドされない場合、これはデフォルトで80文字になります。 つまり、端末がそれよりも大きい場合でも、Clickはデフォルトで80文字を超えるものをフォーマットしません。 それに加えて、フォーマッターは右側にいくつかの安全マッピングを追加する場合があります。

• resilient_parsing （ bool ）–このフラグが有効になっている場合、Clickは対話性やコールバックの呼び出しなしで解析します。 デフォルト値も無視されます。 これは、完了サポートなどの実装に役立ちます。

• allow_extra_args （オプション [ bool ] ）–これが True に設定されている場合その場合、最後に追加の引数を指定してもエラーは発生せず、コンテキストに保持されます。 デフォルトでは、コマンドから継承します。

• allow_interspersed_args （オプション [ bool ] ）–これが False に設定されている場合その場合、オプションと引数を混在させることはできません。 デフォルトでは、コマンドから継承します。

• ignore_unknown_options （オプション [ bool ] ）–不明なオプションを無視するようにクリックを指示し、それらを保持します後で処理するため。

• help_option_names （オプション [ リスト [ str ] ] ）–オプションで、デフォルトのヘルプパラメータの命名方法を定義する文字列のリスト。 デフォルトは['--help']です。

• token_normalize_func （オプション [ 呼び出し可能 [ [ str ] 、 str ] ] ）–トークン（オプション、選択肢）を正規化するために使用されるオプション関数、 NS。）。 たとえば、これを使用して、大文字と小文字を区別しない動作を実装できます。

• color （オプション [ bool ] ）–端末がANSIカラーをサポートするかどうかを制御します。 デフォルトは自動検出です。 これは、クリックが印刷するテキストでANSIコードが使用されている場合にのみ必要ですが、デフォルトではそうではありません。 これは、たとえばヘルプ出力に影響します。

• show_default （オプション [ bool ] ）–すべてのオプションのデフォルトを表示します。 設定されていない場合、デフォルトで親コンテキストの値になります。 オプションのshow_default引数をオーバーライドします。

リターンタイプ

なし

バージョン8.0で変更： show_defaultパラメーターは、デフォルトで親コンテキストの値になります。

バージョン7.1で変更： show_defaultパラメーターが追加されました。

バージョン4.0で変更： color、ignore_unknown_options、およびmax_content_widthパラメーターが追加されました。

バージョン3.0で変更： allow_extra_argsおよびallow_interspersed_argsパラメーターが追加されました。

バージョン2.0で変更： resilient_parsing、help_option_names、およびtoken_normalize_funcパラメーターが追加されました。

abort()

スクリプトを中止します。

リターンタイプ

te.NoReturn

allow_extra_args

コンテキストが追加の引数を許可するかどうか、または解析に失敗する必要があるかどうかを示します。

バージョン3.0の新機能。

allow_interspersed_args: bool

コンテキストで引数とオプションの混合が許可されているかどうかを示します。

バージョン3.0の新機能。

args: List[str]

残りの引数。

call_on_close(f)

コンテキストが破棄されたときに呼び出される関数を登録します。

これは、スクリプトの実行中に開かれたリソースを閉じるために使用できます。 withステートメントで使用されるPythonのコンテキストマネージャープロトコルをサポートするリソースは、代わりに with_resource（）に登録する必要があります。

パラメーター

f （ Callable [ [ ... ] 、[ X77X] Any ] ）–ティアダウン時に実行する関数。

リターンタイプ

呼び出し可能[[…]、任意]

close()

call_on_close（）で登録されたすべてのクローズコールバックを呼び出し、 with_resource（）で入力されたすべてのコンテキストマネージャーを終了します。

リターンタイプ

なし

color: Optional[bool]

スタイリング出力が必要かどうかを制御します。

command

このコンテキストのコマンド。

property command_path: str

計算されたコマンドパス。 これは、ヘルプページのusage情報に使用されます。 コンテキストチェーンの情報名をルートに結合することにより、自動的に作成されます。

ensure_object(object_type)

find_object（）と同様ですが、最も内側のオブジェクトが存在しない場合は、 object_type の新しいインスタンスに設定します。

パラメーター

object_type （ Type [ click.core.V ] ）–

リターンタイプ

click.core.V

exit(code=0)

指定された終了コードでアプリケーションを終了します。

パラメーター

コード（ int ）–

リターンタイプ

te.NoReturn

fail(message)

特定のエラーメッセージを表示してプログラムの実行を中止します。

パラメーター

メッセージ（ str ）–失敗するエラーメッセージ。

リターンタイプ

te.NoReturn

find_object(object_type)

指定されたタイプの最も近いオブジェクトを検索します。

パラメーター

object_type （ Type [ click.core.V ] ）–

リターンタイプ

オプション[click.core.V]

find_root()

最も外側のコンテキストを検索します。

リターンタイプ

click.core.Context

formatter_class

click.formatting.HelpFormatter のエイリアス

forward(_Context__cmd, *args, **kwargs)

invoke（）に似ていますが、他のコマンドが予期する場合、現在のコンテキストからデフォルトのキーワード引数を入力します。 これはコールバックを直接呼び出すことはできず、他のコマンドのみを呼び出すことができます。

バージョン8.0で変更：すべてのkwargsは params で追跡されるため、forwardが複数のレベルで呼び出された場合に渡されます。

パラメーター

• _Context__cmd （ click.core.Command ）–

• args （ Any ）–

• kwargs （ Any ）–

リターンタイプ

どれでも

get_help()

現在のコンテキストとコマンドのフォーマットされたヘルプページを取得するためのヘルパーメソッド。

リターンタイプ

str

get_parameter_source(name)

パラメータのソースを取得します。 これは、パラメーターの値が取得された場所を示します。

これは、ユーザーがコマンドラインでデフォルト値と同じ値をいつ指定したかを判断するのに役立ちます。 値が実際にデフォルトから取得された場合にのみ、 DEFAULT になります。

パラメーター

name （ str ）–パラメーターの名前。

リターンタイプ

ParameterSource

バージョン8.0で変更：パラメーターがどのソースからも提供されなかった場合はNoneを返します。

get_usage()

現在のコンテキストとコマンドのフォーマットされた使用法文字列を取得するためのヘルパーメソッド。

リターンタイプ

str

help_option_names: List[str]

ヘルプオプションの名前。

ignore_unknown_options: bool

コマンドが理解できないオプションを無視するようにクリックするように指示し、後で処理するためにコンテキストに保存します。 これは主に、外部プログラムを呼び出したい状況で役立ちます。 一般に、このパターンは、すべての引数をロスレスで転送することはできないため、強くお勧めしません。

バージョン4.0の新機能。

info_name

説明情報の名前

invoke(_Context__callback, *args, **kwargs)

期待どおりにコマンドコールバックを呼び出します。 このメソッドを呼び出すには、次の2つの方法があります。

1. 最初の引数はコールバックにすることができ、他のすべての引数とキーワード引数は関数に直接転送されます。

2. 最初の引数はクリックコマンドオブジェクトです。 その場合、すべての引数も転送されますが、適切なクリックパラメータ（オプションとクリック引数）はキーワード引数である必要があり、Clickはデフォルトを入力します。

Click 3.2より前は、このコードの意図に反してキーワード引数が適切に入力されておらず、コンテキストが作成されていないことに注意してください。 この変更とバグ修正リリースで行われた理由の詳細については、 3.2 へのアップグレードを参照してください。

バージョン8.0で変更：すべてのkwargsは params で追跡されるため、 forward（）が複数のレベルで呼び出された場合に渡されます。

パラメーター

• _Context__callback （ Union [ click.core.Command 、 Callable [ [ ... ] 、 任意 ] [X189X ]] ）–

• args （ Any ）–

• kwargs （ Any ）–

リターンタイプ

どれでも

invoked_subcommand: Optional[str]

このフラグは、サブコマンドが実行されるかどうかを示します。 グループコールバックは、この情報を使用して、直接実行されているのか、実行フローがサブコマンドに渡されるのかを判断できます。 デフォルトではNoneですが、実行するサブコマンドの名前にすることもできます。

チェーンが有効になっている場合、コマンドが実行された場合に備えて、これは'*'に設定されます。 しかし、どれを見つけることはできません。 この知識が必要な場合は、result_callback()を使用する必要があります。

lookup_default(name, call=True)

default_mapからパラメータのデフォルトを取得します。

パラメーター

• name （ str ）–パラメーターの名前。

• call （ bool ）–デフォルトが呼び出し可能である場合は、それを呼び出します。 代わりに呼び出し可能オブジェクトを返す場合は無効にします。

リターンタイプ

オプション[任意]

バージョン8.0で変更： callパラメーターが追加されました。

make_formatter()

ヘルプと使用法の出力用に HelpFormatter を作成します。

このメソッドをオーバーライドせずに使用するフォーマッタークラスをすばやくカスタマイズするには、 formatter_class 属性を設定します。

バージョン8.0で変更： formatter_class 属性が追加されました。

リターンタイプ

click.formatting.HelpFormatter

max_content_width: Optional[int]

フォーマットされたコンテンツの最大幅（ほとんどの場合80である実用的なデフォルトを意味するものはありません）。

property meta: Dict[str, Any]

これは、ネストされているすべてのコンテキストと共有される辞書です。 クリックユーティリティが必要に応じてここに状態を保存できるようにするために存在します。 ただし、この辞書を適切に管理するのは、そのコードの責任です。

キーは一意の点線の文字列であると想定されています。 たとえば、モジュールパスはそのための良い選択です。 そこに保存されているものは、クリックの操作とは無関係です。 ただし、重要なのは、ここにデータを配置するコードがシステムの一般的なセマンティクスに準拠していることです。

使用例：

LANG_KEY = f'{__name__}.lang'

def set_language(value):
    ctx = get_current_context()
    ctx.meta[LANG_KEY] = value

def get_language():
    return get_current_context().meta.get(LANG_KEY, 'en_US')

バージョン5.0の新機能。

obj: Any

保存されているユーザーオブジェクト。

params: Dict[str, Any]

パラメータ名の解析値へのマップ。 expose_value=Falseのパラメーターは保存されません。

parent

親コンテキスト、または存在しない場合は None 。

protected_args: List[str]

保護された引数。 これらは、特定の解析シナリオが発生したときに args の前に付加される引数ですが、別の引数に伝播してはなりません。 これは、ネストされた解析を実装するために使用されます。

resilient_parsing: bool

復元力のある解析が有効になっているかどうかを示します。 その場合、Clickは失敗を引き起こさないように最善を尽くし、デフォルト値は無視されます。 完了に役立ちます。

scope(cleanup=True)

このヘルパーメソッドをコンテキストオブジェクトとともに使用して、現在のスレッドローカルにプロモートできます（ get_current_context（）を参照）。 これのデフォルトの動作は、 cleanup を False に設定することで無効にできるクリーンアップ関数を呼び出すことです。 クリーンアップ関数は通常、ファイルハンドルを閉じるなどの目的で使用されます。

クリーンアップが意図されている場合は、コンテキストオブジェクトをコンテキストマネージャーとして直接使用することもできます。

使用例：

with ctx.scope():
    assert get_current_context() is ctx

これは同等です：

with ctx:
    assert get_current_context() is ctx

バージョン5.0の新機能。

パラメーター

cleanup （ bool ）–クリーンアップ機能を実行するかどうかを制御します。 デフォルトでは、これらの関数を実行します。 状況によっては、コンテキストを一時的にプッシュしたいだけの場合があります。その場合、これを無効にすることができます。 ネストされたプッシュは、クリーンアップを自動的に延期します。

リターンタイプ

イテレータ[ click.core.Context ]

set_parameter_source(name, source)

パラメータのソースを設定します。 これは、パラメーターの値が取得された場所を示します。

パラメーター

• name （ str ）–パラメーターの名前。

• source （ click.core.ParameterSource ）– ParameterSource のメンバー。

リターンタイプ

なし

show_default: Optional[bool]

ヘルプテキストをフォーマットするときにオプションのデフォルト値を表示します。

terminal_width: Optional[int]

端末の幅（自動検出はありません）。

to_info_dict()

ユーザー向けのドキュメントを生成するツールに役立つ可能性のある情報を収集します。 これにより、CLI構造全体がトラバースされます。

with Context(cli) as ctx:
    info = ctx.to_info_dict()

バージョン8.0の新機能。

リターンタイプ

Dict [str、Any]

token_normalize_func: Optional[Callable[[str], str]]

トークンのオプションの正規化関数。 これは、オプション、選択肢、コマンドなどです。

with_resource(context_manager)

withステートメントで使用されているかのようにリソースを登録します。 コンテキストがポップされると、リソースがクリーンアップされます。

contextlib.ExitStack.enter_context()を使用します。 リソースの__enter__()メソッドを呼び出し、結果を返します。 コンテキストがポップされると、スタックが閉じられ、リソースの__exit__()メソッドが呼び出されます。

コンテキストマネージャではないもののクリーンアップ関数を登録するには、 call_on_close（）を使用します。 または、contextlibの何かを使用して、最初にコンテキストマネージャーに変換します。

@click.group()
@click.option("--name")
@click.pass_context
def cli(ctx):
    ctx.obj = ctx.with_resource(connect_db(name))

パラメーター

context_manager （ ContextManager [ click.core.V ] ）–入力するコンテキストマネージャー。

戻り値

context_manager.__enter__()が返すものは何でも。

リターンタイプ

click.core.V

バージョン8.0の新機能。

click.get_current_context(silent=False)

現在のクリックコンテキストを返します。 これは、どこからでも現在のコンテキストオブジェクトにアクセスする方法として使用できます。 これは、 pass_context（）デコレータのより暗黙的な代替手段です。 この関数は主に、現在のコンテキストに基づいて動作を変更することに関心がある echo（）などのヘルパーに役立ちます。

現在のコンテキストをプッシュするには、 Context.scope（）を使用できます。

バージョン5.0の新機能。

パラメーター

silent （ bool ）– True に設定すると、使用可能なコンテキストがない場合、戻り値は None になります。 デフォルトの動作では、RuntimeErrorが発生します。

リターンタイプ

オプション[コンテキスト]

class click.core.ParameterSource(value)

これは、パラメーターの値のソースを示すEnumです。

click.Context.get_parameter_source（）を使用して、パラメーターのソースを名前で取得します。

バージョン8.0で変更： Enumを使用し、validateメソッドを削除します。

バージョン8.0で変更： PROMPT値が追加されました。

COMMANDLINE = 1

値はコマンドライン引数によって提供されました。

ENVIRONMENT = 2

値は環境変数で提供されました。

DEFAULT = 3

パラメータで指定されたデフォルトを使用しました。

DEFAULT_MAP = 4

Context.default_mapによって提供されるデフォルトを使用しました。

PROMPT = 5

プロンプトを使用して、デフォルトを確認するか、値を指定しました。

種類

click.STRING = STRING

;; パラメーター

;;* 値（任意）–

• param （オプション [ パラメーター ] ）–
• ctx （オプション [ コンテキスト ] ）–

リターンタイプ

どれでも

click.INT = INT

;; パラメーター

;;* 値（任意）–

• param （オプション [ パラメーター ] ）–
• ctx （オプション [ コンテキスト ] ）–

リターンタイプ

どれでも

click.FLOAT = FLOAT

;; パラメーター

;;* 値（任意）–

• param （オプション [ パラメーター ] ）–
• ctx （オプション [ コンテキスト ] ）–

リターンタイプ

どれでも

click.BOOL = BOOL

;; パラメーター

;;* 値（任意）–

• param （オプション [ パラメーター ] ）–
• ctx （オプション [ コンテキスト ] ）–

リターンタイプ

どれでも

click.UUID = UUID

;; パラメーター

;;* 値（任意）–

• param （オプション [ パラメーター ] ）–
• ctx （オプション [ コンテキスト ] ）–

リターンタイプ

どれでも

click.UNPROCESSED = UNPROCESSED

;; パラメーター

;;* 値（任意）–

• param （オプション [ パラメーター ] ）–
• ctx （オプション [ コンテキスト ] ）–

リターンタイプ

どれでも

class click.File(mode='r', encoding=None, errors='strict', lazy=None, atomic=False)

パラメータを読み取りまたは書き込み用のファイルとして宣言します。 コンテキストが破棄されると（コマンドの動作が終了した後）、ファイルは自動的に閉じられます。

ファイルは、読み取りまたは書き込み用に開くことができます。 特別な値-は、モードに応じてstdinまたはstdoutを示します。

デフォルトでは、ファイルはテキストデータの読み取り用に開かれますが、バイナリモードまたは書き込み用に開くこともできます。 エンコーディングパラメータを使用して、特定のエンコーディングを強制できます。

lazy フラグは、ファイルをすぐに開くか、最初のIOで開くかを制御します。 デフォルトでは、標準の入力ストリームと出力ストリーム、および読み取り用に開かれたファイルの場合は遅延なし、それ以外の場合は遅延になります。 読み取りのためにファイルを遅延して開く場合でも、検証のために一時的に開かれますが、最初のIOまで開いたままになりません。 lazyは、必要になるまでファイルが作成されないようにするために、書き込み用に開くときに主に役立ちます。

Click 2.0以降、ファイルをアトミックに開くこともできます。その場合、すべての書き込みは同じフォルダー内の別のファイルに送られ、完了するとファイルは元の場所に移動されます。 これは、他のユーザーが定期的に読み取るファイルが変更されている場合に役立ちます。

詳細については、ファイル引数を参照してください。

パラメーター

• モード（ str ）–

• エンコーディング（オプション [ str ] ）–

• エラー（オプション [ str ] ）–

• lazy （オプション [ bool ] ）–

• atomic （ bool ）–

リターンタイプ

なし

class click.Path(exists=False, file_okay=True, dir_okay=True, writable=False, readable=True, resolve_path=False, allow_dash=False, path_type=None)

パスタイプはファイルタイプに似ていますが、異なるチェックを実行します。 まず、開いているファイルハンドルを返す代わりに、ファイル名だけを返します。 次に、ファイルまたはディレクトリがどうあるべきかについて、さまざまな基本的なチェックを実行できます。

パラメーター

• exists （ bool ）– trueに設定されている場合、この値を有効にするには、ファイルまたはディレクトリが存在している必要があります。 これが不要で、ファイルが実際に存在しない場合、それ以降のすべてのチェックはサイレントにスキップされます。

• file_okay （ bool ）–ファイルが可能な値であるかどうかを制御します。

• dir_okay （ bool ）–ディレクトリが可能な値であるかどうかを制御します。

• 書き込み可能（ bool ）– trueの場合、書き込み可能チェックが実行されます。

• 読み取り可能（ bool ）– trueの場合、読み取り可能チェックが実行されます。

• resolve_path （ bool ）–これがtrueの場合、値が渡される前にパスが完全に解決されます。 これは、それが絶対的であり、シンボリックリンクが解決されることを意味します。 これはシェルによってのみ行われることになっているため、チルダプレフィックスは展開されません。

• allow_dash （ bool ）–これが True に設定されている場合、標準ストリームを示す単一のダッシュが許可されます。

• path_type （オプション [ Type ] ）–着信パス値をこのタイプに変換します。 Noneの場合、Pythonのデフォルトであるstrを維持します。 pathlib.Pathに変換するのに便利です。

バージョン8.0で変更： type=pathlib.Pathの受け渡しを許可します。

バージョン6.0で変更： allow_dashパラメーターが追加されました。

class click.Choice(choices, case_sensitive=True)

選択タイプを使用すると、サポートされている値の固定セットに対して値をチェックできます。 これらの値はすべて文字列である必要があります。

選択肢のリストまたはタプルのみを渡す必要があります。 他の反復可能オブジェクト（ジェネレーターなど）は、驚くべき結果につながる可能性があります。

結果の値は、case_sensitiveまたはctx.token_normalize_funcが指定されているかどうかに関係なく、常に最初に渡された選択肢の1つになります。

例については、選択オプションを参照してください。

パラメーター

• case_sensitive （ bool ）– falseに設定すると、大文字と小文字が区別されません。 デフォルトはtrueです。

• 選択肢（シーケンス [ str ] ）–

リターンタイプ

なし

class click.IntRange(min=None, max=None, min_open=False, max_open=False, clamp=False)

click.INT 値を許容値の範囲に制限します。 範囲オプションを参照してください。

minまたはmaxが渡されない場合、その方向で任意の値が受け入れられます。 min_openまたはmax_openが有効になっている場合、対応する境界は範囲に含まれません。

clampが有効になっている場合、範囲外の値は失敗するのではなく、境界にクランプされます。

バージョン8.0で変更： min_openおよびmax_openパラメーターが追加されました。

パラメーター

• min （オプション [ float ] ）–

• max （オプション [ float ] ）–

• min_open （ bool ）–

• max_open （ bool ）–

• クランプ（ブール）–

リターンタイプ

なし

class click.FloatRange(min=None, max=None, min_open=False, max_open=False, clamp=False)

click.FLOAT 値を許容値の範囲に制限します。 範囲オプションを参照してください。

minまたはmaxが渡されない場合、その方向で任意の値が受け入れられます。 min_openまたはmax_openが有効になっている場合、対応する境界は範囲に含まれません。

clampが有効になっている場合、範囲外の値は失敗するのではなく、境界にクランプされます。 いずれかの境界がopenとマークされている場合、これはサポートされません。

バージョン8.0で変更： min_openおよびmax_openパラメーターが追加されました。

パラメーター

• min （オプション [ float ] ）–

• max （オプション [ float ] ）–

• min_open （ bool ）–

• max_open （ bool ）–

• クランプ（ブール）–

リターンタイプ

なし

class click.DateTime(formats=None)

DateTime型は、日付文字列を datetime オブジェクトに変換します。

チェックされるフォーマット文字列は構成可能ですが、デフォルトではいくつかの一般的な（タイムゾーンに対応しない）ISO8601フォーマットになっています。

DateTime 形式を指定するときは、リストまたはタプルのみを渡す必要があります。 ジェネレーターのような他の反復可能オブジェクトは、驚くべき結果につながる可能性があります。

フォーマット文字列はdatetime.strptimeを使用して処理されるため、許可されるフォーマット文字列が定義されます。

各形式を順番に使用して解析が試行され、正常に解析された最初の形式が使用されます。

パラメーター

フォーマット（オプション [ シーケンス [ str ] ] ）–日付形式の文字列のリストまたはタプル（試行する順序）。 デフォルトは'%Y-%m-%d'、'%Y-%m-%dT%H:%M:%S'、'%Y-%m-%d %H:%M:%S'です。

class click.Tuple(types)

Clickのデフォルトの動作は、値にタイプを直接適用することです。 これは、 nargs が固定カウントに設定されており、アイテムごとに異なるタイプを使用する必要がある場合を除いて、ほとんどの場合にうまく機能します。 この場合、タプルタイプを使用できます。 このタイプは、 nargs が固定数に設定されている場合にのみ使用できます。

詳細については、マルチバリューオプションとしてのタプルを参照してください。

これは、Pythonタプルリテラルを型として使用して選択できます。

パラメーター

タイプ（シーケンス [ ユニオン [ タイプ 、 click.types.ParamType ] ] ）–タプルアイテムに使用する必要があるタイプのリスト。

リターンタイプ

なし

class click.ParamType

パラメータのタイプを表します。 コマンドラインまたはPythonからの値を検証し、正しいタイプに変換します。

カスタム型を実装するには、サブクラス化して、少なくとも以下を実装します。

• name クラス属性を設定する必要があります。

• Noneを使用してタイプのインスタンスを呼び出すと、Noneが返される必要があります。 これはすでにデフォルトで実装されています。

• convert（）は、文字列値を正しいタイプに変換する必要があります。

• convert（）は、すでに正しいタイプの値を受け入れる必要があります。

• ctxおよびparam引数がNoneの場合、値を変換できる必要があります。 これは、プロンプト入力を変換するときに発生する可能性があります。

convert(value, param, ctx)

値を正しいタイプに変換します。 値がNone（欠落している値）の場合、これは呼び出されません。

これは、コマンドラインからの文字列値と、すでに正しいタイプの値を受け入れる必要があります。 また、他の互換性のあるタイプを変換する場合もあります。

paramおよびctx引数は、プロンプト入力を変換する場合など、特定の状況ではNoneになる場合があります。

値を変換できない場合は、説明メッセージを付けて fail（）を呼び出します。

パラメーター

• value （ Any ）–変換する値。

• param （オプション [ パラメーター ] ）–このタイプを使用して値を変換するパラメーター。 Noneの可能性があります。

• ctx （オプション [ コンテキスト ] ）–この値に到達した現在のコンテキスト。 Noneの可能性があります。

リターンタイプ

どれでも

envvar_list_splitter: ClassVar[Optional[str]] = None

このタイプのリストが予期され、値が文字列環境変数から取得される場合、これがそれを分割するものです。 なしは空白を意味します。 すべてのパラメーターについて、一般的な規則は、空白がそれらを分割することです。 例外は、デフォルトでos.path.pathsepによって分割されるパスとファイルです（Unixでは「：」、Windowsでは「;」）。

fail(message, param=None, ctx=None)

無効な値のメッセージで失敗するヘルパーメソッド。

パラメーター

• メッセージ（ str ）–

• param （オプション [ パラメーター ] ）–

• ctx （オプション [ コンテキスト ] ）–

リターンタイプ

t.NoReturn

get_metavar(param)

このパラメータが提供されている場合は、このパラメータのデフォルトのmetavarを返します。

パラメーター

param （パラメーター）–

リターンタイプ

オプション[str]

get_missing_message(param)

オプションで、欠落しているパラメーターに関する追加情報を返す場合があります。

バージョン2.0の新機能。

パラメーター

param （パラメーター）–

リターンタイプ

オプション[str]

name: str

このタイプの説明的な名前

shell_complete(ctx, param, incomplete)

不完全な値の CompletionItem オブジェクトのリストを返します。 ほとんどのタイプは補完を提供しませんが、一部は補完を提供します。これにより、カスタムタイプでもカスタム補完を提供できます。

パラメーター

• ctx （ Context ）–このコマンドの呼び出しコンテキスト。

• param （ Parameter ）–完了を要求しているパラメーター。

• 不完全（ str ）–値が完了しています。 空の可能性があります。

リターンタイプ

リスト[完了アイテム]

バージョン8.0の新機能。

split_envvar_value(rv)

環境変数からの値が与えられると、これは定義されたenvvarリストスプリッターに応じてそれを小さなチャンクに分割します。

スプリッターが None に設定されている場合、つまり空白が分割されている場合、先頭と末尾の空白は無視されます。 それ以外の場合、先頭と末尾のスプリッターは通常、空のアイテムが含まれることになります。

パラメーター

rv （ str ）–

リターンタイプ

シーケンス[str]

to_info_dict()

ユーザー向けのドキュメントを生成するツールに役立つ可能性のある情報を収集します。

click.Context.to_info_dict（）を使用して、CLI構造全体をトラバースします。

バージョン8.0の新機能。

リターンタイプ

Dict [str、Any]

例外

exception click.ClickException(message)

Clickが処理してユーザーに表示できる例外。

パラメーター

メッセージ（ str ）–

リターンタイプ

なし

exception click.Abort

クリックして中止するように通知する内部シグナリング例外。

exception click.UsageError(message, ctx=None)

使用エラーを通知する内部例外。 これは通常、それ以上の処理を中止します。

パラメーター

;;* メッセージ（ str ）–表示するエラーメッセージ。

• ctx （オプション [ コンテキスト ] ）–オプションでこのエラーの原因となったコンテキスト。 クリックすると、状況によっては自動的にコンテキストが入力されます。

リターンタイプ

なし

exception click.BadParameter(message, ctx=None, param=None, param_hint=None)

不正なパラメータの標準化されたエラーメッセージをフォーマットする例外。 これは、Clickがコンテキスト情報（たとえば、どのパラメーターであるか）を添付するため、コールバックまたはタイプからスローされる場合に役立ちます。

バージョン2.0の新機能。

パラメーター

• param （オプション [ Parameter ] ）–このエラーの原因となったパラメーターオブジェクト。 これは省略できます。可能であれば、Clickはこの情報自体を添付します。

• param_hint （オプション [ str ] ）–パラメーター名として表示される文字列。 これは、カスタム検証が発生する必要がある場合に、 param の代わりに使用できます。 文字列の場合はそのまま使用され、リストの場合は各項目が引用符で囲まれて区切られます。

• メッセージ（ str ）–

• ctx （オプション [ コンテキスト ] ）–

リターンタイプ

なし

exception click.FileError(filename, hint=None)

ファイルを開くことができない場合に発生します。

パラメーター

;;* ファイル名（ str ）–

• ヒント（オプション [ str ] ）–

リターンタイプ

なし

exception click.NoSuchOption(option_name, message=None, possibilities=None, ctx=None)

クリックが存在しないオプションを処理しようとした場合に発生します。

バージョン4.0の新機能。

パラメーター

• option_name （ str ）–

• メッセージ（オプション [ str ] ）–

• 可能性（オプション [ シーケンス [ str ] ] ）–

• ctx （オプション [ コンテキスト ] ）–

リターンタイプ

なし

exception click.BadOptionUsage(option_name, message, ctx=None)

オプションが一般的に提供されているが、オプションの使用が正しくなかった場合に発生します。 これは、たとえば、オプションの引数の数が正しくない場合に発生します。

バージョン4.0の新機能。

パラメーター

• option_name （ str ）–誤って使用されているオプションの名前。

• メッセージ（ str ）–

• ctx （オプション [ コンテキスト ] ）–

リターンタイプ

なし

exception click.BadArgumentUsage(message, ctx=None)

引数が一般的に提供されているが、引数の使用が正しくなかった場合に発生します。 これは、たとえば、引数の値の数が正しくない場合に発生します。

バージョン6.0の新機能。

パラメーター

• メッセージ（ str ）–

• ctx （オプション [ コンテキスト ] ）–

リターンタイプ

なし

フォーマット

class click.HelpFormatter(indent_increment=2, width=None, max_width=None)

このクラスは、テキストベースのヘルプページのフォーマットに役立ちます。 これは通常、非常に特殊な内部ケースに必要なだけですが、開発者が独自の派手な出力を作成できるように公開されています。

現在、常にメモリに書き込みます。

パラメーター

• indent_increment （ int ）–各レベルの追加の増分。

• width （オプション [ int ] ）–テキストの幅。 これはデフォルトで最大78にクランプされた端子幅になります。

• max_width （オプション [ int ] ）–

リターンタイプ

なし

dedent()

インデントを減らします。

リターンタイプ

なし

getvalue()

バッファの内容を返します。

リターンタイプ

str

indent()

インデントを増やします。

リターンタイプ

なし

indentation()

インデントを増やすコンテキストマネージャー。

リターンタイプ

イテレータ[なし]

section(name)

段落、見出し、インデントを作成する便利なコンテキストマネージャー。

パラメーター

name （ str ）–見出しとして記述されるセクション名。

リターンタイプ

イテレータ[なし]

write(string)

Unicode文字列を内部バッファに書き込みます。

パラメーター

string （ str ）–

リターンタイプ

なし

write_dl(rows, col_max=30, col_spacing=2)

定義リストをバッファに書き込みます。 これは、オプションとコマンドが通常フォーマットされる方法です。

パラメーター

• 行（シーケンス [ タプル [ str 、 str ] ] ）–用語と値の2つの項目タプルのリスト。

• col_max （ int ）–最初の列の最大幅。

• col_spacing （ int ）–最初の列と2番目の列の間のスペースの数。

リターンタイプ

なし

write_heading(heading)

見出しをバッファに書き込みます。

パラメーター

見出し（ str ）–

リターンタイプ

なし

write_paragraph()

段落をバッファに書き込みます。

リターンタイプ

なし

write_text(text)

再インデントされたテキストをバッファに書き込みます。 これにより、段落が再ラップされて保持されます。

パラメーター

テキスト（ str ）–

リターンタイプ

なし

write_usage(prog, args=, prefix=None)

使用ラインをバッファに書き込みます。

パラメーター

• prog （ str ）–プログラム名。

• args （ str ）–空白で区切られた引数のリスト。

• prefix （オプション [ str ] ）–最初の行のプレフィックス。 デフォルトは"Usage: "です。

リターンタイプ

なし

click.wrap_text(text, width=78, initial_indent=, subsequent_indent=, preserve_paragraphs=False)

テキストをインテリジェントに折り返すヘルパー関数。 デフォルトでは、テキストの1つの段落で動作することを前提としていますが、 prepare_paragraphs パラメーターが指定されている場合、段落（2つの空の行で定義）をインテリジェントに処理します。

段落が処理される場合、段落の前に\b文字（\x08）を含む空の行を付けて、そのブロックで再折り返しが発生しないことを示すことができます。

パラメーター

• text （ str ）–再ラップする必要のあるテキスト。

• width （ int ）–テキストの最大幅。

• initial_indent （ str ）–最初の行に文字列として配置する必要がある最初のインデント。

• subject_indent （ str ）–連続する各行に配置する必要のあるインデント文字列。

• prepare_paragraphs （ bool ）–このフラグが設定されている場合、ラッピングは段落をインテリジェントに処理します。

リターンタイプ

str

構文解析

class click.OptionParser(ctx=None)

オプションパーサーは、オプションと引数を解析するために最終的に使用される内部クラスです。 optparseをモデルにしており、同様ですが大幅に簡素化されたAPIを提供します。 高レベルのClickクラスがそれをラップするため、通常は直接使用しないでください。

上位レベルで実装されている機能（タイプやデフォルトなど）を実装していないため、optparseやargparseほど拡張性はありません。

パラメーター

ctx （オプション [ コンテキスト ] ）–オプションでコンテキストこのパーサーと一緒に行く必要があります。

リターンタイプ

なし

add_argument(obj, dest, nargs=1)

dest という名前の位置引数をパーサーに追加します。

obj を使用して、パーサーから返されるオーダーリスト内のオプションを識別できます。

パラメーター

• obj （ CoreArgument ）–

• dest （オプション [ str ] ）–

• nargs （ int ）–

リターンタイプ

なし

add_option(obj, opts, dest, action=None, nargs=1, const=None)

dest という名前の新しいオプションをパーサーに追加します。 宛先は（optparseとは異なり）推測されないため、明示的に指定する必要があります。 アクションは、store、store_const、append、appnd_const、またはcountのいずれかになります。

obj を使用して、パーサーから返されるオーダーリスト内のオプションを識別できます。

パラメーター

• obj （ CoreOption ）–

• opts （ Sequence [ str ] ）–

• dest （オプション [ str ] ）–

• アクション（オプション [ str ] ）–

• nargs （ int ）–

• const （オプション [ Any ] ）–

リターンタイプ

なし

allow_interspersed_args

これは、パーサーが散在する引数を処理する方法を制御します。 これが False に設定されている場合、パーサーは最初の非オプションで停止します。 Clickはこれを使用して、ネストされたサブコマンドを安全に実装します。

ctx

このパーサーのコンテキスト。 一部の高度なユースケースでは、これは None の場合があります。

ignore_unknown_options

これは、パーサーに不明なオプションの処理方法を指示します。 デフォルトではエラーが発生しますが（これは賢明です）、それを無視して、すべての不明なオプションを結果の引数にシフトした後、処理を続行する2番目のモードがあります。

parse_args(args)

位置引数を解析し、解析されたオプションと引数、および残りの引数がある場合は(values, args, order)を返します。 順序は、コマンドラインに表示されるオブジェクトのリストです。 引数が複数回出現する場合、それらも複数回記憶されます。

パラメーター

args （ List [ str ] ）–

リターンタイプ

タプル [Dict [str、Any]、List [str]、List [CoreParameter]]

シェルの完成

Clickのシェル補完システムの有効化とカスタマイズについては、シェル補完を参照してください。

class click.shell_completion.CompletionItem(value, type='plain', help=None, **kwargs)

完了値とその値に関するメタデータを表します。 デフォルトのメタデータは、特別なシェル処理を示すtypeであり、シェルが値の横にヘルプ文字列を表示することをサポートしている場合はhelpです。

オブジェクトの作成時に任意のパラメーターを渡し、item.attrを使用してアクセスできます。 属性が渡されなかった場合、その属性にアクセスするとNoneが返されます。

パラメーター

• value （ Any ）–完了の提案。

• type （ str ）–タイプに特別な補完サポートを提供するようにシェルスクリプトに指示します。 クリックは"dir"と"file"を使用します。

• help （オプション [ str ] ）–サポートされている場合、値の横に表示される文字列。

• kwargs （ Any ）–任意のメタデータ。 組み込みの実装ではこれを使用しませんが、カスタムシェルサポートと組み合わせたカスタム型補完で使用できます。

リターンタイプ

なし

class click.shell_completion.ShellComplete(cli, ctx_args, prog_name, complete_var)

シェル補完サポートを提供するための基本クラス。 特定のシェルのサブクラスは、属性とメソッドをオーバーライドして、完了命令（sourceおよびcomplete）を実装します。

パラメーター

• cli （ click.core.BaseCommand ）–呼び出されているコマンド。

• prog_name （ str ）–シェル内の実行可能ファイルの名前。

• complete_var （ str ）–完了命令を保持する環境変数の名前。

• ctx_args （ Dict [ str 、 Any ] ）– –

リターンタイプ

なし

バージョン8.0の新機能。

name: ClassVar[str]

add_completion_class（）のようにシェルを登録するための名前。 これは、完了手順（{name}_sourceおよび{name}_complete）で使用されます。

source_template: ClassVar[str]

source（）でフォーマットされた完了スクリプトテンプレート。 これはサブクラスによって提供される必要があります。

property func_name: str

完了スクリプトによって定義されたシェル関数の名前。

source_vars()

source_template をフォーマットするための変数。

デフォルトでは、これはcomplete_func、complete_var、およびprog_nameを提供します。

リターンタイプ

Dict [str、Any]

source()

完了関数を定義するシェルスクリプトを作成します。 デフォルトでは、この%スタイルは source_template をフォーマットし、dictは source_vars（）によって返されます。

リターンタイプ

str

get_completion_args()

シェルスクリプトで定義されたenv変数を使用して、args, incompleteのタプルを返します。 これは、サブクラスによって実装する必要があります。

リターンタイプ

タプル [リスト[str]、str]

get_completions(args, incomplete)

完全な引数からコンテキストと最後の完全なコマンドまたはパラメーターを決定します。 そのオブジェクトのshell_completeメソッドを呼び出して、不完全な値の補完を取得します。

パラメーター

• args （ List [ str ] ）–不完全な値の前の完全な引数のリスト。

• 不完全（ str ）–値が完了しています。 空の可能性があります。

リターンタイプ

リスト[ click.shell_completion.CompletionItem ]

format_completion(item)

完了項目をシェルスクリプトで認識される形式にフォーマットします。 これは、サブクラスによって実装する必要があります。

パラメーター

item （ click.shell_completion.CompletionItem ）–フォーマットする完了アイテム。

リターンタイプ

str

complete()

シェルに送り返す完了データを生成します。

デフォルトでは、これは get_completion_args（）を呼び出し、完了を取得してから、完了ごとに format_completion（）を呼び出します。

リターンタイプ

str

click.shell_completion.add_completion_class(cls, name=None)

指定された名前で ShellComplete サブクラスを登録します。 名前は、完了時に完了命令環境変数によって提供されます。

パラメーター

;;* cls （ Type [ click.shell_completion.ShellComplete ] ）–の完了を処理する完了クラスシェル。

• name （オプション [ str ] ）–クラスを登録する名前。 デフォルトは、クラスのname属性です。

リターンタイプ

なし

テスト

class click.testing.CliRunner(charset='utf-8', env=None, echo_stdin=False, mix_stderr=True)

CLIランナーは、分離された環境で単体テストを行うためにClickコマンドラインスクリプトを呼び出す機能を提供します。 これは、グローバルインタープリターの状態を変更するため、並行性のないシングルスレッドシステムでのみ機能します。

パラメーター

• charset （ str ）–入力および出力データの文字セット。

• env （オプション [ マッピング [ str 、 オプション [ str ] ] ] ）–オーバーライドします。

• echo_stdin （ bool ）–これが True に設定されている場合、stdinからの読み取りはstdoutに書き込みます。 これは、状況によっては例を示すのに役立ちます。 通常のプロンプトは自動的に入力をエコーすることに注意してください。

• mix_stderr （ bool ）–これが False に設定されている場合、stdoutとstderrは独立したストリームとして保持されます。 これは、予測可能なstdoutとノイズの多いstderrがあり、それぞれを個別に測定できるUnix哲学アプリに役立ちます。

リターンタイプ

なし

get_default_prog_name(cli)

コマンドオブジェクトを指定すると、デフォルトのプログラム名が返されます。 デフォルトは name 属性、または設定されていない場合は"root"です。

パラメーター

cli （ BaseCommand ）–

リターンタイプ

str

invoke(cli, args=None, input=None, env=None, catch_exceptions=True, color=False, **extra)

隔離された環境でコマンドを呼び出します。 引数はコマンドラインスクリプトに直接転送され、 extra キーワード引数はコマンドのmain()関数に渡されます。

これにより、 Result オブジェクトが返されます。

パラメーター

• cli （ BaseCommand ）–呼び出すコマンド

• 引数（オプション [ ユニオン [ str 、 シーケンス [ str ] ] ] ）–呼び出す引数。 iterableまたはstringとして指定できます。 文字列として指定すると、Unixシェルコマンドとして解釈されます。 詳細については、shlex.split()をご覧ください。

• 入力（オプション [ ユニオン [ str 、 bytes 、 IO ] ] ）– sys.stdin の入力データ。

• env （オプション [ マッピング [ str 、 オプション [ str ] ] ] ）–環境がオーバーライドされます。

• catch_exceptions （ bool ）– SystemExit以外の例外をキャッチするかどうか。

• extra （ Any ）– main()に渡すキーワード引数。

• color （ bool ）–出力にカラーコードを含めるかどうか。 アプリケーションは、これを明示的にオーバーライドできます。

リターンタイプ

click.testing.Result

バージョン8.0で変更：結果オブジェクトには、呼び出されたコマンドから返された値を持つreturn_value属性があります。

バージョン4.0で変更： colorパラメーターが追加されました。

バージョン3.0で変更： catch_exceptionsパラメーターが追加されました。

バージョン3.0で変更：結果オブジェクトにはexc_info属性があり、使用可能な場合はトレースバックがあります。

isolated_filesystem(temp_dir=None)

一時ディレクトリを作成し、現在の作業ディレクトリをそれに変更するコンテキストマネージャ。 これにより、CWDの内容に影響を与えるテストが分離され、相互に干渉するのを防ぎます。

パラメーター

temp_dir （オプション [ Union [ str 、 os.PathLike ] ] ）–このディレクトリの下に一時ディレクトリを作成します。 指定した場合、作成されたディレクトリは終了時に削除されません。

リターンタイプ

イテレータ[str]

バージョン8.0で変更： temp_dirパラメーターが追加されました。

isolation(input=None, env=None, color=False)

コマンドラインツールを呼び出すための分離を設定するコンテキストマネージャー。 これにより、指定された入力データを使用してstdinが設定され、指定されたディクショナリからのオーバーライドを使用して os.environ が設定されます。 これにより、クリックしてモックされる内部の一部も再バインドされます（プロンプト機能など）。

これは、 invoke（）メソッドで自動的に実行されます。

パラメーター

• 入力（オプション [ ユニオン [ str 、 bytes 、 IO ] ] ）– sys.stdinに入力する入力ストリーム。

• env （オプション [ マッピング [ str 、 オプション [ str ] ] ] ）–環境は辞書としてオーバーライドされます。

• color （ bool ）–出力にカラーコードを含めるかどうか。 アプリケーションは、これを明示的にオーバーライドできます。

リターンタイプ

イテレータ[タプル [_ io.BytesIO、オプション[_io.BytesIO]]]

バージョン8.0で変更： stderrは、デフォルトの"strict"ではなくerrors="backslashreplace"で開かれます。

バージョン4.0で変更： colorパラメーターが追加されました。

make_env(overrides=None)

スクリプトを呼び出すための環境オーバーライドを返します。

パラメーター

オーバーライド（オプション [ マッピング [ str 、 オプション [ str ] ] ] ）–

リターンタイプ

マッピング[str、オプション[str]]

class click.testing.Result(runner, stdout_bytes, stderr_bytes, return_value, exit_code, exception, exc_info=None)

呼び出されたCLIスクリプトのキャプチャされた結果を保持します。

パラメーター

• ランナー（ CliRunner ）–

• stdout_bytes （ bytes ）–

• stderr_bytes （オプション [ bytes ] ）–

• return_value （ Any ）–

• exit_code （ int ）–

• 例外（オプション [ BaseException ] ）–

• exc_info （オプション [ タプル [ タイプ [ BaseException ] 、 BaseException 、 types.TracebackType ] [X209X ] ] ）–

exc_info

トレースバック

exception

発生した場合に発生した例外。

exit_code

整数としての終了コード。

property output: str

ユニコード文字列としての（標準）出力。

return_value

呼び出されたコマンドから返される値。

バージョン8.0の新機能。

runner

結果を生み出したランナー

property stderr: str

Unicode文字列としての標準エラー。

stderr_bytes

バイト単位の標準エラー、または使用できない場合はなし

property stdout: str

Unicode文字列としての標準出力。

stdout_bytes

バイトとしての標準出力。