Я работаю над несколькими модулями Python, методы которых (по замыслу) не перехватывают исключения из функций, вызываемых в их теле. Насколько я понимаю результаты моего исследования, вы должны документировать любые соответствующие исключения в блоках docstring :raises ...:, в моем случае, в первую очередь, чтобы помочь пользователям или их IDE, а не для автоматического документирования.
Как показано в примере ниже, мне придется повторить блоки :raises ...: несколькими методами с одной и той же информацией:
< pre class="lang-none Prettyprint-override">def myFunction(param1, param2):
"""
:param str param1: first parameter...
:param int param2: second parameter...
:return void:
:raises MyException1: in case...
:raises MyException2: (from myFunction2) in case...
:raises ValueError: (from myFunction3) in case...
"""
if param1 is None:
raise MyException1
myFunction2(param1, param2)
def myFunction2(param1, param2):
"""
:param str param1: first parameter...
:param int param2: second parameter...
:return void:
:raises MyException2: in case...
:raises ValueError: (from myFunction3) in case...
"""
if param2 is None:
raise MyException2
myFunction3(param1)
def myFunction3(param):
"""
:param str param: parameter...
:return void:
:raises ValueError: in case...
"""
if param is None:
raise ValueError
Есть ли способ сказать в myFunction1 "здесь можно было бы вызвать: myException1 и все исключения из myFunction2 рекурсивно" и так далее в myFunction2?
То есть:
def myFunction(param1, param2):
"""
:param str param1: first parameter...
:param int param2: second parameter...
:return void:
:raises MyException1: in case...
:raisesfrom myFunction2: ??? does anything like this exists, or some other way ???
"""
if param1 is None:
raise MyException1
myFunction2(param1, param2)
...
Подробнее здесь: https://stackoverflow.com/questions/792 ... -exception
Есть ли ярлык для строки документации Python для документирования неявно возникшего исключения? ⇐ Python
-
- Похожие темы
- Ответы
- Просмотры
- Последнее сообщение