在Python中使用**kwargs的正确方法

问题描述 投票：0回答：14

当涉及到默认值时，在 Python 中使用 

**kwargs
的正确方法是什么？

kwargs
返回一本字典，但是设置默认值的最佳方法是什么？或者有没有一种方法？我应该把它当作字典来访问吗？使用获取函数？ 

class ExampleClass:
    def __init__(self, **kwargs):
        self.val = kwargs['val']
        self.val2 = kwargs.get('val2')

一个简单的问题，但我找不到好的资源。我见过人们在代码中采用不同的方式来实现这一点，但很难知道该使用什么。

python default-value keyword-argument
14个回答
631
投票

您可以将默认值传递给

get()
，用于不在字典中的键：

self.val2 = kwargs.get('val2',"default value")

但是，如果您计划使用具有特定默认值的特定参数，为什么不首先使用命名参数呢？

def __init__(self, val2="default value", **kwargs):
307
投票

虽然大多数答案都这么说，例如，

def f(**kwargs):
    foo = kwargs.pop('foo')
    bar = kwargs.pop('bar')
    ...etc...

“与”相同

def f(foo=None, bar=None, **kwargs):
    ...etc...

这不是真的。在后一种情况下，

f
可以被称为
f(23, 42)
，而前一种情况仅接受命名参数——没有位置调用。通常，您希望为调用者提供最大的灵活性，因此，正如大多数答案所断言的那样，第二种形式是更好的：但情况并非总是如此。当您接受许多可选参数（通常只传递少数参数）时，强制使用命名参数可能是一个好主意（避免调用站点发生意外和不可读的代码！） - 
threading.Thread
就是一个例子。第一种形式是如何在 Python 2 中实现它。

这个习惯用法非常重要，以至于在 Python 3 中它现在有了特殊的支持语法：

*
签名中单个 
def
之后的每个参数都是关键字，也就是说，不能作为位置参数传递，而只能作为一个有名字的人。所以在 Python 3 中你可以将上面的代码编码为：

def f(*, foo=None, bar=None, **kwargs):
    ...etc...

事实上，在 Python 3 中，您甚至可以拥有不是可选的仅关键字参数（没有默认值的参数）。

但是，Python 2 仍有很长的生产寿命，因此最好不要忘记让您在 Python 2 中实现 Python 3 语言直接支持的重要设计思想的技术和习惯用法！

105
投票

我建议这样

def testFunc( **kwargs ):
    options = {
            'option1' : 'default_value1',
            'option2' : 'default_value2',
            'option3' : 'default_value3', }

    options.update(kwargs)
    print options

testFunc( option1='new_value1', option3='new_value3' )
# {'option2': 'default_value2', 'option3': 'new_value3', 'option1': 'new_value1'}

testFunc( option2='new_value2' )
# {'option1': 'default_value1', 'option3': 'default_value3', 'option2': 'new_value2'}

然后以任何你想要的方式使用这些值

dictionaryA.update(dictionaryB)
将 
dictionaryB
的内容添加到 
dictionaryA
，覆盖任何重复的键。

64
投票

你会的

self.attribute = kwargs.pop('name', default_value)

或

self.attribute = kwargs.get('name', default_value)

如果您使用

pop
，那么您可以检查是否发送了任何虚假值，并采取适当的操作（如果有）。

53
投票

使用 **kwargs 和默认值很容易。然而，有时，您一开始就不应该使用 **kwargs。

在这种情况下，我们并没有真正充分利用 **kwargs。

class ExampleClass( object ):
    def __init__(self, **kwargs):
        self.val = kwargs.get('val',"default1")
        self.val2 = kwargs.get('val2',"default2")

以上是“何必呢？”宣言。是一样的

class ExampleClass( object ):
    def __init__(self, val="default1", val2="default2"):
        self.val = val
        self.val2 = val2

当您使用 **kwargs 时，您的意思是关键字不仅是可选的，而且是有条件的。有比简单的默认值更复杂的规则。

当您使用 **kwargs 时，您通常意味着类似于以下内容，其中简单的默认值不适用。

