Merge pull request #96 from Pyhass/github-fixes

KJonline · web-flow · commit ad7cbcd1f39d · 2025-08-26T19:13:46.000+01:00
GitHub fixes
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -10,7 +10,7 @@ on:
 
 env:
   CACHE_VERSION: 1
-  DEFAULT_PYTHON: 3.8
+  DEFAULT_PYTHON: "3.10"
   PRE_COMMIT_HOME: ~/.cache/pre-commit
 
 jobs:
@@ -44,6 +44,7 @@ jobs:
       - name: Create Python virtual environment
         if: steps.cache-venv.outputs.cache-hit != 'true'
         run: |
+          sudo apt-get update && sudo apt-get install -y libxml2-dev libxslt1-dev python3-dev build-essential
           python -m venv venv
           . venv/bin/activate
           pip install -U "pip<20.3" setuptools
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -31,7 +31,7 @@ jobs:
           # NOTE: put your own distribution build steps here.
           python -m pip install build
           python -m build
-        
+
       - name: Upload wheel to GitHub Release
         uses: ncipollo/release-action@v1
         with:
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,18 +1,18 @@
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.34.0
+    rev: v3.20.0
     hooks:
       - id: pyupgrade
         args: [--py38-plus]
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 25.1.0
     hooks:
       - id: black
         args:
           - --safe
           - --quiet
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.1.0
+    rev: v2.4.1
     hooks:
       - id: codespell
         args:
@@ -21,36 +21,38 @@ repos:
           - --quiet-level=2
         exclude_types: [csv, json]
   - repo: https://github.com/pycqa/flake8
-    rev: 3.9.2
+    rev: 7.3.0
     hooks:
       - id: flake8
         additional_dependencies:
-          - flake8-docstrings==1.5.0
-          - pydocstyle==5.1.1
+          - flake8-docstrings==1.7.0
+          - pydocstyle==6.3.0
   - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.4
+    rev: 1.8.6
     hooks:
       - id: bandit
         args:
           - --quiet
           - --format=custom
           - --configfile=tests/bandit.yaml
+        additional_dependencies:
+          - pbr
   - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
+    rev: 6.0.1
     hooks:
       - id: isort
         args: ["--profile", "black"]
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.26.3
+    rev: v1.37.1
     hooks:
       - id: yamllint
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v2.7.1
+    rev: v4.0.0-alpha.8
     hooks:
       - id: prettier
         stages: [manual]
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v6.0.0
     hooks:
       - id: check-executables-have-shebangs
         stages: [manual]
@@ -66,8 +68,7 @@ repos:
         entry: pylint
         language: system
         types: [python]
