Leitfaden für Python-Typhinweise

Hinweise zum Master-Python-Typ für eine bessere Codedokumentation, IDE-Unterstützung und statische Analyse

Anleitung zu Python-Typhinweisen

Typhinweise machen Ihren Python-Code lesbarer und wartbarer und erkennen Fehler vor der Laufzeit.

Grundlegende Syntax

def greet(name: str) -> str:
    return f"Hello, {name}!"

def add(a: int, b: int) -> int:
    return a + b

Häufige Typen

from typing import Optional, Union, Any

# Optional - can be None
def find_user(user_id: int) -> Optional[User]:
    ...

# Union - multiple types (Python 3.10+: use |)
def process(value: Union[str, int]) -> str:
    ...

# Python 3.10+ syntax
def process(value: str | int) -> str:
    ...

Sammlungen

# Lists
names: list[str] = ["Alice", "Bob"]

# Dictionaries
ages: dict[str, int] = {"Alice": 30, "Bob": 25}

# Sets
unique_ids: set[int] = {1, 2, 3}

# Tuples (fixed length)
point: tuple[int, int] = (10, 20)

Geben Sie Aliase ein

from typing import TypeAlias

UserId: TypeAlias = int
UserMap: TypeAlias = dict[UserId, "User"]

def get_users() -> UserMap:
    ...

Statische Typprüfung

Verwenden Sie mypy oder pyright, um Typen zu überprüfen:

mypy your_module.py
pyright your_module.py

Beide lassen sich in die meisten IDEs integrieren, um Echtzeit-Feedback zu ermöglichen.