cli Modul

Jednoduchý tvůrce rozhraní příkazového řádku nad definovaným rozhraním API

Třídy

AsDict

Akce argparse založené na páru klíč/hodnota

Funkce

add_base

přidání základních argumentů, které by měly být vždy k dispozici

add_base(parser)

Parametry

parser

add_func_args

Převod podpisu funkce na parametry argparse

Pomocí poznámek typu pythonu se dozvíte, jak se vytvářejí parametry argparse.

add_func_args(parser, impl)

Parametry

parser
impl

add_funcs

Přidání funkcí ve vrstvě implementace

add_funcs(inst, subparser)

Parametry

inst
subparser

add_nested

Recurse prostřednictvím objektů v dané instanci třídy jako podpříkazy argparse

add_nested(main_parser, parent_parser, inst, api_types, level=0)

Parametry

main_parser
parent_parser
inst
api_types
level
výchozí hodnota: 0

arg_bool

Ověřte, že zadaný argument je pravdivý nebo nepravdivý.

arg_bool(arg)

Parametry

arg

arg_dir

Ověřte, že zadaným argumentem je adresář.

arg_dir(arg)

Parametry

arg

arg_file

Ověřte, že zadaným argumentem je soubor.

arg_file(arg)

Parametry

arg

build_arg_parser

Vytvoření argparse nejvyšší úrovně

build_arg_parser(inst, api_types, version)

Parametry

inst
api_types
version

call_func

Získání argumentů pro zadanou funkci a jejich volání

call_func(func, args)

Parametry

func
args

execute_api

Zveřejnění rozhraní API prostřednictvím jednoduchého rozhraní příkazového řádku

execute_api(api, api_types, version)

Parametry

api
api_types
version

get_arg_names

Získání názvů argumentů funkce

get_arg_names(func)

Parametry

func

get_help_text

získání textu nápovědy na základě řetězců pydoc

get_help_text(impl)

Parametry

impl

print_help

najít odpovídající pomoc od dílčích oddělení

print_help(parser, args)

Parametry

parser
args

set_logging

Nastavení podrobností protokolu

set_logging(api, verbose)

Parametry

api
verbose