Python Docstring: raise vs. raiseses

Question

Używam IDC PyCharm, który pomaga w tworzeniu documentów zgodnych z PEP0257. Zapewnia ona dwa atrybuty nie całkowicie zrozumieć różnicę pomiędzy/użycia:

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

Kiedy użyłbym raise jak sprzeciwia się raises w moim docstring? W szczególności, jeśli klasa wymagała argumentu, który nie został dostarczony i podniósł TypeError, który powinien zostać użyty do udokumentowania tego?

Answer 1

TL; DR

raises jest używane do opisania, że ​​możliwe odstępstwa podniesiony. raise jest rozpoznawany przez Sphinx podczas uruchamiania autodoc i jest taki sam jak raises.

pełne wyjaśnienie

pycharm pomaga w użyciu kilku różnych stylów docstring komentarze.

Trzy których często używam to:

1. NumPy Format
2. Google Format
3. Sphinx (znacznie bardziej niż format)

We wszystkich z nich znajduje się specjalna sekcja dla Raises które można zobaczyć w starszej wersji testów kodu PyCharm:

1. Simple NumPy
2. Simple Google

Implementacja SphinxDocString możemy see here tam istnieje wiele słów kluczowych, które mogą być uznane. Tagi te następnie link do listy RAISES_TAGS, które można znaleźć here.

Mam nadzieję, że ta informacja jest przydatna.