lghorizon 0.7.5b2__tar.gz → 0.8.0b2__tar.gz

{lghorizon-0.7.5b2 → lghorizon-0.8.0b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lghorizon
-Version: 0.7.5b2
+Version: 0.8.0b2
 Summary: Python client for Liberty Global Horizon settop boxes
 Home-page: https://github.com/sholofly/LGHorizon-python
 Author: Rudolf Offereins
@@ -20,7 +20,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: paho-mqtt<2.0.0
+Requires-Dist: paho-mqtt>=2.0.0
 Requires-Dist: requests>=2.22.0
 Requires-Dist: backoff>=1.9.0
 

{lghorizon-0.7.5b2 → lghorizon-0.8.0b2}/lghorizon/__init__.py

@@ -20,4 +20,22 @@ from .const import (
     RECORDING_TYPE_SHOW,
     RECORDING_TYPE_SEASON,
     RECORDING_TYPE_SINGLE,
-)  # noqa
+)
+
+__all__ = [
+    "LGHorizonApi",
+    "LGHorizonBox",
+    "LGHorizonRecordingListSeasonShow",
+    "LGHorizonRecordingSingle",
+    "LGHorizonRecordingShow",
+    "LGHorizonRecordingEpisode",
+    "LGHorizonCustomer",
+    "LGHorizonApiUnauthorizedError",
+    "LGHorizonApiConnectionError",
+    "LGHorizonApiLockedError",
+    "ONLINE_RUNNING",
+    "ONLINE_STANDBY",
+    "RECORDING_TYPE_SHOW",
+    "RECORDING_TYPE_SEASON",
+    "RECORDING_TYPE_SINGLE",
+]  # noqa

{lghorizon-0.7.5b2 → lghorizon-0.8.0b2}/lghorizon/helpers.py

@@ -1,8 +1,9 @@
 """Helper functions."""
+
 import random
 
 
-def make_id(stringLength=10):
+def make_id(string_length=10):
     """Create an id with given length."""
     letters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
-    return "".join(random.choice(letters) for i in range(stringLength))
+    return "".join(random.choice(letters) for i in range(string_length))

{lghorizon-0.7.5b2 → lghorizon-0.8.0b2}/lghorizon/lghorizon_api.py

@@ -1,17 +1,22 @@
 """Python client for LGHorizon."""
+# pylint: disable=broad-exception-caught
+# pylint: disable=line-too-long
 
 import logging
 import json
-import sys, traceback
+import re
+
+from typing import Any, Callable, Dict, List
+import backoff
+
+from requests import Session, exceptions as request_exceptions
+
 from .exceptions import (
     LGHorizonApiUnauthorizedError,
     LGHorizonApiConnectionError,
     LGHorizonApiLockedError,
 )
