PySide6.QtCore.QCommandLineOption

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)
Parameters:

其他 – QCommandLineOption

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

另请参阅

operator=()

__init__(name)
Parameters:

name – str

构造一个具有名称 name 的命令行选项对象。

名称可以是短的或长的。如果名称的长度为一个字符，则被视为短名称。选项名称不能为空，不能以破折号或斜杠字符开头，不能包含=，并且不能重复。

__init__(names)
Parameters:

names – 字符串列表

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

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

名称可以是短的或长的。列表中任何长度为1个字符的名称都是短名称。选项名称不能为空，不能以破折号或斜杠字符开头，不能包含=，并且不能重复。

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

  • name – str

  • 描述 – str

  • valueName – str

  • defaultValue – str

警告

本节包含从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, description[, valueName=""[, defaultValue=""]])
Parameters:

  • names – 字符串列表

  • 描述 – str

  • valueName – str

  • defaultValue – str

警告

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

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

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

选项的名称设置为names。名称可以是短的或长的。列表中长度为1个字符的任何名称都是短名称。选项名称不能为空，不能以破折号或斜杠字符开头，不能包含=，并且不能重复。

描述设置为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()
Return type:

字符串列表

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

另请参阅

setDefaultValues()

description()
Return type:

字符串

返回为此选项设置的描述。

另请参阅

setDescription()

flags()
Return type:

Flag的组合

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

另请参阅

setFlags() Flags

names()
Return type:

字符串列表

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

setDefaultValue(defaultValue)
Parameters:

defaultValue – str

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

如果应用程序的用户未在命令行上指定选项，则使用默认值。

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

setDefaultValues(defaultValues)
Parameters:

defaultValues – 字符串列表

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

如果应用程序的用户未在命令行上指定选项，则使用默认值。

setDescription(description)
Parameters:

描述 – str

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

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

描述由showHelp()使用。

另请参阅

description()

setFlags(aflags)
Parameters:

aflags – Flag 的组合

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

另请参阅

flags() 标志

setValueName(name)
Parameters:

name – str

为文档设置预期值的名称为valueName。

没有赋值的选项具有类似布尔值的行为：用户要么指定–option，要么不指定。

需要为已分配值的选项设置一个预期值的名称，以便在帮助输出中记录该选项。一个具有名称o和output，以及值名称为file的选项将显示为-o, --output 。

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

另请参阅

valueName()

swap(other)
Parameters:

其他 – QCommandLineOption

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

valueName()
Return type:

字符串

返回预期值的名称。

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

另请参阅

setValueName()