cli Modulo

Generatore di interfaccia della riga di comando semplice sopra un'API definita

Classi

AsDict

Azione chiave/valore basata su argparse

Funzioni

add_base

aggiungere argomenti di base che devono essere sempre disponibili

add_base(parser)

Parametri

parser

add_func_args

Convertire una firma di funzione in parametri argparse

In questo modo vengono usate annotazioni di tipo Python per informare come vengono create le params argparse.

add_func_args(parser, impl)

Parametri

parser
impl

add_funcs

Aggiungere funzioni al livello di implementazione

add_funcs(inst, subparser)

Parametri

inst
subparser

add_nested

Recurse tramite oggetti in un'istanza di classe specificata come sottocomandi argparse

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

Parametri

main_parser
parent_parser
inst
api_types
level
valore predefinito: 0

arg_bool

Verificare che l'argomento specificato sia true o false

arg_bool(arg)

Parametri

arg

arg_dir

Verificare che l'argomento specificato sia una directory

arg_dir(arg)

Parametri

arg

arg_file

Verificare che l'argomento specificato sia un file

arg_file(arg)

Parametri

arg

build_arg_parser

Creazione di argparse di primo livello

build_arg_parser(inst, api_types, version)

Parametri

inst
api_types
version

call_func

Ottenere gli argomenti per la funzione specificata e chiamarla

call_func(func, args)

Parametri

func
args

execute_api

Esporre un'API tramite un'interfaccia della riga di comando di peso leggero

execute_api(api, api_types, version)

Parametri

api
api_types
version

get_arg_names

Ottenere i nomi degli argomenti della funzione

get_arg_names(func)

Parametri

func

get_help_text

ottenere il testo della Guida in base alle stringhe pydoc

get_help_text(impl)

Parametri

impl

print_help

trovare la guida appropriata dai sottoparer

print_help(parser, args)

Parametri

parser
args

set_logging

Impostare la verbosità del log

set_logging(api, verbose)

Parametri

api
verbose