Python Docstring: élever contre soulève

- Je utiliser le PyCharm IDE qui aide à l'artisanat PEP0257 conforme docstrings. Il fournit deux attributs que je n'est pas tout à fait comprendre la distinction/utilisation entre:

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

Quand dois-je utiliser raise comme s'oppose à raises dans mon docstring? Plus précisément, si une classe a exigé un argument qui n'a pas été fourni et pose une TypeError, qui devrait servir de document?

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

    TL;DR

    raises est utilisé pour décrire les exceptions soulevées. raise est reconnu par Sphinx lors de l'exécution de autodoc et est le même que raises.

    Explication Complète

    PyCharm aide dans l'utilisation de différents styles de docstring commentaires.

    Trois que j'utilise souvent sont:

    1. NumPy Format
    2. Google Format
    3. Sphinx (beaucoup plus qu'un format de)

    Dans tous ces il y a une section spéciale pour les Raises vous pouvez le voir dans une version plus ancienne de la PyCharm code tests:

    1. Simple NumPy
    2. Simple Google

    La mise en œuvre de SphinxDocString nous pouvons voir ici là il y a de nombreux mots-clés qui peuvent être reconnus. Ces balises lien vers la liste des RAISES_TAGS qui peut être trouvé ici.

    J'espère que cette information est utile.

    InformationsquelleAutor erik-e