モジュールmyscript.pyがあるとします。このモジュールは製品コードであり、しばしば_%dir%>python myscript.py foo bar
_と呼ばれます。
キーワード引数を取るように拡張したいと思います。私は以下のスクリプトを使用してこれらの引数を取ることができることを知っていますが、残念ながら1つを使用してそれを呼び出す必要があります
%dir%>python myscript.py main(foo, bar)
。
argparse
モジュールを使用できることはわかっていますが、その方法がわかりません。
_import sys
def main(foo,bar,**kwargs):
print 'Called myscript with:'
print 'foo = %s' % foo
print 'bar = %s' % bar
if kwargs:
for k in kwargs.keys():
print 'keyword argument : %s' % k + ' = ' + '%s' % kwargs[k]
if __name__=="__main__":
exec(''.join(sys.argv[1:]))
_
メイン関数と同じようにキーワード引数を渡したい場合は、key=value
、次のように実行できます。
import sys
def main(foo, bar, *args):
print "Called my script with"
print "foo = %s" % foo
print "bar = %s" % bar
for arg in args:
k = arg.split("=")[0]
v = arg.split("=")[1]
print "Keyword argument: %s = %s" % (k, v)
if __name__ == "__main__":
if len(sys.argv) < 3:
raise SyntaxError("Insufficient arguments.")
if len(sys.argv) != 3:
# If there are keyword arguments
main(sys.argv[1], sys.argv[2], *sys.argv[3:])
else:
# If there are no keyword arguments
main(sys.argv[1], sys.argv[2])
いくつかの例:
$> python my_file.py a b x=4
Called my script with
foo = a
bar = b
Keyword argument: x = 4
$> python my_file.py foo bar key=value
Called my script with
foo = foo
bar = bar
Keyword argument: key = value
ただし、これは、キーと値の間に空白がないことを前提としていますkey = value
動作しないでしょう。
あなたが探しているなら--argument
種類のキーワード引数、あなたすべきargparse
を使用します。
@Moonは同様の解決策で私を打ち負かしましたが、事前に解析して実際のkwargs
を渡すことをお勧めします。
import sys
def main(foo, bar, **kwargs):
print('Called myscript with:')
print('foo = {}'.format(foo))
print('bar = {}'.format(bar))
for k, v in kwargs.items():
print('keyword argument: {} = {}'.format(k, v))
if __name__=='__main__':
main(sys.argv[1], # foo
sys.argv[2], # bar
**dict(arg.split('=') for arg in sys.argv[3:])) # kwargs
# Example use:
# $ python myscript.py foo bar hello=world 'with spaces'='a value'
# Called myscript with:
# foo = foo
# bar = bar
# keyword argument: hello = world
# keyword argument: with spaces = a value
まず、引数として任意のPython=式を渡すことはありません。もろくて安全ではありません。
引数パーサーを設定するには、必要な引数を定義し、それらを解析して、コマンドライン呼び出しで指定された情報を含むNamespace
オブジェクトを生成します。
import argparse
p = argparse.ArgumentParser()
p.add_argument('foo')
p.add_argument('bar')
p.add_argument('--add-feature-a', dest='a', action='store_true', default=False)
あなたの__main__
ブロックでは、引数を解析してから、Namespace
から生成された辞書をmain
に渡します。
if __name__ == '__main__':
args = p.parse_args()
main(**vars(args))
次に、次のような行でスクリプトを呼び出します
# foo = "3", bar = "6", a = True
python myscript.py 3 6 --add-feature-a
または
# foo = "moo", bar="7.7", a = False
python myscript.py moo 7.7
argparse
でできることは他にもたくさんありますが、これは、生成する値をmain
に取得する簡単な例です。
2行のコードで、標準のargsとkwargsのように操作できるargsとkwargsを取得できます。
import sys
if __name__=='__main__':
argv=argv[1:]
kwargs={kw[0]:kw[1] for kw in [ar.split('=') for ar in argv if ar.find('=')>0]}
args=[arg for arg in argv if arg.find('=')<0]
#and you can the use args and kwargs as so:
if 'reset' in args:
do_some_functions_with_reset()
a_device_var=kwargs.get('device',False):
#or whatever you want to do with args and kwargs
そして結果は:
$python test.py reset device=foo format=1 bar
->args=['reset','bar']
->kwargs={'device':'foo','format':'1'}
少し内省すると、関数のシグネチャからArgumentParser
を設定して、コマンドラインパラメータを関数の引数に直接マッピングできます。
import argparse
import inspect
def myfun(mode, count=1, frobify=False, *files):
print('Doing %s %d times on %s (%sfrobifying)' % (
mode, count, files, '' if frobify else 'not '
))
def funopt(fun, argv=None):
parser = argparse.ArgumentParser()
if hasattr(inspect, 'getfullargspec'):
spec = inspect.getfullargspec(fun)
else:
spec = inspect.getargspec(fun)
num_defaults = len(spec.defaults) if spec.defaults is not None else 0
for i in range(len(spec.args)):
if i < len(spec.args) - num_defaults:
parser.add_argument(spec.args[i])
Elif spec.defaults[i - len(spec.args)] is False:
parser.add_argument('--' + spec.args[i],
default=False, action='store_true')
else:
default = spec.defaults[i - len(spec.args)]
parser.add_argument('--' + spec.args[i],
default=default,
type=type(default))
if spec.varargs is not None:
parser.add_argument(spec.varargs,
nargs='*')
kwargs = vars(parser.parse_args(argv))
args = []
for arg in spec.args:
args += [kwargs[arg]]
if spec.varargs is not None:
args += kwargs[spec.varargs]
fun(*args)
funopt(myfun)
結果:
$ python test.py
usage: test.py [-h] [--count COUNT] [--frobify] mode [files [files ...]]
test.py: error: too few arguments
$ python test.py myaction a b c
Doing myaction 1 times on ('a', 'b', 'c') (not frobifying)
$ python test.py --frobify --count=5 myaction a b c
Doing myaction 5 times on ('a', 'b', 'c') (frobifying)