Cách sử dụng đúng ** kwargs trong Python

Cách thích hợp để sử dụng **kwargstrong Python khi nói đến các giá trị mặc định là gì?

kwargstrả về một từ điển, nhưng cách tốt nhất để đặt các giá trị mặc định là gì? Tôi có nên truy cập nó như một từ điển? Sử dụng chức năng get?

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

Một câu hỏi đơn giản, nhưng một câu hỏi mà tôi không thể tìm thấy tài nguyên tốt. Mọi người thực hiện theo nhiều cách khác nhau trong mã mà tôi đã thấy và thật khó để biết nên sử dụng cái gì.

Bạn có thể chuyển một giá trị mặc định get()cho các khóa không có trong từ điển:

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

Tuy nhiên, nếu bạn có kế hoạch sử dụng một đối số cụ thể với một giá trị mặc định cụ thể, tại sao không sử dụng các đối số được đặt tên ở vị trí đầu tiên?

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

Trong khi hầu hết các câu trả lời đang nói rằng, ví dụ,

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

là "giống như"

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

Đây không phải là sự thật. Trong trường hợp sau, fcó thể được gọi là f(23, 42), trong khi các trường hợp trước đây chấp nhận tên đối số duy nhất - không có cuộc gọi vị trí. Thường thì bạn muốn cho phép người gọi linh hoạt tối đa và do đó, hình thức thứ hai, như hầu hết các câu trả lời khẳng định, là thích hợp hơn: nhưng điều đó không phải lúc nào cũng đúng. Khi bạn chấp nhận nhiều tham số tùy chọn trong đó thường chỉ có một vài thông số được thông qua, đó có thể là một ý tưởng tuyệt vời (tránh tai nạn và mã không thể đọc được tại các trang web cuộc gọi của bạn!) Để buộc sử dụng các đối số được đặt tên - threading.Threadlà một ví dụ. Hình thức đầu tiên là cách bạn triển khai nó trong Python 2.

Các thành ngữ là quan trọng đến nỗi bằng Python 3 nó bây giờ có cú pháp hỗ trợ đặc biệt: mọi lý luận sau khi một đơn *trong defchữ ký là từ khóa mà thôi, có nghĩa là, không thể được thông qua như là một đối số vị trí, nhưng chỉ như một tên. Vì vậy, trong Python 3, bạn có thể mã ở trên là:

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

Thật vậy, trong Python 3, bạn thậm chí có thể có các đối số chỉ từ khóa không phải là tùy chọn (những đối số không có giá trị mặc định).

Tuy nhiên, Python 2 vẫn còn nhiều năm hoạt động lâu dài, vì vậy tốt hơn hết là đừng quên các kỹ thuật và thành ngữ cho phép bạn thực hiện trong Python 2 ý tưởng thiết kế quan trọng được hỗ trợ trực tiếp bằng ngôn ngữ trong Python 3!

Tôi đề nghị một cái gì đó như thế này

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

Và sau đó sử dụng các giá trị theo bất kỳ cách nào bạn muốn

dictionaryA.update(dictionaryB)thêm nội dung dictionaryBđể dictionaryAghi đè bất kỳ khóa trùng lặp.

Bạn sẽ làm

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

hoặc là

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

Nếu bạn sử dụng pop, thì bạn có thể kiểm tra xem có bất kỳ giá trị giả nào được gửi không và thực hiện hành động thích hợp (nếu có).

Sử dụng ** kwargs và các giá trị mặc định rất dễ dàng. Tuy nhiên, đôi khi, bạn không nên sử dụng ** kwargs ở nơi đầu tiên.

Trong trường hợp này, chúng tôi không thực sự sử dụng ** kwargs tốt nhất.

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

Trên đây là một "tại sao phải bận tâm?" tờ khai. Nó giống như

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

Khi bạn đang sử dụng ** kwargs, bạn có nghĩa là một từ khóa không chỉ là tùy chọn, mà còn có điều kiện. Có các quy tắc phức tạp hơn các giá trị mặc định đơn giản.

Khi bạn đang sử dụng ** kwargs, bạn thường có nghĩa giống như sau, trong đó mặc định đơn giản không áp dụng.

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

Vì **kwargsđược sử dụng khi số lượng đối số không xác định, tại sao không làm điều này?

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

Đây là một cách tiếp cận khác:

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)

Tôi nghĩ rằng cách thích hợp để sử dụng **kwargstrong Python khi nói đến các giá trị mặc định là sử dụng phương thức từ điển setdefault, như được đưa ra dưới đây:

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

Theo cách này, nếu người dùng vượt qua 'val' hoặc 'val2' trong từ khóa args, họ sẽ được sử dụng; mặt khác, các giá trị mặc định đã được đặt sẽ được sử dụng.

Bạn có thể làm một cái gì đó như thế này

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

Theo dõi đề xuất @srhegde về việc sử dụng 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]

Biến thể này hữu ích khi lớp dự kiến ​​sẽ có tất cả các mục trong acceptabledanh sách của chúng tôi .

Nếu bạn muốn kết hợp điều này với * args, bạn phải giữ * args và ** kwargs ở cuối định nghĩa.

Vì thế:

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

@AbhinavGupta và @Steef đã đề xuất sử dụng update(), điều mà tôi thấy rất hữu ích để xử lý danh sách đối số lớn:

args.update(kwargs)

Điều gì xảy ra nếu chúng tôi muốn kiểm tra xem người dùng đã không vượt qua bất kỳ đối số giả / không được hỗ trợ nào? @VinaySajip chỉ ra rằng pop()có thể được sử dụng để xử lý lặp lại danh sách các đối số. Sau đó, bất kỳ đối số còn lại là giả mạo. Đẹp.

Đây là một cách có thể khác để làm điều này, đó là giữ cú pháp đơn giản của việc sử dụng 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_argslà một settên chứa các đối số không xảy ra trong mặc định.

Một giải pháp đơn giản khác để xử lý các đối số chưa biết hoặc nhiều đối số có thể là:

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

** kwargs cho phép tự do thêm bất kỳ số lượng đối số từ khóa. Người ta có thể có một danh sách các khóa mà anh ta có thể đặt các giá trị mặc định. Nhưng việc thiết lập các giá trị mặc định cho số lượng khóa không xác định có vẻ không cần thiết. Cuối cùng, điều quan trọng là có các khóa làm thuộc tính thể hiện. Vì vậy, tôi sẽ làm điều này như sau:

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)