-        args:
-          [
-            "-rn",  # Only display messages
-            "-sn",  # Don't display the score
-          ]
+        args: [
+          "-rn",  # Only display messages
+          "-sn",  # Don't display the score
+        ]
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 ![CodeQL](https://github.com/Pyhive/Pyhiveapi/workflows/CodeQL/badge.svg) ![Python Linting](https://github.com/Pyhive/Pyhiveapi/workflows/Python%20package/badge.svg)
 
 # Introduction
-This is a library which intefaces with the Hive smart home platform. 
+This is a library which interfaces with the Hive smart home platform. 
 This library is built mainly to integrate with the Home Assistant platform,
 but it can also be used independently (See examples below.)
 
diff --git a/pyhiveapi/apyhiveapi/__init__.py b/pyhiveapi/apyhiveapi/__init__.py
@@ -1,4 +1,5 @@
 """__init__.py."""
+
 # pylint: skip-file
 if __name__ == "pyhiveapi":
     from .api.hive_api import HiveApi as API  # noqa: F401
diff --git a/pyhiveapi/apyhiveapi/action.py b/pyhiveapi/apyhiveapi/action.py
@@ -1,4 +1,5 @@
 """Hive Action Module."""
+
 # pylint: skip-file
 
 
diff --git a/pyhiveapi/apyhiveapi/alarm.py b/pyhiveapi/apyhiveapi/alarm.py
@@ -1,4 +1,5 @@
 """Hive Alarm Module."""
+
 # pylint: skip-file
 
 
diff --git a/pyhiveapi/apyhiveapi/api/hive_api.py b/pyhiveapi/apyhiveapi/api/hive_api.py
@@ -1,4 +1,5 @@
 """Hive API Module."""
+
 # pylint: skip-file
 import json
 
diff --git a/pyhiveapi/apyhiveapi/api/hive_async_api.py b/pyhiveapi/apyhiveapi/api/hive_async_api.py
@@ -1,4 +1,5 @@
 """Hive API Module."""
+
 # pylint: skip-file
 import json
 from typing import Optional
@@ -339,7 +340,7 @@ async def setAction(self, n_id, data):
         return self.json_return
 
     async def error(self):
-        """An error has occurred iteracting with the Hive API."""
+        """An error has occurred interacting with the Hive API."""
         raise web_exceptions.HTTPError
 
     async def isFileBeingUsed(self):
diff --git a/pyhiveapi/apyhiveapi/api/hive_auth.py b/pyhiveapi/apyhiveapi/api/hive_auth.py
@@ -70,7 +70,7 @@ class HiveAuth:
     SMS_MFA_CHALLENGE = "SMS_MFA"
     DEVICE_VERIFIER_CHALLENGE = "DEVICE_SRP_AUTH"
 
-    def __init__(
+    def __init__(  # pylint: disable=too-many-positional-arguments
         self,
         username: str,
         password: str,
@@ -227,7 +227,7 @@ def generate_hash_device(self, device_group_key, device_key):
         }
         return device_password, device_secret_verifier_config
 
-    def get_device_authentication_key(
+    def get_device_authentication_key(  # pylint: disable=too-many-positional-arguments
         self, device_group_key, device_key, device_password, server_b_value, salt
     ):
         """Get the device authentication key."""
diff --git a/pyhiveapi/apyhiveapi/api/hive_auth_async.py b/pyhiveapi/apyhiveapi/api/hive_auth_async.py
@@ -58,7 +58,7 @@ class HiveAuthAsync:
     SMS_MFA_CHALLENGE = "SMS_MFA"
     DEVICE_VERIFIER_CHALLENGE = "DEVICE_SRP_AUTH"
 
-    def __init__(
+    def __init__(  # pylint: disable=too-many-positional-arguments
         self,
         username: str,
         password: str,
@@ -219,7 +219,7 @@ async def generate_hash_device(self, device_group_key, device_key):
         self.device_password = device_password
         return device_secret_verifier_config
 
-    async def get_device_authentication_key(
+    async def get_device_authentication_key(  # pylint: disable=too-many-positional-arguments
         self, device_group_key, device_key, device_password, server_b_value, salt
     ):
         """Get device authentication key."""
@@ -560,8 +560,9 @@ async def refresh_token(self, token):
                 "NotAuthorizedException",
                 "CodeMismatchException",
             ):
-                if "Refresh Token has expired" in err.response.get(
-                    "Error", {}).get("Message", ""):
+                if "Refresh Token has expired" in err.response.get("Error", {}).get(
+                    "Message", ""
+                ):
                     raise HiveRefreshTokenExpired from err
                 raise HiveInvalid2FACode from err
         except botocore.exceptions.EndpointConnectionError as err:
diff --git a/pyhiveapi/apyhiveapi/camera.py b/pyhiveapi/apyhiveapi/camera.py
@@ -1,4 +1,5 @@
 """Hive Camera Module."""
+
 # pylint: skip-file
 
 
diff --git a/pyhiveapi/apyhiveapi/device_attributes.py b/pyhiveapi/apyhiveapi/device_attributes.py
@@ -1,4 +1,5 @@
 """Hive Device Attribute Module."""
+
 # pylint: skip-file
 from .helper.const import HIVETOHA
 from .helper.logger import Logger
diff --git a/pyhiveapi/apyhiveapi/heating.py b/pyhiveapi/apyhiveapi/heating.py
@@ -1,4 +1,5 @@
 """Hive Heating Module."""
+
 # pylint: skip-file
 from .helper.const import HIVETOHA
 
diff --git a/pyhiveapi/apyhiveapi/helper/__init__.py b/pyhiveapi/apyhiveapi/helper/__init__.py
@@ -1,4 +1,5 @@
 """__init__.py file."""
+
 # pylint: skip-file
 from .hive_helper import HiveHelper  # noqa: F401
 from .logger import Logger  # noqa: F401
diff --git a/pyhiveapi/apyhiveapi/helper/const.py b/pyhiveapi/apyhiveapi/helper/const.py
@@ -1,4 +1,5 @@
 """Constants for Pyhiveapi."""
+
 # pylint: skip-file
 SYNC_PACKAGE_NAME = "pyhiveapi"
 SYNC_PACKAGE_DIR = "/pyhiveapi/"
diff --git a/pyhiveapi/apyhiveapi/helper/debugger.py b/pyhiveapi/apyhiveapi/helper/debugger.py
@@ -1,4 +1,5 @@
 """Debugger file."""
+
 # pylint: skip-file
 import logging
 
diff --git a/pyhiveapi/apyhiveapi/helper/hive_exceptions.py b/pyhiveapi/apyhiveapi/helper/hive_exceptions.py
@@ -1,4 +1,5 @@
 """Hive exception class."""
+
 # pylint: skip-file
 
 
@@ -25,13 +26,15 @@ class HiveApiError(Exception):
         Exception (object): Exception object to invoke
     """
 
+
 class HiveRefreshTokenExpired(Exception):
     """Refresh token expired.
 
     Args:
         Exception (object): Exception object to invoke
     """
 
+
 class HiveReauthRequired(Exception):
     """Re-Authentication is required.
 
diff --git a/pyhiveapi/apyhiveapi/helper/hive_helper.py b/pyhiveapi/apyhiveapi/helper/hive_helper.py
@@ -1,4 +1,5 @@
 """Helper class for pyhiveapi."""
+
 # pylint: skip-file
 import datetime
 import operator
diff --git a/pyhiveapi/apyhiveapi/helper/hivedataclasses.py b/pyhiveapi/apyhiveapi/helper/hivedataclasses.py
@@ -1,4 +1,5 @@
 """Device data class."""
+
 # pylint: skip-file
 
 from dataclasses import dataclass
diff --git a/pyhiveapi/apyhiveapi/helper/logger.py b/pyhiveapi/apyhiveapi/helper/logger.py
@@ -1,4 +1,5 @@
 """Custom Logging Module."""
+
 # pylint: skip-file
 import inspect
 from datetime import datetime
diff --git a/pyhiveapi/apyhiveapi/helper/map.py b/pyhiveapi/apyhiveapi/helper/map.py
@@ -1,4 +1,5 @@
 """Dot notation for dictionary."""
+
 # pylint: skip-file
 
 
diff --git a/pyhiveapi/apyhiveapi/hive.py b/pyhiveapi/apyhiveapi/hive.py
@@ -1,4 +1,5 @@
 """Start Hive Session."""
+
 # pylint: skip-file
 import sys
 import traceback
diff --git a/pyhiveapi/apyhiveapi/hotwater.py b/pyhiveapi/apyhiveapi/hotwater.py
@@ -1,4 +1,5 @@
 """Hive Hotwater Module."""
+
 # pylint: skip-file
 
 from .helper.const import HIVETOHA
diff --git a/pyhiveapi/apyhiveapi/hub.py b/pyhiveapi/apyhiveapi/hub.py
@@ -1,4 +1,5 @@
 """Hive Hub Module."""
+
 # pylint: skip-file
 from .helper.const import HIVETOHA
 
diff --git a/pyhiveapi/apyhiveapi/light.py b/pyhiveapi/apyhiveapi/light.py
@@ -1,4 +1,5 @@
 """Hive Light Module."""
+
 # pylint: skip-file
 import colorsys
 
diff --git a/pyhiveapi/apyhiveapi/plug.py b/pyhiveapi/apyhiveapi/plug.py
@@ -1,4 +1,5 @@
 """Hive Switch Module."""
+
 # pylint: skip-file
 from .helper.const import HIVETOHA
 
diff --git a/pyhiveapi/apyhiveapi/sensor.py b/pyhiveapi/apyhiveapi/sensor.py
@@ -1,4 +1,5 @@
 """Hive Sensor Module."""
+
 # pylint: skip-file
 from .helper.const import HIVE_TYPES, HIVETOHA, sensor_commands
 
diff --git a/pyhiveapi/apyhiveapi/session.py b/pyhiveapi/apyhiveapi/session.py
@@ -1,4 +1,5 @@
 """Hive Session Module."""
+
 # pylint: skip-file
 import asyncio
 import copy
@@ -475,7 +476,7 @@ async def startSession(self, config: dict = {}):
             config (dict, optional): Configuration for Home Assistant to use. Defaults to {}.
 
         Raises:
-            HiveUnknownConfiguration: Unknown configuration identifed.
+            HiveUnknownConfiguration: Unknown configuration identified.
             HiveReauthRequired: Tokens have expired and reauthentication is required.
 
         Returns:
diff --git a/requirements_test.txt b/requirements_test.txt
@@ -1 +1,4 @@
-tox
+tox
+pylint
+pytest
+pbr
diff --git a/setup.py b/setup.py
@@ -1,4 +1,5 @@
 """Setup pyhiveapi package."""
+
 # pylint: skip-file
 import os
 import re
diff --git a/tests/common.py b/tests/common.py
@@ -1,4 +1,5 @@
 """Mock services for tests."""
+
 # pylint: skip-file
 
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""__init__.py."""`
	`2`	`+`
`2`	`3`	`# pylint: skip-file`
`3`	`4`	`if __name__ == "pyhiveapi":`
`4`	`5`	`from .api.hive_api import HiveApi as API # noqa: F401`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Hive Action Module."""`
	`2`	`+`
`2`	`3`	`# pylint: skip-file`
`3`	`4`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Hive Alarm Module."""`
	`2`	`+`
`2`	`3`	`# pylint: skip-file`
`3`	`4`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Hive API Module."""`
	`2`	`+`
`2`	`3`	`# pylint: skip-file`
`3`	`4`	`import json`
`4`	`5`