API

この部分文書は、すべての共通クラスおよび関数の完全なAPI参照を示している。

積み込み工.

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

新しいのを作る Command コールバックとして修飾関数を用いる.これも自動的にすべての装飾を option() sと argument() sをコマンドのパラメータとする.

この命令の名前は，デフォルトで下線を破折号の関数名に置き換える.これを変更したい場合、ターゲット名を最初のパラメータとして渡すことができます。

すべてのキーワードパラメータは基本コマンドクラスに転送される.

修飾を行うと，その関数は1つになる Command 例として、このインスタンスは、コマンドラインユーティリティとして呼び出されるか、またはコマンドに追加されることができる Group それがそうです。

パラメータ

  • name -- 命令の名前。これはデフォルトで下線を破れた関数名に置き換えると考えられる.

  • cls -- インスタンス化された命令クラス.このデフォルト値は Command それがそうです。

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

新しいのを作る Group コールバックとして関数を用いる.他の場合その働き方は command() ただ一つだけ、それは cls パラメータは Group それがそうです。

click.argument(*param_decls, **attrs)

パラメータを命令に付加する.すべての位置パラメータはパラメータ宣言として渡される. Argument ；すべてのキーワードパラメータをそのまま転送(除く) cls ）。これは1つのものを作ることに相当します Argument 事例を付加して Command.params リストです。

パラメータ

cls -- インスタンス化するパラメータクラス.このデフォルト値は Argument それがそうです。

click.option(*param_decls, **attrs)

コマンドにオプションを添付します。すべての位置パラメータはパラメータ宣言として渡される. Option ；すべてのキーワードパラメータをそのまま転送(除く) cls ）。これは1つのものを作ることに相当します Option 事例を付加して Command.params リストです。

パラメータ

cls -- インスタンス化するオプションクラス.このデフォルト値は Option それがそうです。

click.password_option(*param_decls, **kwargs)

1つ追加する --password パスワードを入力するオプションを提示し，入力を隠して再入力値を要求して確認する.

パラメータ

  • param_decls -- 1つまたは複数のオプション名。デフォルトは単値である "--password" それがそうです。

  • kwargs -- 追加のパラメータを option() それがそうです。

click.confirmation_option(*param_decls, **kwargs)

1つ追加する --yes オプションは，そのオプションを通過していない場合は，継続する前にヒントを表示する.もし提示が拒否されたら、手続きは脱退するだろう。

パラメータ

  • param_decls -- 1つまたは複数のオプション名。デフォルトは単値である "--yes" それがそうです。

  • kwargs -- 追加のパラメータを option() それがそうです。

click.version_option(version=None, *param_decls, package_name=None, prog_name=None, message='%(prog)s, version %(version)s', **kwargs)

1つ追加する --version オプションは、直ちにバージョン番号を印刷し、プログラムを終了します。

もし version Clickは使用しようとします importlib.metadata.version() 取得する package_name それがそうです。Python<3.8では importlib_metadata ポストポートをインストールしなければなりません。

もし package_name Clickはスタックフレームをチェックすることでそれを検出しようと試みる.これは、バージョンを検出するために使用されるので、インストールされたソフトウェアパッケージの名前と一致しなければならない。

パラメータ

  • version -- 表示されるバージョン番号です。提供されていない場合は、クリックして検出を試みます。

  • param_decls -- 1つまたは複数のオプション名。デフォルトは単値である "--version" それがそうです。

  • package_name -- その中からバージョンのパケット名を検出します。提供されていない場合は、クリックして検出を試みます。

  • prog_name -- メッセージに表示されるCLIの名前です。提供されていない場合は、コマンドから検出される。

  • message -- The message to show. The values %(prog)s, %(package)s, and %(version)s are available.

  • kwargs -- 追加のパラメータを option() それがそうです。

例外

RuntimeError -- version 検出できません。

バージョン 8.0 で変更: 追加 package_name パラメータは、 %(package)s メッセージの値。

バージョン 8.0 で変更: 使用 importlib.metadata ではなく pkg_resources それがそうです。

click.help_option(*param_decls, **kwargs)

1つ追加する --help オプションは、ヘルプページを直ちに印刷し、プログラムを終了することができます。

これは通常不要ですなぜなら --help オプションは自動的に各コマンドに追加されます。 add_help_option=False もう過ぎました。

パラメータ

  • param_decls -- 1つまたは複数のオプション名。デフォルトは単値である "--help" それがそうです。

  • kwargs -- 追加のパラメータを option() それがそうです。

click.pass_context(f)

コールバックは、現在のコンテキストオブジェクトを受信したいことを第1のパラメータとしてマークする。

click.pass_obj(f)

似たような pass_context() ただし，文脈でのみ対象を前方に伝達する (Context.obj ）。このオブジェクトが入れ子システムの状態を表すならば，これは非常に有用である.

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 -- 伝達するオブジェクトのタイプ。

  • ensure -- もし設定が True コンテキスト内に新しいオブジェクトが作成され、記憶されます(それがまだそこにない場合)。

公共事業.

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

メッセージおよび改行は、所与のファイルまたは標準出力に印刷される。一見、印刷関数のように見えるが、システム構成がどんなに悪くても、これらのデータは失敗しないUnicodeおよびバイナリデータの処理のサポートを改善している。

これは、主に、2.xおよび3.x上のバイナリデータおよびUnicodeデータを最適な方法で所与のファイルに印刷することができることを意味します。これは失敗しないように最善を尽くすため、非常に心配のない機能だ。Click 6.0からは、Windowsコンソール上のUnicode出力のサポートが含まれています。

それ以外にも colorama 実装後，ECHO関数はANSIコードの巧みな処理をサポートする.基本的には、その後、以下の動作を実行する。

  • WindowsにANSIカラーコードに対する透過処理を追加する.

  • ターゲットファイルが端末でなければ，ANSIコードを自動的に隠蔽する.

Changelog

バージョン 6.0 で変更: Click 6.0から、ECHO関数はWindowsコンソール上でUnicode出力を正しくサポートします。クリックがインタプリタを何も修正しないというわけではありません sys.stdout そうでなければ、PRINT文または関数は依然としてUnicodeサポートを提供しないだろう。

バージョン 4.0 で変更: 追加 color 旗。

バージョン 3.0 で追加: ♪the err パラメータは追加されました。

バージョン 2.0 で変更: Click 2.0バージョンからColoramaを実装すると，反映機能はColoramaとともに使用される.

パラメータ

  • message -- 印刷するメッセージ

  • file -- 記入するファイル(デフォルト) stdout ）

  • err -- Trueに設定されている場合、ファイルデフォルトは stderr ではなく stdout それがそうです。これは電話をかけるよりも早く来たほうが簡単だ get_text_stderr() 自分で。

  • nl -- もし設定が True (デフォルト設定)後に改行が印刷されます。

  • color -- 制御端子はANSI色に対応しているかどうか.デフォルト値は自動検出である.

click.echo_via_pager(text_or_generator, color=None)

この関数はテキストを取得し，stdout上の環境に特化したページャで表示する.

Changelog

バージョン 3.0 で変更: 追加 color 旗。

パラメータ

  • text_or_generator -- ページを分割するテキスト、または別に選択された、テキストをページに発行する生成器。

  • color -- ポケベルが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 例外です。

Changelog

バージョン 7.0 で追加: SHOW_CHOICESパラメータを追加しました。

バージョン 6.0 で追加: Windowsにはcmd.exeに対するUnicodeサポートを追加した.

バージョン 4.0 で追加: 追加 err パラメータ

パラメータ

  • text -- 提示のために表示されるテキスト。

  • default -- 入力が発生していない場合に使用するデフォルト値。もしこれが与えられなかったら、それは中止されるまで提示されるだろう。

  • hide_input -- TRUEに設定されている場合、入力値は隠蔽される。

  • confirmation_prompt -- この値の確認を要求する.

  • type -- 値を検査するためのタイプ。

  • value_proc -- このパラメータが与えられた場合、タイプ変換ではなく、関数が呼び出されて値が変換される。

  • prompt_suffix -- プロンプトに付加すべき接尾辞

  • show_default -- プロンプトのデフォルト値を表示または隠蔽します。

  • err -- Trueに設定されている場合、ファイルデフォルトは stderr ではなく stdout ECHOと同様である。

  • show_choices -- 転送のタイプがChoiceである場合、オプションが表示または隠蔽されます。たとえば，typeがDayまたはWeekオプション，show_chotionsがTRUE，テキストが“Group by”であれば，“Group by(day，Week)：”であることが提示される.

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

確認を提示する(Yes/No問題).

ユーザが割り込み信号を送信することによって入力を中止する場合、この関数はそれを捕捉し、開始する。 Abort 例外です。

Changelog

バージョン 4.0 で追加: 追加 err パラメータ

パラメータ

  • text -- 質問する質問は。

  • default -- 提示されたデフォルト値。

  • abort -- これを設定すると True 否定と答えることで Abort それがそうです。

  • prompt_suffix -- プロンプトに付加すべき接尾辞

  • show_default -- プロンプトのデフォルト値を表示または隠蔽します。

  • err -- Trueに設定されている場合、ファイルデフォルトは stderr ではなく stdout ECHOと同様である。

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 項目(カウント済み)。反復が生じると、この関数は、提示されたプログレスバーを所与のものに印刷する。 file (デフォルトではstdout)、残り時間およびより多くの時間の計算を試みる。デフォルトの場合、ファイルが端末でなければ、このプログレスバーは提示されません。

コンテキストマネージャは、プログレスバーを作成します。コンテキストマネージャが入力されると、プログレスバーが作成されています。プログレスバー上の繰返しごとに，プログレスバーに渡される反復量が進み，ストリップも更新される.コンテキストマネージャが終了すると、改行が印刷され、プログレスバーが画面上で終了する。

注意：プログレスバーは，現在，総進捗に少なくとも数秒かかる用例を予想するために設計されている.そのため，ProgressBarクラスオブジェクトは速すぎると考えられる進捗や，ステップ間の時間が1秒未満の進捗を示すことはない.

印刷してはいけません。そうでなければ、プログレスバーは意外に破壊されます

例示的な用法：

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

あるいは，Iterableが指定されていなければ通過可能である. update() 方法は、プログレスバー上で直接反復するのではない。UPDATEメソッドは、インクリメント棒グラフのステップ数を受け取る：

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

♪the 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)
パラメータ

  • iterable -- 反復トラバースの反復器。提供されていない場合には、長さが必要となる。

  • length -- 反復する項数.デフォルトでは，プログレスバーは反復器の長さを問い合わせることを試みるが，機能しない可能性もある.反復器も提供される場合、このパラメータは、オーバーレイ長のために使用されてもよい。反復量が提供されない場合、プログレスバーは、その長さの範囲内で反復される。

  • label -- プログレスバーの横に表示されたラベルが必要です。

  • show_eta -- 推定時間表示を有効または無効にします。長さが決定できない場合、オプションは自動的に無効になります。

  • show_percent -- 百分率表示を有効または無効にします。黙認する. True 反復数が長さを持つ場合 False もしそうでなければ。

  • show_pos -- 絶対位置表示を有効または無効にします。黙認する. False それがそうです。

  • item_show_func -- 現在項呼び出しの関数を使用して、関数は、プログレスバーの横に現在項を表示するために文字列を返すことができる。現在の項は None よし！

  • fill_char -- プログレスバー充填部の文字を表示する。

  • empty_char -- プログレスバー未充填部分の文字を表示する。

  • bar_template -- 棒グラフテンプレートとして使用されるフォーマット文字列。そのパラメータには label ラベルにとっては bar 進捗条和 info 情報エリアにあります。

  • info_sep -- 複数の情報項目(ETAなど)間の区切り

  • width -- プログレスバーの幅(文字単位)，0は終端幅全体を表す.

  • file -- 記入するファイルです。これが端末でなければ、ラベルのみを印刷する。

  • color -- 制御端子はANSI色に対応しているかどうか.デフォルト値は自動検出である.プログレスバー出力中のどの位置にもANSIコードが含まれている場合にのみそうする必要があり，デフォルトではそうではない.

  • update_min_steps -- この数の更新が完了した後にのみレンダリングを行う.これは非常に速い反復器の最適化を可能にする.

