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