cli Modul
Enkel CLI-byggare ovanpå ett definierat API
AsDict |
En nyckel/värde-parbaserad argparse-åtgärd |
lägga till grundläggande argument som alltid ska vara tillgängliga
add_base(parser)
Parametrar
- parser
Konvertera en funktionssignatur till argparse-parametrar
Detta använder python-skrivkommentarer för att informera om hur argparse-paramerna skapas.
add_func_args(parser, impl)
Parametrar
- parser
- impl
Lägga till funktioner i implementeringsskiktet
add_funcs(inst, subparser)
Parametrar
- inst
- subparser
Upprepas via objekt i en viss klassinstans som argparse-underkommandon
add_nested(main_parser, parent_parser, inst, api_types, level=0)
Parametrar
- main_parser
- parent_parser
- inst
- api_types
- level
Kontrollera att det angivna argumentet antingen är sant eller falskt
arg_bool(arg)
Parametrar
- arg
Kontrollera att det angivna argumentet är en katalog
arg_dir(arg)
Parametrar
- arg
Kontrollera att det angivna argumentet är en fil
arg_file(arg)
Parametrar
- arg
Skapa argparse på översta nivån
build_arg_parser(inst, api_types, version)
Parametrar
- inst
- api_types
- version
Hämta argumenten för den angivna funktionen och anropa den
call_func(func, args)
Parametrar
- func
- args
Exponera ett API via ett lättvikts-CLI
execute_api(api, api_types, version)
Parametrar
- api
- api_types
- version
Hämta namn på funktionsargument
get_arg_names(func)
Parametrar
- func
hämta hjälptexten baserat på pydoc-strängar
get_help_text(impl)
Parametrar
- impl
hitta lämplig hjälp från underparsers
print_help(parser, args)
Parametrar
- parser
- args
Ange loggveroalitet
set_logging(api, verbose)
Parametrar
- api
- verbose