** kwargs的目的和用途是什么?

时间:2009-11-20 09:40:57

标签: python kwargs

Python中**kwargs有什么用途?

我知道你可以在桌面上做objects.filter并传入一个**kwargs参数。

我是否也可以指定时间增量,即timedelta(hours = time1)

它究竟是如何运作的?这类是“解包”吗?喜欢a,b=1,2

13 个答案:

答案 0 :(得分:813)

您可以使用**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 Tutorial包含一个很好的解释,它包含一些不错的例子。

< - 更新 - >

对于使用Python 3而不是iteritems()的人,请使用items()

答案 1 :(得分:306)

解包词典

**解包词典。

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)

答案 2 :(得分:60)

kwargs只是一个添加到参数中的字典。

字典可以包含键值对。这就是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)

但是等一下,有一个新参数“车辆” - 你之前不知道。现在你必须将它添加到myDo函数的签名中。

在这里,您可以将kwargs投入游戏 - 您只需将kwargs添加到签名中:

def myDo(what, where, why, **kwargs):
   if what == 'drive':
      doDrive(where, why, **kwargs)
   elif what == 'swim':
      doSwim(where, why, **kwargs)

这样,每次调用的某些例程可能会发生变化时,您无需更改接口函数的签名。

这只是一个很好的例子,你可以找到有用的kwargs。

答案 3 :(得分:46)

基于好的样本有时候比长话语更好,我将使用所有python变量参数传递工具(位置和命名参数)编写两个函数。您应该能够轻松地自己查看它的作用:

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

答案 4 :(得分:25)

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:两个
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:两个
arg3:3

底线:*args没有智能,它只是将传递的参数插入参数(按从左到右的顺序),而**kwargs通过在适当的值@所需位置智能地表现< / p>

答案 5 :(得分:20)

    kwargs中的
  • **kwargs只是变量名称。你很可能有**anyVariableName
  • kwargs代表“关键字参数”。但我认为最好将它们称为“命名参数”,因为这些只是与名称一起传递的参数(我在“关键字参数”一词中找不到“关键字”这个词的任何意义。我猜“关键字”通常意味着由编程语言保留的单词,因此不被程序员用于变量名。在kwargs的情况下,这里不会发生这样的事情。)所以我们给出了名字 param1param2传递给函数的两个参数值如下:func(param1="val1",param2="val2"),而不是仅传递值func(val1,val2)。因此,我认为它们应该被恰当地称为“任意数量的命名参数”,因为如果func具有签名{{1},我们可以指定任意数量的这些参数(即参数) }

所以说,让我首先解释“命名参数”,然后解释“任意数量的命名参数”func(**kwargs)

命名参数

  • 命名args应该遵循位置args
  • 命名args的顺序并不重要
  • 实施例

    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'

  • 功能参数序列:
    1. 位置参数
    2. 形式参数捕获任意数量的参数(以*为前缀)
    3. 命名形式参数
    4. 形式参数捕获任意数量的命名参数(前缀为**)
  • 实施例

    kwargs

传递自定义参数的元组和字典变量

为了完成它,我还要注意,我们可以通过

  • “正式参数捕获任意数量的参数”作为元组变量和
  • “正式参数捕获任意数量的命名参数”作为dict变量

因此,上述相同的调用可以如下进行:

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

最后在上面的函数调用中注意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') args:

dict

给出

function2("arg1",
      *tupleCustomArgs,   
      param3="arg3",
      param2="arg2", 
      dictCustomNamedArgs   #omitting **
      )

答案 6 :(得分: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必须是最后一个参数

答案 7 :(得分:5)

这是一个简单的函数,用于解释用法:

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

答案 8 :(得分:5)

kwargs是一个语法糖,用于将名称参数作为字典(用于func)或字典作为命名参数(用于func)

答案 9 :(得分: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

这里的关键是,调用中可变数量的命名参数转换为函数中的字典。

答案 10 :(得分:1)

关键字参数通常在Python中缩短为 kwargs 。在computer programming中,

关键字参数是指计算机语言对功能的支持 明确指出每个参数名称的调用 函数调用。

在参数名称​​ ** kwargs 之前使用两个星号是指不知道将多少个关键字参数传递给该函数的情况。在这种情况下,它称为任意/通配符关键字参数。

一个例子是Django's receiver functions

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

请注意,该函数带有sender参数以及通配符 关键字参数(** kwargs);所有信号处理程序必须将这些 论点。 所有信号都会发送关键字参数,并且可能会更改这些参数 关键字参数。对于request_finished,它是 记录为不发送任何参数,这意味着我们可能会被诱惑 将信号处理写为my_callback(sender)。

这是错误的-实际上,如果您这样做,Django将抛出错误 所以。那是因为在任何时候都可以将参数添加到 信号,并且您的接收器必须能够处理这些新参数。

请注意,它不必称为 kwargs ,但它必须具有**(名称​​ kwargs 是一个约定)。

答案 11 :(得分:0)

这是一个简单的示例,可了解有关 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

答案 12 :(得分: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.

另一种思考方式。