Программа курса Урок 25 из 250 · Функции
Функции

Docstrings и Type Hints

Две маленькие правки превращают рабочую функцию в профессиональную: docstring и type hints.

docstring - это строковый литерал, который ставится самой первой строкой в теле функции. Он объясняет, что делает функция. Инструменты и help() читают его, а Python хранит его на function.__doc__:

def add(a, b):
    """Return the sum of a and b."""
    return a + b

print(add.__doc__)   # Return the sum of a and b.

Тройные кавычки позволяют docstring занимать несколько строк, что удобно для длинных объяснений.

Type hints указывают, какими типами должны быть параметры и возвращаемое значение. Вы пишете name: type для каждого параметра и -> type для возвращаемого значения:

def add(a: int, b: int) -> int:
    """Return the sum of a and b."""
    return a + b

Подсказки не ограничивают ничего во время выполнения. Python не помешает вам передать строку. Это документация, которую редакторы и чекеры используют для раннего поиска ошибок, и они делают ваши сигнатуры понятными сами по себе. Общие типы подсказок включают int, float, str и bool.

Отныне пиши функции с обоими: понятным docstring и честными type hints.

Твоя очередь

Определите функцию multiply с подсказками типов def multiply(a: int, b: int) -> int: и docstring (её первая строка) со значением Return the product of a and b.. Тело функции должно return a * b.

Заметили проблему в этом уроке? Сообщите о ней · Спросить об этом уроке

Это упражнение откроется скоро

Закончи предыдущий урок, чтобы открылся этот. Весь курс бесплатный, аккаунт не нужен, и ты можешь прочитать этот урок прямо сейчас.