Аннотации (type hints) в Python

НАВИГАЦИЯ ПО СТРАНИЦЕ

Аннотации (type hints) рефакторинге кода
ПОЛНЫЙ ОТВЕТ
БЕЗ ВОДЫ
Без воды — краткий вариант ответа,
легко понять и запомнить

Аннотации (type hints) в Python — механизм, который позволяет указать ожидаемый тип данных для параметров функции и возвращаемого значения. Аннотации используются для предоставления информации о типах данных, которые функция ожидает или возвращает, но они не обязательны для выполнения кода. Python остается динамически типизированным языком, и аннотации являются скорее соглашением и инструментом для документации, чем строгой статической типизацией.

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

def add(x: int, y: int) -> int:
    """
    Это функция складывает два числа.

    Args:
        x (int): Первое число для сложения.
        y (int): Второе число для сложения.

    Returns:
        int: Результат сложения x и y.
    """
    return x + y

В данном примере:

  • x: int и y: int - это аннотации для параметров x и y, указывающие, что они должны быть целыми числами.

  • -> int - это аннотация для возвращаемого значения, указывающая, что функция должна вернуть целое число.

Аннотации могут быть полезны при разработке и рефакторинге кода, а также при использовании инструментов для статической анализа кода, таких как Mypy, которые могут проверить соответствие типов. Однако они не влияют на выполнение кода, и Python все равно будет выполнять динамическую типизацию.

Аннотации могут быть использованы и в других контекстах, таких как переменные и атрибуты классов, что позволяет более подробно описывать структуру данных и интерфейсы. Они улучшают читаемость и понимание кода, особенно при работе в команде и создании документации.