Аннотации Any и Iterable в Python
Обновлено:
Мы уже познакомились с базовыми аннотациями Python:
int
str
list[int]
dict[str, float]
Теперь начнём изучать более универсальные аннотации, которые позволяют описывать не только конкретные классы, но и возможности объектов.
Сегодня рассмотрим два типа:
Anyиз модуляtyping;Iterableиз модуляcollections.abc.
1. Аннотация Any
Импортируем:
from typing import Any
Any обозначает динамически типизированное значение, для которого статический анализатор не требует обычной проверки совместимости типов.
Например:
from typing import Any
value: Any = 100
value = 'Python'
value = [10, 20, 30]
value = None
Все эти присваивания допустимы для mypy.
Более того, Any позволяет выполнять операции, даже если анализатор не знает, поддерживает ли их настоящий объект.
Например:
from typing import Any
def make_upper(value: Any) -> Any:
return value.upper()
mypy не будет жаловаться на вызов:
value.upper()
даже если тип объекта заранее неизвестен.
Но если вызвать:
print(make_upper(100))
во время выполнения возникнет:
AttributeError
Потому что у int нет метода upper().
Важно: Any ослабляет статическую проверку, но не меняет поведение самого Python и не защищает от ошибок во время выполнения.
2. Для чего используется Any
Иногда программа действительно должна работать с объектами произвольных типов.
Например:
from typing import Any
def show_value(value: Any) -> None:
print(value)
Теперь можно передавать:
show_value(100)
show_value('Python')
show_value([10, 20, 30])
show_value(None)
Во всех случаях функция принимает объект и выводит его на экран.
Также Any иногда используется как компромисс при работе со сложным кодом, где статический анализатор не может достаточно точно определить тип.
Однако злоупотреблять им не стоит.
Если мы точно знаем, какой тип должна получать функция, лучше указать его явно:
def show_name(name: str) -> None:
print(name.upper())
Так мы сохраняем преимущества статической проверки.
3. Any и object
Мы уже знаем, что почти все привычные Python-объекты являются экземплярами базового класса object.
Поэтому аннотация:
value: object = 100
тоже позволяет принимать объекты разных типов.
Но между Any и object есть важное различие.
Any |
object |
|---|---|
| Принимает значения любых типов | Принимает значения любых типов |
| Разрешает анализатору практически любые операции | Разрешает только операции, гарантированные для object |
| Ослабляет статическую проверку | Сохраняет статическую проверку |
Например:
from typing import Any
value: Any = 'Python'
print(value.upper())
mypy не будет возражать.
А:
value: object = 'Python'
print(value.upper())
вызовет предупреждение mypy: метод upper() не гарантирован для любого объекта.
Пока для простых учебных примеров, в которых мы намеренно разрешаем произвольные значения и операции с ними, будем использовать Any.
Более подробно разницу между Any и object разберём после знакомства с ООП.
Аннотация Iterable
4. Модуль collections.abc
Импортируем:
from collections.abc import Iterable
Обратите внимание на название:
collections.abc
В этом модуле находятся абстрактные базовые классы, описывающие возможности различных объектов.
Что такое абстрактные базовые классы, мы подробно рассмотрим при изучении ООП.
Сейчас достаточно знать, что:
Iterable
описывает итерируемые объекты.
5. Почему импортируем из collections.abc
Раньше для аннотаций часто использовали:
from typing import Iterable
Начиная с Python 3.9, благодаря PEP 585 стало возможно напрямую писать параметризованные аннотации:
from collections.abc import Iterable
и:
Iterable[int]
Вариант typing.Iterable с Python 3.9 считается устаревшим псевдонимом.
При этом сам модуль collections.abc существовал и раньше. Изменилось именно рекомендуемое место получения Iterable для современных аннотаций.
Поэтому в актуальном Python используем:
from collections.abc import Iterable
6. Что означает Iterable
Мы уже знаем, что итерируемым является объект, элементы которого можно последовательно получать, например с помощью цикла:
for element in iterable:
...
К знакомым нам итерируемым объектам относятся:
list
tuple
str
range
dict
set
frozenset
Аннотация Iterable полезна, когда функция должна принимать не конкретную коллекцию, а любой подходящий итерируемый объект.
Например:
from collections.abc import Iterable
from typing import Any
def show_elements(
elements: Iterable[Any],
) -> None:
for element in elements:
print(element)
Теперь мы можем передать список:
show_elements([10, 20, 30])
Кортеж:
show_elements((10, 20, 30))
Диапазон:
show_elements(range(3))
Или строку:
show_elements('Python')
Во всех случаях функция просто последовательно обходит элементы.
Ей не требуется знать конкретный класс коллекции.
7. Iterable с указанием типа элементов
Можно использовать:
Iterable
без квадратных скобок, если тип элементов не уточняется.
Но чаще полезно указать, какие именно значения мы ожидаем:
Iterable[int]
Например:
from collections.abc import Iterable
def calculate_total(
numbers: Iterable[int],
) -> int:
return sum(numbers)
Теперь функция предназначена для итерируемого объекта с целыми числами.
Ей подойдут:
print(calculate_total([10, 20, 30]))
# 60
print(calculate_total((10, 20, 30)))
# 60
print(calculate_total(range(1, 6)))
# 15
Если аннотировать параметр только как:
list[int]
то другие типы коллекций уже не будут соответствовать объявленному контракту.
А:
Iterable[int]
позволяет принимать разные виды итерируемых объектов.
8. Другой пример — строки
from collections.abc import Iterable
def normalize_words(
words: Iterable[str],
) -> list[str]:
return [
word.strip().upper()
for word in words
]
Используем:
print(
normalize_words(
[' python ', ' sql ']
)
)
# ['PYTHON', 'SQL']
Или передаём кортеж:
print(
normalize_words(
(' django ', ' flask ')
)
)
# ['DJANGO', 'FLASK']
Здесь:
Iterable[str]
говорит анализатору:
Функция принимает итерируемый объект, который отдаёт строки.
Поэтому внутри функции переменная word предполагается строкой, а редактор может предлагать её методы.
9. Почему Iterable не означает list
Аннотация:
Iterable[int]
обещает, что объект можно обойти.
Но она не гарантирует, что объект поддерживает:
elements[0]
или:
len(elements)
Например, существуют итерируемые объекты без индексов и без определённой длины.
Поэтому функция, принимающая Iterable, обычно должна работать с объектом через итерацию:
for element in elements:
...
Если нам необходимо обращаться по индексам или обязательно использовать len(), существуют другие аннотации, с которыми познакомимся позже.
Общее правило: аннотируйте параметр по тем возможностям объекта, которые действительно нужны функции.
Iterable и isinstance()
10. Проверка итерируемого объекта
Объект Iterable из collections.abc можно передать в функцию:
isinstance()
Например:
from collections.abc import Iterable
print(isinstance([10, 20], Iterable))
# True
print(isinstance((10, 20), Iterable))
# True
print(isinstance('Python', Iterable))
# True
print(isinstance(range(10), Iterable))
# True
print(isinstance(100, Iterable))
# False
Таким образом, мы можем проверить, соответствует ли объект интерфейсу Iterable.
Для всех знакомых нам встроенных итерируемых типов такой способ работает.
Существуют и редкие пользовательские объекты, которые Python может итерировать, но isinstance(..., Iterable) их не распознает. С этим нюансом познакомимся при изучении протоколов объектов.
11. Any нельзя использовать с isinstance()
Сравним:
from collections.abc import Iterable
from typing import Any
Проверка:
print(
isinstance([10, 20], Iterable)
)
# True
работает.
А:
isinstance(100, Any)
приведёт к:
TypeError
Почему?
Потому что Any — специальная конструкция системы статической типизации, а не обычный класс для проверки принадлежности объекта во время выполнения.
Также нельзя написать:
isinstance([10, 20], Iterable[int])
В isinstance() используется сам Iterable, без параметризации типа элементов.
Пока достаточно запомнить:
isinstance(value, Iterable)
→ работает
isinstance(value, Any)
→ TypeError
isinstance(value, Iterable[int])
→ TypeError
Главное по теме
Any импортируется из:
from typing import Any
Он обозначает динамически типизированное значение и позволяет ослаблять статическую проверку:
def show_value(value: Any) -> None:
print(value)
Использовать Any следует осознанно, поскольку излишнее применение уменьшает пользу от mypy.
Iterable импортируется из:
from collections.abc import Iterable
Он используется для аннотации итерируемых объектов:
def show_elements(
elements: Iterable[Any],
) -> None:
for element in elements:
print(element)
Можно указывать конкретный тип элементов:
Iterable[int]
Iterable[str]
Iterable[float]
Например:
def get_total(
numbers: Iterable[int],
) -> int:
return sum(numbers)
Для проверки объекта во время выполнения:
isinstance(value, Iterable)
А Any для проверки через isinstance() не используется.
В следующих темах познакомимся с другими аннотациями из collections.abc и typing, которые позволят точнее описывать возможности объектов и интерфейсы наших функций.