Pythonのコマンドラインで設定オプションをオーバーライドできるようにする最良の方法はどれですか？
Pythonアプリケーションにはかなりの数（〜30）の構成パラメーターが必要です。これまでは、OptionParserクラスを使用してアプリ自体のデフォルト値を定義し、個々のアプリケーションを呼び出すときのコマンドラインでのパラメーター。
ここで、たとえばConfigParserクラスからの「適切な」構成ファイルを使用したいと思います。同時に、ユーザーはコマンドラインで個々のパラメーターを変更できる必要があります。
私は、2つのステップを組み合わせる方法があるかどうか疑問に思っていました。 optparse（または新しいargparse）を使用してコマンドラインオプションを処理しますが、ConfigParse構文の構成ファイルからデフォルト値を読み取ります。
これを簡単に行う方法はありますか？手動でConfigParseを呼び出してから、すべてのoptinoのすべてのデフォルトを適切な値に手動で設定するのはあまり好きではありません...
argparse.ArgumentParser.parse_known_args()でこれができることを発見しました。 parse_known_args()を使用してコマンドラインから構成ファイルを解析し、次にConfigParserで読み取り、デフォルトを設定してから、parse_args()で残りのオプションを解析します。これにより、デフォルト値を設定し、設定ファイルでそれを上書きしてから、コマンドラインオプションでそれを上書きできます。例えば。：
ユーザー入力なしのデフォルト：
$ ./argparse-partial.py
Option is "default"
構成ファイルのデフォルト：
$ cat argparse-partial.config
[Defaults]
option=Hello world!
$ ./argparse-partial.py -c argparse-partial.config
Option is "Hello world!"
構成ファイルからのデフォルト、コマンドラインでオーバーライド：
$ ./argparse-partial.py -c argparse-partial.config --option override
Option is "override"
argprase-partial.pyが続きます。 -hを適切に処理するのは少し複雑です。
import argparse
import ConfigParser
import sys
def main(argv=None):
# Do argv default this way, as doing it in the functional
# declaration sets it at compile time.
if argv is None:
argv = sys.argv
# Parse any conf_file specification
# We make this parser with add_help=False so that
# it doesn't parse -h and print help.
conf_parser = argparse.ArgumentParser(
description=__doc__, # printed with -h/--help
# Don't mess with format of description
formatter_class=argparse.RawDescriptionHelpFormatter,
# Turn off help, so we print all options in response to -h
add_help=False
)
conf_parser.add_argument("-c", "--conf_file",
help="Specify config file", metavar="FILE")
args, remaining_argv = conf_parser.parse_known_args()
defaults = { "option":"default" }
if args.conf_file:
config = ConfigParser.SafeConfigParser()
config.read([args.conf_file])
defaults.update(dict(config.items("Defaults")))
# Parse rest of arguments
# Don't suppress add_help here so it will handle -h
parser = argparse.ArgumentParser(
# Inherit options from config_parser
parents=[conf_parser]
)
parser.set_defaults(**defaults)
parser.add_argument("--option")
args = parser.parse_args(remaining_argv)
print "Option is \"{}\"".format(args.option)
return(0)
if __== "__main__":
sys.exit(main())
ConfigArgParse -新しいPyPIパッケージ（ オープンソース ）を確認してください。これは、構成ファイルと環境変数のサポートが追加されたargparseのドロップイン代替品として機能します。
このようなタスクを処理するために、ConfigParserとargparseをサブコマンドとともに使用しています。以下のコードの重要な行は次のとおりです。
subp.set_defaults(**dict(conffile.items(subn)))
これにより、サブコマンドのデフォルト（argparseから）が構成ファイルのセクションの値に設定されます。
より完全な例を以下に示します。
####### content of example.cfg:
# [sub1]
# verbosity=10
# gggg=3.5
# [sub2]
# Host=localhost
import ConfigParser
import argparse
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()
parser_sub1 = subparsers.add_parser('sub1')
parser_sub1.add_argument('-V','--verbosity', type=int, dest='verbosity')
parser_sub1.add_argument('-G', type=float, dest='gggg')
parser_sub2 = subparsers.add_parser('sub2')
parser_sub2.add_argument('-H','--Host', dest='Host')
conffile = ConfigParser.SafeConfigParser()
conffile.read('example.cfg')
for subp, subn in ((parser_sub1, "sub1"), (parser_sub2, "sub2")):
subp.set_defaults(**dict(conffile.items(subn)))
print parser.parse_args(['sub1',])
# Namespace(gggg=3.5, verbosity=10)
print parser.parse_args(['sub1', '-V', '20'])
# Namespace(gggg=3.5, verbosity=20)
print parser.parse_args(['sub1', '-V', '20', '-G','42'])
# Namespace(gggg=42.0, verbosity=20)
print parser.parse_args(['sub2', '-H', 'www.example.com'])
# Namespace(Host='www.example.com')
print parser.parse_args(['sub2',])
# Namespace(Host='localhost')
私はそれが最良の方法だとは言えませんが、私はそれを行うOptionParserクラスを持っています-optparse.OptionParserのように動作し、デフォルトは設定ファイルセクションから来ます。きみにあげる...
class OptionParser(optparse.OptionParser):
def __init__(self, **kwargs):
import sys
import os
config_file = kwargs.pop('config_file',
os.path.splitext(os.path.basename(sys.argv[0]))[0] + '.config')
self.config_section = kwargs.pop('config_section', 'OPTIONS')
self.configParser = ConfigParser()
self.configParser.read(config_file)
optparse.OptionParser.__init__(self, **kwargs)
def add_option(self, *args, **kwargs):
option = optparse.OptionParser.add_option(self, *args, **kwargs)
name = option.get_opt_string()
if name.startswith('--'):
name = name[2:]
if self.configParser.has_option(self.config_section, name):
self.set_default(name, self.configParser.get(self.config_section, name))
ソースを自由に参照してください 。テストは兄弟ディレクトリにあります。
更新：この回答にはまだ問題があります。たとえば、required引数を処理できず、扱いにくい構成構文が必要です。代わりに、 ConfigArgParse は、この質問がまさに求めているもののようで、透過的なドロップイン置換です。
current の1つの問題は、構成ファイルの引数が無効であってもエラーにならないことです。以下に、別の欠点があるバージョンを示します。キーに接頭辞--または-を含める必要があります。
pythonコード（ Gistリンク with MITライセンス）：
# Filename: main.py
import argparse
import configparser
if __== "__main__":
parser = argparse.ArgumentParser()
parser.add_argument('--config_file', help='config file')
args, left_argv = parser.parse_known_args()
if args.config_file:
with open(args.config_file, 'r') as f:
config = configparser.SafeConfigParser()
config.read([args.config_file])
parser.add_argument('--arg1', help='argument 1')
parser.add_argument('--arg2', type=int, help='argument 2')
for k, v in config.items("Defaults"):
parser.parse_args([str(k), str(v)], args)
parser.parse_args(left_argv, args)
print(args)
設定ファイルの例を次に示します。
# Filename: config_correct.conf
[Defaults]
--arg1=Hello!
--arg2=3
今、実行中
> python main.py --config_file config_correct.conf --arg1 override
Namespace(arg1='override', arg2=3, config_file='test_argparse.conf')
ただし、設定ファイルにエラーがある場合：
# config_invalid.conf
--arg1=Hello!
--arg2='not an integer!'
必要に応じて、スクリプトを実行するとエラーが生成されます。
> python main.py --config_file config_invalid.conf --arg1 override
usage: test_argparse_conf.py [-h] [--config_file CONFIG_FILE] [--arg1 ARG1]
[--arg2 ARG2]
main.py: error: argument --arg2: invalid int value: 'not an integer!'
主な欠点は、ArgumentParserからエラーチェックを取得するためにparser.parse_argsを多少ハッキングに使用することですが、これに代わるものはありません。
このようにしてみてください
# encoding: utf-8
import imp
import argparse
class LoadConfigAction(argparse._StoreAction):
NIL = object()
def __init__(self, option_strings, dest, **kwargs):
super(self.__class__, self).__init__(option_strings, dest)
self.help = "Load configuration from file"
def __call__(self, parser, namespace, values, option_string=None):
super(LoadConfigAction, self).__call__(parser, namespace, values, option_string)
config = imp.load_source('config', values)
for key in (set(map(lambda x: x.dest, parser._actions)) & set(dir(config))):
setattr(namespace, key, getattr(config, key))
これを使って：
parser.add_argument("-C", "--config", action=LoadConfigAction)
parser.add_argument("-H", "--Host", dest="Host")
そして、設定例を作成します：
# Example config: /etc/myservice.conf
import os
Host = os.getenv("Host_NAME", "localhost")
ChainMap を使用できます
A ChainMap groups multiple dicts or other mappings together to create a single, updateable view. If no maps are specified, a single empty dictionary is provided so that a new chain always has at least one mapping.
コマンドライン、環境変数、構成ファイルの値を組み合わせて、値が存在しない場合はデフォルト値を定義できます。
import os
from collections import ChainMap, defaultdict
options = ChainMap(command_line_options, os.environ, config_file_options,
defaultdict(lambda: 'default-value'))
value = options['optname']
value2 = options['other-option']
print(value, value2)
'optvalue', 'default-value'
fromfile_prefix_chars
完璧なAPIではないかもしれませんが、知っておく価値はあります。 main.py：
#!/usr/bin/env python3
import argparse
parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
parser.add_argument('-a', default=13)
parser.add_argument('-b', default=42)
print(parser.parse_args())
次に：
$ printf -- '-a\n1\n-b\n2\n' > opts.txt
$ ./main.py
Namespace(a=13, b=42)
$ ./main.py @opts.txt
Namespace(a='1', b='2')
$ ./main.py @opts.txt -a 3 -b 4
Namespace(a='3', b='4')
$ ./main.py -a 3 -b 4 @opts.txt
Namespace(a='1', b='2')
ドキュメント： https://docs.python.org/3.6/library/argparse.html#fromfile-prefix-chars
テスト済みPython 3.6.5、Ubuntu 18.04。