cli Módulo

Construtor de CLI simples sobre uma API definida

Classes

AsDict

Uma ação argparse baseada no par chave/valor

Funções

add_base

adicionar argumentos básicos que devem estar sempre disponíveis

add_base(parser)

Parâmetros

parser

add_func_args

Converter uma assinatura de função em parâmetros argparse

Isto utiliza anotações de tipo python para informar como os parâmetros argparse são criados.

add_func_args(parser, impl)

Parâmetros

parser
impl

add_funcs

Adicionar funções na camada de implementação

add_funcs(inst, subparser)

Parâmetros

inst
subparser

add_nested

Voltar a ocorrer através de objetos numa determinada instância de classe como subcomandos argparse

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

Parâmetros

main_parser
parent_parser
inst
api_types
level
valor predefinido: 0

arg_bool

Verifique se o argumento especificado é verdadeiro ou falso

arg_bool(arg)

Parâmetros

arg

arg_dir

Verifique se o argumento especificado é um diretório

arg_dir(arg)

Parâmetros

arg

arg_file

Verifique se o argumento especificado é um ficheiro

arg_file(arg)

Parâmetros

arg

build_arg_parser

Criação de argparse de nível superior

build_arg_parser(inst, api_types, version)

Parâmetros

inst
api_types
version

call_func

Obter os argumentos para a função especificada e chamá-la

call_func(func, args)

Parâmetros

func
args

execute_api

Expor uma API através de uma CLI leve

execute_api(api, api_types, version)

Parâmetros

api
api_types
version

get_arg_names

Obter nomes de argumentos de função

get_arg_names(func)

Parâmetros

func

get_help_text

obter o texto de ajuda com base em cadeias de pydoc

get_help_text(impl)

Parâmetros

impl

print_help

encontrar a ajuda adequada dos subparsers

print_help(parser, args)

Parâmetros

parser
args

set_logging

Definir verbosidade do registo

set_logging(api, verbose)

Parâmetros

api
verbose