Merge branch 'DavidMStraub:master' into documentation-improvements

Author: nagelp

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+env:
+  DEFAULT_PYTHON: "3.12"
+
+jobs:
+  ruff:
+    name: Check ruff
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code from GitHub
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+
+      - name: Upgrade pip
+        run: |
+          python -m pip install --upgrade pip
+          pip --version
+
+      - name: Install ruff
+        run: |
+          pip install ruff
+
+      - name: Run ruff
+        run: |
+          ruff check homeconnect

homeconnect/api.py

@@ -1,12 +1,14 @@
 import json
 import logging
 import os
-import time
 from threading import Thread
+import time
 from typing import Callable, Dict, Optional, Union
 
 from oauthlib.oauth2 import TokenExpiredError
 from requests import Response
+from requests.adapters import HTTPAdapter, Retry
+from requests.exceptions import RetryError
 from requests_oauthlib import OAuth2Session
 
 from .sseclient import SSEClient
@@ -16,6 +18,8 @@
 ENDPOINT_TOKEN = "/security/oauth/token"
 ENDPOINT_APPLIANCES = "/api/homeappliances"
 TIMEOUT_S = 120
+TOTAL_RETRIES = 1
+
 
 LOGGER = logging.getLogger("homeconnect")
 
@@ -52,6 +56,9 @@ def __init__(
             token=token,
             token_updater=token_updater,
         )
+        self.retry = Retry(TOTAL_RETRIES, status_forcelist=[429])
+        self._oauth.mount("https://", HTTPAdapter(max_retries=self.retry))
+        self._oauth.mount("http://", HTTPAdapter(max_retries=self.retry))
 
     def refresh_tokens(self) -> Dict[str, Union[str, int]]:
         """Refresh and return new tokens."""
@@ -77,6 +84,9 @@ def request(self, method: str, path: str, **kwargs) -> Response:
             self._oauth.token = self.refresh_tokens()
 
             return getattr(self._oauth, method)(url, **kwargs)
+        except RetryError as e:
+            LOGGER.warning("Retry failed: %s", e)
+            return e.response
 
     def get(self, endpoint):
         """Get data as dictionary from an endpoint."""
@@ -128,8 +138,7 @@ def delete(self, endpoint):
         return res
 
     def get_appliances(self):
-        """Return a list of `HomeConnectAppliance` instances for all
-        appliances."""
+        """Return a list of `HomeConnectAppliance` instances for all appliances."""
 
         appliances = {}
 
@@ -150,7 +159,7 @@ def get_appliances(self):
     def get_authurl(self):
         """Get the URL needed for the authorization code grant flow."""
         authorization_url, _ = self._oauth.authorization_url(
-            f"{self.host}/{ENDPOINT_AUTHORIZE}"
+            f"{self.host}{ENDPOINT_AUTHORIZE}"
         )
         return authorization_url
 
