Python Docstring: raise vs. wirft

Ich die PyCharm IDE hilft mit crafting PEP0257-konform docstrings. Es enthält zwei Attribute, die ich nicht ganz verstehen, die Unterscheidung zu/zwischen:

  • :raise Exception: exception explanation here
  • :raises Exception: exception explanation here

Wenn würde ich raise als gegen raises in meinem docstring? Speziell, wenn eine Klasse benötigt ein argument, das war nicht vorgesehen, und wirft eine TypeError, die verwendet werden sollten, um das zu dokumentieren?

InformationsquelleAutor Bob Dylan | 2015-12-08
  1. 56

    TL;DR

    raises wird verwendet, um zu beschreiben, die möglichen Ausnahmen, die ausgelöst wird. raise ist anerkannt durch Sphinx beim laufen autodoc und ist das gleiche wie raises.

    Vollständige Erklärung

    PyCharm hilft, mit ein paar verschiedene Arten von docstring-Kommentare.

    Drei, die ich oft benutze sind:

    1. NumPy-Format
    2. Google-Format
    3. Sphinx (viel mehr als ein format)

    In all diesen gibt es einen besonderen Abschnitt für Raises denen Sie sehen können, die in einer älteren version von PyCharm-code-tests:

    1. Einfach NumPy
    2. Einfach Google

    Umsetzung für SphinxDocString können wir siehe hier dort gibt es zahlreiche Schlagworte, die erkannt werden können. Diese tags dann den link zu der Liste der RAISES_TAGS gefunden werden kann hier.

    Ich hoffe, diese Informationen nützlich ist.

    InformationsquelleAutor erik-e
Schreibe einen Kommentar