Typing & Protocols
TypeScript interfaces → Python Protocols
Section titled “TypeScript interfaces → Python Protocols”In TypeScript, an interface defines a contract. Any object that has the required shape satisfies it — this is called structural typing. Python’s Protocol (from the typing module) is exactly the same idea: a class satisfies a Protocol if it has the right methods and attributes, regardless of what it inherits from.
// TypeScript structural interfaceinterface Drawable { draw(): string;}
function render(shape: Drawable): string { return shape.draw();}
class Circle { draw() { return "Drawing Circle"; }}
class Square { draw() { return "Drawing Square"; }}
console.log(render(new Circle())); // "Drawing Circle"console.log(render(new Square())); // "Drawing Square"from typing import Protocol
class Drawable(Protocol): def draw(self) -> str: ...
def render(shape: Drawable) -> str: return shape.draw()
class Circle: def draw(self) -> str: return "Drawing Circle"
class Square: def draw(self) -> str: return "Drawing Square"
print(render(Circle())) # Drawing Circleprint(render(Square())) # Drawing SquareNotice Circle and Square do not inherit from Drawable. They just happen to have a draw() method with the right signature — that is enough. Static analysis tools like mypy and pyright will catch violations.
Generics: TypeVar and Generic
Section titled “Generics: TypeVar and Generic”TypeScript generics map directly to Python’s TypeVar + Generic.
// TypeScript generic classclass Stack<T> { private items: T[] = []; push(item: T): void { this.items.push(item); } pop(): T { return this.items.pop()!; } peek(): T { return this.items[this.items.length - 1]; }}
const stack = new Stack<number>();stack.push(1);stack.push(2);console.log(stack.pop()); // 2from typing import TypeVar, Generic
T = TypeVar('T')
class Stack(Generic[T]): def __init__(self) -> None: self._items: list[T] = []
def push(self, item: T) -> None: self._items.append(item)
def pop(self) -> T: return self._items.pop()
def peek(self) -> T: return self._items[-1]
stack: Stack[int] = Stack()stack.push(1)stack.push(2)print(stack.pop()) # 2From Python 3.9+ you can also write list[T] directly in class bodies without importing List from typing. From 3.12, type T = ... syntax was added as a shorthand — but TypeVar remains the most compatible form.
TypedDict: typed dictionaries
Section titled “TypedDict: typed dictionaries”TypedDict is Python’s equivalent of a TypeScript interface that describes a plain object (no methods). It is perfect for JSON-shaped data.
// TypeScript interface for a plain objectinterface UserRecord { name: string; age: number; email?: string; // optional key}
const user: UserRecord = { name: "Alice", age: 30 };console.log(user.name);from typing import TypedDict, NotRequired
class UserRecord(TypedDict): name: str age: int email: NotRequired[str] # optional key
user: UserRecord = {"name": "Alice", "age": 30}print(user["name"]) # Alice
# mypy/pyright will catch missing required keys:# bad: UserRecord = {"name": "Alice"} # age missingOptional and Union
Section titled “Optional and Union”TypeScript uses string | null | undefined for nullable types. Python uses Optional[T] (which is T | None) or the modern union syntax T | None (Python 3.10+).
// TypeScriptfunction greet(name: string | null): string { if (name === null) return "Hello, stranger!"; return `Hello, ${name}!`;}
// Modern TS nullable shorthandfunction greet2(name?: string): string { return name ? `Hello, ${name}!` : "Hello, stranger!";}from typing import Optional
# Optional[str] is exactly str | Nonedef greet(name: Optional[str] = None) -> str: if name is None: return "Hello, stranger!" return f"Hello, {name}!"
# Python 3.10+ union syntaxdef greet_modern(name: str | None = None) -> str: return f"Hello, {name}!" if name else "Hello, stranger!"
print(greet()) # Hello, stranger!print(greet("Alice")) # Hello, Alice!Try it
Section titled “Try it”from typing import Protocol, TypeVar, Generic, TypedDict, Optional
# Protocol — structural typingclass Serializable(Protocol): def to_json(self) -> str: ...
class User: def __init__(self, name: str, age: int) -> None: self.name = name self.age = age def to_json(self) -> str: return f'{{"name": "{self.name}", "age": {self.age}}}'
class Product: def __init__(self, title: str) -> None: self.title = title def to_json(self) -> str: return f'{{"title": "{self.title}"}}'
def export_data(item: Serializable) -> str: return item.to_json()
print(export_data(User("Alice", 30)))print(export_data(Product("Widget")))
# Generic StackT = TypeVar('T')
class Stack(Generic[T]): def __init__(self) -> None: self._items: list[T] = [] def push(self, item: T) -> None: self._items.append(item) def pop(self) -> T: return self._items.pop()
s: Stack[str] = Stack()s.push("hello")s.push("world")print(s.pop())
# TypedDictclass Config(TypedDict): host: str port: int
cfg: Config = {"host": "localhost", "port": 8080}print(f"Connecting to {cfg['host']}:{cfg['port']}")
# Optionaldef find_user(user_id: int) -> Optional[str]: db = {1: "Alice", 2: "Bob"} return db.get(user_id)
print(find_user(1)) # Aliceprint(find_user(99)) # NoneLoading Python runtime (first run only)…