Аннотации типов

Объектно-ориентированное программирование на Python: средний уровень

Jake Roach

Data Engineer

Код без аннотаций типов

class Student:
    def __init__(self, name, student_id, tuition_balance):
        self.name = name
        self.student_id = student_id
        self.tuition_balance = tuition_balance

# Trying to create a class can be tricky
walker = Student("Sarah Walker", 319921, 15000)

Должен ли student_id быть целым числом?
Должен ли tuition_balance быть float, целым числом или строкой?
После создания walker — как вспомнить его тип позже в коде?

Аннотации типов

Необязательный инструмент для добавления информации о типах объектов в код

Упрощает чтение и отладку
Один из лучших способов продемонстрировать навыки Python уровня production
Интерпретатор не проверяет соответствие типов
Встроенные ключевые слова, библиотека typing, пользовательские классы

# Add type hinting when creating a 
# variable
gpa: float = 3.92

# Add type hinting to a function/method 
# definition
def check_grades(year: str) -> List[int]:
    ...

# Can even use custom classes
students: Dict[str, Student] = {...}

Аннотации типов со встроенными ключевыми словами

# Type hinting for declarative logic
name: str = "Frost"  # Before: name = "Frost"
student_id: int = 91031367
tuition_balance: float = 17452.78

# Type hinting for function/method definitions
def get_schedule(semester: str) -> dict:
    ...

Синтаксис: variable: type
Декларативные выражения и сигнатуры функций/методов
def .... () -> type: — указание возвращаемого типа

Библиотека typing

typing — библиотека с расширенными инструментами для аннотаций типов

List, Dict, Tuple
Аннотирование объектов верхнего уровня и их элементов

from typing import List, Dict

student_names: List[str] = ["Morgan", "Chuck", "Anna"]
student_gpas: Dict[str, float] = {
    "Casey": 3.71,
    "Sarah": 4.0
}

Any, Set, Iterator, Callable

Аннотации типов с пользовательскими классами

class Student:
    def __init__(self, name: str, student_id: int, tuition_balance: float) -> None:
        self.name: str = name
        self.student_id: int = student_id
        self.tuition_balance: float = tuition_balance

    def get_course(self, course_id: str) -> Course:
        ...
        return course

# Use Student and Course to type hint
walker: Student = Student("Sarah Walker", 319921, 15000)
data_science: Course = walker.get_course("TDM-20100")

Проверка типов объектов

# walker: Student = Student("Sarah Walker", 319921, 15000)
print(type(walker))

<class '__main__.Student'>

# data_science: Course = walker.get_course("TDM-20100")
print(type(data_science))

<class '__main__.Course'>

Давайте потренируемся!

Объектно-ориентированное программирование на Python: средний уровень