Pythonで** kwargsを使用する適切な方法

適切な使用方法は何ですか **kwargsデフォルト値に関して、Pythonでですか？

kwargs辞書を返しますが、デフォルト値を設定する最良の方法は何ですか、またはそれはありますか？辞書としてアクセスするだけですか？get関数を使用しますか？

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

簡単な質問ですが、良いリソースを見つけることができません。人々は私が見たコードでそれをさまざまな方法で行っており、何を使用するかを知るのは困難です。

get()辞書にないキーのデフォルト値を渡すことができます：

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

ただし、特定のデフォルト値で特定の引数を使用する場合は、最初に名前付き引数を使用しないのはなぜですか？

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

ほとんどの答えはそれを言っているが、例えば、

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

「と同じ」

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

本当じゃない。後者の場合fはとして呼び出すことができますがf(23, 42)、前者の場合は名前付き引数のみを受け入れます-位置呼び出しは行いません。多くの場合、発信者に最大限の柔軟性を許可する必要があるため、ほとんどの回答が主張するように、2番目の形式が望ましいですが、常にそうであるとは限りません。多くのオプションのパラメーターを受け入れる場合、通常はいくつかしか渡されませんが、名前付き引数の使用を強制することは優れたアイデアである可能性があります（事故や読み取り不能なコードを回避する！）threading.Thread。最初の形式は、Python 2でそれを実装する方法です。

このイディオムは非常に重要なので、Python 3では特別なサポート構文が追加さ*れました。defシグネチャ内のシングルの後のすべての引数はキーワードのみです。つまり、位置引数として渡すことはできず、名前付き引数としてのみ渡すことができます。したがって、Python 3では、上記を次のようにコーディングできます。

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

実際、Python 3では、オプションではないキーワードのみの引数（デフォルト値のない引数）を使用することもできます。

ただし、Python 2にはまだ長年の生産性があるため、Python 3の言語で直接サポートされている重要な設計アイデアをPython 2に実装できるようにする手法とイディオムを忘れないようにしてください。

私はこのようなものを提案します

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上書きします。

あなたがします

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

または

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

を使用popする場合は、偽の値が送信されていないかどうかを確認し、適切なアクション（ある場合）を実行できます。

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

**kwargs引数の数が不明な場合に使用されるので、なぜこれを行わないのですか？

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

ここに別のアプローチがあります：

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)

**kwargsPythonでデフォルト値を使用する適切な方法はsetdefault、以下に示すように、辞書メソッドを使用することだと思います。

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

このように、ユーザーがキーワードargsに「val」または「val2」を渡すと、それらが使用されます。それ以外の場合は、設定されているデフォルト値が使用されます。

あなたはこのようなことをすることができます

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

setattrの使用に関する@srhegde提案のフォローアップ：

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リスト内のすべての項目を持つことが期待される場合に役立ちます。

これを* argsと組み合わせる場合は、定義の最後に* argsと** kwargsを保持する必要があります。

そう：

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

@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、デフォルトでは発生しません。引数の名前を含みます。

不明な引数または複数の引数を処理するための別の簡単な解決策は、

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は、任意の数のキーワード引数を自由に追加できます。デフォルト値を設定できるキーのリストがあるかもしれません。ただし、不特定の数のキーのデフォルト値を設定する必要はないようです。最後に、キーをインスタンス属性として持つことが重要な場合があります。だから、私はこれを次のように行います：

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)