PyQt 的优雅命令行参数解析

我正在编写一个新的 PyQt 应用程序。我正在尝试使用尽可能多的 PyQt API 来完成与程序和 ui 相关的所有事情，作为提高我对 PyQt 和 Qt 总体知识的一种手段。

我的问题是，PyQt/Qt 中是否有 API 可以优雅地处理命令行参数解析？

到目前为止我的研究表明：

• 制作方法的示例与 python 的 opt_parser 配合得很好 http://lateral.netmanagers.com.ar/weblog/posts/BB997.html模块，但它不处理 QApplication 的内置 arg 解析。
• PyKDE 的 KCmdLineArgs http://techbase.kde.org/Development/Languages/Python/Using_PyKDE_4#KCmdLineArgs.2C_KAboutData（这引入了不需要的 KDE 依赖项）
• 看起来 KCmdLineArgs 正在作为 QCommandLineParser 移植到 Qt5.1 的上游，这很酷，但我希望现在就可以使用它，而不是 18 个月后。

那么 PyQt 应用程序通常如何处理这个问题呢？或者是 opt_parser/argparse 的出路？

这远不是一个好的解决方案......

#!/usr/bin/python
# -*- coding: utf-8 -*-

import sys, argparse
from PyQt4 import QtGui

def main(argv):

  app = QtGui.QApplication(argv) # QApplication eats argv in constructor

  # We can get a QStringList out of QApplication of those arguments it 
  # didn't decide were reserved by Qt.
  argv2 = app.arguments()   

  # now we need to turn them back into something that optparse/argparse 
  # can understand, since a QStringList is not what it wants
  argv3 = []
  for i in argv2:
    argv3.append(str(i))

  # now we can pass this to optparse/argparse
  process_args(argv3)

  # dummy app
  mw = QtGui.QMainWindow()
  mw.show()
  sys.exit(app.exec_())

def process_args(argv):
  parser = argparse.ArgumentParser(description='PyQt4 argstest', 
                                   add_help=False)

  # we now have to add all of the options described at 
  # http://qt-project.org/doc/qt-4.8/qapplication.html#QApplication
  # but have them do nothing - in order to have them show up in the help list

  # add this to the list if Qt is a debug build (How to detect this?)
  parser.add_argument("-nograb", action=ignore,
                      help="don't grab keyboard/mouse for debugging")

  # add these to the list if Qt is a debug build for X11
  parser.add_argument("-dograb", action=ignore,
                      help="grab keyboard/mouse for debugging")
  parser.add_argument("-sync", action=ignore,
                      help="run in synchronous mode for debugging")

  # add all the standard args that Qt will grab on all platforms
  parser.add_argument("-reverse", action=ignore,
                      help="run program in Right-to-Left mode")
  # an example -- there are 10 such items in the docs for QApplication

  # then we need to figure out if we're running on X11 and add these
  parser.add_argument("-name", action=ignore,
                      help="sets the application name")
  # an example -- there are 13 such items in the docs

  # reimplement help (which we disabled above) so that -help works rather 
  # than --help; done to be consistent with the style of args Qt wants
  parser.add_argument("-h", "-help", action='help',
                      help="show this help message and exit")

  parser.parse_args(argv[1:])

class ignore(argparse.Action):
  # we create an action that does nothing, so the Qt args do nothing
  def __call__(self, parser, namespace, values, option_string=None):
    pass

if __name__ == "__main__":
  main(sys.argv)

这里最好的解决方案是使用argparse模块的parse_known_args()方法 （docs http://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.parse_known_args) 首先处理非 Qt 命令行选项。不再需要进行配置工作ArgumentParser—它只是更改您调用的方法，并在返回中为您提供一个元组而不是单个对象。这让您两全其美。

一个简化的示例，仅捕获几个 Qt 4.8 参数和其他一些参数，但给出了总体思路。

# my_script.py

import argparse
from PyQt4 import QtGui  # this will work with PySide.QtGui, too

def process_cl_args():
    parser = argparse.ArgumentParser()
    parser.add_argument('-s', '--swallow', action='store')  # optional flag
    parser.add_argument('holy_hand_grenade', action='store')  # positional argument

    parsed_args, unparsed_args = parser.parse_known_args()
    return parsed_args, unparsed_args

if __name__ == '__main__':
    parsed_args, unparsed_args = process_cl_args()
    # QApplication expects the first argument to be the program name.
    qt_args = sys.argv[:1] + unparsed_args
    app = QtGui.QApplication(qt_args)
    # ... the rest of your handling: `sys.exit(app.exec_())`, etc.

假设您要这样运行：

$ python my_script.py -dograb --swallow=unladen 3 -style cde

Then parsed_args会有平常的Namespace with holy_hand_grenade set to 3 and --swallow set to 'unladen', while unparsed_args会有一个简单的列表：['-dograb', '-style,' 'cde']。这又可以正常传递给QApplication包含程序名称sys.argv[0]（谢谢marcin https://stackoverflow.com/users/104453/marcin for 指出这一点 https://stackoverflow.com/questions/11713006/elegant-command-line-argument-parsing-for-pyqt/21166631?noredirect=1#comment50925070_21166631）。我们用sys.argv[:1]获取一个用于连接的数组unparsed_args;你也可以这样做[sys.argv[0]]

除此之外，这还可以让您设置应用程序来指定是否启动 Qt UI、是否作为命令行运行、是否运行单元测试等等（如果您愿意的话）。首先处理非 Qt（或其他任何）参数会更好，因为它不会留下argparse取决于您正在使用的设置，但反之亦然。