skodaconnect / myskoda
87%
main: 87%

LAST BUILD BRANCH: fix-charging-profile-model
DEFAULT BRANCH: main
Repo Added
Files 40
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH v2.0.0
branch: v2.0.0
CHANGE BRANCH
x

coverage: 86.946% (+0.7%) from 86.233%
15323283221

push

github

web-flow 
BREAKING CHANGE: MQTT Event model overhaul (#438)

* refactor!: MQTT Event model overhaul

BREAKING CHANGE: this changes all MQTT Event models and will require
clients, including homeassistant-myskoda, to update accordingly.

Main changes:
- "Flatten" event classes. Everything is now in a single object, rather
than having, for e.g., a `EventCharging` with inside a `ServiceEvent`.
So no more `event.event.data`, but just `event.data`
- Use mashumaro descriminators to automatically parse an MQTT payload
into the 'correct' model class. No more generics. There are two
descriminator levels: In `BaseEvent` the `event_type` (`EventType`)
determines if the event is a `VehicleEvent`, `ServiceEvent`,
`OperationEvent` or `AccountEvent`. In `ServiceEvent` the `name`
(`ServiceEventName`) determines the exact Service Event class.
- This means `MySkodaMqttClient._parse_topic()` no longer needs a huge
`if-elif` contraption, inspecting the event_type and topic to pick the
correct class to use. We just create a `BaseEvent` instance if
automatically get the correct subclass.
- `models/event/base.py` provides a helper `event_factory` for this,
using the original topic and payload to return the event object, in just
a few lines of code.
- Group all event model code in a new sub-package,
`myskoda.models.event`.

Fixes #405

* chore!: bump minimum Python version to 3.13

BREAKING CHANGE: will break installations on Pyton < 3.13

Mostly because we want to use https://docs.python.org/3/library/enum.html#enum.EnumType._add_value_alias

* refactor: replace custom deserialization with Enum aliases

2238 of 2574 relevant lines covered (86.95%)

0.87 hits per line

Relevant lines Covered
2574 RELEVANT LINES 2238 COVERED LINES
0.87 HITS PER LINE
Source Files on v2.0.0

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
15323283221 v2.0.0 BREAKING CHANGE: MQTT Event model overhaul (#438) * refactor!: MQTT Event model overhaul BREAKING CHANGE: this changes all MQTT Event models and will require clients, including homeassistant-myskoda, to update accordingly. Main changes: - "Flat... push web-flow github
86.95
See All Builds (1004)