**kwargs
Pythonでの用途は何ですか?
objects.filter
テーブルに対して を実行して**kwargs
引数 を渡すことができることは知っています。
時間のデルタを指定するためにこれを行うこともできますtimedelta(hours = time1)
か?
それはどのように正確に機能しますか?「アンパック」としてのクラスですか?のようにa,b=1,2
?
**kwargs
Pythonでの用途は何ですか?
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 チュートリアルには、いくつかの優れた例とともに、それがどのように機能するかについての適切な説明が含まれています。
Python 3 の場合、 の代わりにiteritems()
、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)
.items()
の代わりに使用.iteritems()
def setstyle(**styles):
for key, value in styles.iteritems(): # styles is a regular dictionary
setattr(someobject, key, value)
これにより、次のように関数を使用できます。
setstyle(color="red", bold=False)
kwargs
はキーワード引数に使用される変数名ですが、別の変数名を使用できます。重要な部分は、それが辞書であり、二重アスタリスク演算子で展開されていること**
です。*
kwargs
とを使用するのがおそらく最善です。args
kwargs は、パラメーターに追加される単なる辞書です。
ディクショナリには、キーと値のペアを含めることができます。そしてそれがクワーグです。わかりました、これが方法です。
何のためにあるのかはそれほど単純ではありません。
たとえば、(非常に仮説的な) ジョブを実行するために他のルーチンを呼び出すだけのインターフェイスがあります。
def myDo(what, where, why):
if what == 'swim':
doSwim(where, why)
elif what == 'walk':
doWalk(where, why)
...
これで、新しいメソッド「ドライブ」を取得できます:
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 が役立つと思われる良い例の 1 つにすぎません。
優れたサンプルは長い談話よりも優れている場合があるということを踏まえて、すべての 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})
kwargs
in**kwargs
は単なる変数名です。あなたは非常によく持つことができます**anyVariableName
kwargs
「キーワード引数」の略です。しかし、これらは単に名前とともに渡される引数であるため、「名前付き引数」と呼ぶ方がよいと思います(「キーワード引数」という用語の「キーワード」という単語には意味がありません。「キーワード」は通常、プログラミング言語によって予約されている単語であるため、プログラマーが変数名に使用することはできません.kwargsの場合、ここではそのようなことは起こりません.) そのため、関数に渡される 2 つのパラメーター値に、値のみを渡す代わりに、次のように名前
param1
と名前を付けます: 。したがって、これらのパラメーターは任意の数 (つまり、param2
func(param1="val1",param2="val2")
func(val1,val2)
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
カスタム引数のタプルと dict 変数を渡す
最後に、合格できることにも注意してください
したがって、上記と同じ呼び出しを次のように行うことができます。
tupleCustomArgs = ("custom param1", "custom param2", "custom param3")
dictCustomNamedArgs = {"customNamedParam1":"val1", "customNamedParam2":"val2"}
function2("arg1",
*tupleCustomArgs, #note *
param3="arg3",
param2="arg2",
**dictCustomNamedArgs #note **
)
最後に、上記の関数呼び出しに注意*
してください。**
それらを省略すると、悪い結果が生じる可能性があります。
*
タプル引数の省略:
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)
関数定義で指定されていない引数は、キーワード引数であるかどうかに応じて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
kwargsは、名前引数を辞書として(funcの場合)、または辞書を名前付き引数として(funcの場合)渡すための構文糖衣です。
これは私が役立つことを願っている例です:
#! /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
ここで重要なのは、呼び出し内の可変数の名前付き引数が関数内の辞書に変換されることです。