0. Введение
После написания функции я хочу добавить некоторую дополнительную информацию в параметры этой функции, чтобы другие пользователи могли четко знать, как использовать эту функцию.
1. Метод
Использование аннотаций параметров функций — отличный способ сообщить программисту, как правильно использовать функцию. Например, вот аннотированная функция:
def add(x:int, y:int) -> int:
return x + y
Интерпретатор Python не добавляет к этим аннотациям никакой семантики. Они не проверяются на тип и работают так же, как если бы они не были аннотированы. Тем не менее, это полезно для тех, кто читает исходный код. Сторонние инструменты и платформы могут добавлять семантику к этим аннотациям. Они также появятся в документе одновременно.
>>> help(add)
Help on function add in module __main__:
add(x: int, y: int) -> int
>>>
Хотя вы можете аннотировать функции объектами любого типа (например, числами, строками, экземплярами объектов и т. д.), обычно лучше использовать классы или строки.
2. Дополнение
Аннотации функций хранятся только в__annotations__
в свойствах. Например:
>>> add.__annotations__
{'y': <class 'int'>, 'return': <class 'int'>, 'x': <class 'int'>}
Хотя аннотации можно использовать по-разному, их основная цель — документирование. Поскольку в python нет объявлений типов, обычно трудно понять, какие параметры следует передать этой функции, просто прочитав исходный код. В настоящее время использование аннотаций может дать программистам больше подсказок, чтобы они могли правильно использовать функции.
-1. Ссылка
-1.0:Python3-cookbook.Прочитайте документ S.IO/this_cn/latshan…