cli モジュール
定義された API 上の単純な CLI ビルダー
クラス
| AsDict |
キーと値のペアベースの argparse アクション |
機能
add_base
常に使用できる基本的な引数を追加する
add_base(parser)パラメーター
- parser
add_func_args
関数シグネチャを argparse パラメーターに変換する
これにより、python 型の注釈を使用して、argparse パラメーターの作成方法が通知されます。
add_func_args(parser, impl)パラメーター
- parser
- impl
add_funcs
実装レイヤーに関数を追加する
add_funcs(inst, subparser)パラメーター
- inst
- subparser
add_nested
指定されたクラス インスタンス内のオブジェクトを argparse サブコマンドとして再帰する
add_nested(main_parser, parent_parser, inst, api_types, level=0)パラメーター
- main_parser
- parent_parser
- inst
- api_types
- level
既定値: 0
arg_bool
指定した引数が true または false であることを確認します
arg_bool(arg)パラメーター
- arg
arg_dir
指定した引数がディレクトリであることを確認する
arg_dir(arg)パラメーター
- arg
arg_file
指定した引数がファイルであることを確認する
arg_file(arg)パラメーター
- arg
build_arg_parser
最上位レベルの argparse の作成
build_arg_parser(inst, api_types, version)パラメーター
- inst
- api_types
- version
call_func
指定した関数の引数を取得し、それを呼び出します
call_func(func, args)パラメーター
- func
- args
execute_api
軽量 CLI を使用して API を公開する
execute_api(api, api_types, version)パラメーター
- api
- api_types
- version
get_arg_names
関数の引数名を取得する
get_arg_names(func)パラメーター
- func
get_help_text
pydoc 文字列に基づいてヘルプ テキストを取得する
get_help_text(impl)パラメーター
- impl
print_help
サブ解析器から適切なヘルプを見つける
print_help(parser, args)パラメーター
- parser
- args
set_logging
ログの詳細度を設定する
set_logging(api, verbose)パラメーター
- api
- verbose