cli Модуль
Простой построитель CLI поверх определенного API
Классы
| AsDict |
Действие argparse на основе пары "ключ-значение" |
Функции
add_base
Добавление основных аргументов, которые всегда должны быть доступны
add_base(parser)Параметры
- parser
add_func_args
Преобразование сигнатуры функции в параметры argparse
При этом используются заметки типа Python для информирования о создании параметров argparse.
add_func_args(parser, impl)Параметры
- parser
- impl
add_funcs
Добавление функций на уровне реализации
add_funcs(inst, subparser)Параметры
- inst
- subparser
add_nested
Рекурсивная обработка объектов в заданном экземпляре класса в качестве подкоманд argparse
add_nested(main_parser, parent_parser, inst, api_types, level=0)Параметры
- main_parser
- parent_parser
- inst
- api_types
- level
arg_bool
Убедитесь, что указанный аргумент имеет значение true или false.
arg_bool(arg)Параметры
- arg
arg_dir
Убедитесь, что указанный аргумент является каталогом
arg_dir(arg)Параметры
- arg
arg_file
Убедитесь, что указанный аргумент является файлом
arg_file(arg)Параметры
- arg
build_arg_parser
Создание argparse верхнего уровня
build_arg_parser(inst, api_types, version)Параметры
- inst
- api_types
- version
call_func
Получение аргументов для указанной функции и ее вызов
call_func(func, args)Параметры
- func
- args
execute_api
Предоставление API с помощью облегчаемого интерфейса командной строки
execute_api(api, api_types, version)Параметры
- api
- api_types
- version
get_arg_names
Получение имен аргументов функции
get_arg_names(func)Параметры
- func
get_help_text
получение текста справки на основе строк pydoc
get_help_text(impl)Параметры
- impl
print_help
найти соответствующую справку от вложенных разделов
print_help(parser, args)Параметры
- parser
- args
set_logging
Настройка детализации журнала
set_logging(api, verbose)Параметры
- api
- verbose