Python: erforderlich kwarg, die Ausnahme zu erhöhen?

Ein Weg, um sicherzustellen, dass eine Methode aufgerufen wird, die mit einer bestimmten kwarg wäre wie:

def mymethod(self, *args, **kwargs):
    assert "required_field" in kwargs

Anheben AssertionError scheint nicht der am besten geeignete, was zu tun. Gibt es eine vereinbarte vordefinierte Ausnahme zu handhaben, mit einer netten Fehlermeldung?

Weitere Infos: es gibt 3rd-party-Unterklassen Fragen, wo *args und **kwargs ein bisschen' übergeben werden müssen, so dass "required_field" eine positionelle argument ist nicht wirklich eine gute option.

  • Ich denke, die standard-Sache ist, nicht machen es zu einem "Standard-argument".
  • es gibt bereits positionale Argumente, dass ich nicht zu verwirren wollen mit.
  • Generell gibt es auch Fälle, wurden kwargs kann annehmen darf, zahlreiche Schlüssel, mit denen einige nur erforderlich, wenn bestimmte Bedingungen erfüllt sind, die mit Bezug auf das Vorhandensein oder die Werte der anderen Schlüsselwort-Argumente.
InformationsquelleAutor Skylar Saveland | 2012-11-16
  1. 30
    >>> def foo(bar): pass
... 
>>> foo()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: foo() missing 1 required positional argument: 'bar'

    Ich würde nur gehen mit TypeError..

    InformationsquelleAutor Otto Allmendinger
  2. 16

    +1 für TypeError. Dies ist, was die Python-3-Erhöhungen für erforderlich, die nur aus Keywords Argumente:

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

    (TypeError Vorschlag wurde schon gegeben (und akzeptiert); ich schrieb diese Antwort zu erwähnen, das Python 3-Funktion).

    • Die Erwähnung des Python 3, die nur aus Keywords Argumente, die sehr hilfreich ist hier; Menschen, die vielleicht kommen auf diese Frage denken, Sie tun sollten, exception handling, wenn sich die Sprache selbst unterstützt wird, benötigt Schlüsselwort-Argumente (es sei denn, Sie sind unglücklich genug, stecken mit Python 2, natürlich).
    InformationsquelleAutor Mikhail Korobov
  3. 14

    Die standard-Bibliothek scheint zu erhöhen TypeError wenn es die falsche Anzahl von Argumenten. Das ist im wesentlichen dein problem, also würde ich erhöhen.

    Sagte, **kwargs im wesentlichen füllen Sie für Standard-Argumente die meisten der Zeit, so dass eine erforderliche Standard-argument scheint ein wenig verwunderlich/verwirrend.

    Beachten Sie, dass python-gerne lassen wir Sie rufen positionale Argumente per Schlüsselwort:

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

    aber ich vermute, dass Sie dann alle werden referenziert durch das Schlüsselwort (foo(2, a=2) funktioniert nicht), den Sie nicht wollen.

    • "**kwargs im wesentlichen füllen Sie für die Standard-Argumente, die meiste Zeit". Nicht wirklich. Das ist ein nutzen, aber **kwargs hat mehrere andere wichtige Anwendungen: 1) in den Oberklassen hin statt, wobei Unterklassen können wollen, die sich anders Verhalten, 2) wenn Sie haben eine lange Liste von Argumenten, in denen Sie nicht möchten, dass der client merken, die Reihenfolge der Argumente **kwargs vermeidet eine Menge Kram. Es gibt zweifellos andere, aber diese sind die ersten, die mir einfallen. Der ehemalige (Oberklasse) war, was darin endete, was mich zu diesem thread.
    InformationsquelleAutor mgilson
  4. 0

    Wenn Sie benötigen, um ein erforderliches Schlüsselwort, etwas zu tun:

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

    Sollten Sie nicht wirklich brauchen, ziehen Sie es aus kwargs.

    • fügen Sie einfach *args,**kwargs 🙂
    InformationsquelleAutor IT Ninja
  5. 0

    Ich denke KeyError am besten geeignet wäre, weil **kwargs ist ein dict. 

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

    Wenn das Feld tatsächlich erforderlich sind, Sie könnte prüfen, denn es

    try:
  kwargs['required']
except KeyError:
  raise KeyError('required is a Required Argument')
    • KeyError gilt in der Regel direkt auf eine Datenstruktur, in der Erwägung, dass die OP informieren möchte einen Missbrauch der Funktion, die Unterschrift.
    InformationsquelleAutor munk
Schreibe einen Kommentar