Как распечатать документацию вашей функции python

Question

Я искал ответ на некоторое время. Предположим, что я написал функцию в python, и я сделал краткую документацию о том, что делает эта функция. Есть ли способ распечатать документацию функции из основного? Или из самой функции?

Answer 1

Вы можете использовать help() или распечатать __doc__. help() печатает более подробное описание объекта, в то время как __doc__ содержит только строку документации, которую вы определили с тройными котировками """ """в начале вашей функции.

Например, при использовании __doc__ явно на встроенной функции sum:

print(sum.__doc__) 
Return the sum of a 'start' value (default: 0) plus an iterable of numbers 

When the iterable is empty, return the start value. 
This function is intended specifically for use with numeric values and may 
reject non-numeric types. 

Кроме того, поскольку Python первый компилирует объект и во время выполнения оценивает его можно вызвать __doc__ в функции без проблем:

def foo(): 
    """sample doc""" 
    print(foo.__doc__) 

foo() # prints sample doc 

и, кроме того, функции, модули и классы имеют атрибут __doc__, содержащий их документацию.

В качестве альтернативы, используя help()sum для:

help(sum) 

Напечатает:

Help on built-in function sum in module builtins: 

sum(iterable, start=0, /) 
    Return the sum of a 'start' value (default: 0) plus an iterable of numbers 

    When the iterable is empty, return the start value. 
    This function is intended specifically for use with numeric values and may 
    reject non-numeric types. 

дает немного больше информации, в том числе строку документации.