Toggle navigation sidebar
configpile
General information
Home page
Tutorial
Index
Step 1: Simple calculator
Step 2: Reuse defaults, short flags
Step 3: Two positional arguments
Step 4: Many positional arguments
Step 5: Additional features
Step 6: Final calculator script
Concepts
Overview of the process
Error handling in
configpile
Parsers
Params (parameters)
Parameter and configuration validation
Configurations
API
API
arg
Arg
Expander
Param
collector
Collector
config
Config
IniSection
enums
Derived
ForceCase
Positional
SpecialAction
handlers
CLConfigParam
CLHandler
CLInserter
CLParam
CLPos
CLRootParam
CLSpecialAction
CLStdHandler
KVConfigParam
KVHandler
KVParam
KVRootParam
parsers
path_parser
int_parser
str_parser
stripped_str_parser
float_parser
ErrorMessageProvider
Parser
Predicate
processor
IniProcessor
Processor
ProcessorFactory
State
userr
collect
collect_seq
flat_map
in_context
map
wrap
Err
Err1
ManyErr
util
assert_never
dict_from_multiple_keys
filter_ordered_dict
filter_ordered_dict_by_value_type
filter_sequence_by_value_type
filter_types
filter_types_single
ClassDoc
Toggle navigation
Index
_
|
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
U
|
V
|
W
|
Z
_
__call__() (ErrorMessageProvider method)
(Predicate method)
__init__() (Arg method)
(ClassDoc method)
(CLConfigParam method)
(CLInserter method)
(CLParam method)
(CLPos method)
(CLRootParam method)
(CLSpecialAction method)
(CLStdHandler method)
(Config method)
(Err1 method)
(ErrorMessageProvider method)
(Expander method)
(IniProcessor method)
(IniSection method)
(KVConfigParam method)
(KVParam method)
(KVRootParam method)
(ManyErr method)
(Param method)
(Predicate method)
(Processor method)
(ProcessorFactory method)
(State method)
__new__() (ClassDoc static method)
(CLConfigParam static method)
(CLParam static method)
(CLRootParam static method)
(Collector static method)
(ErrorMessageProvider static method)
(KVConfigParam static method)
(KVParam static method)
(KVRootParam static method)
(Param static method)
(Parser static method)
(Predicate static method)
(Processor static method)
(ProcessorFactory static method)
_Arg (in module configpile.arg)
_Class (in module configpile.util)
_Config (in module configpile.arg)
(in module configpile.config)
(in module configpile.processor)
_Item (in module configpile.collector)
(in module configpile.parsers)
_Item_co (in module configpile.arg)
_Key (in module configpile.util)
_Parameter (in module configpile.parsers)
_Parameters (in module configpile.userr)
_ReturnType (in module configpile.parsers)
(in module configpile.userr)
_Type (in module configpile.util)
_U (in module configpile.userr)
_V (in module configpile.userr)
_Value (in module configpile.collector)
(in module configpile.handlers)
(in module configpile.parsers)
(in module configpile.util)
_Value_co (in module configpile.arg)
(in module configpile.userr)
_W (in module configpile.userr)
A
action() (CLConfigParam method)
(CLParam method)
(CLRootParam method)
(KVConfigParam method)
(KVParam method)
(KVRootParam method)
all_config_key_names() (Param method)
all_env_var_names() (Param method)
all_flags() (Arg method)
(Expander method)
(Param method)
ap_commands (ProcessorFactory attribute)
ap_optional (ProcessorFactory attribute)
ap_required (ProcessorFactory attribute)
append() (Collector static method)
(Param static method)
(State method)
append1() (Param static method)
Arg (class in configpile.arg)
arg_required() (Collector method)
argparse_argument_kwargs() (Arg method)
(Collector method)
(Expander method)
(Param method)
argument_parser (Processor attribute)
(ProcessorFactory attribute)
as_sequence_of_one() (Parser method)
assert_never() (in module configpile.util)
C
check() (Err static method)
(Err1 static method)
(ManyErr static method)
choices() (Parser method)
cl_flag_handlers (ProcessorFactory attribute)
cl_handler (Processor attribute)
cl_positionals (ProcessorFactory attribute)
ClassDoc (class in configpile.util)
CLConfigParam (class in configpile.handlers)
CLHandler (class in configpile.handlers)
CLInserter (class in configpile.handlers)
CLParam (class in configpile.handlers)
CLPos (class in configpile.handlers)
CLRootParam (class in configpile.handlers)
CLSpecialAction (class in configpile.handlers)
CLStdHandler (class in configpile.handlers)
collect() (Collector method)
(Err static method)
(Err1 static method)
(in module configpile.userr)
(ManyErr static method)
collect1() (Err static method)
(Err1 static method)
(ManyErr static method)
collect_seq() (in module configpile.userr)
Collector (class in configpile.collector)
collector (Param attribute)
Config (class in configpile.config)
config() (Param static method)
config_files_to_process (State attribute)
config_key_name (Param attribute)
config_type (Processor attribute)
configpile.arg
module
configpile.collector
module
configpile.config
module
configpile.enums
module
configpile.handlers
module
configpile.parsers
module
configpile.processor
module
configpile.userr
module
configpile.util
module
contexts (Err1 attribute)
D
default_value (Param attribute)
derive() (Derived method)
Derived (class in configpile.enums)
description_ (Config attribute)
dict_from_multiple_keys() (in module configpile.util)
docs (ClassDoc attribute)
E
empty_means_none() (Parser method)
env_handlers (Processor attribute)
(ProcessorFactory attribute)
env_prefix_ (Config attribute)
env_var_name (Param attribute)
Err (class in configpile.userr)
Err1 (class in configpile.userr)
ErrorMessageProvider (class in configpile.parsers)
errors() (Err method)
(Err1 method)
(ManyErr method)
errs (ManyErr attribute)
Expander (class in configpile.arg)
F
fallback (CLStdHandler attribute)
filter_ordered_dict() (in module configpile.util)
filter_ordered_dict_by_value_type() (in module configpile.util)
filter_sequence_by_value_type() (in module configpile.util)
filter_types() (in module configpile.util)
filter_types_single() (in module configpile.util)
flags (CLStdHandler attribute)
flat_map() (in module configpile.userr)
(Parser method)
float_parser (in module configpile.parsers)
ForceCase (class in configpile.enums)
from_choices() (Parser static method)
from_command_line_() (Config class method)
from_function() (Parser static method)
from_function_that_raises() (Parser static method)
from_mapping() (Parser static method)
from_parsy_parser() (Parser static method)
G
get_argument_parser_() (Config class method)
H
handle() (CLConfigParam method)
(CLHandler method)
(CLInserter method)
(CLParam method)
(CLPos method)
(CLRootParam method)
(CLSpecialAction method)
(CLStdHandler method)
(KVConfigParam method)
(KVHandler method)
(KVParam method)
(KVRootParam method)
help (Arg attribute)
(Expander attribute)
(Param attribute)
HELP (SpecialAction attribute)
I
in_context() (Err method)
(Err1 method)
(in module configpile.userr)
(ManyErr method)
ini_handlers (ProcessorFactory attribute)
ini_processor (Processor attribute)
ini_relaxed_sections_ (Config attribute)
ini_section_strict (ProcessorFactory attribute)
ini_sections_() (Config class method)
ini_strict_sections_ (Config attribute)
IniProcessor (class in configpile.processor)
IniSection (class in configpile.config)
inserted_args (CLInserter attribute)
inserts() (Expander method)
instances (State attribute)
int_parser (in module configpile.parsers)
is_config (Param attribute)
is_required() (Param method)
is_root_path (Param attribute)
K
KEBAB_CASE (Derived attribute)
keep_last() (Collector static method)
kv_handlers (IniProcessor attribute)
KVConfigParam (class in configpile.handlers)
KVHandler (class in configpile.handlers)
KVParam (class in configpile.handlers)
KVRootParam (class in configpile.handlers)
L
long_flag_name (Arg attribute)
(Expander attribute)
(Param attribute)
LOWER (ForceCase attribute)
M
make() (ClassDoc static method)
(CLPos static method)
(Err static method)
(Err1 static method)
(Expander static method)
(ManyErr static method)
(Processor static method)
(ProcessorFactory static method)
(State static method)
ManyErr (class in configpile.userr)
map() (in module configpile.userr)
(Parser method)
markdown() (Err method)
(Err1 method)
(ManyErr method)
module
configpile.arg
configpile.collector
configpile.config
configpile.enums
configpile.handlers
configpile.parsers
configpile.processor
configpile.userr
configpile.util
msg (Err1 attribute)
N
name (IniSection attribute)
(Param attribute)
new_flag (Expander attribute)
new_value (Expander attribute)
NO_CHANGE (ForceCase attribute)
O
ONCE (Positional attribute)
ONE_OR_MORE (Positional attribute)
P
Param (class in configpile.arg)
param (CLConfigParam attribute)
(CLParam attribute)
(CLRootParam attribute)
(KVConfigParam attribute)
(KVParam attribute)
(KVRootParam attribute)
params_by_name (Processor attribute)
(ProcessorFactory attribute)
parse() (Parser method)
parse_command_line_() (Config class method)
parse_ini_contents_() (Config class method)
parse_ini_file_() (Config class method)
Parser (class in configpile.parsers)
parser (Param attribute)
path_parser (in module configpile.parsers)
pos (CLPos attribute)
Positional (class in configpile.enums)
positional (Param attribute)
Predicate (class in configpile.parsers)
pretty_print() (Err method)
(Err1 method)
(ManyErr method)
process() (IniProcessor method)
(Processor method)
process_command_line() (Processor method)
process_fields() (Processor static method)
process_ini_contents() (Processor method)
process_ini_file() (Processor method)
process_string() (IniProcessor method)
Processor (class in configpile.processor)
processor_() (Config class method)
ProcessorFactory (class in configpile.processor)
prog_ (Config attribute)
R
raw() (ClassDoc method)
Res (in module configpile.userr)
root_path (State attribute)
root_path() (Param static method)
S
section_strict (IniProcessor attribute)
separated_by() (Parser method)
short_flag_name (Arg attribute)
(Expander attribute)
(Param attribute)
should_be_last() (Positional method)
SNAKE_CASE (Derived attribute)
SNAKE_CASE_UPPER_CASE (Derived attribute)
special_action (CLSpecialAction attribute)
(State attribute)
SpecialAction (class in configpile.enums)
State (class in configpile.processor)
store() (Param static method)
str_parser (in module configpile.parsers)
strict (IniSection attribute)
stripped_str_parser (in module configpile.parsers)
U
update_dict_() (Arg method)
(Expander method)
(Param method)
update_processor() (Arg method)
(Expander method)
(Param method)
updated() (Arg method)
(Expander method)
(Param method)
UPPER (ForceCase attribute)
V
validated() (Parser method)
validators (Processor attribute)
(ProcessorFactory attribute)
validators_() (Config class method)
VERSION (SpecialAction attribute)
version_() (Config class method)
W
wrap() (in module configpile.userr)
Z
ZERO_OR_MORE (Positional attribute)