Definieren von DocString -Erhöhungen für Funktionen, die nicht explizit die Ausnahme erhöhen ⇐ Python

[Anonymous]

Code: Select all

import requests

def example():
"""An example function

:raises KeyError: ?
:raises HttpError: ?
"""
result: Dict = do_something()
log(result["key"])
response = requests.get(url)
return response

Die obige Funktion erhöht keine Ausnahme, aber wie zu sehen ist, kann ihre Ausführung keyError und httperror möglicherweise erhöhen. Ist es in Ordnung, diese in Docstring zu erwähnen? Was sagt die Best Practice aus?