@@ -184,15 +193,16 @@ def handle_event(self, event, appliance):
         """Handle a new event.
 
         Updates the status with the event data and executes any callback
-        function."""
+        function.
+        """
         event_data = json.loads(event.data)
         items = event_data.get("items")
         if items is not None:
             data_dict = self.json2dict(items)
         else:
             data_dict = {event_data.pop("key"): event_data}
 
-        if event.event == "NOTIFY" or event.event == "STATUS":
+        if event.event in ("NOTIFY", "STATUS", "EVENT"):
             appliance.status.update(data_dict)
 
         elif event.event == "CONNECTED":
@@ -208,8 +218,11 @@ def handle_event(self, event, appliance):
 
     @staticmethod
     def json2dict(lst):
-        """Turn a list of dictionaries where one key is called 'key'
-        into a dictionary with the value of 'key' as key."""
+        """Convert JSON to dictionary.
+
+        Turn a list of dictionaries where one key is called 'key'
+        into a dictionary with the value of 'key' as key.
+        """
         return {d.pop("key"): d for d in lst}
 
 
@@ -237,14 +250,23 @@ def token_dump(self, token):
             json.dump(token, f)
 
     def token_load(self):
-        """Load the token from the cache if exists it and is not expired,
-        otherwise return None."""
+        """Load the token from the cache if exists and not expired."""
         if not os.path.exists(self.token_cache):
             return None
         with open(self.token_cache, "r") as f:
             token = json.load(f)
         now = int(time.time())
         token["expires_in"] = token.get("expires_at", now - 1) - now
+        self._oauth = OAuth2Session(
+            client_id=self.client_id,
+            redirect_uri=self.redirect_uri,
+            auto_refresh_kwargs={
+                "client_id": self.client_id,
+                "client_secret": self.client_secret,
+            },
+            token=token,
+            token_updater=self.token_updater,
+        )
         return token
 
     def token_expired(self, token):
@@ -253,11 +275,10 @@ def token_expired(self, token):
         return token["expires_at"] - now < 60
 
     def get_token(self, authorization_response):
-        """Get the token given the redirect URL obtained from the
-        authorization."""
+        """Get the token given the redirect URL obtained from the authorization."""
         LOGGER.info("Fetching token ...")
         token = self._oauth.fetch_token(
-            f"{self.host}/{ENDPOINT_TOKEN}",
+            f"{self.host}{ENDPOINT_TOKEN}",
             authorization_response=authorization_response,
             client_secret=self.client_secret,
         )
@@ -291,7 +312,10 @@ def __init__(
         self.event_callback = None
 
     def __repr__(self):
-        return "HomeConnectAppliance(hc, haId='{}', vib='{}', brand='{}', type='{}', name='{}', enumber='{}', connected={})".format(
+        return (
+            "HomeConnectAppliance(hc, haId='{}', vib='{}', brand='{}'"
+            ", type='{}', name='{}', enumber='{}', connected={})"
+        ).format(
             self.haId,
             self.vib,
             self.brand,
@@ -302,16 +326,19 @@ def __repr__(self):
         )
 
     def listen_events(self, callback=None):
-        """Register event callback method"""
+        """Register event callback method."""
         self.event_callback = callback
 
         if not self.hc.listening_events:
             self.hc.listen_events()
 
     @staticmethod
     def json2dict(lst):
-        """Turn a list of dictionaries where one key is called 'key'
-        into a dictionary with the value of 'key' as key."""
+        """Convert JSON to dictionary.
+
+        Turn a list of dictionaries where one key is called 'key'
+        into a dictionary with the value of 'key' as key.
+        """
         return {d.pop("key"): d for d in lst}
 
     def get(self, endpoint):

homeconnect/sseclient.py

@@ -1,14 +1,13 @@
-"""Taken from https://github.com/btubbs/sseclient"""
+"""Taken from https://github.com/btubbs/sseclient."""
 
 import codecs
 import logging
 import re
 import time
 import warnings
 
-import requests
-import six
 from oauthlib.oauth2 import TokenExpiredError
+import requests
 from requests.exceptions import HTTPError
 
 # Technically, we should support streams that mix line endings.  This regex,
