** kwargsの目的と用途は何ですか?


763

**kwargsPython の用途は何ですか?

私はあなたがobjects.filterテーブルでを行い、**kwargs引数を渡すことができることを知っています。  

時間デルタを指定するためにこれを行うこともできますtimedelta(hours = time1)か?

正確にはどのように機能しますか?「開梱」のクラスですか?のようにa,b=1,2


27
私としてこの質問にぶつかった
sumid

3
非常に簡潔な説明をここに:「*収集タプル内のすべての位置引数」、「**収集辞書内のすべてのキーワード引数」。キーワードはcollectsです。
osa

24
Just FYI:kwargsKeyWord ARGumentS、つまりキーを設定した引数を意味します
Richard de Wit

回答:


868

を使用**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()を使用してください。


1
@ yashas123いいえ。空の何かをループしても何も起こらないので、次に来るコードは通常通り実行されます。
JG、

330

辞書の解凍

** 辞書を解凍します。

この

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)

13
kwargは単なる変数名ですか?だから私はdef func(** args)を使用できます:そしてそれはwudの仕事ですか?
スリラム

11
@スリラム:そうです。アスタリスクは重要です。kwargsは、これ以上ない場合に付ける名前です。(通常はあります。)
GeorgSchölly11年

54
@Sriram:読みやすさのために、kwargsに固執する必要があります-他のプログラマーはそれを高く評価します。
johndodo

12
** do unpack dictionaries.>>心を吹き飛ばさ/もちろん!そのビットを説明するための+1。
Marc

13
注:.iteritems()名前に変更された.items()のPython 3に
fnkr

67

kwargsは、パラメーターに追加される単なる辞書です。

辞書には、キーと値のペアを含めることができます。そしてそれがクワーグです。わかりました、これは方法です。

目的はそれほど単純ではありません。

たとえば(非常に架空のもの)たとえば、ジョブを実行するために他のルーチンを呼び出すだけのインターフェイスがあります。

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が役立つと思われる良い例の1つにすぎません。


46

良いサンプルが長い談話よりも優れている場合があることを踏まえて、すべての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})

28

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、必要な場所に適切な値を配置することでインテリジェントに動作します


24
  • kwargsin **kwargsは単なる変数名です。あなたはとてもよく持つことができます**anyVariableName
  • kwargs「キーワード引数」を表します。しかし、これらは名前付きで渡される単なる引数なので、「名前付き引数」と呼ぶ方がよいと思います(「キーワード引数」という用語の「キーワード」という単語には何の意味もありません。「キーワード」は通常、プログラミング言語で予約されているため、プログラマが変数名に使用しない単語です。kwargsの場合、このようなことはここでは発生しません。したがって、次のように名前 param1param2関数に渡される2つのパラメーター値を指定します:func(param1="val1",param2="val2")値のみを渡すのではなく:func(val1,val2)。したがって、これらのパラメーターはいくつでも指定できるため(つまり、任意の数の名前付き引数)、適切に呼び出す必要があると感じます(つまり、funcfunc(**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

  • 関数パラメーターのシーケンス:
    1. 位置パラメータ
    2. 任意の数の引数をキャプチャする仮パラメーター(接頭辞*)
    3. 名前付き仮パラメーター
    4. 任意の数の名前付きパラメーターをキャプチャする仮パラメーター(接頭辞**)
  • 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変数を渡す

それを完了するために、私たちが渡すことができることにも注意させてください

  • タプル変数として「任意の数の引数をキャプチャする仮パラメータ」と
  • 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

3
私は想像keywordする用語は、あなたがキーと値のペアのデータベースで辞書に渡しているという事実から来ています。
クロバー

「key」-valueペアの「key」単語を意味しますか?また、通常はデータベースと呼ばれていませんが、辞書です。しかし、それでも「キーワード」という単語の使用に意味を見つけることはできません。
Mahesha999 2017年

9

さらに、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は最後の引数でなければならないことに注意してください


5

kwargsは名前引数を辞書(funcの場合)として、または辞書を名前付き引数(funcの場合)として渡す構文上の砂糖です。


5

使い方を説明するのに役立つ簡単な関数は次のとおりです。

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

1

これが私が役に立つと思う例です:

#! /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

ここで重要なのは、呼び出しでの可変数の名前付き引数が関数の辞書に変換されることです。


0

これは、Pythonの解凍について理解するための簡単な例です。

>>> def f(*args, **kwargs):
...    print 'args', args, 'kwargs', kwargs

例1:

>>>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

0

Javaでは、コンストラクターを使用してクラスをオーバーロードし、複数の入力パラメーターを許可します。Pythonでは、kwargsを使用して同様の動作を提供できます。

Javaの例:https : //beginnersbook.com/2013/05/constructor-overloading/

pythonの例:

class Robot():
    # name is an arg and color is a kwarg
    def __init__(self,name, color='red'):
        self.name = name
        self.color = color

red_robot = Robot('Bob')
blue_robot = Robot('Bob', color='blue')

print("I am a {color} robot named {name}.".format(color=red_robot.color, name=red_robot.name))
print("I am a {color} robot named {name}.".format(color=blue_robot.color, name=blue_robot.name))

>>> I am a red robot named Bob.
>>> I am a blue robot named Bob.

それについて考えるためのちょうど別の方法。


0

Python では、キーワード引数は多くの場合kwargsに短縮されます。では、コンピュータプログラミング

キーワード引数は、関数呼び出し内の各パラメーターの名前を明確に示す関数呼び出しに対するコンピューター言語のサポートを参照します。

パラメータ名** kwargsの前にある2つのアスタリスクの使い方は、関数に渡されるキーワード引数の数がわからない場合です。その場合は、任意/ワイルドカードキーワード引数と呼ばれます。

この1つの例は、Djangoのレシーバー関数です。

def my_callback(sender, **kwargs):
    print("Request finished!")

この関数は、ワイルドカードキーワード引数(** kwargs)とともに送信者引数を取ることに注意してください。すべてのシグナルハンドラはこれらの引数を取る必要があります。すべてのシグナルはキーワード引数を送信し、いつでもそれらのキーワード引数を変更する可能性があります。request_finishedの場合、引数を送信しないと記載されています。つまり、my_callback(sender)として信号処理を記述したくなるかもしれません。

これは誤りです。実際、Djangoはエラーをスローします。これは、いつでも引数が信号に追加される可能性があり、レシーバーがそれらの新しい引数を処理できる必要があるためです。

kwargsと呼ばれる必要はありませんが、**が必要です(kwargsという名前は慣習です)。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.