バージョン 8.0 で追加: 追加 update_min_steps パラメータ

Changelog

バージョン 4.0 で変更: 追加 color パラメータ追加 update メソッドをオブジェクトに追加する.

バージョン 2.0 で追加.

click.clear()

端末画面をクリアします。これは、端末の可視空間全体を除去し、カーソルを左上隅に移動させる効果がある。端末に接続されていない場合には、何の動作も実行されない。

Changelog

バージョン 2.0 で追加.

click.style(text, fg=None, bg=None, bold=None, dim=None, underline=None, blink=None, reverse=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色モードをサポートしなければならない.

  • 中の3つの整数のRGBタプル [0，255] それがそうです。端末は24ビット/真カラーモードをサポートしなければならない.

詳細はhttps：//en.wikipedia.org/wiki/ansi_colorとhttps：//gis.github.com/xville/8346728を参照されたい。

パラメータ

  • text -- ANSIコードを使用してスタイルの文字列を設定します。

  • fg -- 提供すれば、この色は前の景色になるだろう。

  • bg -- 提供されれば、これは背景色となる。

  • bold -- 提供された場合、これは太字モードを有効または無効にするだろう。

  • dim -- 提供される場合、これは調光モードを有効または無効にする。これは大きな支持を受けた。

  • underline -- 提供された場合、これは下線を有効または無効にするだろう。

  • blink -- 提供された場合、これは点滅を有効または無効にするだろう。

  • reverse -- 提供される場合、これは逆レンダリングを有効または無効にする(前景が背景になり、その逆も同様である)。

  • reset -- デフォルトの場合，文字列の末尾に1つのすべてのリセットコードが付加され，スタイルが保持されないことを意味する.このオプションを無効にしてスタイルを作成することができます。

バージョン 8.0 で変更: 非文字列 message 文字列に変換する。

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

Changelog

バージョン 7.0 で変更: 鮮やかな色へのサポートを追加しました。

バージョン 2.0 で追加.

click.unstyle(text)

ANSIスタイル情報は文字列から削除されます。通常，この関数を用いる必要はないが，Clickの反転関数は必要に応じてパターンを自動的に削除するためである.

Changelog

バージョン 2.0 で追加.

パラメータ

text -- その中からスタイル情報のテキストを削除する.

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

この関数の組み合わせは echo() そして style() 電話があります。したがって、以下の2つの呼は同じである。

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

すべてのキーワードパラメータは下位関数に転送され，具体的にはそれらがどれを使用しているかに依存する.

非文字列タイプは、変換されます str それがそうです。しかし bytes 直接伝えることができます echo() パターンを適用しませんテキストを表すバイトパターンを設定する場合は、呼び出してください bytes.decode() まず。

バージョン 8.0 で変更: 非文字列 message 文字列に変換する。バイトはパターンを適用せずに転送される.

Changelog

バージョン 2.0 で追加.

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 -- 編集するテキストです。

  • editor -- オプションで使用するエディタです。デフォルトでは自動検出である.

  • env -- エディタの環境変数に転送します。

  • require_save -- これが本当であれば，エディタに保存しないで返却値を変更する. None それがそうです。

  • extension -- エディタの拡張子に伝えなければなりません。このデフォルト値は .txt しかし，これを変更することは文法強調表示を変更する可能性がある.

  • filename -- 提供された場合、提供されたテキストコンテンツではなく、このファイルを編集する。この場合、間接アドレスとして一時ファイルを使用しない。

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

この関数は、このファイルタイプのデフォルトビューアアプリケーションにおいて、所与のURL(またはファイル名)を起動する。これが実行可能ファイルである場合、新しいセッションで実行可能ファイルを開始する可能性がある。返り値は，起動したアプリケーションのログアウトコードである.通常、 0 成功を示す。

例：

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

バージョン 2.0 で追加.

パラメータ

  • url -- 起動するオブジェクトのURLやファイル名。

  • wait -- 手続きが終了してから戻ります。これは起動されたプログラムが阻止されたときにのみ機能する.特に、 xdg-open Linuxでは阻止されません

  • locate -- これを設定すると True そして、URLに関連するアプリケーションを起動するのではなく、ファイルマネージャの起動を試みる。URLがファイルシステムを指していないと，奇妙な効果が生じる可能性がある.

click.getchar(echo=False)

端末から単一文字を取得して返す.これは常にUnicode文字に戻り、いくつかのごく少数の場合には複数の文字が返される可能性がある。複数の文字を返す場合は，どのような理由でも，複数の文字が最終的に端末バッファに出現するか，標準入力が実際には端末ではない.

これは、いくつかのコンテンツがパイプを介して標準入力に送信されても、端末から常に読み取られることに留意されたい。

Windows注意事項：ごく少数の場合，非ASCII文字を入力すると，この関数は2文字目を待ち，同時に2文字を返す可能性がある.これは，あるUnicode文字が特殊なキータグのように見えるためである.

Changelog

バージョン 2.0 で追加.

パラメータ

echo -- もし設定が True また，読み取った文字も端末に表示される.デフォルトでは表示されません。

click.pause(info='Press any key to continue ...', err=False)

この命令は実行を停止し，ユーザが任意のキーを押して継続するのを待つ.これは，Windowsが“一時停止”コマンドをバッチ処理することと同様である.プログラムが端末を介して実行されていない場合、このコマンドは何の操作も実行しない。

Changelog

バージョン 4.0 で追加: 追加 err パラメータ

バージョン 2.0 で追加.

パラメータ

  • info -- 一時停止前に印刷する情報文字列。

  • err -- Messageに設定されていれば、転送します。 stderr ではなく stdout ECHOと同様である。

click.get_terminal_size()

フォームでは、端末の現在のサイズをタプル形式で返します (width, height) 列と行為単位で。

click.get_binary_stream(name)

バイト処理のためのシステムストリームを返す.

パラメータ

name -- the name of the stream to open. Valid names are 'stdin', 'stdout' and 'stderr'

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

テキスト処理のためのシステムフローを返す.これは通常、戻りバイナリストリームの周囲からパッケージのストリームに戻ります。 get_binary_stream() しかしながら、正しく構成されたストリームに迅速な方法を提供することもできる。

パラメータ

  • name -- the name of the stream to open. Valid names are 'stdin', 'stdout' and 'stderr'

  • encoding -- 検出されたデフォルトコードを上書きします。

  • errors -- デフォルトエラーモードを上書きします。

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

これは似たようなものです File 有効ですが、手動でのみ使用できます。デフォルトの場合、ファイルは不活性な方法で開きます。これは、通常のファイルを開くことができ、以下の場合にはstdin/stdoutを開くこともできます。 '-' もう過ぎました。

Stdin/stdoutを返すとストリームがパッケージされ，コンテキストマネージャが意外にストリームを閉じることはない.これにより、予期せずに標準ストリームを閉じることを心配することなく、このような関数を常に使用することができる。

with open_file(filename) as f:
    ...
Changelog

バージョン 3.0 で追加.

パラメータ

  • filename -- 開くファイルの名前(または '-' 標準入力/標準出力)に用いられる.

  • mode -- ファイルのモードを開く。

  • encoding -- 使うコードです。

  • errors -- このファイルのエラー処理。

  • lazy -- Trueに反転して怠惰にファイルを開くことができる.

  • atomic -- 原子モードでは、書き込み動作は一時ファイルに入り、オフ状態に移行される。

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

アプリケーションの構成フォルダに戻ります。デフォルトアクションは、オペレーティングシステムに最適な任意のコンテンツを返すことです。

アイデアを与えるために "Foo Bar" 以下のようなフォルダの内容が返される場合があります。

MacOSX：

~/Library/Application Support/Foo Bar

Mac OS X(POSIX)：

~/.foo-bar

UNIX：

~/.config/foo-bar

UNIX(POSIX)：

~/.foo-bar

Win XP(ローミング)：

C:\Documents and Settings\<user>\Local Settings\Application Data\Foo Bar

Win XP(非ローミング)：

C:\Documents and Settings\<user>\Application Data\Foo Bar

Win 7(ローミング)：

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

Win 7(非ローミング)：

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

Changelog

バージョン 2.0 で追加.

パラメータ

  • app_name -- アプリケーション名。これは適切に大文字でなければならず、スペースを含めることができる。

  • roaming -- フォルダをWindows上でローミングすべきかどうかを制御します。そうでなければ何の影響もない。

  • force_posix -- これを設定すると True その後、いずれのPOSIXシステムにおいても、このフォルダは、XDG config homeまたはDarwinのアプリケーションサポートフォルダに格納されるのではなく、プリアンブルドットを有するメインフォルダに格納される。

click.format_filename(filename, shorten=False)

ユーザが表示するためにファイル名をフォーマットする.この機能の主な目的は，ファイル名が完全に表示できるようにすることである.必要であれば、これは失敗しないようにファイル名をUnicodeに復号する。あるいは、ファイル名を含まない完全パスにファイル名を短縮することができる。

パラメータ

  • filename -- UI表示用のファイル名をフォーマットする。これも失敗せずにファイル名をUnicodeに変換する.

  • shorten -- これは、ファイル名を選択的に短縮して、それへの経路を除去することができる。

指令

class click.BaseCommand(name, context_settings=None)

Base命令は命令の最小APIプロトコルを実現する.多くの有用な機能を実現していないため，多くのコードは決して使用されないが，Click解析器に依存しない代替解析手法の直接サブクラスとして機能することができる.

例えば、これは、argparseやdocoptのようなClickと他のシステムを接続するために使用されてもよい。

基本命令はClickの他の部分が当たり前と考えられる多くのAPIを実現していないため，すべての操作がそれらをサポートしているわけではない.例えば、それらは、通常、装飾器と共に使用することができず、内蔵されたコールバックシステムを備えていない。

Changelog

バージョン 2.0 で変更: 追加 context_settings パラメータ

パラメータ

  • name -- グループが上書きされない限り、使用するコマンドの名前です。

  • context_settings -- Contextオブジェクトに渡されるデフォルト値付きオプション辞書。

allow_extra_args = False

のデフォルト設定は Context.allow_extra_args 旗。

allow_interspersed_args = True

のデフォルト設定は Context.allow_interspersed_args 旗。

context_class

作成するためのコンテキストクラス make_context() それがそうです。

バージョン 8.0 で追加.

alias of click.core.Context

context_settings

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

ignore_unknown_options = False

のデフォルト設定は Context.ignore_unknown_options 旗。

invoke(ctx)

コンテキストが与えられた場合、これはコマンドを呼び出す。デフォルト実現は“未実現”(Not Implemented)エラーを引き起こす.

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

これは，すべての派手なスクリプトをコマンドラインアプリケーションとして呼び出す方法である.これは、常に呼び出し後にアプリケーションを終了する。もしこれが私たちが望むものでなければ SystemExit 捕まる必要があります。

この方法は直接呼び出すことでも可能である Command それがそうです。

Changelog

バージョン 3.0 で追加: 追加 standalone_mode 独立モードを制御するためのフラグ。

パラメータ

  • args -- 分析のパラメータに適用する.提供されていなければ sys.argv[1:] 全部使っています。

  • prog_name -- 使用すべきプログラム名。デフォルトの場合，プログラム名はファイル名を sys.argv[0] それがそうです。

  • complete_var -- Bash完了サポートを制御する環境変数.黙認する. "_<prog_name>_COMPLETE" PROG_NAMEは大文字である.

  • standalone_mode -- デフォルトアクションは，独立モードでのダウンレギュレート用スクリプトである.その後、クリックして例外を処理し、エラーメッセージに変換します。関数は決して返さず、インタプリタをオフにします。これを設定すると False これらは呼び出し元に伝播され、この関数の返り値は invoke() それがそうです。

  • extra -- 追加のキーワードパラメータは文脈構造関数に転送される.見 Context より多くの情報を得ることができます

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

メッセージ名およびパラメータが与えられると、この関数は解析を開始し、新しいものを作成する。 Context それがそうです。ただし，実際の命令コールバックは呼び出していない.

この方法を書き直すことなく使用する文脈を高速にカスタマイズする場合は、 context_class 属性です。

パラメータ

  • info_name -- この呼び出しのメッセージ名.一般に、これは、スクリプトまたはコマンドの最も記述的な名前である。上位スクリプトの場合は，通常スクリプトの名前であり，その次の命令に対しては，通常スクリプトの名前である.

  • args -- 文字列リストのパラメータとして解析する.

  • parent -- 親文脈(利用可能であれば)。

  • extra -- コンテキスト構造関数の追加のキーワードパラメータに転送します。

バージョン 8.0 で変更: 追加 context_class 属性です。

name

命令はそれが持つ名前を考える.命令を登録する Group グループは、この情報のデフォルトコマンド名を使用します。あなたは変更すべきです Context の info_name 属性です。

parse_args(ctx, args)

コンテキストおよびパラメータリストが与えられた場合、これは、パーサを作成し、パラメータを解析し、その後、必要に応じてコンテキストを修正する。これは自動で呼び出されます make_context() それがそうです。

shell_complete(ctx, incomplete)

整数値の完了リストを返すことができない.リンクされたマルチコマンドの名前を表示します。

どの命令もリンクされたマルチ命令の一部であってもよいため，同レベル命令は命令完了期間のいつでも有効である.他のコマンドクラスは、より多くの完了を返します。

パラメータ

  • ctx -- この命令の呼び出しコンテキスト.

  • incomplete -- 完成している値です。空かもしれません。

バージョン 8.0 で追加.

to_info_dict(ctx)

ユーザ向け文書を生成するツールに有用である可能性のある情報を収集する.これは、このコマンドの下の構造全体を遍歴するだろう。

使用 click.Context.to_info_dict() CLI構造全体を遍歴することができます

パラメータ

ctx -- A Context この命令を代表する。

バージョン 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における命令行インタフェースの基本構築ブロックである.基本命令処理命令行解析は，より多くの解析をその下にネストされた命令に割り当てることが可能である.

バージョン 8.0 で変更: コマンド名を表示するeprを追加しました

Changelog

バージョン 7.1 で変更: 追加 no_args_is_help パラメータ

バージョン 2.0 で変更: 追加 context_settings パラメータ

パラメータ

  • name -- グループが上書きされない限り、使用するコマンドの名前です。

  • context_settings -- Contextオブジェクトに渡されるデフォルト値付きオプション辞書。

  • callback -- コールバックをお願いします。これはオプションです。

  • params -- この命令を用いて登録されたパラメータ.これは…。 Option あるいは…。 Argument 物体です。

  • help -- このコマンドのためのヘルプ文字列.

  • epilog -- ヘルプ文字列と同様であるが，ヘルプページの末尾，他のすべてのコンテンツの後に印刷される.

  • short_help -- この命令のための簡単な助け。これは親命令の命令リストに表示される.

  • add_help_option -- デフォルトの場合、各コマンドは1つ登録されます --help 選択します。このパラメータは、この機能を無効にすることができる。

  • no_args_is_help -- これは，パラメータが与えられていない場合に発生する場合を制御する.デフォルトの場合、このオプションは無効状態になります。有効であれば、これは追加されます --help 何のパラメータも渡されていない場合は，パラメータとする.

  • hidden -- ヘルプ出力にこのコマンドを隠蔽します。

  • deprecated -- その命令が廃棄されたことを示すメッセージを送った。

callback

コマンドをトリガする際に実行するコールバック.これはおそらく None このような状況では何も起こらないだろう。

collect_usage_pieces(ctx)

エントリ用法行のすべてのセグメントを返し，それを文字列リストとして返す.

format_epilog(ctx, formatter)

Epilogをフォーマットプログラム(存在すれば)に書き込む.

format_help(ctx, formatter)

フォーマットされたプログラム(存在すれば)への書き込みを支援する.

これは呼び出しの下品な方法です get_help() それがそうです。

これは，以下の方法を呼び出す.

format_help_text(ctx, formatter)

フォーマットされたプログラム(存在する場合)にテキストを書き込むのを助ける.

format_options(ctx, formatter)

すべてのオプションをフォーマットプログラム(存在する場合)に書き込みます。

format_usage(ctx, formatter)

フォーマットされたプログラムに法行で書き込みます。

これは呼び出しの下品な方法です get_usage() それがそうです。

get_help(ctx)

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

電話をかける format_help() 内部にあります。

get_help_option(ctx)

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

get_help_option_names(ctx)

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

get_short_help_str(limit=45)

取得命令の短いヘルプ，あるいは長いヘルプ文字列を短縮することでヘルプを行う.

get_usage(ctx)

法行で文字列にフォーマットして返す.

電話をかける format_usage() 内部にあります。

invoke(ctx)

コンテキストが与えられた場合、これは、(存在する場合)追加のコールバックを正しい方法で呼び出すであろう。

make_parser(ctx)

このコマンドの基本オプション解析器を作成します。

params

この命令のパラメータリストは，それらがヘルプページに表示され実行される順に並べられる.緊急パラメータは非緊急パラメータの前に自動的に処理されるだろう。

parse_args(ctx, args)

コンテキストおよびパラメータリストが与えられた場合、これは、パーサを作成し、パラメータを解析し、その後、必要に応じてコンテキストを修正する。これは自動で呼び出されます make_context() それがそうです。

shell_complete(ctx, incomplete)

整数値の完了リストを返すことができない.オプションの名前とリンクのマルチコマンドを表示します。

パラメータ

  • ctx -- この命令の呼び出しコンテキスト.

  • incomplete -- 完成している値です。空かもしれません。

バージョン 8.0 で追加.

to_info_dict(ctx)

ユーザ向け文書を生成するツールに有用である可能性のある情報を収集する.これは、このコマンドの下の構造全体を遍歴するだろう。

使用 click.Context.to_info_dict() CLI構造全体を遍歴することができます

パラメータ

ctx -- A Context この命令を代表する。

バージョン 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)

多命令は，子命令に割り当てられた命令の基本的な実現である.最も一般的なバージョンは Group それがそうです。

パラメータ

  • invoke_without_command -- これは、マルチコマンド自体をどのように呼び出すかを制御する。デフォルトでは，サブ命令が与えられたときにのみそれを呼び出す.

  • no_args_is_help -- これは，パラメータが与えられていない場合に発生する場合を制御する.以下の場合、デフォルトでこのオプションを有効にします。 invoke_without_command 無効化または無効化されています(有効化されている場合)。有効であれば、これは追加されます --help 何のパラメータも渡されていない場合は，パラメータとする.

  • subcommand_metavar -- 文書中のサブコマンドの位置を指示するための文字列.

  • chain -- これを設定すると True 複数のサブコマンドのリンクが有効になっている。これは，オプションパラメータを持つことができないが，複数の命令をリンクすることを可能にするため，命令の形式を制限する.

  • result_callback -- この多命令に付加された結果はコールバックする.

collect_usage_pieces(ctx)

エントリ用法行のすべてのセグメントを返し，それを文字列リストとして返す.

format_commands(ctx, formatter)

オプションの後にすべてのコマンドを追加するための複数の方法の追加フォーマット方法。

format_options(ctx, formatter)

すべてのオプションをフォーマットプログラム(存在する場合)に書き込みます。

