cli Modul

Einfacher CLI-Generator auf der Grundlage einer definierten API

Klassen

AsDict

Eine auf Schlüssel-Wert-Paaren basierende Argparseaktion

Functions

add_base

Hinzufügen grundlegender Argumente, die immer verfügbar sein sollten

add_base(parser)

Parameter

parser

add_func_args

Konvertieren einer Funktionssignatur in Argparseparameter

Dabei werden Python-Typanmerkungen verwendet, um zu informieren, wie die Argparseparameter erstellt werden.

add_func_args(parser, impl)

Parameter

parser
impl

add_funcs

Hinzufügen von Funktionen auf der Implementierungsebene

add_funcs(inst, subparser)

Parameter

inst
subparser

add_nested

Wiederholen von Objekten in einer bestimmten Klasseninstanz als argparse-Unterbefehle

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

Parameter

main_parser
parent_parser
inst
api_types
level
Standardwert: 0

arg_bool

Vergewissern Sie sich, dass das angegebene Argument entweder "true" oder "false" ist.

arg_bool(arg)

Parameter

arg

arg_dir

Überprüfen, ob das angegebene Argument ein Verzeichnis ist

arg_dir(arg)

Parameter

arg

arg_file

Überprüfen, ob das angegebene Argument eine Datei ist

arg_file(arg)

Parameter

arg

build_arg_parser

Argparseerstellung auf oberster Ebene

build_arg_parser(inst, api_types, version)

Parameter

inst
api_types
version

call_func

Rufen Sie die Argumente für die angegebene Funktion ab, und rufen Sie sie auf.

call_func(func, args)

Parameter

func
args

execute_api

Verfügbarmachen einer API über eine einfache CLI

execute_api(api, api_types, version)

Parameter

api
api_types
version

get_arg_names

Abrufen von Funktionsargumentnamen

get_arg_names(func)

Parameter

func

get_help_text

Abrufen des Hilfetexts basierend auf pydoc-Zeichenfolgen

get_help_text(impl)

Parameter

impl

print_help

finden Sie die geeignete Hilfe von Unterverzeichnissen.

print_help(parser, args)

Parameter

parser
args

set_logging

Festlegen der Ausführlichkeit von Protokollen

set_logging(api, verbose)

Parameter

api
verbose