class ExampleClass( object ):
    def __init__(self, **kwargs):
        self.val = "default1"
        self.val2 = "default2"
        if "val" in kwargs:
            self.val = kwargs["val"]
            self.val2 = 2*self.val
        elif "val2" in kwargs:
            self.val2 = kwargs["val2"]
            self.val = self.val2 / 2
        else:
            raise TypeError( "must provide val= or val2= parameter values" )
50
投票

既然

**kwargs
是在参数数量未知时使用的，为什么不这样做呢？

class Exampleclass(object):
  def __init__(self, **kwargs):
    for k in kwargs.keys():
       if k in [acceptable_keys_list]:
          self.__setattr__(k, kwargs[k])
19
投票

这是另一种方法：

def my_func(arg1, arg2, arg3):
    ... so something ...

kwargs = {'arg1': 'Value One', 'arg2': 'Value Two', 'arg3': 'Value Three'}
# Now you can call the function with kwargs like this:

my_func(**kwargs)
19
投票

我认为在Python中使用

**kwargs
默认值的正确方法是使用字典方法
setdefault
，如下所示：

class ExampleClass:
    def __init__(self, **kwargs):
        kwargs.setdefault('val', value1)
        kwargs.setdefault('val2', value2)

这样，如果用户在关键字

args
中传递'val'或'val2'，它们就会被使用；否则，将使用已设置的默认值。

16
投票

跟进@srhegde使用setattr的建议：

class ExampleClass(object):
    __acceptable_keys_list = ['foo', 'bar']

    def __init__(self, **kwargs):
        [self.__setattr__(key, kwargs.get(key)) for key in self.__acceptable_keys_list]

当班级预计拥有我们的 

acceptable
列表中的所有项目时，此变体非常有用。

14
投票

你可以做这样的事情

class ExampleClass:
    def __init__(self, **kwargs):
        arguments = {'val':1, 'val2':2}
        arguments.update(kwargs)
        self.val = arguments['val']
        self.val2 = arguments['val2']
7
投票

如果你想将它与 *args 结合起来，你必须在定义的末尾保留 *args 和 **kwargs。

所以：

def method(foo, bar=None, *args, **kwargs):
    do_something_with(foo, bar)
    some_other_function(*args, **kwargs)
3
投票

处理未知或多个参数的另一个简单解决方案可以是：

class ExampleClass(object):

    def __init__(self, x, y, **kwargs):
      self.x = x
      self.y = y
      self.attributes = kwargs

    def SomeFunction(self):
      if 'something' in self.attributes:
        dosomething()
2
投票

**kwargs 可以自由添加任意数量的关键字参数。人们可能有一个可以为其设置默认值的键列表。但为无限数量的键设置默认值似乎没有必要。最后，将键作为实例属性可能很重要。所以，我会这样做：

class Person(object):
listed_keys = ['name', 'age']

def __init__(self, **kwargs):
    _dict = {}
    # Set default values for listed keys
    for item in self.listed_keys: 
        _dict[item] = 'default'
    # Update the dictionary with all kwargs
    _dict.update(kwargs)

    # Have the keys of kwargs as instance attributes
    self.__dict__.update(_dict)
1
投票

@AbhinavGupta 和 @Steef 建议使用 

update()
，我发现这对于处理大型参数列表非常有帮助：

args.update(kwargs)

如果我们想检查用户是否传递了任何虚假/不支持的参数怎么办？ @VinaySajip 指出 

pop()
可用于迭代处理参数列表。那么，任何剩下的论点都是虚假的。不错。

这是另一种可能的方法，它保留了使用 

update()
的简单语法：

# kwargs = dictionary of user-supplied arguments
# args = dictionary containing default arguments

# Check that user hasn't given spurious arguments
unknown_args = user_args.keys() - default_args.keys()
if unknown_args:
    raise TypeError('Unknown arguments: {}'.format(unknown_args))

# Update args to contain user-supplied arguments
args.update(kwargs)


unknown_args
是一个 
set
，包含默认值中未出现的参数名称。

最新问题
© www.soinside.com 2019 - 2024. All rights reserved.