Есть ли ярлык для строки документации Python для документирования неявно возникшего исключения?Python

Программы на Python
Ответить Пред. темаСлед. тема
Anonymous
 Есть ли ярлык для строки документации Python для документирования неявно возникшего исключения?

Сообщение Anonymous »

Я работаю над несколькими модулями 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
Реклама
Ответить Пред. темаСлед. тема

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

  • Похожие темы
    Ответы
    Просмотры
    Последнее сообщение
  • Есть ли ярлык для строки документации Python для документирования неявно возникшего исключения?
    Anonymous » » в форуме Python
    0 Ответы
    14 Просмотры
    Последнее сообщение Anonymous
  • Есть ли ярлык для строки документации Python для документирования неявно возникшего исключения?
    Anonymous » » в форуме Python
    0 Ответы
    17 Просмотры
    Последнее сообщение Anonymous
  • Перехват исключения, возникшего в функции foreachBatch
    Anonymous » » в форуме Python
    0 Ответы
    12 Просмотры
    Последнее сообщение Anonymous
  • Перехват исключения, возникшего в функции foreachBatch
    Anonymous » » в форуме Python
    0 Ответы
    37 Просмотры
    Последнее сообщение Anonymous
  • Перехват исключения, возникшего в функции foreachBatch
    Anonymous » » в форуме Python
    0 Ответы
    9 Просмотры
    Последнее сообщение Anonymous

Вернуться в «Python»