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

问题描述：

**kwargs当谈到默认值时，在 Python 中正确的使用方法是什么？

kwargs返回一个字典，但设置默认值的最佳方法是什么，或者有一种方法吗？我应该将其作为字典访问吗？使用get函数？

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

据我所知，人们在代码中使用不同的方法，很难知道该使用哪种。

解决方案 1：

get()您可以为字典中没有的键传递一个默认值：

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

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

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

解决方案 2：

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

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 语言中直接支持的重要设计思想的技术和习语！

解决方案 3：

我建议这样的

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覆盖任何重复的键。

解决方案 4：

你会这样做

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

或者

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

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

解决方案 5：

使用 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" )

解决方案 6：

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

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

解决方案 7：

这是另一种方法：

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)

解决方案 8：

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

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

这样，如果用户在关键字中传递了‘val’或‘val2’ args，那么将使用它们；否则，将使用已设置的默认值。

解决方案 9：

按照@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。

解决方案 10：

你可以做这样的事情

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

解决方案 11：

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

所以：

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

解决方案 12：

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

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

解决方案 13：

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

解决方案 14：

@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默认值中未出现的参数名称。