lghorizon 0.9.0.dev3__py3-none-any.whl → 0.9.1__py3-none-any.whl

lghorizon/lghorizon_models.py

@@ -8,7 +8,7 @@ import time
 from abc import ABC, abstractmethod
 from datetime import datetime
 from enum import Enum
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, Optional, Callable
 
 import backoff
 from aiohttp import ClientResponseError, ClientSession
@@ -52,7 +52,7 @@ class LGHorizonRecordingState(Enum):
     UNKNOWN = "unknown"
 
 
-class LGHorizonRecordingType(Enum):
+class LGHorizonRecordingType(Enum):  # type: ignore[no-redef]
     """Enumeration of LG Horizon recording states."""
 
     SINGLE = "single"
@@ -91,6 +91,12 @@ class LGHorizonMessage(ABC):
     def __init__(self, topic: str, payload: dict) -> None:
         """Abstract base class for LG Horizon messages."""
         self._topic = topic
+        """Initialize the abstract base class for LG Horizon messages.
+
+        Args:
+            topic: The MQTT topic of the message.
+            payload: The dictionary payload of the message.
+        """
         self._payload = payload
 
     def __repr__(self) -> str:
@@ -122,7 +128,7 @@ class LGHorizonStatusMessage(LGHorizonMessage):
 
 
 class LGHorizonSourceType(Enum):
-    """Enumeration of LG Horizon message types."""
+    """Enumeration of LG Horizon source types."""
 
     LINEAR = "linear"
     REVIEWBUFFER = "reviewBuffer"
@@ -141,7 +147,7 @@ class LGHorizonSource(ABC):
 
     @property
     @abstractmethod
-    def source_type(self) -> LGHorizonSourceType:
+    def source_type(self) -> LGHorizonSourceType:  # type: ignore[no-redef]
         """Return the message type."""
 
 
@@ -182,7 +188,7 @@ class LGHorizonReviewBufferSource(LGHorizonSource):
 
 
 class LGHorizonNDVRSource(LGHorizonSource):
-    """Represent the ReviewBuffer Source of an LG Horizon device."""
+    """Represent the Network Digital Video Recorder (NDVR) Source of an LG Horizon device."""
 
     @property
     def recording_id(self) -> str:
@@ -223,7 +229,7 @@ class LGHorizonVODSource(LGHorizonSource):
 
 
 class LGHorizonReplaySource(LGHorizonSource):
-    """Represent the VOD Source of an LG Horizon device."""
+    """Represent the Replay Source of an LG Horizon device."""
 
     @property
     def event_id(self) -> str:
@@ -237,7 +243,7 @@ class LGHorizonReplaySource(LGHorizonSource):
 
 
 class LGHorizonUnknownSource(LGHorizonSource):
-    """Represent the Linear Source of an LG Horizon device."""
+    """Represent an unknown source type of an LG Horizon device."""
 
     @property
     def source_type(self) -> LGHorizonSourceType:
@@ -268,6 +274,13 @@ class LGHorizonPlayerState:
         """Return the last speed change time."""
         return self._raw_json.get("lastSpeedChangeTime", 0.0)
 
+    @property
+    def relative_position(
+        self,
+    ) -> int:
+        """Return the last speed change time."""
+        return self._raw_json.get("relativePosition", 0.0)
+
     @property
     def source(self) -> LGHorizonSource | None:  # Added None to the return type
         """Return the last speed change time."""
@@ -288,7 +301,7 @@ class LGHorizonPlayerState:
 
 
 class LGHorizonAppsState:
-    """Represent the State of an LG Horizon device."""
+    """Represent the Apps State of an LG Horizon device."""
 
     def __init__(self, raw_json: dict) -> None:
         """Initialize the Apps state."""
@@ -311,7 +324,7 @@ class LGHorizonAppsState:
 
 
 class LGHorizonUIState:
-    """Represent the State of an LG Horizon device."""
+    """Represent the UI State of an LG Horizon device."""
 
     _player_state: LGHorizonPlayerState | None = None
     _apps_state: LGHorizonAppsState | None = None
