Вывод документации функции в Python
В теле функции можно прописать строку,
описывающую суть проводимой работы. Такую
строку принято считать документацией
функции. Она заключается в одинарные кавычки
и размещается в первой строке тела функции.
Чтобы ее прочитать, нужно использовать
специальную функцию help
, в параметр
который передается имя функции.
Пусть у нас есть функция, суммирующая два числа. Об этом оставлена строка с соответствующей информацией:
def getSum(num1, num2):
'this function sums two numbers'
return num1 + num2
Давайте вызовем help
и узнаем, что
закомментировано в getSum
:
help(getSum)
После выполнения кода в консоли появится строка с названием функции и ее документацией:
Help on function getSum in module __main__:
getSum(num1, num2)
this function sums two numbers
С помощью функции help
можно читать
документацию и стандартных функций. Давайте
узнаем информацию о функции print
:
help(print)
Для того, чтобы вывести только строку с
документацией из функции, нужно передать
в help
после имени функции служебную
конструкцию .__doc__
:
help(print.__doc__)
Создайте функцию, которая будет принимать параметром список названий месяцев и выводить их с заглавной буквы. Опишите суть работы функции в документации и выведите ее в консоль.
Выведите всю документацию о функции sum
.
Выведите только строку с документацией о
функции len
.