Pythonの**kwargs
の用途は何ですか?
テーブルにobjects.filter
を実行して**kwargs
引数を渡すことができることを私は知っています。
時間デルタ、すなわちtimedelta(hours = time1)
を指定するためにこれを行うこともできますか?
それはどの程度正確に機能しますか?それは「開梱」としてのクラスですか? a,b=1,2
のような?
**kwargs
を使用して、関数に任意の数のキーワード引数を取らせることができます( "kwargs"は "キーワード引数"を意味します)。
>>> def print_keyword_args(**kwargs):
... # kwargs is a dict of the keyword args passed to the function
... for key, value in kwargs.iteritems():
... print "%s = %s" % (key, value)
...
>>> print_keyword_args(first_name="John", last_name="Doe")
first_name = John
last_name = Doe
キーワード引数の辞書を作成してそれを関数に渡すことで、関数を呼び出すときに**kwargs
構文を使うこともできます。
>>> kwargs = {'first_name': 'Bobby', 'last_name': 'Smith'}
>>> print_keyword_args(**kwargs)
first_name = Bobby
last_name = Smith
Pythonチュートリアル には、それがどのように機能するかについての良い説明と、いくつかのいい例があります。
<--Update-->
Iteritems()の代わりにPython 3を使っている人には、items()を使ってください。
**
は辞書を解凍します。
この
func(a=1, b=2, c=3)
と同じです
args = {'a': 1, 'b': 2, 'c':3}
func(**args)
あなたがパラメータを構築しなければならないならば、それは役に立ちます:
args = {'name': person.name}
if hasattr(person, "address"):
args["address"] = person.address
func(**args) # either expanded to func(name=person.name) or
# func(name=person.name, address=person.address)
def setstyle(**styles):
for key, value in styles.iteritems(): # styles is a regular dictionary
setattr(someobject, key, value)
これにより、次のような機能を使用できます。
setstyle(color="red", bold=False)
kwargsはパラメータに追加された単なる辞書です。
辞書にはキーと値のペアを含めることができます。そしてそれが争いです。わかりました、これはどうですか。
Whatforはそれほど単純ではありません。
例えば(非常に仮説的な)あなたは仕事をするために他のルーチンを呼び出すだけのインターフェースを持っている:
def myDo(what, where, why):
if what == 'swim':
doSwim(where, why)
Elif what == 'walk':
doWalk(where, why)
...
今、あなたは新しい方法 "drive"を得ます:
Elif what == 'drive':
doDrive(where, why, vehicle)
しかし、ちょっと待ってください、新しいパラメータ "vehicle"があります - あなたはそれを以前は知りませんでした。今度はそれをmyDo関数のシグネチャに追加する必要があります。
ここであなたはkwargsを場に出すことができます - あなたはただ署名にkwargsを追加するだけです:
def myDo(what, where, why, **kwargs):
if what == 'drive':
doDrive(where, why, **kwargs)
Elif what == 'swim':
doSwim(where, why, **kwargs)
こうすれば、呼び出されるルーチンの一部が変わるたびに、インターフェイス関数のシグネチャを変更する必要がなくなります。
これは、kwargsが役に立つと思う良い例です。
良いサンプルは長い談話よりも優れていることがあるので、すべてのpython変数引数渡し機能(位置引数と名前付き引数の両方)を使用して2つの関数を書きます。あなたはそれが自分で何をしているのかを簡単に見ることができるはずです:
def f(a = 0, *args, **kwargs):
print("Received by f(a, *args, **kwargs)")
print("=> f(a=%s, args=%s, kwargs=%s" % (a, args, kwargs))
print("Calling g(10, 11, 12, *args, d = 13, e = 14, **kwargs)")
g(10, 11, 12, *args, d = 13, e = 14, **kwargs)
def g(f, g = 0, *args, **kwargs):
print("Received by g(f, g = 0, *args, **kwargs)")
print("=> g(f=%s, g=%s, args=%s, kwargs=%s)" % (f, g, args, kwargs))
print("Calling f(1, 2, 3, 4, b = 5, c = 6)")
f(1, 2, 3, 4, b = 5, c = 6)
そして、これが出力です。
Calling f(1, 2, 3, 4, b = 5, c = 6)
Received by f(a, *args, **kwargs)
=> f(a=1, args=(2, 3, 4), kwargs={'c': 6, 'b': 5}
Calling g(10, 11, 12, *args, d = 13, e = 14, **kwargs)
Received by g(f, g = 0, *args, **kwargs)
=> g(f=10, g=11, args=(12, 2, 3, 4), kwargs={'c': 6, 'b': 5, 'e': 14, 'd': 13})
Motif:*args
と**kwargs
は、関数呼び出しに渡す必要がある引数のプレースホルダーとして機能します
*args
と**kwargs
を使って関数を呼び出す
def args_kwargs_test(arg1, arg2, arg3):
print "arg1:", arg1
print "arg2:", arg2
print "arg3:", arg3
今度は*args
を使って上記の関数を呼び出します。
#args can either be a "list" or "Tuple"
>>> args = ("two", 3, 5)
>>> args_kwargs_test(*args)
arg1:2
arg2:3
arg3:5
さて、**kwargs
を使って同じ関数を呼び出す
#keyword argument "kwargs" has to be a dictionary
>>> kwargs = {"arg3":3, "arg2":'two', "arg1":5}
>>> args_kwargs_test(**kwargs)
arg1:5
arg2:2
arg3:3
結論:*args
は情報を持たず、渡された引数をパラメータに(左から右の順に)補間するだけで、**kwargs
は適切な値を必要な場所に配置することで賢く動作します
**kwargs
のkwargs
は単なる変数名です。 **anyVariableName
を手に入れることができますkwargs
は "キーワード引数"を表します。しかし、これらは単に名前と一緒に渡される引数であるため、「名前付き引数」と呼ばれる方が良いと思います(「キーワード引数」という言葉に「キーワード」という言葉の意味がまったくありません)。プログラミング言語によって予約されているので変数名のためにプログラマによって使用されるべきではありません。このようなことはkwargsの場合にはここで起こりません。)したがって、func(param1="val1",param2="val2")
のように値だけを渡すのではなく、func(val1,val2)
のように、関数に渡される2つのパラメータ値にparam1
とparam2
という名前を付けます。 func
がシグネチャfunc(**kwargs)
を持つ場合、これらのパラメータ(つまり引数)をいくつでも指定できるので、これらは適切に "任意の数の名前付き引数" と呼ばれるべきだと思います。そのため、最初に「名前付き引数」を説明し、次に「任意の数の名前付き引数」kwargs
について説明します。
名前付き引数
例
def function1(param1,param2="arg2",param3="arg3"):
print("\n"+str(param1)+" "+str(param2)+" "+str(param3)+"\n")
function1(1) #1 arg2 arg3 #1 positional arg
function1(param1=1) #1 arg2 arg3 #1 named arg
function1(1,param2=2) #1 2 arg3 #1 positional arg, 1 named arg
function1(param1=1,param2=2) #1 2 arg3 #2 named args
function1(param2=2, param1=1) #1 2 arg3 #2 named args out of order
function1(1, param3=3, param2=2) #1 2 3 #
#function1() #invalid: required argument missing
#function1(param2=2,1) #invalid: SyntaxError: non-keyword arg after keyword arg
#function1(1,param1=11) #invalid: TypeError: function1() got multiple values for argument 'param1'
#function1(param4=4) #invalid: TypeError: function1() got an unexpected keyword argument 'param4'
任意の数の名前付き引数kwargs
例
def function2(param1, *tupleParams, param2, param3, **dictionaryParams):
print("param1: "+ param1)
print("param2: "+ param2)
print("param3: "+ param3)
print("custom Tuple params","-"*10)
for p in tupleParams:
print(str(p) + ",")
print("custom named params","-"*10)
for k,v in dictionaryParams.items():
print(str(k)+":"+str(v))
function2("arg1",
"custom param1",
"custom param2",
"custom param3",
param3="arg3",
param2="arg2",
customNamedParam1 = "val1",
customNamedParam2 = "val2"
)
# Output
#
#param1: arg1
#param2: arg2
#param3: arg3
#custom Tuple params ----------
#custom param1,
#custom param2,
#custom param3,
#custom named params ----------
#customNamedParam2:val2
#customNamedParam1:val1
カスタム引数にTupleとdict変数を渡す
それを終わらせるために、私達が渡すことができることにも注目させてください
したがって、上記と同じ呼び出しを次のように行うことができます。
tupleCustomArgs = ("custom param1", "custom param2", "custom param3")
dictCustomNamedArgs = {"customNamedParam1":"val1", "customNamedParam2":"val2"}
function2("arg1",
*tupleCustomArgs, #note *
param3="arg3",
param2="arg2",
**dictCustomNamedArgs #note **
)
最後に、上記の関数呼び出しの*
と**
に注意してください。それらを省略すると、悪い結果が出る可能性があります。
Tuple引数で*
を省略します。
function2("arg1",
tupleCustomArgs, #omitting *
param3="arg3",
param2="arg2",
**dictCustomNamedArgs
)
版画
param1: arg1
param2: arg2
param3: arg3
custom Tuple params ----------
('custom param1', 'custom param2', 'custom param3'),
custom named params ----------
customNamedParam2:val2
customNamedParam1:val1
タプルの上('custom param1', 'custom param2', 'custom param3')
はそのまま印刷されます。
dict
引数を省略します。
function2("arg1",
*tupleCustomArgs,
param3="arg3",
param2="arg2",
dictCustomNamedArgs #omitting **
)
与える
dictCustomNamedArgs
^
SyntaxError: non-keyword arg after keyword arg
さらに、kwargs関数を呼び出すときにさまざまな使用方法を組み合わせることもできます。
def test(**kwargs):
print kwargs['a']
print kwargs['b']
print kwargs['c']
args = { 'b': 2, 'c': 3}
test( a=1, **args )
この出力を与えます:
1
2
3
** kwargsが最後の引数でなければならないことに注意してください
使い方を説明するのに役立つ簡単な関数は次のとおりです。
def print_wrap(arg1, *args, **kwargs):
print(arg1)
print(args)
print(kwargs)
print(arg1, *args, **kwargs)
関数定義で not で指定されている引数は、キーワード引数であるかどうかに応じて、args
リストまたはkwargs
リストに入れられます。
>>> print_wrap('one', 'two', 'three', end='blah', sep='--')
one
('two', 'three')
{'end': 'blah', 'sep': '--'}
one--two--threeblah
関数に渡されないキーワード引数を追加すると、エラーが発生します。
>>> print_wrap('blah', dead_arg='anything')
TypeError: 'dead_arg' is an invalid keyword argument for this function
これが参考になることを願います。
#! /usr/bin/env python
#
def g( **kwargs) :
print ( "In g ready to print kwargs" )
print kwargs
print ( "in g, calling f")
f ( **kwargs )
print ( "In g, after returning from f")
def f( **kwargs ) :
print ( "in f, printing kwargs")
print ( kwargs )
print ( "In f, after printing kwargs")
g( a="red", b=5, c="Nassau")
g( q="purple", w="W", c="Charlie", d=[4, 3, 6] )
プログラムを実行すると、次のようになります。
$ python kwargs_demo.py
In g ready to print kwargs
{'a': 'red', 'c': 'Nassau', 'b': 5}
in g, calling f
in f, printing kwargs
{'a': 'red', 'c': 'Nassau', 'b': 5}
In f, after printing kwargs
In g, after returning from f
In g ready to print kwargs
{'q': 'purple', 'c': 'Charlie', 'd': [4, 3, 6], 'w': 'W'}
in g, calling f
in f, printing kwargs
{'q': 'purple', 'c': 'Charlie', 'd': [4, 3, 6], 'w': 'W'}
In f, after printing kwargs
In g, after returning from f
ここで重要なのは、呼び出し内の可変数の名前付き引数が関数内の辞書に変換されることです。
これは pythonの解凍について理解するための簡単な例です 、
>>> def f(*args, **kwargs):
... print 'args', args, 'kwargs', kwargs
eg1:
>>>f(1, 2)
>>> args (1,2) kwargs {} #args return parameter without reference as a Tuple
>>>f(a = 1, b = 2)
>>> args () kwargs {'a': 1, 'b': 2} #args is empty Tuple and kwargs return parameter with reference as a dictionary