V6 rewrite

.github/workflows/python-publish.yml

@@ -16,16 +16,12 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: "3.13"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip poetry
-          poetry config virtualenvs.create false
-          poetry install
-
-      - name: build release distributions
-        run: |
-          # NOTE: put your own distribution build steps here.
-          poetry build
+        run: uv sync
+      - name: Build release distributions
+        run: uv build
 
       - name: upload dists
         uses: actions/upload-artifact@v4
@@ -48,4 +44,4 @@ jobs:
           path: dist/
 
       - name: Publish release distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test-suite.yml

@@ -4,15 +4,13 @@ on:
     paths:
       - "**.py"
       - "pyproject.toml"
-      - "poetry.lock"
   pull_request:
     branches:
       - master
       - dev
     paths:
       - "**.py"
       - "pyproject.toml"
-      - "poetry.lock"
   workflow_dispatch:
 
 jobs:
@@ -23,21 +21,21 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v3
         with:
-          python-version: "3.9"
+          python-version: "3.11"
       - name: Checkout
         uses: actions/checkout@v3
         with:
           ref: ${{ github.event.pull_request.head.sha }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
       - name: Install Dependencies
-        run: |
-          pip install poetry
-          poetry install --with styling
+        run: uv sync --group dev
       - name: Run Ruff format
-        run: poetry run ruff format homeassistant_api
+        run: uv run ruff format homeassistant_api
       - name: Run Ruff linting
-        run: poetry run ruff check homeassistant_api
-      - name: Run MyPy
-        run: poetry run mypy homeassistant_api --show-error-codes
+        run: uv run ruff check homeassistant_api
+      - name: Run Zuban
+        run: uv run zuban check homeassistant_api
 
   code_functionality:
     name: "Code Functionality"

.gitignore

@@ -1,3 +1,5 @@
+CHANGELOG.draft.md
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -133,6 +135,8 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+uv.lock
+poetry.lock
 
 # Spyder project settings
 .spyderproject

.pre-commit-config.yaml

@@ -1,11 +1,12 @@
 repos:
-  - repo: https://github.com/pre-commit/mirrors-mypy
+  - repo: local
     hooks:
-      - id: mypy
-        additional_dependencies:
-          - types-requests
-          - types-simplejson
-    rev: "v1.17.1"
+      - id: zuban
+        name: zuban
+        entry: uv run zuban check homeassistant_api
+        language: system
+        types: [python]
+        pass_filenames: false
   - repo: https://github.com/pre-commit/pre-commit-hooks
     hooks:
       - id: trailing-whitespace

.readthedocs.yml

@@ -4,15 +4,11 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.10"
+    python: "3.11"
   jobs:
-    pre_create_environment:
-      - asdf plugin add poetry
-      - asdf install poetry 1.8.3
-      - asdf global poetry 1.8.3
-      - poetry export -f requirements.txt --output requirements.txt --with docs
     post_install:
-      - pip install -r requirements.txt
+      - pip install uv
+      - uv export --group docs --no-hashes | uv pip install -r -
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

CHANGELOG.md

@@ -0,0 +1,57 @@
+# HomeAssistant-API v6.0 Changelog
+
+## Breaking Changes
+A lot has changed in this version. A lot went into modernising and standardizing the interfaces of the clients.
+As such, many of the previous paradigms have changed. If you run into any bugs or issues, please let us know.
+### Minimum Python version raised to 3.11
+Python 3.9 and 3.10 are no longer supported.
+
+### Client classes restructured
+The old `Client` class (which combined sync and async via a `use_async` flag) has been removed. There are now four distinct client classes:
+
+| Old | New |
+|---|---|
+| `Client(use_async=False)` | `Client` |
+| `Client(use_async=True)` | `AsyncClient` |
+| `WebsocketClient` (sync) | `WebsocketClient` |
+| — | `AsyncWebsocketClient` (new) |
+
+Async client methods no longer have the `async_` prefix — e.g. `async_get_states()` is now just `get_states()` on `AsyncClient`.
+
+### Models split into Base/Sync/Async variants
+`Domain`, `Entity`, `Group`, `Service`, and `Event` now have three variants each:
+- **`Base*`** — plain data, no client reference
+- **`*`** (e.g. `Domain`) — sync, bound to `Client`
+- **`Async*`** (e.g. `AsyncDomain`) — async, bound to `AsyncClient`
+
+### Processing module rewritten
+The decorator-based `@Processing.processor(mimetype)` registry has been replaced with simple dict-based MIME dispatch and separate `sync`/`async` entry points. Custom processor registration and the `decode_bytes` parameter have been removed.
+
+### Build system moved from Poetry to uv + hatchling
+`poetry.lock` is removed. The project now uses `uv` for dependency management and `hatchling` as the build backend.
+
+### Type checker changed from mypy to zuban
+
+## New Features
+
+### WebSocket API support (sync & async)
+Full WebSocket client implementation for both sync (`WebsocketClient`) and async (`AsyncWebsocketClient`) with support for:
+- **Config entries** — get, disable, enable, ignore flow, subentries, subscribe
+- **Entity registry** — list, get, update, remove entries
+- **Events** — subscribe, fire, and listen
+- **Services** — trigger with full domain/service routing
+- **Templates** — render and subscribe to template updates
+
+### Entity registry models
+New models: `EntityRegistryEntry`, `EntityRegistryEntryExtended`, `EntityRegistryUpdateResult`.
+
+### Configurable WebSocket max message size
+WS clients accept a `max_size` parameter (default 16 MB) to handle large responses like full entity registry lists.
+
+## Improvements
+
+- Unified method signatures across all four client classes for consistency
+- Expanded ruff lint rules to `ALL` (from just E, F, W)
+- Test coverage improved to ~99%
+- Modernized type annotations throughout
+- Response content is now read lazily, eliminating internal `_buffer` access hacks

Dockerfile

@@ -1,20 +1,13 @@
-ARG BUILD_FROM
+FROM ghcr.io/astral-sh/uv:python3.13-bookworm AS dependencies
+WORKDIR /app
+COPY pyproject.toml README.md ./
+RUN uv sync --group dev
 
-FROM ${BUILD_FROM} AS base
+FROM python:3.13-bookworm
 ENV PYTHONPATH=.
 WORKDIR /app
-COPY ./ /app/
-
-FROM base AS dependencies
-RUN pip install --upgrade pip wheel
-RUN pip install poetry
-RUN python3 -m venv .venv && \
-    . .venv/bin/activate && \
-    poetry install --with testing && \
-    deactivate
-
-FROM base AS final
 COPY --from=dependencies /app/.venv /app/.venv
+ENV PATH="/app/.venv/bin:$PATH"
+COPY ./ /app/
 
-ENTRYPOINT [ "sh", "entrypoint.sh" ]
-
+ENTRYPOINT [ "sh", "entrypoint.sh" ]

README.md

@@ -25,25 +25,22 @@ with Client(
     '<API Server URL>', # i.e. 'http://homeassistant.local:8123/api/'
     '<Your Long Lived Access-Token>'
 ) as client:
-    light = client.trigger_service('light', 'turn_on', entity_id="light.living_room")
+    client.trigger_service('light', 'turn_on', entity_id="light.living_room")
 ```
 
-All the methods also support async/await!
-Just prefix the method with `async_` and pass the `use_async=True` argument to the `Client` constructor.
-Then you can use the methods as coroutines
-(i.e. `await light.async_turn_on(...)`).
+All four client classes share the same method names.
+The async clients (`AsyncClient`, `AsyncWebsocketClient`) use `async def` methods that you `await`.
 
 ```py
 import asyncio
-from homeassistant_api import Client
+from homeassistant_api import AsyncClient
 
 async def main():
-    with Client(
+    async with AsyncClient(
         '<REST API Server URL>', # i.e. 'http://homeassistant.local:8123/api/'
         '<Your Long Lived Access-Token>',
-        use_async=True
     ) as client:
-    light = await client.async_trigger_service('light', 'turn_on', entity_id="light.living_room")
+        await client.trigger_service('light', 'turn_on', entity_id="light.living_room")
 
 asyncio.run(main())
 ```
@@ -57,11 +54,9 @@ with WebsocketClient(
     '<WS API Server URL>', # i.e. 'ws://homeassistant.local:8123/api/websocket'
     '<Your Long Lived Access-Token>'
 ) as ws_client:
-    light = ws_client.trigger_service('light', 'turn_on', entity_id="light.living_room")
+    ws_client.trigger_service('light', 'turn_on', entity_id="light.living_room")
 ```
 
-> Note: The Websocket API is not yet supported in async/await mode.
-
 ## Documentation
 
 All documentation, API reference, contribution guidelines and pretty much everything else

compose.yml

@@ -8,8 +8,6 @@ services:
   tests:
     build:
       context: .
-      args:
-        BUILD_FROM: "python:3.13"
     image: homeassistant-tests:latest
     volumes:
       - ./volumes/coverage:/app/coverage:rw

docs/CONTRIBUTING.rst

@@ -37,12 +37,12 @@ Next run in your terminal.
 Step Three: Installing Dependencies
 ======================================
 
-Firstly, you need to have Python 3.7 or newer with Pip installed.
+Firstly, you need to have Python 3.11 or newer installed.
 Download the latest Python Version from `here <https://www.python.org/>`__.
-Then you need to install the very popular Python Package Manager, :code:`poetry`.
-Checkout the `Poetry Docs <https://python-poetry.org/docs/>`__.
-You can install that with :code:`pip` by running :code:`pip install poetry`.
-Now you can install the project's dependencies by running :code:`cd HomeAssistantAPI && poetry install`
+Then you need to install :code:`uv`, a fast Python package manager.
+Checkout the `uv Docs <https://docs.astral.sh/uv/>`__.
+You can install it with :code:`pip` by running :code:`pip install uv`, or see the uv docs for other installation methods.
+Now you can install the project's dependencies by running :code:`cd HomeAssistantAPI && uv sync`
 
 Step Four: [Optional] Setting Up a Home Assistant Development Environment.
 =============================================================================
@@ -69,7 +69,7 @@ Code Styling Guidelines
 In order to make sure that our code is easy to read, and navigate.
 As well as to stop stupid mistakes like typos, undefined variables, etc.
 We enforce code standards.
-Using the tools, :code:`ruff`, :code:`pytest`, and :code:`docker`, we make make sure that our code quality is top notch, and that are changes work everywhere.
+Using the tools, :code:`ruff`, :code:`zuban`, :code:`pytest`, and :code:`docker`, we make make sure that our code quality is top notch, and that are changes work everywhere.
 You can those tools manually yourself, but they also run automatically when you open a PR.
 
 Merging Your Contributions