Merge pull request #50 from EVWorth/ruff-formatting

Ruff formatting, pre-commit, and validate workflow

Author: EVWorth

.github/workflows/validate.yaml

@@ -0,0 +1,25 @@
+name: Validate
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Ruff Check
+        uses: astral-sh/ruff-action@v3
+        with:
+          args: check --output-format=github
+
+      - name: Ruff Format
+        uses: astral-sh/ruff-action@v3
+        with:
+          args: format --check --diff

.pre-commit-config.yaml

@@ -1,22 +1,19 @@
 ---
 fail_fast: true
 
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
-    hooks:
-      - id: trailing-whitespace
-      - id: end-of-file-fixer
-      - id: requirements-txt-fixer
-
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.12.3
-    hooks:
-      - id: ruff
-        args: [--fix] # run linter
-      - id: ruff-format # run formatter
+# To update pre-commit hooks run:
+# uv run pre-commit autoupdate
 
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.20.0
-    hooks:
-      - id: pyupgrade
+repos:
+-   hooks:
+    -   id: check-yaml
+    -   id: check-toml
+    -   id: check-json
+    -   id: no-commit-to-branch
+    repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+-   hooks:
+    -   id: ruff-check
+    -   id: ruff-format
+    repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.13.3

.vscode/settings.json

@@ -5,5 +5,7 @@
         "tests"
     ],
     "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true
+    "python.testing.pytestEnabled": true,
+    "ruff.enable": true,
+    "ruff.configuration": "pyproject.toml"
 }

CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.2.11 (2025-07-12)
+## What's Changed
+* Refactor for uv by @EVWorth in https://github.com/homeassistant-projects/pyadtpulse/pull/45
+* Update aiohttp zlib ng to aiohttp fast zlib zlib ng  by @EVWorth in https://github.com/homeassistant-projects/pyadtpulse/pull/47
+* Workflow improvements by @EVWorth in https://github.com/homeassistant-projects/pyadtpulse/pull/48
+* Unit test fixes/removals by @HeroesDieYoung in https://github.com/homeassistant-projects/pyadtpulse/pull/42
+
+## New Contributors
+* @EVWorth made their first contribution in https://github.com/homeassistant-projects/pyadtpulse/pull/45
+
+**Full Changelog**: https://github.com/homeassistant-projects/pyadtpulse/compare/1.2.10...1.2.11
+
 ## 1.2.9 (2024-04-21)
 
 * ignore query string in check_login_errors().  This should fix a bug where the task was logged out

example-client.py

@@ -1,33 +1,33 @@
 #!/usr/bin/env python
 """Sample client for using pyadtpulse."""
 
+import sys
+import json
+import asyncio
 import logging
 import argparse
-import asyncio
-import json
-import sys
+from time import time, sleep
 from pprint import pprint
-from time import sleep, time
 
 from pyadtpulse import PyADTPulse
+from pyadtpulse.site import ADTPulseSite
 from pyadtpulse.const import (
-    ADT_DEFAULT_KEEPALIVE_INTERVAL,
-    ADT_DEFAULT_POLL_INTERVAL,
-    ADT_DEFAULT_RELOGIN_INTERVAL,
     API_HOST_CA,
     DEFAULT_API_HOST,
+    ADT_DEFAULT_POLL_INTERVAL,
+    ADT_DEFAULT_RELOGIN_INTERVAL,
+    ADT_DEFAULT_KEEPALIVE_INTERVAL,
 )
 from pyadtpulse.exceptions import (
-    PulseAuthenticationError,
-    PulseClientConnectionError,
+    PulseLoginException,
     PulseConnectionError,
+    PulseAuthenticationError,
     PulseGatewayOfflineError,
-    PulseLoginException,
+    PulseClientConnectionError,
     PulseServerConnectionError,
     PulseServiceTemporarilyUnavailableError,
 )
 from pyadtpulse.pyadtpulse_async import PyADTPulseAsync
-from pyadtpulse.site import ADTPulseSite
 
 USER = "adtpulse_user"
 PASSWD = "adtpulse_password"
