使用文件来存储 optparse 参数

Question

我已经使用 optparse 一段时间了，并且想添加从配置文件加载参数的功能。

到目前为止，我能想到的最好的方法是使用硬编码参数的包装批处理脚本......看起来很笨拙。

最优雅的方法是什么？

Answer 1

我同意 S.Lott 使用配置文件的想法，但我建议使用内置的 ConfigParser（3.0中的configparser）模块来解析它，而不是自制的解决方案。

下面是一个简短的脚本，演示了 ConfigParser 和 optparse 的实际操作。

import ConfigParser
from optparse import OptionParser

CONFIG_FILENAME = 'defaults.cfg'

def main():
    config = ConfigParser.ConfigParser()
    config.read(CONFIG_FILENAME)

    parser = OptionParser()
    parser.add_option("-l",
                      "--language",
                      dest="language",
                      help="The UI language",
                      default=config.get("Localization", "language"))
    parser.add_option("-f",
                      "--flag",
                      dest="flag",
                      help="The country flag",
                      default=config.get("Localization", "flag"))

    print parser.parse_args()

if __name__ == "__main__":
    main()

输出：

(<Values at 0x2182c88: {'flag': 'japan.png', 'language': 'Japanese'}>, [])

使用“parser.py --language=French”运行：

(<Values at 0x2215c60: {'flag': 'japan.png', 'language': 'French'}>, [])

内置帮助。
使用“parser.py --help”运行：

Usage: parser.py [options]

Options:
  -h, --help            show this help message and exit
  -l LANGUAGE, --language=LANGUAGE
                        The UI language
  -f FLAG, --flag=FLAG  The country flag

配置文件：

[Localization]
language=Japanese
flag=japan.png

Answer 2

您可以使用argparse 模块：

>>> open('args.txt', 'w').write('-f\nbar')
>>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
>>> parser.add_argument('-f')
>>> parser.parse_args(['-f', 'foo', '@args.txt'])
Namespace(f='bar')

它可能包含在 stdlib 中，请参阅 pep 389 。

Answer 3

我遇到了类似的问题，但也想将配置文件指定为参数。受到 S. Lott 答案的启发，我想出了以下代码。

示例终端会话：

$ python defaultconf.py # use hard-coded defaults
False
$ python defaultconf.py --verbose # verbose on command line
True
$ python defaultconf.py --loadconfig blah # load config with 'verbose':True
True
$ python defaultconf.py --loadconfig blah --quiet # Override configured value
False

代码：

#!/usr/bin/env python2.6
import optparse

def getParser(defaults):
    """Create and return an OptionParser instance, with supplied defaults
    """
    o = optparse.OptionParser()
    o.set_defaults(**defaults)
    o.add_option("--verbose", dest = "verbose", action="store_true")
    o.add_option("--quiet", dest = "verbose", action="store_false")

    o.add_option("--loadconfig", dest = "loadconfig")

    return o


def main():
    # Hard coded defaults (including non-command-line-argument options)
    my_defaults = {'verbose': False, 'config_only_variable': 42}

    # Initially parse arguments
    opts, args = getParser(my_defaults).parse_args()

    if opts.loadconfig is not None:
        # Load config from disk, update the defaults dictionary, and reparse
        # Could use ConfigParser, simplejson, yaml etc.

        config_file_values = {'verbose': True} # the dict loaded from disk

        my_defaults.update(config_file_values)
        opts, args = getParser(my_defaults).parse_args()

    print opts.verbose

if __name__ == '__main__':
    main()

可以在 Github 上找到实际的实现： 默认字典，参数解析器和< a href="http://github.com/dbr/tvnamer/blob/26b0efedc89dfdd5b9bf2d68d8de54a2dd8b9590/tvnamer/main.py#L198" rel="nofollow noreferrer">主要功能

Answer 4

这就是 set_defaults 函数的用途。 http://docs.python.org/library/optparse.html# optparse.OptionParser.set_defaults

创建一个作为默认值字典的文件。

{ 'arg1': 'this',
'arg2': 'that'
}

然后读取此文件，对其进行评估以将文本转换为字典，并将此字典作为 set_defaults 的参数提供。

如果您确实担心 eval，请对此文件使用 JSON（或 YAML）表示法。或者您甚至可以从中创建一个 .INI 文件并使用 configparser 获取默认值。

或者您可以使用赋值语句和 exec 的简单列表。

配置文件。

arg1 = 'this'
arg2 = 'that'

读取配置文件。

defaults= {}
with open('defaults.py','r') as config
    exec config in {}, defaults

Answer 5

从文件（例如@commands）中读取相同命令行格式的参数，然后使用原始解析器来解析它们。

options, args = parser.parse_args()

if args[0][0] == '@': # script.py @optfile 
    with open(args[0][1:]) as f:
        fa = [l.strip() for l in f]
    fa = fa + args[1:] # put back any other positional arguments
    # Use your original parser to parse the new options
    options, args = parser.parse_args(args=fa, values=options)

Answer 6

我最近构建了很多带有标志和选项的脚本，并且提出了此处描述的解决方案。

基本上，我实例了一个带有特殊标志的选项解析器，该标志告诉尝试从文件加载选项，因此您可以正常使用脚本从命令行指定选项或从文件提供它们（或一组）。

更新：我在 GitHub 上共享了代码