@@ -319,6 +332,11 @@ class LGHorizonUIState:
     def __init__(self, raw_json: dict) -> None:
         """Initialize the State."""
         self._raw_json = raw_json
+        """Initialize the UI State.
+
+        Args:
+            raw_json: The raw JSON dictionary containing UI state information.
+        """
 
     @property
     def ui_status(self) -> LGHorizonUIStateType:
@@ -453,6 +471,7 @@ class LGHorizonAuth:
     _country_code: str
     _host: str
     _use_refresh_token: bool
+    _token_refresh_callback: Callable[str, None] | None  # pyright: ignore[reportInvalidTypeForm]
 
     def __init__(
         self,
@@ -474,6 +493,7 @@ class LGHorizonAuth:
         self._host = COUNTRY_SETTINGS[country_code]["api_url"]
         self._use_refresh_token = COUNTRY_SETTINGS[country_code]["use_refreshtoken"]
         self._service_config = None
+        self._token_refresh_callback = None
 
     @property
     def websession(self) -> ClientSession:
@@ -589,6 +609,8 @@ class LGHorizonAuth:
         self.household_id = auth_json["householdId"]
         self.access_token = auth_json["accessToken"]
         self.refresh_token = auth_json["refreshToken"]
+        if self._token_refresh_callback:
+            self._token_refresh_callback(self.refresh_token)
         self.username = auth_json["username"]
         self.token_expiry = auth_json["refreshTokenExpiry"]
 
@@ -669,6 +691,16 @@ class LGHorizonChannel:
         """Returns the channel number."""
         return self.channel_json["logicalChannelNumber"]
 
+    @property
+    def replay_pre_padding(self) -> int:
+        """Returns the channel number."""
+        return self.channel_json.get("replayPrePadding", 0)
+
+    @property
+    def replay_post_padding(self) -> int:
+        """Returns the channel number."""
+        return self.channel_json.get("replayPostPadding", 0)
+
     @property
     def is_radio(self) -> bool:
         """Returns if the channel is a radio channel."""
@@ -820,33 +852,44 @@ class LGHorizonCustomer:
 class LGHorizonDeviceState:
     """Represent current state of a box."""
 
+    _id: Optional[str]
     _channel_id: Optional[str]
     _channel_name: Optional[str]
-    _title: Optional[str]
+    _show_title: Optional[str]
+    _episode_title: Optional[str]
+    _season_number: Optional[int]
+    _episode_number: Optional[int]
     _image: Optional[str]
     _source_type: LGHorizonSourceType
     _paused: bool
-    _sub_title: Optional[str]
     _duration: Optional[float]
     _position: Optional[float]
     _last_position_update: Optional[datetime]
     _state: LGHorizonRunningState
     _speed: Optional[int]
+    _start_time: Optional[int]
+    _end_time: Optional[int]
 
     def __init__(self) -> None:
         """Initialize the playing info."""
         self._channel_id = None
-        self._title = None
+        self._show_title = None
+        self._episode_title = None
+        self._season_number = None
+        self._episode_number = None
         self._image = None
         self._source_type = LGHorizonSourceType.UNKNOWN
+        self._ui_state_type = LGHorizonUIStateType.UNKNOWN
         self._paused = False
-        self.sub_title = None
         self._duration = None
         self._position = None
         self._last_position_update = None
         self._state = LGHorizonRunningState.UNKNOWN
         self._speed = None
         self._channel_name = None
+        self._id = None
+        self._start_time = None
+        self._end_time = None
 
     @property
     def state(self) -> LGHorizonRunningState:
@@ -868,6 +911,16 @@ class LGHorizonDeviceState:
         """Set the channel ID."""
         self._channel_id = value
 
+    @property
+    def id(self) -> Optional[str]:
+        """Return the channel ID."""
+        return self._id
+
+    @id.setter
+    def id(self, value: Optional[str]) -> None:
+        """Set the channel ID."""
+        self._id = value
+
     @property
     def channel_name(self) -> Optional[str]:
         """Return the channel ID."""
@@ -879,14 +932,74 @@ class LGHorizonDeviceState:
         self._channel_name = value
 
     @property
-    def title(self) -> Optional[str]:
+    def show_title(self) -> Optional[str]:
+        """Return the title."""
+        return self._show_title
+
+    @show_title.setter
+    def show_title(self, value: Optional[str]) -> None:
+        """Set the title."""
+        self._show_title = value
+
+    @property
+    def app_name(self) -> Optional[str]:
+        """Return the title."""
+        return self._app_name
+
+    @app_name.setter
+    def app_name(self, value: Optional[str]) -> None:
+        """Set the title."""
+        self._app_name = value
+
+    @property
+    def episode_title(self) -> Optional[str]:
+        """Return the title."""
+        return self._episode_title
+
+    @episode_title.setter
+    def episode_title(self, value: Optional[str]) -> None:
+        """Set the title."""
+        self._episode_title = value
+
+    @property
+    def episode_number(self) -> Optional[int]:
+        """Return the title."""
+        return self._episode_number
+
+    @episode_number.setter
+    def episode_number(self, value: Optional[int]) -> None:
+        """Set the title."""
+        self._episode_number = value
+
+    @property
+    def season_number(self) -> Optional[int]:
+        """Return the title."""
+        return self._season_number
+
+    @season_number.setter
+    def season_number(self, value: Optional[int]) -> None:
+        """Set the title."""
+        self._season_number = value
+
+    @property
+    def start_time(self) -> Optional[int]:
         """Return the title."""
-        return self._title
+        return self._start_time
 
-    @title.setter
-    def title(self, value: Optional[str]) -> None:
+    @start_time.setter
+    def start_time(self, value: Optional[int]) -> None:
         """Set the title."""
-        self._title = value
+        self._start_time = value
+
+    @property
+    def end_time(self) -> Optional[int]:
+        """Return the title."""
+        return self._end_time
+
+    @end_time.setter
+    def end_time(self, value: Optional[int]) -> None:
+        """Set the title."""
+        self._end_time = value
 
     @property
     def image(self) -> Optional[str]:
@@ -908,6 +1021,16 @@ class LGHorizonDeviceState:
         """Set the source type."""
         self._source_type = value
 
+    @property
+    def ui_state_type(self) -> LGHorizonUIStateType:
+        """Return the source type."""
+        return self._ui_state_type
+
+    @ui_state_type.setter
+    def ui_state_type(self, value: LGHorizonUIStateType) -> None:
+        """Set the source type."""
+        self._ui_state_type = value
+
     @property
     def paused(self) -> bool:
         """Return if the media is paused."""
@@ -915,16 +1038,6 @@ class LGHorizonDeviceState:
             return False
         return self.speed == 0
 
-    @property
-    def sub_title(self) -> Optional[str]:
-        """Return the channel title."""
-        return self._sub_title
-
-    @sub_title.setter
-    def sub_title(self, value: Optional[str]) -> None:
-        """Set the channel title."""
-        self._sub_title = value
-
     @property
     def duration(self) -> Optional[float]:
         """Return the duration of the media."""
@@ -946,12 +1059,12 @@ class LGHorizonDeviceState:
         self._position = value
 
     @property
-    def last_position_update(self) -> Optional[datetime]:
+    def last_position_update(self) -> Optional[int]:
         """Return the last time the position was updated."""
         return self._last_position_update
 
     @last_position_update.setter
-    def last_position_update(self, value: Optional[datetime]) -> None:
+    def last_position_update(self, value: Optional[int]) -> None:
         """Set the last position update time."""
         self._last_position_update = value
 
@@ -974,12 +1087,18 @@ class LGHorizonDeviceState:
     async def reset(self) -> None:
         """Reset all playing information."""
         self.channel_id = None
-        self.title = None
-        self.sub_title = None
+        self.episode_number = None
+        self.season_number = None
+        self.episode_title = None
+        self.show_title = None
+        self.app_name = None
         self.image = None
         self.source_type = LGHorizonSourceType.UNKNOWN
         self.speed = None
         self.channel_name = None
+        self.id = None
+        self.start_time = None
+        self.end_time = None
         await self.reset_progress()
 
 
@@ -1028,6 +1147,16 @@ class LGHorizonReplayEvent:
         """Return the season number."""
         return self._raw_json.get("seasonNumber")
 
+    @property
+    def start_time(self) -> Optional[int]:
+        """Return the season number."""
+        return self._raw_json.get("startTime", None)
+
+    @property
+    def end_time(self) -> Optional[int]:
+        """Return the season number."""
+        return self._raw_json.get("endTime", None)
+
     @property
     def title(self) -> str:
         """Return the title of the event."""
@@ -1049,10 +1178,6 @@ class LGHorizonReplayEvent:
             full_title += f": {self.episode_name}"
         return full_title
 
-    def __repr__(self) -> str:
-        """Return a string representation of the replay event."""
-        return f"LGHorizonReplayEvent(title='{self.title}', channel_id='{self.channel_id}', event_id='{self.event_id}')"
-
 
 class LGHorizonVODType(Enum):
     """Enumeration of LG Horizon VOD types."""
@@ -1066,6 +1191,11 @@ class LGHorizonVOD:
     """LGHorizon video on demand."""
 
     def __init__(self, vod_json) -> None:
+        """Initialize an LG Horizon VOD object.
+
+        Args:
+            vod_json: The raw JSON dictionary containing VOD information.
+        """
         self._vod_json = vod_json
 
     @property
@@ -1079,26 +1209,14 @@ class LGHorizonVOD:
         return self._vod_json["id"]
 
     @property
-    def season_number(self) -> Optional[int]:
+    def season(self) -> Optional[int]:
         """Return the season number of the recording."""
-        return self._vod_json.get("seasonNumber", None)
+        return self._vod_json.get("season", None)
 
     @property
-    def episode_number(self) -> Optional[int]:
+    def episode(self) -> Optional[int]:
         """Return the episode number of the recording."""
-        return self._vod_json.get("episodeNumber", None)
-
-    @property
-    def full_episode_title(self) -> Optional[str]:
-        """Return the ID of the VOD."""
-        if self.vod_type != LGHorizonVODType.EPISODE:
-            return None
-        if not self.season_number and not self.episode_number:
-            return None
-        full_title = f"""S{self.season_number:02d}E{self.episode_number:02d}"""
-        if self.title:
-            full_title += f": {self.title}"
-        return full_title
+        return self._vod_json.get("episode", None)
 
     @property
     def title(self) -> str:
@@ -1117,7 +1235,7 @@ class LGHorizonVOD:
 
 
 class LGHOrizonRelevantEpisode:
-    """LGHorizon recording."""
+    """Represents a relevant episode within a recording season or show."""
 
     def __init__(self, episode_json: dict) -> None:
         """Abstract base class for LG Horizon recordings."""
@@ -1178,7 +1296,7 @@ class LGHorizonRecording(ABC):
     @property
     def title(self) -> str:
         """Return the title of the recording."""
-        return self._recording_payload["title"]
+        return self._recording_payload.get("title", "unknown")
 
     @property
     def channel_id(self) -> str:
@@ -1194,7 +1312,10 @@ class LGHorizonRecording(ABC):
         return None
 
     def __init__(self, recording_payload: dict) -> None:
-        """Abstract base class for LG Horizon recordings."""
+        """Abstract base class for LG Horizon recordings.
+        Args:
+            recording_payload: The raw JSON dictionary containing recording information.
+        """
         self._recording_payload = recording_payload
 
 
@@ -1206,6 +1327,11 @@ class LGHorizonRecordingSingle(LGHorizonRecording):
         """Return the episode title of the recording."""
         return self._recording_payload.get("episodeTitle", None)
 
+    @property
+    def episode_id(self) -> Optional[str]:
+        """Return the episode title of the recording."""
+        return self._recording_payload.get("episodeId", None)
+
     @property
     def season_number(self) -> Optional[int]:
         """Return the season number of the recording."""
@@ -1221,29 +1347,39 @@ class LGHorizonRecordingSingle(LGHorizonRecording):
         """Return the show ID of the recording."""
         return self._recording_payload.get("showId", None)
 
+    @property
+    def show_title(self) -> Optional[str]:
+        """Return the show ID of the recording."""
+        return self._recording_payload.get("showTitle", None)
+
     @property
     def season_id(self) -> Optional[str]:
         """Return the season ID of the recording."""
         return self._recording_payload.get("seasonId", None)
 
-    @property
-    def full_episode_title(self) -> Optional[str]:
-        """Return the full episode title of the recording."""
-        if not self.season_number and not self.episode_number:
-            return None
-        full_title = f"""S{self.season_number:02d}E{self.episode_number:02d}"""
-        if self.episode_title:
-            full_title += f": {self.episode_title}"
-        return full_title
-
     @property
     def channel_id(self) -> Optional[str]:
         """Return the channel ID of the recording."""
         return self._recording_payload.get("channelId", None)
 
+    @property
+    def duration(self) -> Optional[int]:
+        """Return the title."""
+        return self.recording_payload.get("duration", None)
+
+    @property
+    def start_time(self) -> Optional[int]:
+        """Return the title."""
+        return self.recording_payload.get("startTime", None)
+
+    @property
+    def end_time(self) -> Optional[int]:
+        """Return the title."""
+        return self.recording_payload.get("endTime", None)
+
 
 class LGHorizonRecordingSeason(LGHorizonRecording):
-    """LGHorizon recording."""
+    """Represents an LG Horizon recording season."""
 
     _most_relevant_epsode: Optional[LGHOrizonRelevantEpisode]
 
@@ -1264,6 +1400,11 @@ class LGHorizonRecordingSeason(LGHorizonRecording):
         """Return the season title of the recording."""
         return self._recording_payload.get("seasonTitle", "")
 
+    @property
+    def show_id(self) -> str:
+        """Return the season title of the recording."""
+        return self._recording_payload.get("showId", "")
+
     @property
     def most_relevant_episode(self) -> Optional[LGHOrizonRelevantEpisode]:
         """Return the most relevant episode of the season."""
@@ -1271,7 +1412,7 @@ class LGHorizonRecordingSeason(LGHorizonRecording):
 
 
 class LGHorizonRecordingShow(LGHorizonRecording):
-    """LGHorizon recording."""
+    """Represents an LG Horizon recording show."""
 
     _most_relevant_epsode: Optional[LGHOrizonRelevantEpisode]
 
@@ -1294,7 +1435,7 @@ class LGHorizonRecordingShow(LGHorizonRecording):
 
 
 class LGHorizonRecordingList:
-    """LGHorizon recording."""
+    """Represents a list of LG Horizon recordings."""
 
     @property
     def total(self) -> int:
@@ -1302,9 +1443,49 @@ class LGHorizonRecordingList:
         return len(self._recordings)
 
     def __init__(self, recordings: List[LGHorizonRecording]) -> None:
-        """Abstract base class for LG Horizon recordings."""
+        """Initialize an LG Horizon recording list.
+
+        Args:
+            recordings: A list of LGHorizonRecording objects.
+        """
         self._recordings = recordings
 
+    @property
+    def recordings(self) -> List[LGHorizonRecording]:
+        """Return the total number of recordings."""
+        return self._recordings
+
+
+class LGHorizonShowRecordingList(LGHorizonRecordingList):
+    """LGHorizon recording."""
+
+    def __init__(
+        self,
+        show_title: Optional[str],
+        show_image,
+        recordings: List[LGHorizonRecording],
+    ) -> None:
+        """Initialize an LG Horizon show recording list.
+
+        Args:
+            show_title: The title of the show.
+            show_image: The image URL for the show.
+            recordings: A list of LGHorizonRecording objects belonging to the show.
+        """
+        super().__init__(recordings)
+        self._show_title = show_title
+        self._show_image = show_image
+
+    @property
+    def show_title(self) -> str:
+        """Title of the show."""
+        return self._show_title
+
+    @property
+    def show_image(self) -> Optional[str]:
+        """Image of the show."""
+        return self._show_image
+
 
 class LGHorizonRecordingQuota:
     """LGHorizon recording quota."""