Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve pydantic model default and alias handling #378

Merged
merged 3 commits into from
Mar 23, 2023
Merged

Improve pydantic model default and alias handling #378

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ee2c5b9
Improve pydantic model default and alias handling
cdce8p Mar 8, 2023
9af2b49
Update pinned pydantic version to 1.10.6
cdce8p Mar 8, 2023
5ba5afa
Merge branch 'main' into field-defaults
frenck Mar 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ async def main() -> None:
),
Chart(data=[1, 2, 3, 4, 5, 4, 3, 2, 1]),
],
sound=Sound(id=NotificationSound.WIN),
sound=Sound(sound=NotificationSound.WIN),
),
)

Expand Down
76 changes: 38 additions & 38 deletions poetry.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ profile = "black"
# results.
platform = "linux"
python_version = 3.9
plugins = ["pydantic.mypy"]

# flake8-mypy expects the two following for sensible formatting
show_column_numbers = true
Expand Down
32 changes: 16 additions & 16 deletions src/demetriek/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,16 @@
class Range(BaseModel):
"""Object holding an integer range."""

range_min: int = Field(..., alias="min")
range_max: int = Field(..., alias="max")
range_min: int = Field(alias="min")
range_max: int = Field(alias="max")


class Audio(BaseModel):
"""Object holding the audio state of an LaMetric device."""

volume: int
volume_range: Optional[Range]
volume_limit: Optional[Range]
volume_range: Optional[Range] = None
volume_limit: Optional[Range] = None


class Bluetooth(BaseModel):
Expand All @@ -56,7 +56,7 @@ class Display(BaseModel):
brightness_mode: BrightnessMode
width: int
height: int
display_type: DisplayType = Field(None, alias="type")
display_type: Optional[DisplayType] = Field(default=None, alias="type")


class Wifi(BaseModel):
Expand All @@ -76,7 +76,7 @@ class Wifi(BaseModel):
class Device(BaseModel):
"""Object holding the state of an LaMetric device."""

device_id: str = Field(..., alias="id")
device_id: str = Field(alias="id")
name: str
serial_number: str
os_version: AwesomeVersion
Expand All @@ -91,7 +91,7 @@ class Device(BaseModel):
class Chart(BaseModel):
"""Object holding the chart frame of an LaMetric notification."""

data: list[int] = Field(..., alias="chartData")
data: list[int] = Field(alias="chartData")

class Config:
"""Chart model configuration."""
Expand Down Expand Up @@ -119,7 +119,7 @@ class Goal(BaseModel):
"""Object holding the goal frame of an LaMetric notification."""

icon: Optional[Union[int, str]] = None
data: GoalData = Field(..., alias="goalData")
data: GoalData = Field(alias="goalData")

class Config:
"""Goal model configuration."""
Expand All @@ -130,8 +130,8 @@ class Config:
class Sound(BaseModel):
"""Object holding the notification sound state of an LaMetric device."""

category: Optional[NotificationSoundCategory]
sound: Union[AlarmSound, NotificationSound] = Field(..., alias="id")
category: Optional[NotificationSoundCategory] = None
sound: Union[AlarmSound, NotificationSound] = Field(alias="id")
repeat: int = 1

@root_validator
Expand Down Expand Up @@ -179,8 +179,8 @@ class Notification(BaseModel):
icon_type: Optional[NotificationIconType] = None
life_time: Optional[float] = None
priority: Optional[NotificationPriority] = None
notification_id: Optional[int] = Field(None, alias="id")
notification_type: Optional[NotificationType] = Field(None, alias="type")
notification_id: Optional[int] = Field(default=None, alias="id")
notification_type: Optional[NotificationType] = Field(default=None, alias="type")


class User(BaseModel):
Expand All @@ -191,19 +191,19 @@ class User(BaseModel):
name: str
private_apps_count: int
private_device_count: int
user_id: int = Field(..., alias="id")
user_id: int = Field(alias="id")


class CloudDevice(BaseModel):
"""Object holding the state of an LaMetric device from the Cloud."""

device_id: int = Field(..., alias="id")
device_id: int = Field(alias="id")
name: str
state: DeviceState
serial_number: str
api_key: str
ip: IPv4Address = Field(..., alias="ipv4_internal")
ip: IPv4Address = Field(alias="ipv4_internal")
mac: str
ssid: str = Field(..., alias="wifi_ssid")
ssid: str = Field(alias="wifi_ssid")
created_at: datetime
updated_at: datetime