quart.cli モジュール#

class quart.cli.AppGroup(name: str | None = None, commands: MutableMapping[str, Command] | Sequence[Command] | None = None, **attrs: Any)#

ベース: Group

これは通常のclickのGroupと同様に動作しますが、command()デコレータの動作を変更し、関数をwith_appcontext()で自動的にラップするようにします。

QuartGroupと混同しないようにしてください。

command(*args: Any, **kwargs: Any) → Callable#

これは、通常のclick.Groupの同じ名前のメソッドとまったく同じように動作しますが、with_appcontext=Trueを渡すことで有効になっている場合は、コールバックをwith_appcontext()でラップします。

group(*args: Any, **kwargs: Any) → Callable#

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

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

バージョン 8.1 で変更: このデコレータは、括弧なしで適用できます。

バージョン 8.0 で変更: group_class属性を追加しました。

exception quart.cli.NoAppException(message: str, ctx: Context | None = None)#

ベース: UsageError

class quart.cli.QuartGroup(add_default_commands: bool = True, create_app: Callable[..., Quart] | None = None, add_version_option: bool = True, load_dotenv: bool = True, set_debug_flag: bool = True, **extra: Any)#

ベース: AppGroup

get_command(ctx: Context, name: str) → Command#

コンテキストとコマンド名が与えられた場合、これがCommandオブジェクトが存在する場合はそれを返し、存在しない場合はNoneを返します。

list_commands(ctx: Context) → list[str]#

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

make_context(info_name: str | None, args: list[str], parent: Context | None = None, **extra: Any) → Context#

この関数は、情報名と引数が与えられると、解析を開始し、新しいContextを作成します。ただし、実際のコマンドコールバックは呼び出しません。

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

パラメータ:

  • info_name – この呼び出しの情報名。一般的に、これはスクリプトまたはコマンドの最も記述的な名前です。 トップレベルのスクリプトの場合、通常はスクリプトの名前であり、それより下のコマンドの場合はコマンドの名前です。

  • args – 文字列のリストとして解析する引数。

  • parent – 利用可能な場合は親コンテキスト。

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

バージョン 8.0 で変更: context_class属性を追加しました。

parse_args(ctx: Context, args: list[str]) → list[str]#

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

class quart.cli.ScriptInfo(app_import_path: str | None = None, create_app: Callable[..., Quart] | None = None, set_debug_flag: bool = True)#

ベース: object

load_app() → Quart#
quart.cli.find_app_by_string(module: ModuleType, app_name: str) → Quart#
quart.cli.find_best_app(module: ModuleType) → Quart#
quart.cli.get_version(ctx: Any, param: Any, value: Any) → None#
quart.cli.load_dotenv(path: str | PathLike | None = None) → bool#

環境変数を設定するために、優先順位の高い順に「dotenv」ファイルを読み込みます。環境変数がすでに設定されている場合は上書きされないため、リストの前のファイルが後のファイルよりも優先されます。これは、`python-dotenv`_ がインストールされていない場合は何もしません。 .. _python-dotenv: theskumar/python-dotenv :param path: 検索する代わりに、この場所にあるファイルを読み込みます。 :return: ファイルがロードされた場合は True。

quart.cli.locate_app(module_name: str, app_name: str) → Quart | None#
quart.cli.main() → None#
quart.cli.prepare_import(path: str) → str#

ファイル名が与えられた場合、これはpythonパスを計算し、それを検索パスに追加し、期待される実際のモジュール名を返そうとします。

quart.cli.with_appcontext(fn: Callable | None = None) → Callable#