Python：必要なkwarg、発生する例外はありますか？ <code>AssertionError</code>を上げることは行うには、最も適切なもののように見えるしていません</p> <pre><code>def mymethod(self, *args, **kwargs): assert "required_field" in kwargs </code></pre> <p>：メソッドは、特定のkwargで呼び出されることを保証する

Question

一つの方法は次のようになります。良いエラーメッセージでこれを処理するための合意された組み込み例外がありますか？

詳細情報：サードパーティのサブクラス化の問題があります。* argsと** kwargsを渡す必要があるため、 "required_field"を位置指定することは本当に良い選択肢ではありません。

Answer 1

>>> def foo(bar): pass 
... 
>>> foo() 
Traceback (most recent call last): 
    File "<stdin>", line 1, in <module> 
TypeError: foo() missing 1 required positional argument: 'bar' 

私は標準ライブラリが、それは間違った数の引数を取得するときにTypeErrorを上げたいようだ。..

Answer 2

TypeError例外で行くと思います。それは本質的にあなたの問題なので、私はそれを上げます。

つまり、**kwargsは、ほとんどの場合デフォルトの引数を入力するため、必要なデフォルトの引数はほとんど驚くべき/紛らわしいようです。

>>> def foo(a, b): 
...  print a, b 
... 
>>> foo(a=1, b=2) 
1 2 
>>> foo(b=1, a=2) 
2 1 

が、私は、彼らが すべては（ foo(2, a=2)が動作しません）キーワードによって参照する必要があるとし、あなたがいないことがあります。Pythonは喜んであなたがキーワードで位置引数を呼び出すようになることを

注意欲しいです。

Answer 3

あなたはそれが必要なキーワードをする必要がある場合は、ような何か：

def mymethod(self,myrequired=None): 
    if myrequired==None: 
     #raise error 
    #do other stuff down here 

をあなたは本当にkwargsからからそれをプルする必要があるはずの。

Answer 4

**kwargsがdictなので、KeyErrorが最も適切だと思います。フィールドが実際に必要とされる場合

>>> def foo(**kwargs): 
... print kwargs['abc'] 
... 
>>> foo() 
Traceback (most recent call last): 
    File "<stdin>", line 1, in <module> 
    File "<stdin>", line 2, in foo 
KeyError: 'abc' 

することは、あなたはTypeError例外のためにそれ

try: 
    kwargs['required'] 
except KeyError: 
    raise KeyError('required is a Required Argument')  

Answer 5

+1をチェックすることができます。

>>> def foo(*, x): 
...  pass 
... 
>>> foo() 
Traceback (most recent call last): 
    File "<stdin>", line 1, in <module> 
TypeError: foo() needs keyword-only argument x 
>>> foo(2) 
Traceback (most recent call last): 
    File "<stdin>", line 1, in <module> 
TypeError: foo() takes exactly 0 positional arguments (1 given) 
>>> foo(x=2) 

（;私はこのPythonの3機能を言及するために、この答えを書いてはTypeErrorの提案がすでに）与えられた（と受け入れられた）：これは、Python 3が必要なキーワードのみの引数に対して提起するものです。