class QCommandLineOption#

QCommandLineOption类定义了一个可能的命令行选项。更多信息…

摘要#

方法#

注意

本文档可能包含从 C++ 自动翻译到 Python 的代码片段。我们始终欢迎对片段翻译的贡献。如果您发现翻译有问题，也可以通过创建https:/bugreports.qt.io/projects/PYSIDE上的工单来告知我们。

详细描述#

警告

本节包含从 C++ 自动翻译到 Python 的代码片段，可能包含错误。

此类用于描述命令行上的选项。它允许以多种方式定义相同的选项，允许多个别名。它还用于描述如何使用该选项——它可能是一个标志（例如，-v）或接受一个值（例如，-o file）。

示例

verboseOption = QCommandLineOption("verbose", "Verbose mode. Prints out more information.")
outputOption = QCommandLineOption(QStringList() << "o" << "output", "Write generated data into .", "file")

另请参阅

QCommandLineParser

class Flag#

常量

描述

QCommandLineOption.HiddenFromHelp

(继承自 enum.Flag) 在用户可见的帮助输出中隐藏此选项。默认情况下，所有选项都是可见的。设置此标志使特定选项成为内部选项，即不在帮助输出中列出。

QCommandLineOption.ShortOptionStyle

无论 setSingleDashWordOptionMode 设置了什么，此选项始终被视为短选项。这允许像 -DDEFINE=VALUE 或 -I/include/path 这样带等号的选项在使用 ParseAsLongOptions 模式时被视为短选项。

另请参阅

setFlags() flags()

__init__(other)#
参数:

other – QCommandLineOption

构造一个 QCommandLineOption 对象，它是对 QCommandLineOption 对象 other 的副本。

另请参阅

操作符=()

__init__(name)
参数:

name – 字符串

使用指定的名称name构建一个命令行选项对象。

名称可以是简短或长名称。如果名称仅有一个字符，则被视为简短名称。选项名称必须非空，不得以连字符或斜杠开头，不得包含=，且不得重复。

__init__(name, description[, valueName=""[, defaultValue=""]])
参数:

  • name – 字符串

  • description – 字符串

  • valueName – 字符串

  • defaultValue – 字符串

警告

本节包含从 C++ 自动翻译到 Python 的代码片段，可能包含错误。

使用给定的参数构建一个命令行选项对象。

选项的名称设置为name。名称可以是简短或长名称。如果名称仅有一个字符，则被视为简短名称。选项名称必须非空，不得以连字符或斜杠开头，不得包含=，且不得重复。

描述设置为description。通常在描述的末尾添加一个“。”。

此外，如果选项期望一个值，需要设置valueName。选项的默认值设置为defaultValue。

在Qt 5.4之前的版本中，此构造函数为explicit。在Qt 5.4及以后的版本中，它不再具有此属性，并且可用于统一初始化。

parser = QCommandLineParser()
parser.addOption({"verbose", "Verbose mode. Prints out more information."})

另请参阅

setDescription() setValueName() setDefaultValues()

__init__(names)
参数:

names – 字符串列表

使用names中的名称构建一个命令行选项对象。

此重载允许为选项设置多个名称，例如o和output。

名称可以是简短或长名称。列表中的任何仅有一个字符的名称都是一个简短名称。选项名称必须非空，不得以连字符或斜杠开头，不得包含=，且不得重复。

__init__(names, description[, valueName=""[, defaultValue=""]])
参数:

  • names – 字符串列表

  • description – 字符串

  • valueName – 字符串

  • defaultValue – 字符串

警告

本节包含从 C++ 自动翻译到 Python 的代码片段，可能包含错误。

使用给定的参数构建一个命令行选项对象。

此重载允许为选项设置多个名称，例如o和output。

设置选项名称为 names。名称可以是简短或长的。任何长度为一的名称都在列表中被识别为简短名称。选项名称必须非空，不能以破折号或斜杠开头，不能包含 =，并且不得重复。

描述设置为description。通常在描述的末尾添加一个“。”。

此外，如果选项期望一个值，需要设置valueName。选项的默认值设置为defaultValue。

在Qt 5.4之前的版本中，此构造函数为explicit。在Qt 5.4及以后的版本中，它不再具有此属性，并且可用于统一初始化。

parser = QCommandLineParser()
parser.addOption({{"o", "output"}, "Write generated data into <file>.", "file"})

另请参阅

setDescription() setValueName() setDefaultValues()

defaultValues()#
返回类型：

字符串列表

返回设置此选项的默认值。

另请参阅

setDefaultValues()

description()#
返回类型：

str

返回设置此选项的描述。

另请参阅

setDescription()

flags()#
返回类型：

组合 Flag

返回影响此命令行选项的标志集。

另请参阅

setFlags() Flags

names()#
返回类型：

字符串列表

返回设置为此选项的名称。

setDefaultValue(defaultValue)#
参数:

defaultValue – 字符串

将用于此选项的默认值设置为 defaultValue。

如果应用程序用户没有在命令行上指定此选项，则会使用默认值。

如果 defaultValue 为空，则该选项没有默认值。

setDefaultValues(defaultValues)#
参数:

defaultValues – 字符串列表

将此选项使用的默认值列表设置为 defaultValues。

如果应用程序用户没有在命令行上指定此选项，则会使用默认值。

setDescription(description)#
参数:

description – 字符串

将此选项使用的描述设置为 description。

通常在描述的末尾添加一个“。”。

描述由 showHelp() 使用。

另请参阅

description()

setFlags(aflags)#
参数:

aflags – Flag 的组合

将影响此命令行选项的标志集设置为 flags。

另请参阅

flags() Flags

setValueName(name)#
参数:

name – 字符串

将预期值的名称设置为 valueName，用于文档。

未分配值的选项具有类似于布尔的行为：用户指定 –option 或不指定。

分配了值的选项需要为预期值设置一个名称，以便在帮助输出中对选项进行文档化。名称为 o 和 output，值名称为 file 的选项将显示为 -o, --output <file>。

如果期望该选项只出现一次，请调用 value()，如果期望该选项出现多次，请调用 values()。

另请参阅

valueName()

swap(other)#
参数:

other – QCommandLineOption

交换选项 other 与此选项。此操作非常快，并且永远不会失败。

valueName()#
返回类型：

str

返回预期值的名称。

如果为空，则选项不取值。

另请参阅

setValueName()