clize
stable
About Clize
Why Clize was made
Alternatives to Clize
An illustrated history
Frequently asked questions
Getting started
Basics tutorial
Dispatching to multiple functions
Function compositing
Guides
Extending the parser
Upgrading from older releases
Interoperability with arbitrary callables
Reference
User reference
Customizing the help using the docstring
API Reference
Project documentation
Release notes
Contributing
clize
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
U
|
V
A
add_docstring() (clize.help.HelpForAutodetectedDocstring method)
(clize.help.HelpForClizeDocstring method)
(clize.help.HelpForSphinxDocstring method)
add_from_parameter_sources() (clize.help.HelpForAutodetectedDocstring method)
add_from_parameters() (clize.help.HelpForAutodetectedDocstring method)
add_helpstream() (clize.help.HelpForAutodetectedDocstring method)
after (clize.help.HelpForParameters attribute)
aliases (clize.parser.CliSignature attribute)
alternate (clize.parser.CliSignature attribute)
AlternateCommandParameter (class in clize.parser)
AppendArguments (class in clize.parser)
apply_generic_flags() (clize.parser.Parameter method)
args (clize.parser.CliBoundArguments attribute)
argument_decorator() (in module clize.parameters)
B
blank_from_signature() (clize.help.HelpForParameters class method)
built-in function
clize.Parameter.cli_default()
C
CLI default value
cli() (clize.help.HelpCli method)
CliBoundArguments (class in clize.parser)
CliSignature (class in clize.parser)
Clize (class in clize)
clize() (in module clize)
clize.ArgumentError (built-in class)
clize.errors
module
clize.errors.ArgumentError (built-in class)
clize.errors.UserError (built-in class)
clize.help
module
clize.legacy
module
clize.Parameter.cli_default()
built-in function
clize.parser
module
,
[1]
clize.runner
module
clize.UserError (built-in class)
ClizeHelp (in module clize.help)
code examples
converted default value
converter (clize.parser.CliSignature attribute)
D
datetime() (in module clize.converters)
default value
default_converter() (in module clize.parser)
description (clize.help.HelpCli property)
DRY
E
EL_AFTER (in module clize.help)
EL_FREE_TEXT (in module clize.help)
EL_LABEL (in module clize.help)
EL_PARAM_DESC (in module clize.help)
elements_from_clize_docstring() (in module clize.help)
ExtraPosArgsParameter (class in clize.parser)
F
FallbackCommandParameter (class in clize.parser)
file() (in module clize.converters)
FlagParameter (class in clize.parser)
footer (clize.help.HelpForParameters attribute)
(clize.help.HelpForSubcommands attribute)
from_subject() (clize.help.HelpForAutodetectedDocstring class method)
(clize.help.HelpForSubcommands class method)
func (clize.parser.CliBoundArguments attribute)
G
get_help() (clize.help.HelpCli method)
H
header (clize.help.HelpForParameters attribute)
(clize.help.HelpForSubcommands attribute)
HELP_FOOTER (in module clize.help)
HELP_HEADER (in module clize.help)
HELP_PARAM_AFTER (in module clize.help)
HELP_PARAM_DESC (in module clize.help)
HelpCli (class in clize.help)
HelperParameter (class in clize.parser)
HelpForAutodetectedDocstring (class in clize.help)
HelpForClizeDocstring (class in clize.help)
HelpForParameters (class in clize.help)
HelpForSphinxDocstring (class in clize.help)
HelpForSubcommands (class in clize.help)
helpstream_from_elements() (in module clize.help)
I
IGNORE (clize.Parameter attribute)
IgnoreAllArguments (class in clize.parser)
in_args (clize.parser.CliBoundArguments attribute)
IntOptionParameter (class in clize.parser)
K
kwargs (clize.parser.CliBoundArguments attribute)
L
LABEL_ALT (in module clize.help)
LABEL_OPT (in module clize.help)
LABEL_POS (in module clize.help)
LAST_OPTION (clize.Parameter attribute)
M
make_flag() (in module clize)
mapped() (in module clize.parameters)
meta (clize.parser.CliBoundArguments attribute)
module
clize.errors
clize.help
clize.legacy
clize.parser
,
[1]
clize.runner
multi() (in module clize.parameters)
MultiParameter (class in clize.parser)
N
name (clize.parser.CliBoundArguments attribute)
named (clize.parser.CliSignature attribute)
namedparam (clize.parser.CliBoundArguments attribute)
NamedParameter (class in clize.parser)
not_provided (clize.parser.CliBoundArguments attribute)
O
one_of() (in module clize.parameters)
OptionParameter (class in clize.parser)
P
Parameter (class in clize)
parameter converter
parameter_converter() (in module clize.parser)
parameters (clize.parser.CliSignature attribute)
ParameterWithSourceEquivalent (class in clize.parser)
ParameterWithValue (class in clize.parser)
parse_docstring() (clize.help.HelpForAutodetectedDocstring method)
pass_name() (in module clize.parameters)
posarg_only (clize.parser.CliBoundArguments attribute)
positional (clize.parser.CliSignature attribute)
PositionalParameter (class in clize.parser)
posparam (clize.parser.CliBoundArguments attribute)
post_name (clize.parser.CliBoundArguments attribute)
Python Enhancement Proposals
PEP 3102
PEP 3107
,
[1]
PEP 563
PEP 8
R
read_argument() (clize.parser.Parameter method)
REQUIRED (clize.Parameter attribute)
,
[1]
required (clize.parser.CliSignature attribute)
run() (in module clize)
S
sections (clize.help.HelpForParameters attribute)
show() (clize.help.HelpCli method)
show_full_usage() (clize.help.HelpCli method)
(clize.help.HelpForParameters method)
(clize.help.HelpForSubcommands method)
show_help() (clize.help.HelpForParameters method)
(clize.help.HelpForSubcommands method)
show_usage() (clize.help.HelpCli method)
(clize.help.HelpForParameters method)
(clize.help.HelpForSubcommands method)
sig (clize.parser.CliBoundArguments attribute)
skip (clize.parser.CliBoundArguments attribute)
sticky (clize.parser.CliBoundArguments attribute)
SubcommandDispatcher (class in clize)
subcommands (clize.help.HelpForSubcommands attribute)
U
UNDOCUMENTED (clize.Parameter attribute)
unsatisfied (clize.parser.CliBoundArguments attribute)
usages() (clize.help.HelpCli method)
(clize.help.HelpForParameters method)
(clize.help.HelpForSubcommands method)
use_class() (in module clize.parser)
use_mixin() (in module clize.parser)
V
value conversion
value converter
value_converter() (in module clize.parser)
value_inserter() (in module clize.parameters)
Read the Docs
v: stable
Versions
latest
stable
4.2
4.1
4.0
3.1
3.0
Downloads
On Read the Docs
Project Home
Builds