-import backoff
-from requests import Session, exceptions as request_exceptions
-from paho.mqtt.client import WebsocketConnectionError
-import re
+
 from .models import (
     LGHorizonAuth,
     LGHorizonBox,
@@ -39,7 +44,7 @@ from .const import (
     RECORDING_TYPE_SEASON,
     RECORDING_TYPE_SHOW,
 )
-from typing import Any, Callable, Dict, List
+
 
 _logger = logging.getLogger(__name__)
 _supported_platforms = ["EOS", "EOS2", "HORIZON", "APOLLO"]
@@ -52,7 +57,7 @@ class LGHorizonApi:
     _session: Session = None
     settop_boxes: Dict[str, LGHorizonBox] = None
     customer: LGHorizonCustomer = None
-    _mqttClient: LGHorizonMqttClient = None
+    _mqtt_client: LGHorizonMqttClient = None
     _channels: Dict[str, LGHorizonChannel] = None
     _country_settings = None
     _country_code: str = None
@@ -89,11 +94,9 @@ class LGHorizonApi:
     def _authorize(self) -> None:
         ctry_code = self._country_code[0:2]
         if ctry_code == "be":
-            self.authorize_telenet()
+            self._authorize_telenet()
         elif ctry_code in ("gb", "ch"):
-            self.authorize_with_refreshtoken()
-            # elif ctry_code == "ch":
-            #     self.authorize_sunrise()
+            self._authorize_with_refresh_token()
         else:
             self._authorize_default()
 
@@ -124,7 +127,8 @@ class LGHorizonApi:
         self._auth.fill(auth_response.json())
         _logger.debug("Authorization succeeded")
 
-    def authorize_with_refreshtoken(self) -> None:
+    def _authorize_with_refresh_token(self) -> None:
+        """Handle authorizzationg using request token."""
         _logger.debug("Authorizing via refresh")
         refresh_url = (
             f"{self._country_settings['api_url']}/auth-service/v1/authorization/refresh"
@@ -153,8 +157,8 @@ class LGHorizonApi:
                 raise LGHorizonApiConnectionError("Unknown connection error")
 
         self._auth.fill(auth_response.json())
-        self.refresh_token = self._auth.refreshToken
-        self._session.cookies["ACCESSTOKEN"] = self._auth.accessToken
+        self.refresh_token = self._auth.refresh_token
+        self._session.cookies["ACCESSTOKEN"] = self._auth.access_token
 
         if self._refresh_callback:
             self._refresh_callback()
@@ -162,9 +166,11 @@ class LGHorizonApi:
         _logger.debug("Authorization succeeded")
 
     def set_callback(self, refresh_callback: Callable) -> None:
+        """Set the refresh callback."""
         self._refresh_callback = refresh_callback
 
-    def authorize_telenet(self):
+    def _authorize_telenet(self):
+        """Authorize telenet users."""
         try:
             login_session = Session()
             # Step 1 - Get Authorization data
@@ -176,13 +182,13 @@ class LGHorizonApi:
             if not auth_response.ok:
                 raise LGHorizonApiConnectionError("Can't connect to authorization URL")
             auth_response_json = auth_response.json()
-            authorizationUri = auth_response_json["authorizationUri"]
-            authValidtyToken = auth_response_json["validityToken"]
+            authorization_uri = auth_response_json["authorizationUri"]
+            authorization_validity_token = auth_response_json["validityToken"]
 
             # Step 2 - Get Authorization cookie
             _logger.debug("Step 2 - Get Authorization cookie")
 
-            auth_cookie_response = login_session.get(authorizationUri)
+            auth_cookie_response = login_session.get(authorization_uri)
             if not auth_cookie_response.ok:
                 raise LGHorizonApiConnectionError("Can't connect to authorization URL")
 
@@ -206,20 +212,20 @@ class LGHorizonApi:
                 self._country_settings["oauth_redirect_header"]
             ]
 
-            if not self._identifier is None:
+            if self._identifier is not None:
                 redirect_url += f"&dtv_identifier={self._identifier}"
             redirect_response = login_session.get(redirect_url, allow_redirects=False)
             success_url = redirect_response.headers[
                 self._country_settings["oauth_redirect_header"]
             ]
-            codeMatches = re.findall(r"code=(.*)&", success_url)
+            code_matches = re.findall(r"code=(.*)&", success_url)
 
-            authorizationCode = codeMatches[0]
+            authorization_code = code_matches[0]
 
             new_payload = {
                 "authorizationGrant": {
-                    "authorizationCode": authorizationCode,
-                    "validityToken": authValidtyToken,
+                    "authorizationCode": authorization_code,
+                    "validityToken": authorization_validity_token,
                 }
             }
             headers = {
@@ -229,8 +235,8 @@ class LGHorizonApi:
                 auth_url, json.dumps(new_payload), headers=headers
             )
             self._auth.fill(post_result.json())
-            self._session.cookies["ACCESSTOKEN"] = self._auth.accessToken
-        except Exception as ex:
+            self._session.cookies["ACCESSTOKEN"] = self._auth.access_token
+        except Exception:
             pass
 
     def _obtain_mqtt_token(self):
@@ -238,7 +244,7 @@ class LGHorizonApi:
         mqtt_auth_url = self._config["authorizationService"]["URL"]
         mqtt_response = self._do_api_call(f"{mqtt_auth_url}/v1/mqtt/token")
         self._auth.mqttToken = mqtt_response["token"]
-        _logger.debug(f"MQTT token: {self._auth.mqttToken}")
+        _logger.debug("MQTT token: %s", self._auth.mqttToken)
 
     @backoff.on_exception(
         backoff.expo,
@@ -251,11 +257,12 @@ class LGHorizonApi:
         ),
     )
     def connect(self) -> None:
+        """Start connection process."""
         self._config = self._get_config(self._country_code)
         _logger.debug("Connect to API")
         self._authorize()
         self._obtain_mqtt_token()
-        self._mqttClient = LGHorizonMqttClient(
+        self._mqtt_client = LGHorizonMqttClient(
             self._auth,
             self._config["mqttBroker"]["URL"],
             self._on_mqtt_connected,
@@ -263,14 +270,14 @@ class LGHorizonApi:
         )
 
         self._register_customer_and_boxes()
-        self._mqttClient.connect()
+        self._mqtt_client.connect()
 
     def disconnect(self):
         """Disconnect."""
         _logger.debug("Disconnect from API")
-        if not self._mqttClient or not self._mqttClient.is_connected:
+        if not self._mqtt_client or not self._mqtt_client.is_connected:
             return
-        self._mqttClient.disconnect()
+        self._mqtt_client.disconnect()
 
     def _on_mqtt_connected(self) -> None:
         _logger.debug("Connected to MQTT server. Registering all boxes...")
@@ -281,47 +288,46 @@ class LGHorizonApi:
     def _on_mqtt_message(self, message: str, topic: str) -> None:
         if "action" in message and message["action"] == "OPS.getProfilesUpdate":
             self._update_customer()
-            box: LGHorizonBox
         elif "source" in message:
-            deviceId = message["source"]
-            if not isinstance(deviceId, str):
+            device_id = message["source"]
+            if not isinstance(device_id, str):
                 _logger.debug("ignoring message - not a string")
                 return
-            if not deviceId in self.settop_boxes.keys():
+            if device_id not in self.settop_boxes:
                 return
             try:
                 if "deviceType" in message and message["deviceType"] == "STB":
-                    self.settop_boxes[deviceId].update_state(message)
+                    self.settop_boxes[device_id].update_state(message)
                 if "status" in message:
-                    self._handle_box_update(deviceId, message)
+                    self._handle_box_update(device_id, message)
 
             except Exception:
                 _logger.exception("Could not handle status message")
-                _logger.warning(f"Full message: {str(message)}")
-                self.settop_boxes[deviceId].playing_info.reset()
-                self.settop_boxes[deviceId].playing_info.set_paused(False)
+                _logger.warning("Full message: %s", str(message))
+                self.settop_boxes[device_id].playing_info.reset()
+                self.settop_boxes[device_id].playing_info.set_paused(False)
         elif "CPE.capacity" in message:
             splitted_topic = topic.split("/")
             if len(splitted_topic) != 4:
                 return
-            deviceId = splitted_topic[1]
-            if not deviceId in self.settop_boxes.keys():
+            device_id = splitted_topic[1]
+            if device_id not in self.settop_boxes:
                 return
-            self.settop_boxes[deviceId].update_recording_capacity(message)
+            self.settop_boxes[device_id].update_recording_capacity(message)
 
-    def _handle_box_update(self, deviceId: str, raw_message: Any) -> None:
-        statusPayload = raw_message["status"]
-        if "uiStatus" not in statusPayload:
+    def _handle_box_update(self, device_id: str, raw_message: Any) -> None:
+        status_payload = raw_message["status"]
+        if "uiStatus" not in status_payload:
             return
-        uiStatus = statusPayload["uiStatus"]
-        if uiStatus == "mainUI":
-            playerState = statusPayload["playerState"]
-            if "sourceType" not in playerState or "source" not in playerState:
+        ui_status = status_payload["uiStatus"]
+        if ui_status == "mainUI":
+            player_state = status_payload["playerState"]
+            if "sourceType" not in player_state or "source" not in player_state:
                 return
-            source_type = playerState["sourceType"]
-            state_source = playerState["source"]
-            self.settop_boxes[deviceId].playing_info.set_paused(
-                playerState["speed"] == 0
+            source_type = player_state["sourceType"]
+            state_source = player_state["source"]
+            self.settop_boxes[device_id].playing_info.set_paused(
+                player_state["speed"] == 0
             )
             if (
                 source_type
@@ -332,27 +338,27 @@ class LGHorizonApi:
                 )
                 and "eventId" in state_source
             ):
-                eventId = state_source["eventId"]
+                event_id = state_source["eventId"]
                 raw_replay_event = self._do_api_call(
-                    f"{self._config['linearService']['URL']}/v2/replayEvent/{eventId}?returnLinearContent=true&language={self._country_settings['language']}"
+                    f"{self._config['linearService']['URL']}/v2/replayEvent/{event_id}?returnLinearContent=true&language={self._country_settings['language']}"
                 )
-                replayEvent = LGHorizonReplayEvent(raw_replay_event)
-                channel = self._channels[replayEvent.channelId]
-                self.settop_boxes[deviceId].update_with_replay_event(
-                    source_type, replayEvent, channel
+                replay_event = LGHorizonReplayEvent(raw_replay_event)
+                channel = self._channels[replay_event.channel_id]
+                self.settop_boxes[device_id].update_with_replay_event(
+                    source_type, replay_event, channel
                 )
             elif source_type == BOX_PLAY_STATE_DVR:
-                recordingId = state_source["recordingId"]
+                recording_id = state_source["recordingId"]
                 session_start_time = state_source["sessionStartTime"]
                 session_end_time = state_source["sessionEndTime"]
-                last_speed_change_time = playerState["lastSpeedChangeTime"]
-                relative_position = playerState["relativePosition"]
+                last_speed_change_time = player_state["lastSpeedChangeTime"]
+                relative_position = player_state["relativePosition"]
                 raw_recording = self._do_api_call(
-                    f"{self._config['recordingService']['URL']}/customers/{self._auth.householdId}/details/single/{recordingId}?profileId=4504e28d-c1cb-4284-810b-f5eaab06f034&language={self._country_settings['language']}"
+                    f"{self._config['recordingService']['URL']}/customers/{self._auth.household_id}/details/single/{recording_id}?profileId=4504e28d-c1cb-4284-810b-f5eaab06f034&language={self._country_settings['language']}"
                 )
                 recording = LGHorizonRecordingSingle(raw_recording)
-                channel = self._channels[recording.channelId]
-                self.settop_boxes[deviceId].update_with_recording(
+                channel = self._channels[recording.channel_id]
+                self.settop_boxes[device_id].update_with_recording(
                     source_type,
                     recording,
                     channel,
@@ -362,35 +368,35 @@ class LGHorizonApi:
                     relative_position,
                 )
             elif source_type == BOX_PLAY_STATE_VOD:
-                titleId = state_source["titleId"]
-                last_speed_change_time = playerState["lastSpeedChangeTime"]
-                relative_position = playerState["relativePosition"]
+                title_id = state_source["titleId"]
+                last_speed_change_time = player_state["lastSpeedChangeTime"]
+                relative_position = player_state["relativePosition"]
                 raw_vod = self._do_api_call(
-                    f"{self._config['vodService']['URL']}/v2/detailscreen/{titleId}?language={self._country_settings['language']}&profileId=4504e28d-c1cb-4284-810b-f5eaab06f034&cityId={self.customer.cityId}"
+                    f"{self._config['vodService']['URL']}/v2/detailscreen/{title_id}?language={self._country_settings['language']}&profileId=4504e28d-c1cb-4284-810b-f5eaab06f034&cityId={self.customer.city_id}"
                 )
                 vod = LGHorizonVod(raw_vod)
-                self.settop_boxes[deviceId].update_with_vod(
+                self.settop_boxes[device_id].update_with_vod(
                     source_type, vod, last_speed_change_time, relative_position
                 )
-        elif uiStatus == "apps":
-            app = LGHorizonApp(statusPayload["appsState"])
-            self.settop_boxes[deviceId].update_with_app("app", app)
+        elif ui_status == "apps":
+            app = LGHorizonApp(status_payload["appsState"])
+            self.settop_boxes[device_id].update_with_app("app", app)
 
     @backoff.on_exception(
         backoff.expo, LGHorizonApiConnectionError, max_tries=3, logger=_logger
     )
-    def _do_api_call(self, url: str, tries: int = 0) -> str:
-        _logger.info(f"Executing API call to {url}")
+    def _do_api_call(self, url: str) -> str:
+        _logger.info("Executing API call to %s", url)
         try:
             api_response = self._session.get(url)
             api_response.raise_for_status()
             json_response = api_response.json()
-        except request_exceptions.HTTPError as httpEx:
+        except request_exceptions.HTTPError as http_ex:
             self._authorize()
             raise LGHorizonApiConnectionError(
-                f"Unable to call {url}. Error:{str(httpEx)}"
-            )
-        _logger.debug(f"Result API call: {json_response}")
+                f"Unable to call {url}. Error:{str(http_ex)}"
+            ) from http_ex
+        _logger.debug("Result API call: %s", json_response)
         return json_response
 
     def _register_customer_and_boxes(self):
@@ -412,15 +418,15 @@ class LGHorizonApi:
             else:
                 platform_type = None
             box = LGHorizonBox(
-                device, platform_type, self._mqttClient, self._auth, self._channels
+                device, platform_type, self._mqtt_client, self._auth, self._channels
             )
-            self.settop_boxes[box.deviceId] = box
-            _logger.info("Box %s registered...", box.deviceId)
+            self.settop_boxes[box.device_id] = box
+            _logger.info("Box %s registered...", box.device_id)
 
     def _update_customer(self):
         _logger.info("Get customer data")
         personalisation_result = self._do_api_call(
-            f"{self._config['personalizationService']['URL']}/v1/customer/{self._auth.householdId}?with=profiles%2Cdevices"
+            f"{self._config['personalizationService']['URL']}/v1/customer/{self._auth.household_id}?with=profiles%2Cdevices"
         )
         _logger.debug("Personalisation result: %s ", personalisation_result)
         self.customer = LGHorizonCustomer(personalisation_result)
@@ -429,7 +435,7 @@ class LGHorizonApi:
         self._update_entitlements()
         _logger.info("Retrieving channels...")
         channels_result = self._do_api_call(
-            f"{self._config['linearService']['URL']}/v2/channels?cityId={self.customer.cityId}&language={self._country_settings['language']}&productClass=Orion-DASH"
+            f"{self._config['linearService']['URL']}/v2/channels?cityId={self.customer.city_id}&language={self._country_settings['language']}&productClass=Orion-DASH"
         )
         for channel in channels_result:
             if "isRadio" in channel and channel["isRadio"]:
@@ -441,9 +447,10 @@ class LGHorizonApi:
                 continue
             channel_id = channel["id"]
             self._channels[channel_id] = LGHorizonChannel(channel)
-        _logger.info(f"{len(self._channels)} retrieved.")
+        _logger.info("%s retrieved.", len(self._channels))
 
     def get_display_channels(self):
+        """Returns channels to display baed on profile."""
         all_channels = self._channels.values()
         if not self._profile_id or self._profile_id not in self.customer.profiles:
             return all_channels
@@ -455,11 +462,11 @@ class LGHorizonApi:
             channel for channel in all_channels if channel.id in profile_channel_ids
         ]
 
-    def _get_replay_event(self, listingId) -> Any:
+    def _get_replay_event(self, listing_id) -> Any:
         """Get listing."""
         _logger.info("Retrieving replay event details...")
         response = self._do_api_call(
-            f"{self._config['linearService']['URL']}/v2/replayEvent/{listingId}?returnLinearContent=true&language={self._country_settings['language']}"
+            f"{self._config['linearService']['URL']}/v2/replayEvent/{listing_id}?returnLinearContent=true&language={self._country_settings['language']}"
         )
         _logger.info("Replay event details retrieved")
         return response
@@ -473,38 +480,40 @@ class LGHorizonApi:
         try:
             _logger.info("Retrieving recordingcapacity...")
             quota_content = self._do_api_call(
-                f"{self._config['recordingService']['URL']}/customers/{self._auth.householdId}/quota"
+                f"{self._config['recordingService']['URL']}/customers/{self._auth.household_id}/quota"
             )
-            if not "quota" in quota_content and not "occupied" in quota_content:
+            if "quota" not in quota_content and "occupied" not in quota_content:
                 _logger.error("Unable to fetch recording capacity...")
                 return None
             capacity = (quota_content["occupied"] / quota_content["quota"]) * 100
             self.recording_capacity = round(capacity)
-            _logger.debug(f"Remaining recordingcapacity {self.recording_capacity}%")
+            _logger.debug("Remaining recordingcapacity %s %%", self.recording_capacity)
             return self.recording_capacity
-        except:
+        except Exception:
             _logger.error("Unable to fetch recording capacity...")
             return None
 
     def get_recordings(self) -> List[LGHorizonBaseRecording]:
+        """Returns recordings."""
         _logger.info("Retrieving recordings...")
         recording_content = self._do_api_call(
-            f"{self._config['recordingService']['URL']}/customers/{self._auth.householdId}/recordings?sort=time&sortOrder=desc&language={self._country_settings['language']}"
+            f"{self._config['recordingService']['URL']}/customers/{self._auth.household_id}/recordings?sort=time&sortOrder=desc&language={self._country_settings['language']}"
         )
         recordings = []
         for recording_data_item in recording_content["data"]:
-            type = recording_data_item["type"]
-            if type == RECORDING_TYPE_SINGLE:
+            recording_type = recording_data_item["type"]
+            if recording_type == RECORDING_TYPE_SINGLE:
                 recordings.append(LGHorizonRecordingSingle(recording_data_item))
-            elif type in (RECORDING_TYPE_SEASON, RECORDING_TYPE_SHOW):
+            elif recording_type in (RECORDING_TYPE_SEASON, RECORDING_TYPE_SHOW):
                 recordings.append(LGHorizonRecordingListSeasonShow(recording_data_item))
-        _logger.info(f"{len(recordings)} recordings retrieved...")
+        _logger.info("%s recordings retrieved...", len(recordings))
         return recordings
 
-    def get_recording_show(self, showId: str) -> list[LGHorizonRecordingSingle]:
+    def get_recording_show(self, show_id: str) -> list[LGHorizonRecordingSingle]:
+        """Returns show recording"""
         _logger.info("Retrieving show recordings...")
         show_recording_content = self._do_api_call(
-            f"{self._config['recordingService']['URL']}/customers/{self._auth.householdId}/episodes/shows/{showId}?source=recording&language=nl&sort=time&sortOrder=asc"
+            f"{self._config['recordingService']['URL']}/customers/{self._auth.household_id}/episodes/shows/{show_id}?source=recording&language=nl&sort=time&sortOrder=asc"
         )
         recordings = []
         for item in show_recording_content["data"]:
@@ -512,21 +521,21 @@ class LGHorizonApi:
                 recordings.append(LGHorizonRecordingShow(item))
             else:
                 recordings.append(LGHorizonRecordingEpisode(item))
-        _logger.info(f"{len(recordings)} showrecordings retrieved...")
+        _logger.info("%s showrecordings retrieved...", len(recordings))
         return recordings
 
     def _update_entitlements(self) -> None:
         _logger.info("Retrieving entitlements...")
         entitlements_json = self._do_api_call(
-            f"{self._config['purchaseService']['URL']}/v2/customers/{self._auth.householdId}/entitlements?enableDaypass=true"
+            f"{self._config['purchaseService']['URL']}/v2/customers/{self._auth.household_id}/entitlements?enableDaypass=true"
         )
         self._entitlements.clear()
         for entitlement in entitlements_json["entitlements"]:
             self._entitlements.append(entitlement["id"])
 
     def _get_config(self, country_code: str):
-        ctryCode = country_code[0:2]
-        config_url = f"{self._country_settings['api_url']}/{ctryCode}/en/config-service/conf/web/backoffice.json"
+        base_country_code = country_code[0:2]
+        config_url = f"{self._country_settings['api_url']}/{base_country_code}/en/config-service/conf/web/backoffice.json"
         result = self._do_api_call(config_url)
         _logger.debug(result)
         return result