flan
73a3409353
FreshHarvestActions inherited from itself to graft on basket switching, which is legal Python and a trap. BasketMixin now sits above it and is inherited normally. The four control platforms each carried an identical private _fire; it moves to the base entity as fire_action. Rewriting those call sites mechanically broke two of them - select fired 'donate' instead of 'change_basket', and button lost an argument entirely, a TypeError reachable only by pressing it. Both fixed, and two tests now assert call arity and that no class inherits from itself, because neither fault is reachable from a unit test.
75 lines
2.6 KiB
Python
75 lines
2.6 KiB
Python
"""Shared entity plumbing for Fresh Harvest.
|
|
|
|
Entities read one of three things: the account as a whole, the order arriving
|
|
next, or the order that can still be changed. Declaring that as a `scope` keeps
|
|
each entity's `value_fn` down to the field it actually cares about, instead of
|
|
every one of them repeating the same None checks.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Literal
|
|
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
|
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
|
|
|
from .api import AccountSnapshot, DeliveryOrder
|
|
from .const import DOMAIN, EVENT_ACTION
|
|
from .coordinator import FreshHarvestCoordinator
|
|
|
|
Scope = Literal["account", "next_order", "open_order"]
|
|
|
|
|
|
def resolve_scope(
|
|
snapshot: AccountSnapshot, scope: Scope
|
|
) -> AccountSnapshot | DeliveryOrder | None:
|
|
"""Return the object a scope points at, or None when there is no such order."""
|
|
if scope == "account":
|
|
return snapshot
|
|
return getattr(snapshot, scope)
|
|
|
|
|
|
class FreshHarvestEntity(CoordinatorEntity[FreshHarvestCoordinator]):
|
|
"""Base for every Fresh Harvest entity."""
|
|
|
|
_attr_has_entity_name = True
|
|
|
|
def __init__(
|
|
self,
|
|
coordinator: FreshHarvestCoordinator,
|
|
entry: ConfigEntry,
|
|
key: str,
|
|
) -> None:
|
|
super().__init__(coordinator)
|
|
self._attr_unique_id = f"{entry.entry_id}_{key}"
|
|
self._attr_device_info = DeviceInfo(
|
|
identifiers={(DOMAIN, entry.entry_id)},
|
|
name="Fresh Harvest",
|
|
manufacturer="Fresh Harvest",
|
|
entry_type=DeviceEntryType.SERVICE,
|
|
configuration_url="https://freshharvest.com/p/dashboard/details",
|
|
)
|
|
|
|
def target(self, scope: Scope) -> AccountSnapshot | DeliveryOrder | None:
|
|
"""Resolve this entity's scope against the latest snapshot."""
|
|
return resolve_scope(self.coordinator.data, scope)
|
|
|
|
def fire_action(self, action: str, ok: bool, target: str, detail: str) -> None:
|
|
"""Announce a write action's outcome so automations can notify on it.
|
|
|
|
Lives here because all four control platforms need it identically; four
|
|
private copies drifted apart the moment one of them gained a field.
|
|
"""
|
|
self.hass.bus.async_fire(
|
|
EVENT_ACTION,
|
|
{
|
|
"domain": DOMAIN,
|
|
"entry_id": self.coordinator.config_entry.entry_id,
|
|
"action": action,
|
|
"success": ok,
|
|
"target": target,
|
|
"detail": detail,
|
|
},
|
|
)
|