cli Module

Eenvoudige CLI-opbouwfunctie bovenop een gedefinieerde API

Klassen

AsDict

Een op sleutel/waarde-paar gebaseerde argparse-actie

Functies

add_base

basisargumenten toevoegen die altijd beschikbaar moeten zijn

add_base(parser)

Parameters

parser

add_func_args

Een functiehandtekening converteren naar argparse-parameters

Dit maakt gebruik van python-typeaantekeningen om aan te geven hoe de argparse-params worden gemaakt.

add_func_args(parser, impl)

Parameters

parser
impl

add_funcs

Functies toevoegen aan de implementatielaag

add_funcs(inst, subparser)

Parameters

inst
subparser

add_nested

Recurse door objecten in een bepaald klasse-exemplaar als argparse-subopdrachten

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

Parameters

main_parser
parent_parser
inst
api_types
level
standaardwaarde: 0

arg_bool

Controleer of het opgegeven argument waar of onwaar is

arg_bool(arg)

Parameters

arg

arg_dir

Controleer of het opgegeven argument een map is

arg_dir(arg)

Parameters

arg

arg_file

Controleer of het opgegeven argument een bestand is

arg_file(arg)

Parameters

arg

build_arg_parser

Het maken van argparse op het hoogste niveau

build_arg_parser(inst, api_types, version)

Parameters

inst
api_types
version

call_func

Haal de argumenten voor de opgegeven functie op en roep deze aan

call_func(func, args)

Parameters

func
args

execute_api

Een API beschikbaar maken via een lichtgewicht CLI

execute_api(api, api_types, version)

Parameters

api
api_types
version

get_arg_names

Namen van functieargumenten ophalen

get_arg_names(func)

Parameters

func

get_help_text

Help-tekst ophalen op basis van pydoc-tekenreeksen

get_help_text(impl)

Parameters

impl

print_help

de juiste hulp van subparsers zoeken

print_help(parser, args)

Parameters

parser
args

set_logging

Uitgebreidheid van logboeken instellen

set_logging(api, verbose)

Parameters

api
verbose