get_command(ctx, cmd_name)

コンテキストおよびコマンド名が与えられた場合、これは1つに戻ります Command オブジェクト(それが存在する場合、または戻る場合 None それがそうです。

invoke(ctx)

コンテキストが与えられた場合、これは、(存在する場合)追加のコールバックを正しい方法で呼び出すであろう。

list_commands(ctx)

サブコマンド名リストは、サブコマンド名の表示順に返される。

parse_args(ctx, args)

コンテキストおよびパラメータリストが与えられた場合、これは、パーサを作成し、パラメータを解析し、その後、必要に応じてコンテキストを修正する。これは自動で呼び出されます make_context() それがそうです。

result_callback

格納された結果はコールバックされます。属性は、この属性を設定または書き換えることができます。 resultcallback() 装飾師です。

resultcallback(replace=False)

結果コールバックをコマンドに追加します。デフォルトの場合、結果コールバックが登録されていれば、それらをリンクしますが、使用することができます。 replace パラメータその結果コールバックは，子命令の返り値(または，リンクが有効になっていれば，すべての子命令の返り値リスト)と，主コールに渡されるパラメータを用いて呼び出される.

例：：

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

@cli.resultcallback()
def process_result(result, input):
    return result + input
パラメータ

replace -- もし設定が True 既存の結果コールバックは削除されるだろう。

Changelog

バージョン 3.0 で追加.

shell_complete(ctx, incomplete)

整数値の完了リストを返すことができない.オプション、サブコマンド、およびリンクマルチコマンドの名前を表示します。

パラメータ

  • ctx -- この命令の呼び出しコンテキスト.

  • incomplete -- 完成している値です。空かもしれません。

バージョン 8.0 で追加.

to_info_dict(ctx)

ユーザ向け文書を生成するツールに有用である可能性のある情報を収集する.これは、このコマンドの下の構造全体を遍歴するだろう。

使用 click.Context.to_info_dict() CLI構造全体を遍歴することができます

パラメータ

ctx -- A Context この命令を代表する。

バージョン 8.0 で追加.

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

グループは、サブコマンドを追加することを許可します。これはClickでネストを実現する最も一般的な方法である.

パラメータ

  • name -- グループコマンドの名前。

  • commands -- 名前をマッピングした辞書 Command 物体です。そうでもいい Command それは使用されます Command.name 辞書を作ることができます

  • attrs -- Other command arguments described in MultiCommand, Command, and BaseCommand.

バージョン 8.0 で変更: ♪the commmands パラメータは、コマンドオブジェクトリストであってもよい。

add_command(cmd, name=None)

もう一つを登録する Command この人たちと一緒にいます。名前が提供されていない場合は、コマンドの名前を使用します。

command(*args, **kwargs)

コマンドを宣言し、コマンドをグループに追加するためのショートカット装飾器。これは以下と同様の論拠を採用している command() そして、作成されたコマンドを直ちにグループに登録し、メソッドは呼び出しです。 add_command() それがそうです。

使用するコマンドクラスをカスタマイズする場合は、 command_class 属性です。

バージョン 8.0 で変更: 追加 command_class 属性です。

command_class = None

設定されていれば、そのグループの command() デフォルトで装飾器に設定されています Command 級友たち。これは，すべての子命令にカスタム命令クラスを使用させるために非常に有用である.

バージョン 8.0 で追加.

commands

その名前で登録されたサブコマンドを導出する.

get_command(ctx, cmd_name)

コンテキストおよびコマンド名が与えられた場合、これは1つに戻ります Command オブジェクト(それが存在する場合、または戻る場合 None それがそうです。

group(*args, **kwargs)

グループを宣言し、グループに追加するためのショートカット装飾器。これは以下と同様の論拠を採用している group() 作成されたグループをすぐにグループに登録します。メソッドは呼び出しです。 add_command() それがそうです。

使用するグループ類をカスタマイズする場合は、 group_class 属性です。

バージョン 8.0 で変更: 追加 group_class 属性です。

group_class = None

設定されていれば、そのグループの group() デフォルトで装飾器に設定されています Group 級友たち。これは，すべてのサブグループにカスタムグループクラスを使用させるために非常に有用である.

特殊値に設定すれば type (文字通り) group_class = type )であれば、このグループのクラスはデフォルトクラスとして使用される。これにより，カスタムグループクラスはカスタムグループを生成し続ける.

バージョン 8.0 で追加.

list_commands(ctx)

サブコマンド名リストは、サブコマンド名の表示順に返される。

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

命令集合は，複数の多命令を1つに統合した多命令である.これは、ソースとして一連の異なるマルチコマンドを受け取り、各コマンドにすべてのコマンドを提供する簡単な実装である。

add_source(multi_cmd)

リンクスケジューラに新たなマルチコマンドを追加する.

get_command(ctx, cmd_name)

コンテキストおよびコマンド名が与えられた場合、これは1つに戻ります Command オブジェクト(それが存在する場合、または戻る場合 None それがそうです。

list_commands(ctx)

サブコマンド名リストは、サブコマンド名の表示順に返される。

sources

登録されたマルチコマンドリスト。

パラメータ

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

コマンドのパラメータには2つのバージョンがあります Option sまたは Argument 他のサブクラスは、解析のための内部メカニズムのいくつかが意図的に最終的に決定されていないので、現在設計上サポートされていない。

オプションおよびパラメータは、いくつかの設定をサポートします。

パラメータ

  • param_decls -- このオプションまたは引数のパラメータ宣言.これはフラグまたはパラメータ名のリストである.

  • type -- 使うべきタイプです。あるいはそうだ ParamType Pythonタイプですサポートすれば，後者は自動的に前者に変換される.

  • required -- このオプションがオプションか非オプションかを制御します。

  • default -- 省略するとデフォルト値となる.これは、呼び出し可能であってもよく、この場合、何のパラメータもないデフォルト値が必要な場合に呼び出される。

  • callback -- パラメータマッチング後に実行されるべきコールバック.これはこう呼ばれています fn(ctx, param, value) また，返り値が必要である.

  • nargs -- マッチングするパラメータ数。もしそうでなければ 1 返り値は、単一の値ではなくタプルである。Nargsのデフォルト値は 1 (タイプがタプルでない限り、タプルの数である)。もし nargs=-1 残りのパラメータはすべて収集する.

  • metavar -- この値はヘルプページにおける表示方式である.

  • expose_value -- もしこれが True その後、この値は、コマンドコールバックに渡されてコンテキストに格納され、そうでなければ、値はスキップされる。

  • is_eager -- 緊急値は非緊急値を処理する前に処理を行う.これはパラメータ設定ではなく，そうでなければ処理順序が逆になる.

  • envvar -- 検査すべき環境変数である文字列または文字列リスト.

  • shell_complete -- カスタムシェルが完了した関数に戻る.与えられた場合、パラメータの代わりに使用されるタイプが完了する。Vbl.取る ctx, param, incomplete そして戻らなければなりません CompletionItem 文字列リストです

バージョン 8.0 で変更: autocompletion 改名しました。 shell_complete また，上記の新しい意味を持つ.古い名前は使用されておらず、8.1で削除され、その前に、新しい要求に適合するように包装されるだろう。

バージョン 8.0 で変更: 上の multiple=True, nargs>1 デフォルト値はタプルリストでなければなりません。

バージョン 8.0 で変更: デフォルト値を設定する必要はありません nargs>1 これは黙認しています None それがそうです。 multiple=True あるいは…。 nargs=-1 黙認して考える. () それがそうです。

Changelog

バージョン 7.1 で変更: 空環境変数は空文字列値ではなく無視される.これにより，スクリプトは変数の設定を取り消すことができずに変数を消去することができる.

バージョン 2.0 で変更: パラメータコールバックされた署名は，そのパラメータにも渡されるように変更されている.古いコールバック形式はまだ有効ですが、それはコードをもっと簡単に移行する機会があるように警告します。

get_default(ctx, call=True)

このパラメータのデフォルト値を取得します。やってみる Context.lookup_value() まず、それから地元の約束違反です。

パラメータ

  • ctx -- 現在の文脈。

  • call -- デフォルト値がCallableであれば，それを呼び出す.呼び出し可能なオブジェクトを返すために無効になります。

バージョン 8.0 で変更: 見ろ ctx.default_map まず。

バージョン 8.0 で変更: 追加 call パラメータ

get_error_hint(ctx)

どのパラメータがエラーをもたらしたかを示すために、エラーメッセージのためのパラメータの文字列化バージョンを取得する。

property human_readable_name

このパラメータの人間可読名を返す.これはオプションの名前と同じであるが，パラメータのメタ変数である.

process_value(ctx, value)

値およびコンテキストが与えられた場合、これは、必要に応じて値を変換するために論理を実行する。

shell_complete(ctx, incomplete)

整数値の完了リストを返すことができない.もし1つが shell_complete 関数は初期化過程で与えられ，使用されている.そうでなければ type shell_complete() 関数が使用される。

パラメータ

  • ctx -- この命令の呼び出しコンテキスト.

  • incomplete -- 完成している値です。空かもしれません。

バージョン 8.0 で追加.

to_info_dict()

ユーザ向け文書を生成するツールに有用である可能性のある情報を収集する.

使用 click.Context.to_info_dict() CLI構造全体を遍歴することができます

バージョン 8.0 で追加.

type_cast_value(ctx, value)

一定の値が与えられ、これはタイプシステムで正しく実行されるだろう。これは自動的に処理されます nargs そして multiple そして複合タイプです

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 -- ヘルプページにデフォルト値を表示すべきかどうかを制御します。通常、デフォルト値は表示されません。この値が文字列であれば、値ではなく文字列が表示される。これは動的オプションに特に有用である。

  • show_envvar -- 制御はヘルプページに環境変数を表示すべきかどうかを制御する.通常，環境変数は表示されない.

  • prompt -- もし設定が True あるいは空文字列でない場合は，ユーザに入力を促す.もし設定が True ヒントは大文字のオプション名となります。

  • confirmation_prompt -- 設定すれば，入力を提示すると，その値を確認する必要がある.

  • prompt_required -- もし設定が False すると，オプションが値のないフラグとして指定された場合にのみ，ユーザに入力を促す.

  • hide_input -- もしこれが True 提示上の入力はユーザに隠蔽される.これはパスワード入力に有用です。

  • is_flag -- このオプションを標識として強制する。デフォルト値は自動検出である.

  • flag_value -- フラグが有効である場合、その値はフラグに使用されるべきである。オプション文字列にスラッシュが含まれて2つのオプションをマークすると、自動的にブール値に設定される。

  • multiple -- これを設定すると True そして，その論点は何度も受け入れられて記録されている.これは似たようなものです nargs それはどのように動作するが、任意の数のパラメータをサポートする。

  • count -- このフラグは、オプションを整数にインクリメントする。

  • allow_from_autoenv -- この機能が有効にされている場合、コンテキストでプレフィックスが定義されないように、環境変数からこのパラメータの値が抽出される。

  • help -- 文字列を助ける。

  • hidden -- ヘルプ出力にこのオプションを隠蔽します。

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

パラメータは命令の位置パラメータである.通常選択肢よりも少ない機能を提供していますが無限個を持つことができます nargs デフォルトの場合には必要です。

すべてのパラメータはパラメータ構造関数にフォワードされる.

文脈.

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() 取り壊す。

パラメータ

  • command -- このコンテキストの命令クラス.

  • parent -- 親文脈。

  • info_name -- この呼び出しのメッセージ名.一般に、これは、スクリプトまたはコマンドの最も記述的な名前である。上位スクリプトの場合は，通常スクリプトの名前であり，その次の命令に対しては，通常スクリプトの名前である.

  • obj -- ユーザデータの任意のオブジェクト.

  • auto_envvar_prefix -- 自動環境変数のためのプレフィックス.もしこれが None 環境変数からの読み出しを無効にする.これは，つねに読み込む環境変数を手動で設定することに影響を与えない.

  • default_map -- パラメータのデフォルト値を持つ辞書(オブジェクトと同様)。

  • terminal_width -- 端末の幅。デフォルト値は親コンテキストからの継承である.コンテキスト定義端末幅がなければ，自動検出を適用する.

  • max_content_width -- Clickが提示するコンテンツの最大幅(現在はヘルプページのみに影響を与える)。上書きされていない場合はデフォルトで80文字となる.言い換えると，端末が80文字以上であっても，デフォルトではClickは80文字を超えるコンテンツをフォーマットしない.それに加えて、フォーマットプログラムは右側にいくつかのセキュリティマッピングを追加する可能性があります。

  • resilient_parsing -- このフラグを有効にすると，Clickは何のインタラクションやコールバックも行わずに解析を行う.デフォルト値も無視されます。これは完成支援のようなものを達成するのに有用だ。

  • allow_extra_args -- これを設定すると True 末尾の余分なパラメータは誤りを起こさず，文脈に保持される.デフォルト設定は命令から継承されます。

  • allow_interspersed_args -- これを設定すると False それではオプションとパラメータを混同することはできない.デフォルト設定は命令から継承されます。

  • ignore_unknown_options -- 知らないオプションを無視するようにクリックし、後の処理のために保存することを指示します。

  • help_option_names -- デフォルトヘルプパラメータをどのように名前付けするかの文字列リスト(オプション)を定義します。黙認する. ['--help'] それがそうです。

  • token_normalize_func -- トークン(オプション、オプションなど)を標準化するためのオプション関数。例えば、これは、大文字と小文字を区別しない動作を実現するために使用することができる。

  • color -- 制御端子はANSI色に対応しているかどうか.デフォルト値は自動検出である.印刷されたテキストをクリックしてANSIコードを使用する場合にのみこのオプションが必要となり、デフォルトではそうではありません。例えば、これはヘルプ出力に影響を与えるだろう。

  • show_default -- すべてのオプションのデフォルト値を表示します。設定されていない場合、デフォルトは親コンテキスト内の値である。上書きオプションの show_default 論争する。

バージョン 8.0 で変更: ♪the show_default パラメータはデフォルトで親コンテキスト中の値である.

Changelog

バージョン 7.1 で変更: 追加 show_default パラメータ

バージョン 4.0 で変更: Added the color, ignore_unknown_options, and max_content_width parameters.

バージョン 3.0 で変更: 追加 allow_extra_args そして allow_interspersed_args パラメータです。

バージョン 2.0 で変更: Added the resilient_parsing, help_option_names, and token_normalize_func parameters.

abort()

スクリプトを中止する。

allow_extra_args

文脈が追加のパラメータを許可するかどうか、または解析に失敗すべきかどうかを示す。

Changelog

バージョン 3.0 で追加.

allow_interspersed_args

コンテキストがパラメータおよびオプションの混合を許可するかどうかを示す。

Changelog

バージョン 3.0 で追加.

args

残りの論争。

call_on_close(f)

コンテキスト割込み時に呼び出す関数を登録する.

これは、スクリプト実行中に開いたリソースをオフにするために使用することができる。Pythonをサポートするコンテキストマネージャプロトコルのリソースは、このプロトコルが with 報告書は登録されなければならない with_resource() 代わりに。

パラメータ

f -- TearDown上で実行する関数.

close()

登録されたすべてのオフ·コール·コールを呼び出します call_on_close() 入力されたすべてのコンテキストマネージャを終了します with_resource() それがそうです。

color

パターン出力が必要かどうかを制御する.

command

♪the Command この場合。

property command_path

計算された命令経路.これは usage ページ上の情報を助けます。これは，文脈の情報名をルートに組み合わせることで自動的に作成される.

ensure_object(object_type)

像 find_object() ただし，最内部のオブジェクトは object_type もしそれが存在しなければ。

exit(code=0)

与えられたログアウトコードを使用してアプリケーションを脱退する.

fail(message)

プログラムの実行を中止し，特定のエラーメッセージを表示する.

パラメータ

message -- 失敗するエラーメッセージ。

find_object(object_type)

所与のタイプの最も近いオブジェクトを検索します。

find_root()

最外層の文脈を調べる。

formatter_class

alias of click.formatting.HelpFormatter

forward(**kwargs)

似たような invoke() しかしながら、別のコマンドが必要とされる場合、現在のコンテキストからのデフォルトキーワードパラメータが充填される。これはコールバックを直接呼び出すことはできず，他の命令しか呼び出すことができない.

get_help()

現在のコンテキストおよびコマンドのフォーマットヘルプページを取得するためのHelper方法。

get_parameter_source(name)

パラメータのソースを取得する.これはパラメータ値を取得する位置を表す.

これは、ユーザがいつコマンドライン上でデフォルト値と同じ値を指定したかを決定するために非常に有用である。はい。はい。 DEFAULT この値が実際にデフォルト値をとる場合にのみ.

パラメータ

name -- パラメータの名前。

戻り値の型

ParameterSource

バージョン 8.0 で変更: 返品 None パラメータがどのソースからも提供されない場合。

get_usage()

現在のコンテキストおよびコマンドのフォーマットされた用法文字列を取得するためのHelper方法。

help_option_names

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

ignore_unknown_options

コマンドを無視して理解できないオプションをクリックし、後の処理のためにコンテキストに格納することを指示します。これは主にあなたが外部手続きに加入することを望む場合に適用される。一般的に、すべての論点を可逆的に転送することは不可能であるため、このモデルに強く反対する。

Changelog

バージョン 4.0 で追加.

info_name

記述情報名

invoke(**kwargs)

命令コールバックは、完全に予想に合った方法で呼び出される。この方法を呼び出すには2つの方法がある.

  1. 第1のパラメータは、コールバックであってもよく、他のすべてのパラメータおよびキーワードパラメータは、関数に直接転送される。

  2. 最初のパラメータは、コマンドオブジェクトをクリックすることです。この場合、すべてのパラメータも転送されるが、正しいクリックパラメータ(オプションおよびクリックパラメータ)はキーワードパラメータでなければならず、Clickはデフォルト値を充填する。

Click 3.2までは，このコードの意図とは逆のキーワードパラメータが正しく埋め込まれておらず，コンテキストは作成されていないことに注意されたい.この変更およびエラー修復バージョンでこの変更が行われた理由についての詳細は、参照されたい 3.2にアップグレードする それがそうです。

invoked_subcommand

このフラグは、サブコマンドを実行するか否かを示す。グループコールは、この情報を使用して、実行フローがサブコマンドに転送され続けるので、それが直接実行されるかどうかを決定することができる。デフォルトではNONEであるが、実行するサブコマンドの名前であってもよい。

リンクが有効になっていれば、それを設定します '*' 何の命令も実行しないようにしてください。しかし、どれかを計算することはできない。この知識が必要であれば使用すべきである resultcallback() それがそうです。

lookup_default(name, call=True)

取得パラメータのデフォルト値から default_map それがそうです。

パラメータ

  • name -- パラメータの名前。

  • call -- デフォルト値がCallableであれば，それを呼び出す.呼び出し可能なオブジェクトを返すために無効になります。

バージョン 8.0 で変更: 追加 call パラメータ

make_formatter()

創立 HelpFormatter ヘルプと用法出力に関する情報。

この方法を書き直さずに使用するフォーマットプログラム類を高速にカスタマイズする場合は、 formatter_class 属性です。

バージョン 8.0 で変更: 追加 formatter_class 属性です。

max_content_width

フォーマットコンテンツの最大幅(合理的なデフォルト値を表すことなく，多くの場合80).

property meta

これはすべての入れ子文脈と共有される辞書である.これは，ユーティリティをクリックして必要に応じてここにいくつかの状態を格納できるようにするためである.しかし、この辞書を管理することはそのコードの責任だ。

鍵は唯一の破線文字列であるべきである.例えば，モジュールパスは良い選択である.その中に格納されている内容はクリック操作とは無関係である.しかしながら、データをここに置くコードは、システムの一般的な意味に従うことが重要である。

例示的な用法：

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')
Changelog

バージョン 5.0 で追加.

obj

格納されたユーザオブジェクト。

params

パラメータ名をそれらの解析した値にマッピングする.パラメータ使用 expose_value=False 保存されていません。

parent

親文脈や None もし存在しなければ。

protected_args

保護されたパラメータですこれらのパラメータの接頭辞は args いくつかの解決策に遭遇したが、別のパラメータに伝播してはならない場合。これはネスト解析を実現するためのものである.

resilient_parsing

弾性解析を有効にするかどうかを指示する.この場合、Clickは何の障害も生じないように最善を尽くし、デフォルト値は無視されます。完成に役立ちます。

scope(cleanup=True)

このブースタ方法は、Contextオブジェクトと共に使用して、現在のスレッドローカルにアップグレードすることができる(参照 get_current_context() ）。この操作のデフォルト動作は、設定によって無効になるクリーニング機能を呼び出すことです cleanup 至る False それがそうです。クリーニング関数は，通常，ファイルハンドルを閉じるなどの操作に用いられる.

クリーニングが意図的である場合、コンテキストオブジェクトは、コンテキストマネージャとして直接使用されてもよい。

例示的な用法：

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

これはこれに相当します

with ctx:
    assert get_current_context() is ctx
Changelog

バージョン 5.0 で追加.

パラメータ

cleanup -- 掃除機能を実行すべきかどうかを制御する。デフォルトの場合，これらの関数を実行する.場合によっては、コンテキストは一時的にプッシュされることのみが望ましいが、この場合、この機能を無効にすることができる。入れ子プッシュは自動的に掃除を延期します。

set_parameter_source(name, source)

パラメータのソースを設定する。これはパラメータ値を取得する位置を表す.

パラメータ

  • name -- パラメータの名前。

  • source -- メンバー、メンバー ParameterSource それがそうです。

show_default

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

terminal_width

端子の幅(自動検出なし)。

to_info_dict()

ユーザ向け文書を生成するツールに有用である可能性のある情報を収集する.これはCLI構造全体を横断する.

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

バージョン 8.0 で追加.

token_normalize_func

トークンのオプション正規化関数.これはオプション，選択，コマンドなどである.

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 -- 入るコンテキストマネージャ。

戻り値

どうでもいいよ。 context_manager.__enter__() 復帰する。

バージョン 8.0 で追加.

click.get_current_context(silent=False)

コンテキストを現在クリックします。これは、現在のコンテキストオブジェクトに任意の場所からアクセスする1つの方法として使用することができる。これは正しい pass_context() 装飾師です。この関数は主にブースターのために使用され、例えば echo() それは、現在のコンテキストに基づいてその行動を変更することに関心を持つことができる。

現在の文脈をプッシュするために Context.scope() 使用できます。

Changelog

バージョン 5.0 で追加.

パラメータ

silent -- もし設定が 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
click.INT = INT
click.FLOAT = FLOAT
click.BOOL = BOOL
click.UUID = UUID
click.UNPROCESSED = UNPROCESSED
class click.File(mode='r', encoding=None, errors='strict', lazy=None, atomic=False)

パラメータを読み書き可能なファイルとして宣言する.コンテキストが中断されると(命令が完了した後)、ファイルは自動的にオフになる。

ファイルを開いて読み出しや書き込みを行うことができる.特殊な価値 - Stdinまたはstdoutはモードによって指示されます。

デフォルトの場合、ファイルはテキストデータを読み取るために開いているが、バイナリモードで開いたり、書き込みしたりしてもよい。符号化パラメータを使用して、特定の符号化を強制することができる。

♪the lazy フラグ制御ファイルはすぐに開くべきですか、それとも最初のIOで開くべきですか。標準入出力ストリームおよび読み出しのためのファイルを開く場合、デフォルト設定は不活性に設定されている。 lazy そうでなければ。読み出しのために怠惰にファイルを開いている場合には、そのファイルは一時的に開いて検証を行うが、1回目のIOまでは開いた状態を維持しない。書き込みのために開いた場合、Lazyは主に有用であり、必要な前にファイルを作成しないようにする。

Click 2.0からは，自動的にファイルを開くことも可能であり，この場合，すべての書き込み内容が同一フォルダ中の1つの個別ファイルに格納され，完了後，そのファイルは元の位置に移動される.他のユーザが定期的に読み取ったファイルを修正すれば，この機能は非常に有用である.

見 ファイルパラメータ より多くの情報を得ることができます

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

経路タイプは File タイプですが、それは違う検査を実行します。まず，開いたファイルハンドルを返さず，ファイル名のみを返す.二番目に、それはファイルやディレクトリが何であるべきかに関する様々な基本的なチェックを実行することができる。

Changelog

バージョン 6.0 で変更: allow_dash 入れられました。

パラメータ

  • exists -- Trueに設定すると，この値を有効にするためにファイルやディレクトリが存在する必要がある.これが必要ではなく、ファイルが存在しない場合、さらなるすべての検査は暗黙的にスキップされるであろう。

  • file_okay -- 制御ファイルが可能な値であるかどうか。

  • dir_okay -- ディレクトリが可能な値であるかどうかを制御する.

  • writable -- Trueであれば書き込み可能チェックを実行する.

  • readable -- Trueであれば，可読チェックを実行する.

  • resolve_path -- もし真であれば，その値を渡し続ける前にその経路を完全に解析する.これは絶対的であり，記号リンクが解析されていることを意味する.これはshellのみで行われなければならないので、代数プレフィックスを拡張しないだろう。

  • allow_dash -- これを設定すると True 標準ストリームを表すために、単一の破折番号を使用することが許可される。

  • path_type -- オプションで、パスを表す文字列タイプに適用されます。黙認する. None これは，返り値がバイトまたはUnicodeとなり，特にClickが扱う入力データの中で最も意味のある値に依存することを意味する.

class click.Choice(choices, case_sensitive=True)

選択タイプは、固定されたサポートされた値のセットに対してある値をチェックすることを可能にします。これらの値はすべて文字列でなければならない.

あなたは1つのオプションリストまたはタプルだけを渡さなければなりません。生成器のような他の反復可能なコードは、驚くべき結果を生成する可能性がある。

結果値は常に最初に伝達される選択肢の1つであり，いずれにしても case_sensitive どんなものでも ctx.token_normalize_func 指定されています。

見 オプションを選択する 例を挙げましょう

パラメータ

case_sensitive -- Falseに設定することで、大文字と小文字を区別しないように選択することができます。デフォルトはtrueです。

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 パラメータです。

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 パラメータです。

class click.Tuple(types)

Clickのデフォルトアクションは，タイプを値に直接適用することである.これはほとんどの場合よく働いていますが、以下の場合は除外します。 nargs 固定カウントに設定され、異なる項目は異なるタイプを使用しなければならない。本例では、 Tuple タイプはご利用いただけます。このタイプは以下の場合にのみ使用できます nargs 固定数字に設定する。

より多くの情報については、参照されたい 多値オプションとしてのタプル それがそうです。

これは、Pythonタプル文字をタイプとして選択することができます。

パラメータ

types -- タプル項のタイプリストに適用する.

class click.ParamType

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

カスタムタイプを実現するためには，サブクラス化し，少なくとも以下を実現する.

  • ♪the name クラス属性を設定しなければならない.

  • 呼び出しタイプのインスタンスを使用する None 必ず帰ってきて None それがそうです。これはデフォルトで実現された。

  • convert() 文字列の値を正しいタイプに変換しなければならない.

  • convert() すでに正しいタイプの値であることを受け入れなければならない。

  • 値を変換することができなければなりません ctx そして param パラメータには None それがそうです。ヒント入力を変換する際にこのようなことが発生する可能性がある.

convert(value, param, ctx)

値を正しいタイプに変換する.値があれば None (不足している値)。

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

♪the param そして ctx パラメータは None 場合によっては、例えば、プロンプト入力を変換する場合がある。

この値が変換できない場合は，呼び出しを行う. fail() 記述的な情報を持つ。

パラメータ

  • value -- 変換する値です。

  • param -- このタイプを用いてその値のパラメータを変換する.そうかもしれない None それがそうです。

  • ctx -- この値に達した現在のコンテキスト.そうかもしれない None それがそうです。

envvar_list_splitter = None

このようなタイプのリストが必要であり，その値が文字列環境変数から抽出されている場合，これが分割の理由である. None 任意のスペースを表示します。すべてのパラメータに対して，それらをスペースで分けるのが一般的である.例外的な場合は経路とファイルが分割されています os.path.pathsep デフォルトの場合(Unix上は“：”，Windows上では“；”).

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

ブースタ手法は失敗し，無効値メッセージを返す.

get_metavar(param)

このパラメータのメタ変数デフォルト値を返す(提供すれば).

get_missing_message(param)

オプションで、欠落パラメータに関する追加情報が返される可能性があります。

Changelog

バージョン 2.0 で追加.

name = None

このタイプの記述名

shell_complete(ctx, param, incomplete)

戻ります。 CompletionItem 不完全な値のために作成します。ほとんどのタイプは補完を提供しないが，一部のタイプは補完を提供し，カスタムタイプもカスタム補完を提供することを可能にする.

パラメータ

  • ctx -- この命令の呼び出しコンテキスト.

  • param -- 完了を要求するパラメータ。

  • incomplete -- 完成している値です。空かもしれません。

バージョン 8.0 で追加.

split_envvar_value(rv)

環境変数の値が与えられると、これは、定義されたenvarリスト分割器に従って小さなブロックに分割される。

分解器が None これは，スペース分割を意味し，先頭スペースと末尾スペースを無視することを意味する.そうでなければ、プリアンブル分解器および尾付き分離器は、一般に、空項を含むことをもたらす。

to_info_dict()

ユーザ向け文書を生成するツールに有用である可能性のある情報を収集する.

使用 click.Context.to_info_dict() CLI構造全体を遍歴することができます

バージョン 8.0 で追加.

例外

exception click.ClickException(message)

Clickはユーザに例外を処理して表示することができる.

exception click.Abort

内部シグナリング異常は、中止するためにクリックすることを示します。

exception click.UsageError(message, ctx=None)

使用エラー信号を発する内部異常。これは一般的にどんな追加的な処理も中止するだろう。

パラメータ

  • message -- 表示するエラーメッセージ。

  • ctx -- オプションで、この誤ったコンテキストをもたらします。場合によっては、クリックが自動的にコンテキストを充填します。

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

エラーパラメータの標準化エラーメッセージの異常をフォーマットする.これは、Clickがコンテキスト情報(例えば、どのパラメータであるか)を追加するので、コールバックまたはタイプから開始されるときに非常に有用である。

Changelog

バージョン 2.0 で追加.

パラメータ

  • param -- この誤りを招くパラメータオブジェクト.これを省略することができ，可能であればClickはその情報自体を付加する.

  • param_hint -- パラメータ名の文字列として表示される.これは代替することができます param カスタム検証を行うべき場合.文字列であればこのように使用され，リストであれば，それぞれに引用符を付けて分離しなければならない.

exception click.FileError(filename, hint=None)

ファイルが開いていない場合、起動されます。

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

Clickが存在しないオプションを処理しようと試みると誘発される.

Changelog

バージョン 4.0 で追加.

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

一般にオプションが提供されるが、オプションの使用が正しくない場合、開始される。たとえば，オプションのパラメータ数が正しくなければ，この問題を引き起こす.

Changelog

バージョン 4.0 で追加.

パラメータ

option_name -- 正しく使用されていないオプションの名前です。

exception click.BadArgumentUsage(message, ctx=None)

一般にパラメータが提供されるが、このパラメータの使用が正しくない場合、開始される。たとえば，パラメータの値数が正しくなければ，この問題を引き起こす.

Changelog

バージョン 6.0 で追加.

フォーマットして

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

このようなヘルプは、テキストベースのヘルプページのフォーマットを設定します。それは、一般に、非常に特殊な内部状況にのみ使用されるが、開発者が自分の奇妙な出力を作成することができるように、公開されることもある。

現在、それはいつもメモリに書き込まれている。

パラメータ

  • indent_increment -- 各レベルの追加増加。

  • width -- テキストの幅。デフォルトの場合、端子幅は最大78に制限される。

dedent()

インデントを減らす。

getvalue()

バッファ内容を返す.

indent()

インデントを増やす。

indentation()

インデントのコンテキストマネージャを追加する.

section(name)

段落、タイトル、およびインデントを作成するための有用なコンテキストマネージャ。

パラメータ

name -- タイトルに書かれた節名。

write(string)

Unicode文字列を内部バッファに書き込む.

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

定義リストをバッファに書き込む.これはオプションとコマンドの通常のフォーマットです。

パラメータ

  • rows -- 用語および値の2つのアイテムタプルのリスト。

  • col_max -- 1列目の最大幅。

  • col_spacing -- 第1列と第2列との間のスペース数。

write_heading(heading)

バッファにタイトルを書き込む.

write_paragraph()

バッファにパラグラフを書き込む.

write_text(text)

新たに格納されたテキストをバッファに書き込む.これは再び改行されて段落を維持するだろう。

write_usage(prog, args='', prefix='Usage: ')

フランス行でバッファに書き込みます。

パラメータ

  • prog -- プログラム名。

  • args -- スペースで区切られたパラメータリスト。

  • prefix -- 最初の行のプレフィックス。

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

スマート改行テキストのブースター関数。デフォルトでは、単一のテキスト段落を操作すると仮定しているが、もし preserve_paragraphs パラメータは，段落を知的に処理する(2つの空行で定義される).

段落を処理する場合、段落の前に空行を追加することができ、その中に含まれる \b 性格 (\x08 )は、ブロック内で再包装が発生してはならないことを示すために使用される。

パラメータ

  • text -- 改行すべきテキスト。

  • width -- テキストの最大幅。

  • initial_indent -- 最初の行の初期インデントは文字列として配置されなければなりません。

  • subsequent_indent -- 各連続行に置かれるべきインデント文字列。

  • preserve_paragraphs -- このフラグが設定されていれば，改行はパラグラフを知的に処理する.

解析法.

class click.OptionParser(ctx=None)

オプション解析器は内部クラスであり，最終的にオプションとパラメータを解析するために用いられる.これはoptparseを模倣し，類似しているが大幅に簡略化されたAPIをもたらす.高級Click類がそれを包装してくれるので、一般的にそれを直接使用してはいけない。

より高いレベルで実現される特性(例えば、タイプまたはデフォルト値)を実装していないので、optparseまたはargparseよりもはるかに拡張性がある。

パラメータ

ctx -- 選択可能なのは Context この解析器が使用すべき位置。

add_argument(dest, nargs=1, obj=None)

名前の位置パラメータを追加する dest 解析器まで。

♪the obj パーサから返された注文リスト内のオプションを識別するために使用することができる。

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

Adds a new option named dest to the parser. The destination is not inferred (unlike with optparse) and needs to be explicitly provided. Action can be any of store, store_const, append, appnd_const or count.

♪the obj パーサから返された注文リスト内のオプションを識別するために使用することができる。

allow_interspersed_args

これは解析器が分散したパラメータをどのように処理するかを制御する.これを設定すると False パーサは、最初の非オプションで停止します。このオプションを使用して、ネストされたサブコマンドを安全に実現することができます。

ctx

♪the Context この解析器に使います。これはおそらく None いくつかの高級用例に適用される。

ignore_unknown_options

これは，解析器が未知のオプションをどのように扱うかを教える.デフォルトの場合、それはエラーになりますが(これは合理的です)、それを無視し、すべての未知のオプションを結果パラメータに移した後に処理を継続する別のパターンがあります。

parse_args(args)

位置パラメータを分析して返します (values, args, order) 解析に用いるオプションとパラメータ，および残りのパラメータ(あれば).順序は，オブジェクトがコマンドラインに表示されるリストである.パラメータが複数回出現すれば，それらも複数回記憶される.

殻が完成する.

見 殻が完成する. Clickのshell作成システムの有効化とカスタマイズに関する情報.

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

完成値とその値に関するメタデータを表す.メタデータを黙認して type 特殊な筐体処理を指示し help 筐体プログラムが値の横にヘルプ文字列を表示することをサポートしている場合。

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

パラメータ

  • value -- 完成提案。

  • type -- シェルスクリプトにこのタイプの特殊な完了支援を通知します。使用をクリックする "dir" そして "file" それがそうです。

  • help -- 値の横に表示される文字列(サポートされている場合)。

  • kwargs -- 任意のメタデータ。内蔵実現はそれを使用しないが，カスタムシェルサポートと組み合わせて使用するカスタムタイプ完了はそれを使用することができる.

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

ハウジング完了サポートを提供するためのベースクラス。シェルが与えられたサブクラスは，完了命令を実現するために属性とメソッドを書き換える. (source そして complete ）。

パラメータ

  • cli -- 命令を呼び出しています。

  • prog_name -- Shell中の実行可能ファイルの名前。

  • complete_var -- 完了命令の環境変数の名前を保存する.

バージョン 8.0 で追加.

name = None

筐体を名前として登録する add_completion_class() それがそうです。これは完成説明に用いられる. ({{name}}_source そして {{name}}_complete ）。

source_template = None

完成スクリプトテンプレートのフォーマットは source() それがそうです。これはサブクラスによって提供されなければならない。

property func_name

完成スクリプトで定義されるシェル関数の名前.

source_vars()

フォーマット設定のための変数 source_template それがそうです。

By default this provides complete_func, complete_var, and prog_name.

source()

完了関数を定義するシェルスクリプトを生成する.デフォルトではこれは % -スタイルフォーマット source_template 戻ってきた判決書を使う source_vars() それがそうです。

get_completion_args()

シェルスクリプトで定義されたenv変数を用いて返す. args, incomplete それがそうです。これはサブクラスで実現されなければならない.

get_completions(args, incomplete)

コンテキストおよび最後の完全なコマンドまたはパラメータは、完全なパラメータから決定される。このオブジェクトを呼び出すのは shell_complete 方法により，整数値の完全値を得ることができない.

パラメータ

  • args -- 不完全値の前の完全パラメータリスト。

  • incomplete -- 完成している値です。空かもしれません。

format_completion(item)

完成項をシェルスクリプトで認識可能なフォームにフォーマットする.これはサブクラスで実現されなければならない.

パラメータ

item -- フォーマットしなければならない完成項。

complete()

筐体に返送する完了データを生成する.

デフォルトの場合、この呼び出し get_completion_args() 取得が完了して呼び出します format_completion() 完成するたびに。

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

登録a ShellComplete 名前の下のサブクラスを与える.完了中に、名前は完了命令環境変数によって提供される。

パラメータ

  • cls -- シェルを完成させた完成クラスを処理します。

  • name -- その下にクラスの名前を登録しなければならない.デフォルトクラスの name 属性です。

テストをする

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

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

パラメータ

  • charset -- データの文字集合を入出力する.

  • env -- 書き換えのための環境変数を含む辞書.

  • echo_stdin -- これを設定すると True そして、stdinから読み出してstdoutに書き込みます。これは、場合によっては例を表示するのに有用である。通常の提示は自動的に表示入力されますのでご注意ください。

  • mix_stderr -- これを設定すると False すると，stdoutとstderrを独立したストリームに保持する.これは，予測可能なstdoutや騒々しいstderrを持つunix哲学アプリケーションに非常に有用であり，アプリケーションごとに独立に測定することができる.

get_default_prog_name(cli)

コマンドオブジェクトが与えられると、オブジェクトのデフォルトプログラム名が返される。デフォルト値は name 属性や "root" 設定されていなければ戻ります。

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

隔離環境でコマンドを呼び出す.パラメータはコマンドラインスクリプトに直接転送される、すなわち extra キーワードパラメータは main() 命令の機能。

これは1つに戻ります Result 物体です。

パラメータ

  • cli -- 呼び出す命令

  • args -- 呼び出すパラメータ。それは反復可能または文字列の形で与えることができる。文字列形式で与えられた場合，Unix shellコマンドと解釈される.もっと詳しい情報については、アクセスしてください shlex.split() それがそうです。

  • input -- の入力データ sys.stdin それがそうです。

  • env -- 環境優先。

  • catch_exceptions -- 他の異常を捉えているかどうかではありません SystemExit それがそうです。

  • extra -- 伝達するキーワードパラメータ main() それがそうです。

  • color -- 出力に色コードが含まれるべきかどうか.アプリケーションは、依然としてこの設定を明示的にカバーすることができる。

バージョン 8.0 で変更: 結果対象は return_value 属性は，呼び出した命令から返された値を用いる.

Changelog

バージョン 4.0 で変更: 追加 color パラメータ

バージョン 3.0 で変更: 追加 catch_exceptions パラメータ

バージョン 3.0 で変更: 結果対象は exc_info 属性はバックトラック(利用可能であれば)を用いる.

isolated_filesystem()

一時フォルダを作成し、現在のワークディレクトリをフォルダに変更して独立したファイルシステムテストを行うためのコンテキストマネージャ。

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

コマンドラインツールを設定して、分離されたコンテキストマネージャを呼び出します。これは、所与の入力データを使用して標準入力を設定し、 os.environ 与えられた辞書中のカバーを用いる.これはまた、Click to be mock内のいくつかの内部機能(例えば、提示機能)を再結合する。

これは invoke() 方法です。

Changelog

バージョン 4.0 で追加: ♪the color パラメータは追加されました。

パラメータ

  • input -- Sys.stdinの入力ストリームを入れる.

  • env -- 環境は辞書より優先される。

  • color -- 出力に色コードが含まれるべきかどうか.アプリケーションは、依然としてこの設定を明示的にカバーすることができる。

make_env(overrides=None)

スクリプトを呼び出す環境カバーを返す.

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

呼び出したCLIスクリプトのキャプチャ結果を保存する.

exc_info

後戻りする.

exception

もし誰かがそうしたら、例外が発生するだろう。

exit_code

整数形式の脱退コード.

property output

(標準)Unicode文字列として出力します。

return_value

呼び出した命令から返された値.

バージョン 8.0 で追加.

runner

結果を作成したランナー

property stderr

Unicode文字列で表される標準誤り。

stderr_bytes

標準誤り(バイト単位)は，利用できなければなしとなる.

property stdout

Unicode文字列形式の標準出力.

stdout_bytes

バイト単位の標準出力.