OctavoOpts
Value members
Inherited methods
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfBase
Add a check that either all or none of the provided options have values defined (either supplied in arguments or got from defaults).
Add a check that either all or none of the provided options have values defined (either supplied in arguments or got from defaults).
- Value parameters:
- list
list of options
- Inherited from:
- ScallopConfBase
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.
- Inherited from:
- ScallopConfBase
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.
- Inherited from:
- ScallopConfBase
Checks that this Conf object is verified. If it is not, throws an exception.
Checks that this Conf object is verified. If it is not, throws an exception.
- Inherited from:
- ScallopConfBase
Add a banner string to option builder.
Add a banner string to option builder.
- Value parameters:
- b
Banner string.
- Inherited from:
- ScallopConfBase
Add a new choice option definition to this config.
Add a new choice option definition to this config.
This option takes a single string argument and restricts values to a list of possible choices.
- Value parameters:
- argName
The name for this option argument, as it will appear in help. Defaults to "arg".
- choices
List of possible argument values.
- conv
The converter for this option. Usually found implicitly.
- default
Default value to use if option is not found in input arguments (if you provide this, you can omit the type on method).
- descr
Description for this option, for help description.
- group
Option group to add this option to.
- hidden
If set to true, then this option will be hidden from generated help output.
- name
Name for new option, used as long option name in parsing, and for option identification.
- noshort
If set to true, then this option does not have any short name.
- required
Is this option required? Defaults to false.
- short
Overload the char that will be used as short option name. Defaults to first character of the name.
- Returns:
ScallopOption, container for the parsed option value.
- Inherited from:
- ScallopConfBase
Add a check that either all or none of the provided options have values supplied in arguments.
Add a check that either all or none of the provided options have values supplied in arguments.
- Value parameters:
- list
list of codependent options
- Inherited from:
- ScallopConfBase
Add a check that none of the options in the list were supplied if opt was supplied.
Add a check that none of the options in the list were supplied if opt was supplied.
- Value parameters:
- list
list of dependencies (all will need to be absent)
- opt
option that conflicts with all of options in list
- Inherited from:
- ScallopConfBase
Add a check that all of the options in the list were also supplied if opt was supplied.
Add a check that all of the options in the list were also supplied if opt was supplied.
- Value parameters:
- list
list of dependencies (all will need to be present)
- opt
option that depends on all of options in list
- Inherited from:
- ScallopConfBase
Add a check that at least one of the options in the list was supplied if opt was supplied.
Add a check that at least one of the options in the list was supplied if opt was supplied.
- Value parameters:
- list
list of dependencies (at least one will need to be present)
- opt
option, that depends on any of options in list
- Inherited from:
- ScallopConfBase
Get summary of current parser state, hididng values for some of the options. Useful if you log the summary and want to avoid storing sensitive information in the logs (like passwords)
Get summary of current parser state, hididng values for some of the options. Useful if you log the summary and want to avoid storing sensitive information in the logs (like passwords)
- Value parameters:
- blurred
names of the options that should be hidden.
- Returns:
a list of all options in the builder
- Inherited from:
- ScallopConfBase
Get generated help contents as a string.
Get generated help contents as a string.
- Inherited from:
- ScallopConfBase
Create and return a new option group
Create and return a new option group
- Inherited from:
- ScallopConfBase
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.
- Inherited from:
- ScallopConf
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.
- Inherited from:
- ScallopConf
Get current custom help formatter.
Get current custom help formatter.
- Inherited from:
- ScallopConfBase
Explicitly set width of help printout. By default, Scallop tries to determine it from terminal width or defaults to 80 characters.
Explicitly set width of help printout. By default, Scallop tries to determine it from terminal width or defaults to 80 characters.
- Inherited from:
- ScallopConfBase
Options, that are to be printed first in the help printout
Options, that are to be printed first in the help printout
- Inherited from:
- ScallopConfBase
Add a check that only one or zero of the provided options have values supplied in arguments.
Add a check that only one or zero of the provided options have values supplied in arguments.
- Value parameters:
- list
list of mutually exclusive options
- Inherited from:
- ScallopConfBase
If set to true, then do not generate short names for subsequently defined options by default. Only applied if a subsequent option definition does not explicitly provide its noshort-parameter.
If set to true, then do not generate short names for subsequently defined options by default. Only applied if a subsequent option definition does not explicitly provide its noshort-parameter.
- Inherited from:
- ScallopConfBase
If set to true, then do not generate short names for subsequently defined options by default. Only applied if a subsequent option definition does not explicitly provide its noshort-parameter.
If set to true, then do not generate short names for subsequently defined options by default. Only applied if a subsequent option definition does not explicitly provide its noshort-parameter.
- Inherited from:
- ScallopConfBase
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.
Parses arguments like -1 or -3 (like GNU tail, for example).
- Value parameters:
- conv
The converter for this option. Usually found implicitly.
- default
If this argument is not required and not found in the argument list, use this value.
- descr
Description for this option, for help text.
- group
Option group to add this option to.
- hidden
If set to true then this option will not be present in auto-generated help.
- name
Name for new definition, used for identification.
- required
Is this trailing argument required? Defaults to true.
- validate
The function that validates the parsed value.
- Returns:
ScallopOption, container for the parsed option value.
- Inherited from:
- ScallopConfBase
Add a new simple option definition to this config.
Add a new simple option definition to this config.
- Value parameters:
- argName
The name for this option argument, as it will appear in help. Defaults to "arg".
- conv
The converter for this option. Usually found implicitly.
- default
Default value to use if option is not found in input arguments (if you provide this, you can omit the type on method).
- descr
Description for the option. Will be printed in help message, carefully formatted to the output width (80 characters by default).
- group
Option group to add this option to.
- hidden
Hides description of this option from help (this can be useful for debugging options).
- name
Name for new option, used as long option name in parsing, and for option identification.
- noshort
If set to true, then this option does not have any short name.
- required
Is this option required? Defaults to false.
- short
By default, the first character of option name is used for short option name. You can override it by specifying the required character (
short = 'c').- validate
The function that validates the parsed value.
- Returns:
ScallopOption, container for the parsed option value.
- Inherited from:
- ScallopConfBase
Prints help message (with version, banner, option usage and footer) to stdout.
Prints help message (with version, banner, option usage and footer) to stdout.
- Inherited from:
- ScallopConfBase
Add new property option definition to this config object.
Add new property option definition to this config object.
This option will parse arguments like -Dkey=value or -D key1=value1 key2=value2.
- Value parameters:
- conv
The converter for this option. Usually found implicitly.
- descr
Description for this property option, for help description.
- group
Option group to add this option to.
- hidden
If set to true, then this option will be hidden from generated help output.
- keyName
Name for 'key' part of this option arg name, as it will appear in help option definition. Defaults to "key".
- name
Character that will be used as prefix for property arguments.
- valueName
Name for 'value' part of this option arg name, as it will appear in help option definition. Defaults to "value".
- Returns:
ScallopOption, container for the parsed option value.
- Inherited from:
- ScallopConfBase
Add new property option definition to this config object.
Add new property option definition to this config object.
This option will parse arguments like --Props key1=value1 key2=value2.
- Value parameters:
- conv
The converter for this option. Usually found implicitly.
- descr
Description for this property option, for help description.
- group
Option group to add this option to.
- hidden
If set to true, then this option will be hidden from generated help output.
- keyName
Name for 'key' part of this option arg name, as it will appear in help option definition. Defaults to "key".
- name
Name for new option, used as long option name in parsing, and for option identification.
- valueName
Name for 'value' part of this option arg name, as it will appear in help option definition. Defaults to "value".
- Returns:
ScallopOption, container for the parsed option value.
- Inherited from:
- ScallopConfBase
Add a check that at least one of the options is supplied.
Add a check that at least one of the options is supplied.
- Value parameters:
- list
list of options (at least one must be present)
- Inherited from:
- ScallopConfBase
Add a check that at one and only one option in the list is supplied.
Add a check that at one and only one option in the list is supplied.
- Value parameters:
- list
list of conflicting options (exactly one must be present)
- Inherited from:
- ScallopConfBase
Require subcommand to be provided (validation will fail if no subcommand was provided on the command line).
Require subcommand to be provided (validation will fail if no subcommand was provided on the command line).
- Inherited from:
- ScallopConfBase
If set to true, do not output subcommand options in the help output for the main program
(only output short subcommand description in such cases).
Full help for subcommand options can still be accessed via program subcommand-name --help.
If set to true, do not output subcommand options in the help output for the main program
(only output short subcommand description in such cases).
Full help for subcommand options can still be accessed via program subcommand-name --help.
- Value parameters:
- enable
enable short format for subcommand help
- Inherited from:
- ScallopConfBase
Retrieves the list of the chosen nested subcommands.
Retrieves the list of the chosen nested subcommands.
- Inherited from:
- ScallopConfBase
Get summary of current parser state.
Get summary of current parser state.
- Returns:
a list of all options in the builder, and corresponding values for them.
- Inherited from:
- ScallopConfBase
Add a new tally option definition to this config.
Add a new tally option definition to this config.
Tally options count how many times the option was provided on the command line.
E.g., -vvv will be countet as 3.
- Value parameters:
- descr
Description for this option, for help description.
- group
Option group to add this option to.
- hidden
If set to true, then this option will be hidden from generated help output.
- name
Name for new option, used as long option name in parsing, and for option identification.
- noshort
If set to true, then this option does not have any short name.
- short
Overload the char that will be used as short option name. Defaults to first character of the name.
- Returns:
ScallopOption, container for the parsed option value.
- Inherited from:
- ScallopConfBase
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 create a toggle option with name "verbose", it will be invocable in three ways - "--verbose", "--noverbose", "-v".
- Value parameters:
- default
default value for this option
- descrNo
Description for negative variant of this option.
- descrYes
Description for positive variant of this option.
- group
Option group to add this option to.
- hidden
If set to true, then this option will not be present in auto-generated help.
- name
Name of this option
- noshort
If set to true, then this option will not have any short name.
- prefix
Prefix to name of the option, that will be used for "negative" version of the option.
- required
Is this option required? Defaults to false.
- short
Overload the char that will be used as short option name. Defaults to first character of the name.
- Returns:
ScallopOption, container for the parsed option value.
- Inherited from:
- ScallopConfBase
Add new trailing argument definition to this config.
Add new trailing argument definition to this config.
- Value parameters:
- conv
The converter for this option. Usually found implicitly.
- default
If this argument is not required and not found in the argument list, use this value.
- descr
Description for this option, for help text.
- group
Option group to add this option to.
- hidden
If set to true then this option will not be present in auto-generated help.
- name
Name for new definition, used for identification.
- required
Is this trailing argument required? Defaults to true.
- validate
The function that validates the parsed value.
- Returns:
ScallopOption, container for the parsed option value.
- Inherited from:
- ScallopConfBase
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
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.
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.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Validate that file does not exists.
Validate that file does not exists.
- Inherited from:
- ScallopConfBase
Validate that file argument is directory.
Validate that file argument is directory.
- Inherited from:
- ScallopConfBase
Validate that file is not a directory.
Validate that file is not a directory.
- Inherited from:
- ScallopConfBase
Validate that all the files in the arguments to multi-arg option do not exist.
Validate that all the files in the arguments to multi-arg option do not exist.
- Inherited from:
- ScallopConfBase
Validate that all the files in the arguments to multi-arg option exist.
Validate that all the files in the arguments to multi-arg option exist.
- Inherited from:
- ScallopConfBase
Validate that all the files in the arguments to multi-arg option are directories.
Validate that all the files in the arguments to multi-arg option are directories.
- Inherited from:
- ScallopConfBase
Validate that all the files in the arguments to multi-arg option are not directories.
Validate that all the files in the arguments to multi-arg option are not directories.
- Inherited from:
- ScallopConfBase
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Adds a validation function to this configuration. This function will be run after all other verification steps.
Adds a validation function to this configuration. This function will be run after all other verification steps.
- Value parameters:
- fn
Validation function. In case of error, it should return Left with the error message.
- Inherited from:
- ScallopConfValidations
Validate that path does not point to the existing file.
Validate that path does not point to the existing file.
- Inherited from:
- ScallopConfBase
Validate that path points to the existing file.
Validate that path points to the existing file.
- Inherited from:
- ScallopConfBase
Validate that path points to a directory.
Validate that path points to a directory.
- Inherited from:
- ScallopConfBase
Validate that path points to a file (not directory).
Validate that path points to a file (not directory).
- Inherited from:
- ScallopConfBase
Validate that path target does not exist.
Validate that path target does not exist.
- Inherited from:
- ScallopConfBase
Validate that paths targets exist.
Validate that paths targets exist.
- Inherited from:
- ScallopConfBase
Validate that all paths targets are files (not directories).
Validate that all paths targets are files (not directories).
- Inherited from:
- ScallopConfBase
Verify this configuration - parse the arguments, convert option values, run validations. This method MUST be called at the end of all options definitions, attempts to access option values before it is called will result in runtime exception.
Verify this configuration - parse the arguments, convert option values, run validations. This method MUST be called at the end of all options definitions, attempts to access option values before it is called will result in runtime exception.
- Inherited from:
- ScallopConfBase
Deprecated and Inherited methods
Set options, that are to be printed first in the help printout
Set options, that are to be printed first in the help printout
- Deprecated
[Since version Scallop 4.0.0]- Inherited from:
- ScallopConfBase
Inherited fields
Internal immutable builder for options setup.
Internal immutable builder for options setup.
- Inherited from:
- ScallopConfBase
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).
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.
- Inherited from:
- ScallopConfBase