cli Module
Générateur CLI simple sur une API définie
Classes
| AsDict |
Action argparse basée sur une paire clé/valeur |
Fonctions
add_base
ajouter des arguments de base qui doivent toujours être disponibles
add_base(parser)
Paramètres
- parser
add_func_args
Convertir une signature de fonction en paramètres argparse
Cela utilise des annotations de type Python pour informer la façon dont les paramètres argparse sont créés.
add_func_args(parser, impl)
Paramètres
- parser
- impl
add_funcs
Ajouter des fonctions au niveau de la couche d’implémentation
add_funcs(inst, subparser)
Paramètres
- inst
- subparser
add_nested
Récursez les objets d’une instance de classe donnée en tant que sous-commandes argparse
add_nested(main_parser, parent_parser, inst, api_types, level=0)
Paramètres
- main_parser
- parent_parser
- inst
- api_types
- level
arg_bool
Vérifier que l’argument spécifié est true ou false
arg_bool(arg)
Paramètres
- arg
arg_dir
Vérifier que l’argument spécifié est un répertoire
arg_dir(arg)
Paramètres
- arg
arg_file
Vérifier que l’argument spécifié est un fichier
arg_file(arg)
Paramètres
- arg
build_arg_parser
Création d’argparse de niveau supérieur
build_arg_parser(inst, api_types, version)
Paramètres
- inst
- api_types
- version
call_func
Obtenir les arguments de la fonction spécifiée et l’appeler
call_func(func, args)
Paramètres
- func
- args
execute_api
Exposer une API via une interface CLI légère
execute_api(api, api_types, version)
Paramètres
- api
- api_types
- version
get_arg_names
Obtenir des noms d’arguments de fonction
get_arg_names(func)
Paramètres
- func
get_help_text
obtenir le texte d’aide basé sur des chaînes pydoc
get_help_text(impl)
Paramètres
- impl
print_help
trouver l’aide appropriée auprès des sous-analyseurs
print_help(parser, args)
Paramètres
- parser
- args
set_logging
Définir le détail du journal
set_logging(api, verbose)
Paramètres
- api
- verbose