Как применять аннотации типов (Type Hints) в классах Python?

Ответ

Аннотации типов (Type Hints) в Python используются для указания ожидаемых типов данных в атрибутах, параметрах методов и возвращаемых значениях классов. Это значительно улучшает читаемость кода, упрощает его поддержку и позволяет использовать статические анализаторы (например, mypy) для выявления потенциальных ошибок на этапе разработки.

Почему это важно:

Улучшение читаемости: Код становится более понятным, так как сразу видно, какие типы данных ожидаются.
Статический анализ: Инструменты могут проверять код на соответствие типам без его выполнения, находя ошибки до запуска.
Поддержка IDE: Современные IDE используют аннотации для автодополнения, рефакторинга и предупреждений.
Самодокументирование: Аннотации служат формой документации, описывая интерфейсы классов и методов.

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

from typing import List, Optional

class User:
    def __init__(self, name: str, age: int, friends: Optional[List['User']] = None) -> None:
        self.name = name
        self.age = age
        # Использование 'or []' для обеспечения изменяемого значения по умолчанию
        self.friends = friends if friends is not None else []

    def add_friend(self, friend: 'User') -> None:
        """Добавляет пользователя в список друзей."""
        self.friends.append(friend)

    def get_friends_count(self) -> int:
        """Возвращает количество друзей пользователя."""
        return len(self.friends)

# Использование класса с аннотациями
user1 = User("Alice", 25)
user2 = User("Bob", 30)
user1.add_friend(user2)

print(f"{user1.name} имеет {user1.get_friends_count()} друзей.") # Вывод: Alice имеет 1 друзей.

Пояснения к примеру:

Параметры __init__ и методов: Указаны типы name: str, age: int, friend: 'User'. Optional[List['User']] означает, что friends может быть списком объектов User или None.
Возвращаемые значения: Аннотации -> None и -> int указывают тип данных, который метод возвращает.
Forward Reference ('User'): Используется строковое представление имени класса, когда класс еще не полностью определен (например, для рекурсивных типов, как список друзей, содержащий объекты того же класса).
Модуль typing: Предоставляет специальные типы (List, Optional) для более сложных сценариев аннотирования.

Важно помнить, что аннотации типов в Python являются метаданными и не влияют на выполнение кода во время выполнения. Они служат исключительно для статического анализа и улучшения читаемости.