Created
July 24, 2022 02:24
-
-
Save alkasm/80a13a62615e0889b60d5f0156625d5b to your computer and use it in GitHub Desktop.
A pattern for "required" arguments in dataclasses, allowing for fields without defaults to follow fields with defaults.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
from dataclasses import dataclass, field | |
from datetime import datetime | |
from typing import Optional, TypeVar | |
T = TypeVar("T") | |
def required() -> T: | |
f: T | |
def factory() -> T: | |
# mypy treats a Field as a T, even though it has attributes like .name, .default, etc | |
field_name = f.name # type: ignore[attr-defined] | |
raise ValueError(f"field '{field_name}' required") | |
f = field(default_factory=factory) | |
return f | |
@dataclass | |
class Event: | |
id: str | |
created_at: datetime | |
updated_at: Optional[datetime] = None | |
@dataclass | |
class NamedEvent(Event): | |
name: str = required() | |
event = NamedEvent(name="Some Event", id="ab13c1a", created_at=datetime.now()) | |
print("created event:", event) | |
event2 = NamedEvent("ab13c1a", datetime.now(), name="Some Other Event") | |
print("created event:", event2) | |
event3 = NamedEvent("ab13c1a", datetime.now()) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Example output: