Add subcommand to this config
Add subcommand to this config
In the verify stage, checks that either all or none of the provided options have values defined (either supplied in arguments or got from defaults).
In the verify stage, checks that either all or none of the provided options have values defined (either supplied in arguments or got from defaults).
If set to true, scallop would append auto-generated text about default option value to option descriptions.
If set to true, scallop would append auto-generated text about default option value to option descriptions.
Checks that this Conf object is verified.
Checks that this Conf object is verified. If it is not, throws an exception.
Add a banner string to option builder.
In the verify stage, checks that either all or none of the provided options have values supplied in arguments.
In the verify stage, checks that either all or none of the provided options have values supplied in arguments.
list of codependent options
In the verify stage, if opt was supplied, checks that all of the options in list are not supplied.
In the verify stage, if opt was supplied, checks that all of the options in list are not supplied.
option, that conflicts with all of options in list
list of dependencies (all will need to be absent)
In the verify stage, if opt was supplied, checks that all of the options in list are also supplied.
In the verify stage, if opt was supplied, checks that all of the options in list are also supplied.
option, that depends on all of options in list
list of dependencies (all will need to be present)
In the verify stage, if opt was supplied, checks that at least one of the options in list are also supplied.
In the verify stage, if opt was supplied, checks that at least one of the options in list are also supplied.
option, that depends on any of options in list
list of dependencies (at least one will need to be present)
Short description for this subcommand.
Short description for this subcommand. Used if parent command has shortSubcommandsHelp enabled.
This function is called with the error message when ScallopException occurs.
This function is called with the error message when ScallopException
occurs. By default, this function prints message (prefixed by *printedName*) to stdout,
coloring the output if possible, then calls sys.exit(1)
.
Update this variable with another function if you need to change that behavior.
Add a footer string to this builder.
If true, scallop would try to guess missing option names from the names of their fields.
If true, scallop would try to guess missing option names from the names of their fields.
If set to true, scallop would try to guess missing option names from the names of their fields.
If set to true, scallop would try to guess missing option names from the names of their fields.
Explicitly set width of help printout.
Explicitly set width of help printout. By default, Scallop tries to determine it from terminal width or defaults to 80 characters.
true if this config does not represent a subcommand
true if this config does not represent a subcommand
Options, that are to be printed first in the help printout
Options, that are to be printed first in the help printout
Set options, that are to be printed first in the help printout
Set options, that are to be printed first in the help printout
In the verify stage, checks that only one or zero of the provided options have values supplied in arguments.
In the verify stage, checks that only one or zero of the provided options have values supplied in arguments.
list of mutually exclusive options
Add new number argument definition to this config and get a holder for it's value.
Add new number argument definition to this config and get a holder for it's value.
Name for new definition, used for identification.
Description for this option, for help text.
The function that validates the parsed value.
Is this trailing argument required? Defaults to true.
If this argument is not required and not found in the argument list, use this value.
If set to true then this option will not be present in auto-generated help.
This function is called in event of any exception in arguments parsing.
This function is called in event of any exception in arguments parsing. By default, it catches only standard Scallop errors, letting all other pass through.
Add a new option definition to this config and get a holder for the value.
Add a new option definition to this config and get a holder for the value.
Name for new option, used as long option name in parsing, and for option identification.
Overload the char that will be used as short option name. Defaults to first character of the name.
Description for this option, for help description.
Default value to use if option is not found in input arguments (if you provide this, you can omit the type on method).
Is this option required? Defaults to false.
The name for this option argument, as it will appear in help. Defaults to "arg".
If set to true, then this option does not have any short name.
The converter for this option. Usually found implicitly.
A holder for parsed value
Pointer to parent ScallopConf
Pointer to parent ScallopConf
Prints help message (with version, banner, option usage and footer) to stdout.
Prints help message (with version, banner, option usage and footer) to stdout.
This name would be included in output when reporting errors.
This name would be included in output when reporting errors.
Add new property option definition to this config object, and get a handle for option retreiving.
Add new property option definition to this config object, and get a handle for option retreiving.
Char, that will be used as prefix for property arguments.
Description for this property option, for help description.
Name for 'key' part of this option arg name, as it will appear in help option definition. Defaults to "key".
Name for 'value' part of this option arg name, as it will appear in help option definition. Defaults to "value".
A holder for retreival of the values.
In the verify stage, checks that one, and only one, option in the list is supplied.
In the verify stage, checks that one, and only one, option in the list is supplied.
list of conflicting options (exactly one must be present)
Retrieves the choosen subcommand.
Retrieves the choosen subcommand.
Retrieves the list of the chosen nested subcommands.
Retrieves the list of the chosen nested subcommands.
List of sub-configs of this config.
List of sub-configs of this config.
Get summary of current parser state.
Get summary of current parser state.
a list of all options in the builder, and corresponding values for them.
Add new toggle option definition to this config, and get a holder for it's value.
Add new toggle option definition to this config, and get a holder for it's value.
Toggle options are just glorified flag options. For example, if you will ask for a toggle option with name "verbose", it will be invocable in three ways - "--verbose", "--noverbose", "-v".
Name of this option
default value for this option
Overload the char that will be used as short option name. Defaults to first character of the name.
If set to true, then this option will not have any short name.
Prefix to name of the option, that will be used for "negative" version of the option.
Description for positive variant of this option.
Description for negative variant of this option.
If set to true, then this option will not be present in auto-generated help.
Add new trailing argument definition to this config, and get a holder for it's value.
Add new trailing argument definition to this config, and get a holder for it's value.
Name for new definition, used for identification.
Description for this option, for help text.
The function that validates the parsed value.
Is this trailing argument required? Defaults to true.
If this argument is not required and not found in the argument list, use this value.
If set to true then this option will not be present in auto-generated help.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.
Validation function. In case of error, it should return Left with the error message.
In the verify stage, check that file with supplied name exists.
In the verify stage, check that file with supplied name exists.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
In the verify stage, check that file with the supplied path exists.
In the verify stage, check that file with the supplied path exists.
Add a version string to option builder.