QCommandLineOption — PyQt Documentation v6.9.0 (original) (raw)
PyQt6.QtCore.QCommandLineOption
Description¶
The QCommandLineOption class defines a possible command-line option.
This class is used to describe an option on the command line. It allows different ways of defining the same option with multiple aliases possible. It is also used to describe how the option is used - it may be a flag (e.g. -v) or take a value (e.g. -o file).
Examples:
QCommandLineOption verboseOption("verbose", "Verbose mode. Prints out more information.");
QCommandLineOption outputOption(QStringList() << "o" << "output", "Write generated data into .", "file");
Enums¶
Flag
See also
| Member | Value | Description |
|---|---|---|
| HiddenFromHelp | 0x1 | Hide this option in the user-visible help output. All options are visible by default. Setting this flag for a particular option makes it internal, i.e. not listed in the help output. |
| IgnoreOptionsAfter | 0x4 | [since 6.9] No options beyond this one will be parsed. Useful for cases where you need to send extra command line arguments to a secondary application. If a value is provided for this option, it will be ignored. |
| ShortOptionStyle | 0x2 | The option will always be understood as a short option, regardless of what was set by setSingleDashWordOptionMode(). This allows flags such as -DDEFINE=VALUE or -I/include/path to be interpreted as short flags even when the parser is in ParseAsLongOptions mode. |
Methods¶
__init__(Optional[str])
Constructs a command line option object with the name name.
The name can be either short or long. If the name is one character in length, it is considered a short name. Option names must not be empty, must not start with a dash or a slash character, must not contain a = and cannot be repeated.
__init__(Iterable[Optional[str]])
Constructs a command line option object with the names names.
This overload allows to set multiple names for the option, for instance o and output.
The names can be either short or long. Any name in the list that is one character in length is a short name. Option names must not be empty, must not start with a dash or a slash character, must not contain a = and cannot be repeated.
__init__(QCommandLineOption)
Constructs a QCommandLineOption object that is a copy of the QCommandLineOption object other.
__init__(Optional[str], Optional[str], valueName: Optional[str] = '', defaultValue: Optional[str] = '')
Constructs a command line option object with the given arguments.
The name of the option is set to name. The name can be either short or long. If the name is one character in length, it is considered a short name. Option names must not be empty, must not start with a dash or a slash character, must not contain a = and cannot be repeated.
The description is set to description. It is customary to add a “.” at the end of the description.
In addition, the valueName needs to be set if the option expects a value. The default value for the option is set to defaultValue.
In Qt versions before 5.4, this constructor was explicit. In Qt 5.4 and later, it no longer is and can be used for C++11-style uniform initialization:
QCommandLineParser parser;
parser.addOption({"verbose", "Verbose mode. Prints out more information."});
__init__(Iterable[Optional[str]], Optional[str], valueName: Optional[str] = '', defaultValue: Optional[str] = '')
Constructs a command line option object with the given arguments.
This overload allows to set multiple names for the option, for instance o and output.
The names of the option are set to names. The names can be either short or long. Any name in the list that is one character in length is a short name. Option names must not be empty, must not start with a dash or a slash character, must not contain a = and cannot be repeated.
The description is set to description. It is customary to add a “.” at the end of the description.
In addition, the valueName needs to be set if the option expects a value. The default value for the option is set to defaultValue.
In Qt versions before 5.4, this constructor was explicit. In Qt 5.4 and later, it no longer is and can be used for C++11-style uniform initialization:
QCommandLineParser parser;
parser.addOption({{"o", "output"}, "Write generated data into .", "file"});
defaultValues() → list[str]
Returns the default values set for this option.
See also
description() → str
Returns the description set for this option.
See also
flags() → Flag
Returns a set of flags that affect this command-line option.
See also
setFlags(), QCommandLineOption::Flags.
names() → list[str]
Returns the names set for this option.
setDefaultValue(Optional[str])
Sets the default value used for this option to defaultValue.
The default value is used if the user of the application does not specify the option on the command line.
If defaultValue is empty, the option has no default values.
setDefaultValues(Iterable[Optional[str]])
Sets the list of default values used for this option to defaultValues.
The default values are used if the user of the application does not specify the option on the command line.
setDescription(Optional[str])
Sets the description used for this option to description.
It is customary to add a “.” at the end of the description.
The description is used by showHelp().
setFlags(Flag)
Set the set of flags that affect this command-line option to flags.
See also
flags(), QCommandLineOption::Flags.
setValueName(Optional[str])
Sets the name of the expected value, for the documentation, to valueName.
Options without a value assigned have a boolean-like behavior: either the user specifies –option or they don’t.
Options with a value assigned need to set a name for the expected value, for the documentation of the option in the help output. An option with names o and output, and a value name of file will appear as -o, --output <file>.
Call value() if you expect the option to be present only once, and values() if you expect that option to be present multiple times.
swap(QCommandLineOption)
Swaps this option with other. This operation is very fast and never fails.
valueName() → str
Returns the name of the expected value.
If empty, the option doesn’t take a value.