Remove filtering of user data in Habitica integration (#121759)

Remove context-based userFields filtering
This commit is contained in:
Mr. Bubbles 2024-07-19 17:56:52 +02:00 committed by GitHub
parent e029dad0eb
commit 72d37036b9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 4 additions and 33 deletions

View File

@ -20,6 +20,4 @@ ATTR_DATA = "data"
MANUFACTURER = "HabitRPG, Inc." MANUFACTURER = "HabitRPG, Inc."
NAME = "Habitica" NAME = "Habitica"
ADDITIONAL_USER_FIELDS: set[str] = {"lastCron"}
UNIT_TASKS = "tasks" UNIT_TASKS = "tasks"

View File

@ -17,7 +17,7 @@ from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError, ServiceValidationError from homeassistant.exceptions import HomeAssistantError, ServiceValidationError
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
from .const import ADDITIONAL_USER_FIELDS, DOMAIN from .const import DOMAIN
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
@ -46,10 +46,8 @@ class HabiticaDataUpdateCoordinator(DataUpdateCoordinator[HabiticaData]):
self.api = habitipy self.api = habitipy
async def _async_update_data(self) -> HabiticaData: async def _async_update_data(self) -> HabiticaData:
user_fields = set(self.async_contexts()) | ADDITIONAL_USER_FIELDS
try: try:
user_response = await self.api.user.get(userFields=",".join(user_fields)) user_response = await self.api.user.get()
tasks_response = await self.api.tasks.user.get() tasks_response = await self.api.tasks.user.get()
tasks_response.extend(await self.api.tasks.user.get(type="completedTodos")) tasks_response.extend(await self.api.tasks.user.get(type="completedTodos"))
except ClientResponseError as error: except ClientResponseError as error:

View File

@ -2,7 +2,7 @@
from __future__ import annotations from __future__ import annotations
from typing import TYPE_CHECKING, Any from typing import TYPE_CHECKING
from homeassistant.const import CONF_NAME, CONF_URL from homeassistant.const import CONF_NAME, CONF_URL
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
@ -22,10 +22,9 @@ class HabiticaBase(CoordinatorEntity[HabiticaDataUpdateCoordinator]):
self, self,
coordinator: HabiticaDataUpdateCoordinator, coordinator: HabiticaDataUpdateCoordinator,
entity_description: EntityDescription, entity_description: EntityDescription,
context: Any = None,
) -> None: ) -> None:
"""Initialize a Habitica entity.""" """Initialize a Habitica entity."""
super().__init__(coordinator, context) super().__init__(coordinator)
if TYPE_CHECKING: if TYPE_CHECKING:
assert coordinator.config_entry.unique_id assert coordinator.config_entry.unique_id
self.entity_description = entity_description self.entity_description = entity_description

View File

