cli Módulo

Generador de la CLI simple sobre una API definida

Clases

AsDict

Una acción argparse basada en pares clave-valor

Funciones

add_base

agregar argumentos básicos que siempre deben estar disponibles

add_base(parser)

Parámetros

parser

add_func_args

Convertir una firma de función en parámetros argparse

Esto usa anotaciones de tipo de Python para informar de cómo se crean los parámetros argparse.

add_func_args(parser, impl)

Parámetros

parser
impl

add_funcs

Adición de funciones en la capa de implementación

add_funcs(inst, subparser)

Parámetros

inst
subparser

add_nested

Recursión mediante objetos de una instancia de clase determinada 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 predeterminado: 0

arg_bool

Compruebe que el argumento especificado sea true o false.

arg_bool(arg)

Parámetros

arg

arg_dir

Comprobar que el argumento especificado es un directorio

arg_dir(arg)

Parámetros

arg

arg_file

Comprobar que el argumento especificado es un archivo

arg_file(arg)

Parámetros

arg

build_arg_parser

Creación de argparse de nivel superior

build_arg_parser(inst, api_types, version)

Parámetros

inst
api_types
version

call_func

Obtiene los argumentos de la función especificada y llámalo.

call_func(func, args)

Parámetros

func
args

execute_api

Exposición de una API a través de una CLI ligera

execute_api(api, api_types, version)

Parámetros

api
api_types
version

get_arg_names

Obtención de nombres de argumento de función

get_arg_names(func)

Parámetros

func

get_help_text

obtener el texto de ayuda basado en cadenas pydoc

get_help_text(impl)

Parámetros

impl

print_help

buscar la ayuda adecuada de los subparsers

print_help(parser, args)

Parámetros

parser
args

set_logging

Establecimiento del nivel de detalle del registro

set_logging(api, verbose)

Parámetros

api
verbose