@@ -42,7 +41,7 @@ def __init__(
         self.requests_kwargs["headers"]["Accept"] = "text/event-stream"
 
         # Keep data here as it streams in
-        self.buf = u""
+        self.buf = ""
 
         self._connect()
 
@@ -56,6 +55,8 @@ def _connect(self):
         self.resp = requester.get(self.url, stream=True, **self.requests_kwargs)
         self.resp_iterator = self.resp.iter_content(chunk_size=self.chunk_size)
 
+        self.resp.encoding = "UTF-8"
+
         # TODO: Ensure we're handling redirects.  Might also stick the 'origin'
         # attribute on Events like the Javascript spec requires.
         try:
@@ -84,7 +85,8 @@ def __next__(self):
                     raise EOFError()
                 self.buf += decoder.decode(next_chunk)
 
-            # except (StopIteration, requests.RequestException, EOFError, http.client.IncompleteRead, ValueError) as e:
+            # except (StopIteration, requests.RequestException, EOFError,
+            #         http.client.IncompleteRead, ValueError) as e:
             except Exception as e:
                 LOGGER.warning("Exception while reading event: ", exc_info=True)
                 time.sleep(self.retry / 1000.0)
@@ -113,9 +115,6 @@ def __next__(self):
 
         return msg
 
-    if six.PY2:
-        next = __next__
-
 
 class Event(object):
 
@@ -144,7 +143,8 @@ def dump(self):
 
     @classmethod
     def parse(cls, raw):
-        """
+        """Parse event message.
+
         Given a possibly-multiline string representing an SSE message, parse it
         and return a Event object.
         """
@@ -154,7 +154,7 @@ def parse(cls, raw):
             if m is None:
                 # Malformed line.  Discard but warn.
                 warnings.warn('Invalid SSE line: "%s"' % line, SyntaxWarning)
-                LOGGER.warn('Invalid SSE line: "%s"', line)
+                LOGGER.warning('Invalid SSE line: "%s"', line)
                 continue
 
             name = m.group("name")

pyproject.toml

@@ -0,0 +1,27 @@
+[tool.ruff.lint]
+select = [
+    "D",  # docstrings
+    "E",  # pycodestyle
+    "G",  # flake8-logging-format
+    "I",  # isort
+    "W",  # pycodestyle
+]
+
+ignore = [
+    "D100",  # Missing docstring in public module
+    "D101",  # Missing docstring in public class
+    "D102",  # Missing docstring in public method
+    "D104",  # Missing docstring in public package
+    "D105",  # Missing docstring in magic method
+    "D107",  # Missing docstring in `__init__`
+    "D202",  # No blank lines allowed aftee function docstring
+    "D203",  # 1 blank line required before class docstring
+    "D213",  # Multi-line docstring summary should start at the second line
+    "D401",  # First line should be in imperative mood
+    "E722",  # Do not use bare `except`
+]
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+combine-as-imports = true
+split-on-trailing-comma = false

requirements_test.txt

@@ -0,0 +1,19 @@
+certifi==2024.7.4
+charset-normalizer==3.3.2
+coverage==7.5.4
+execnet==2.1.1
+idna==3.7
+iniconfig==2.0.0
+oauthlib==3.2.2
+packaging==24.1
+pluggy==1.5.0
+pytest==8.2.2
+pytest-cov==5.0.0
+pytest-xdist==3.6.1
+PyYAML==6.0.1
+requests==2.32.3
+requests-mock==1.12.1
+requests-oauthlib==2.0.0
+responses==0.25.3
+typing_extensions==4.12.2
+urllib3==2.2.2

setup.py

@@ -1,20 +1,23 @@
-from setuptools import setup, find_packages
-
+from setuptools import find_packages, setup
 
 with open("README.md") as f:
     LONG_DESCRIPTION = f.read()
 
 setup(
     name="homeconnect",
-    version="0.7.2",
+    version="0.8.0",
     author="David M. Straub",
-    author_email="david.straub@tum.de",
+    author_email="straub@protonmail.com",
     url="https://github.com/DavidMStraub/homeconnect",
     description="Python client for the BSH Home Connect REST API",
     long_description=LONG_DESCRIPTION,
     long_description_content_type="text/markdown",
     license="MIT",
     packages=find_packages(),
     install_requires=["requests", "requests_oauthlib"],
-    extras_require={"testing": ["nose",],},
+    extras_require={
+        "testing": [
+            "nose",
+        ],
+    },
 )

test.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -x 
+
+python3 -m venv .venv
+
+. .venv/bin/activate
+
+pip3 install -r requirements_test.txt
+
+pytest --cov=homeconnect/ --cov-report term-missing -vv ./tests/homeconnect
+
+rm -rf .venv