@ -26,7 +26,6 @@ from homeassistant.helpers.typing import StateType
from . import HabiticaConfigEntry from . import HabiticaConfigEntry
from .const import DOMAIN, UNIT_TASKS from .const import DOMAIN, UNIT_TASKS
from .coordinator import HabiticaDataUpdateCoordinator
from .entity import HabiticaBase from .entity import HabiticaBase
from .util import entity_used_in from .util import entity_used_in
@ -38,7 +37,6 @@ class HabitipySensorEntityDescription(SensorEntityDescription):
"""Habitipy Sensor Description.""" """Habitipy Sensor Description."""
value_fn: Callable[[dict[str, Any]], StateType] value_fn: Callable[[dict[str, Any]], StateType]
ctx: str
@dataclass(kw_only=True, frozen=True) @dataclass(kw_only=True, frozen=True)
@ -72,7 +70,6 @@ SENSOR_DESCRIPTIONS: tuple[HabitipySensorEntityDescription, ...] = (
key=HabitipySensorEntity.DISPLAY_NAME, key=HabitipySensorEntity.DISPLAY_NAME,
translation_key=HabitipySensorEntity.DISPLAY_NAME, translation_key=HabitipySensorEntity.DISPLAY_NAME,
value_fn=lambda user: user.get("profile", {}).get("name"), value_fn=lambda user: user.get("profile", {}).get("name"),
ctx="profile",
), ),
HabitipySensorEntityDescription( HabitipySensorEntityDescription(
key=HabitipySensorEntity.HEALTH, key=HabitipySensorEntity.HEALTH,
@ -80,7 +77,6 @@ SENSOR_DESCRIPTIONS: tuple[HabitipySensorEntityDescription, ...] = (
native_unit_of_measurement="HP", native_unit_of_measurement="HP",
suggested_display_precision=0, suggested_display_precision=0,
value_fn=lambda user: user.get("stats", {}).get("hp"), value_fn=lambda user: user.get("stats", {}).get("hp"),
ctx="stats",
), ),
HabitipySensorEntityDescription( HabitipySensorEntityDescription(
key=HabitipySensorEntity.HEALTH_MAX, key=HabitipySensorEntity.HEALTH_MAX,
@ -88,7 +84,6 @@ SENSOR_DESCRIPTIONS: tuple[HabitipySensorEntityDescription, ...] = (
native_unit_of_measurement="HP", native_unit_of_measurement="HP",
entity_registry_enabled_default=False, entity_registry_enabled_default=False,
value_fn=lambda user: user.get("stats", {}).get("maxHealth"), value_fn=lambda user: user.get("stats", {}).get("maxHealth"),
ctx="stats",
), ),
HabitipySensorEntityDescription( HabitipySensorEntityDescription(
key=HabitipySensorEntity.MANA, key=HabitipySensorEntity.MANA,
@ -96,34 +91,29 @@ SENSOR_DESCRIPTIONS: tuple[HabitipySensorEntityDescription, ...] = (
native_unit_of_measurement="MP", native_unit_of_measurement="MP",
suggested_display_precision=0, suggested_display_precision=0,
value_fn=lambda user: user.get("stats", {}).get("mp"), value_fn=lambda user: user.get("stats", {}).get("mp"),
ctx="stats",
), ),
HabitipySensorEntityDescription( HabitipySensorEntityDescription(
key=HabitipySensorEntity.MANA_MAX, key=HabitipySensorEntity.MANA_MAX,
translation_key=HabitipySensorEntity.MANA_MAX, translation_key=HabitipySensorEntity.MANA_MAX,
native_unit_of_measurement="MP", native_unit_of_measurement="MP",
value_fn=lambda user: user.get("stats", {}).get("maxMP"), value_fn=lambda user: user.get("stats", {}).get("maxMP"),
ctx="stats",
), ),
HabitipySensorEntityDescription( HabitipySensorEntityDescription(
key=HabitipySensorEntity.EXPERIENCE, key=HabitipySensorEntity.EXPERIENCE,
translation_key=HabitipySensorEntity.EXPERIENCE, translation_key=HabitipySensorEntity.EXPERIENCE,
native_unit_of_measurement="XP", native_unit_of_measurement="XP",
value_fn=lambda user: user.get("stats", {}).get("exp"), value_fn=lambda user: user.get("stats", {}).get("exp"),
ctx="stats",
), ),
HabitipySensorEntityDescription( HabitipySensorEntityDescription(
key=HabitipySensorEntity.EXPERIENCE_MAX, key=HabitipySensorEntity.EXPERIENCE_MAX,
translation_key=HabitipySensorEntity.EXPERIENCE_MAX, translation_key=HabitipySensorEntity.EXPERIENCE_MAX,
native_unit_of_measurement="XP", native_unit_of_measurement="XP",
value_fn=lambda user: user.get("stats", {}).get("toNextLevel"), value_fn=lambda user: user.get("stats", {}).get("toNextLevel"),
ctx="stats",
), ),
HabitipySensorEntityDescription( HabitipySensorEntityDescription(
key=HabitipySensorEntity.LEVEL, key=HabitipySensorEntity.LEVEL,
translation_key=HabitipySensorEntity.LEVEL, translation_key=HabitipySensorEntity.LEVEL,
value_fn=lambda user: user.get("stats", {}).get("lvl"), value_fn=lambda user: user.get("stats", {}).get("lvl"),
ctx="stats",
), ),
HabitipySensorEntityDescription( HabitipySensorEntityDescription(
key=HabitipySensorEntity.GOLD, key=HabitipySensorEntity.GOLD,
@ -131,7 +121,6 @@ SENSOR_DESCRIPTIONS: tuple[HabitipySensorEntityDescription, ...] = (
native_unit_of_measurement="GP", native_unit_of_measurement="GP",
suggested_display_precision=2, suggested_display_precision=2,
value_fn=lambda user: user.get("stats", {}).get("gp"), value_fn=lambda user: user.get("stats", {}).get("gp"),
ctx="stats",
), ),
HabitipySensorEntityDescription( HabitipySensorEntityDescription(
key=HabitipySensorEntity.CLASS, key=HabitipySensorEntity.CLASS,
@ -139,7 +128,6 @@ SENSOR_DESCRIPTIONS: tuple[HabitipySensorEntityDescription, ...] = (
value_fn=lambda user: user.get("stats", {}).get("class"), value_fn=lambda user: user.get("stats", {}).get("class"),
device_class=SensorDeviceClass.ENUM, device_class=SensorDeviceClass.ENUM,
options=["warrior", "healer", "wizard", "rogue"], options=["warrior", "healer", "wizard", "rogue"],
ctx="stats",
), ),
) )
@ -226,18 +214,6 @@ class HabitipySensor(HabiticaBase, SensorEntity):
entity_description: HabitipySensorEntityDescription entity_description: HabitipySensorEntityDescription
def __init__(
self,
coordinator: HabiticaDataUpdateCoordinator,
entity_description: HabitipySensorEntityDescription,
) -> None:
"""Initialize a generic Habitica sensor."""
super().__init__(
coordinator,
entity_description,
context=entity_description.ctx,
)
@property @property
def native_value(self) -> StateType: def native_value(self) -> StateType:
"""Return the state of the device.""" """Return the state of the device."""