@@ -82,10 +82,12 @@ def setup_logger(level: int):
 
 
 def handle_args() -> argparse.Namespace:
-    """Handle program arguments using argparse.
+    """
+    Handle program arguments using argparse.
 
     Returns:
         argparse.Namespace: Parsed command-line arguments.
+
     """
     parser = argparse.ArgumentParser(description="ADT Pulse example client")
     parser.add_argument("json_file", nargs="?", help="JSON file containing parameters")
@@ -217,14 +219,16 @@ def handle_args() -> argparse.Namespace:
 
 
 def load_parameters_from_json(json_file: str) -> dict | None:
-    """Load parameters from a JSON file.
+    """
+    Load parameters from a JSON file.
 
     Args:
         json_file (str): Path to the JSON file.
 
     Returns:
         Optional[Dict]: Loaded parameters as a dictionary,
                         or None if there was an error.
+
     """
     try:
         with open(json_file, encoding="utf-8") as file:
@@ -268,10 +272,12 @@ def load_parameters_from_json(json_file: str) -> dict | None:
 
 
 def print_site(site: ADTPulseSite) -> None:
-    """Print site information.
+    """
+    Print site information.
 
     Args:
         site (ADTPulseSite): The site to display
+
     """
     print(f"Site: {site.name} (id={site.id})")
     print("Alarm panel: ")
@@ -281,7 +287,8 @@ def print_site(site: ADTPulseSite) -> None:
 
 
 def check_updates(site: ADTPulseSite, adt: PyADTPulse, run_alarm_test: bool) -> bool:
-    """Check a site for updates and print details.
+    """
+    Check a site for updates and print details.
 
     We don't really need to do this anymore, as the data will be
     updated in the background
@@ -292,6 +299,7 @@ def check_updates(site: ADTPulseSite, adt: PyADTPulse, run_alarm_test: bool) ->
         test_alarm: bool: sleep a bit if testing alarm
 
         Returns: bool: True if update successful
+
     """
     if run_alarm_test:
         while (
@@ -311,12 +319,14 @@ def check_updates(site: ADTPulseSite, adt: PyADTPulse, run_alarm_test: bool) ->
 
 
 def test_alarm(site: ADTPulseSite, adt: PyADTPulse) -> None:
-    """Test alarm functions.
+    """
+    Test alarm functions.
 
     Args:
         site (ADTPulseSite): site to test
         adt (PyADTPulse): ADT Pulse connection objecct
         sleep_interval (int): length to sleep between tests
+
     """
     print("Arming alarm stay")
     if site.arm_home():
@@ -382,7 +392,8 @@ def sync_example(
     relogin_interval: int,
     detailed_debug_logging: bool,
 ) -> None:
-    """Run example of sync pyadtpulse calls.
+    """
+    Run example of sync pyadtpulse calls.
 
     Args:
         username (str): Pulse username
@@ -394,6 +405,7 @@ def sync_example(
         keepalive_interval (int): keepalive interval in minutes
         relogin_interval (int): relogin interval in minutes
         detailed_debug_logging (bool): True to enable detailed debug logging
+
     """
     while True:
         try:
@@ -497,11 +509,13 @@ def sync_example(
 
 
 async def async_test_alarm(adt: PyADTPulse) -> None:
-    """Test alarm functions.
+    """
+    Test alarm functions.
 
     Args:
         site (ADTPulseSite): site to test
         adt (PyADTPulse): ADT Pulse connection objecct
+
     """
     print("Arming alarm stay")
     if await adt.site.async_arm_home():
@@ -619,7 +633,8 @@ async def async_example(
     relogin_interval: int,
     detailed_debug_logging: bool,
 ) -> None:
-    """Run example of pytadtpulse async usage.
+    """
+    Run example of pytadtpulse async usage.
 
     Args:
         username (str): Pulse username
@@ -631,6 +646,7 @@ async def async_example(
         keepalive_interval (int): keepalive interval in minutes
         relogin_interval (int): relogin interval in minutes
         detailed_debug_logging (bool): enable detailed debug logging
+
     """
     adt = PyADTPulseAsync(
         username,