Improve enum structure #1925

iMicknl · 2026-01-27T19:05:45Z

No description provided.

* Bump minimum required Python version to 3.12 * Update CI/CD

…oup for Execution typing (#1864) * Rename scenario to action group * Rename test * Fix docstring formatting in ActionGroup class * Remove unnecessary assertions in ActionGroup initialization

…methods. (#1862) - `client.execute_command()` and `client.execute_commands()` are replaced by `client.execute_action_group()` - `client.execute_action_group()` now supports multiple execution modes (high priority, internal, geolocated) - `client.execute_action_group()` now supports multiple device actions in the same request The current execution methods are poorly typed and do not support concurrent execution across multiple devices, which makes it impossible to properly work around TooManyExecutionsException and TooManyConcurrentRequestsException. The main change is the move from `client.execute_command()` and `client.execute_commands()` to a single `client.execute_action_group()`. An action group takes a list of actions, each of which can include multiple device actions, including multiple commands per action. ```python3 await client.execute_action_group( actions=[ Action( device_url="io://1234-5678-1234/12345678", commands=[ Command(name="down"), Command(name="refresh") ] ) ], label="Execution via Home Assistant" ) ``` New (mode) options like high priority will be possible now: ```python3 await client.execute_action_group( actions=[ Action( device_url="io://1234-5678-1234/12345678", commands=[ Command(name=OverkizCommand.SET_CLOSURE, parameters=[0]) ] ) ], label="Execution via Home Assistant", mode=CommandMode.HIGH_PRIORITY ) ``` This could serve as a foundation for grouping commands that are executed within a short time window, for example when triggered by a scene or automation in Home Assistant. Requests issued close together could be batched and sent as a single action group, reducing the impact of current Overkiz limitations. The open question is where this queue should live: inside this integration itself, or as part of the Home Assistant core implementation. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…ial classes (#1867) - Introduced UsernamePasswordCredentials and LocalTokenCredentials for better credential management. - Updated OverkizClient to utilize the new credential classes and refactored login logic. - Added authentication strategies for various servers, including Somfy and Rexel. - Created new modules for auth strategies and credentials to improve code organization. - Enhanced README with updated usage examples for the new authentication methods. - `OverkizServer` class is renamed to `ServerConfig` and has additional `server` and `type` (cloud/local) property - `generate_local_server` is renamed to `create_local_server_config` - `client.api_type` is removed and now available via `ServerConfig` (e.g. `client.server_config.type`) - The `OverkizClient` constructor now requires passing a `ServerConfig` via `server` - The `OverkizClient` constructur now requires passing an `Credentials` class via `credentials`, e.g. `UsernamePasswordCredentials(USERNAME, PASSWORD)` for most server. - The OverkizClient constructor now supports passing a Server enum directly, such as `OverkizClient(server=Server.SOMFY_EUROPE, ...)`. --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: iMicknl <1424596+iMicknl@users.noreply.github.com>

## Enhancement - Publish detailed developer documentation via GitHub Pages [imicknl.github.io/python-overkiz-api](https://imicknl.github.io/python-overkiz-api/). Fixes #190, #1522

…ty (#1917) Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Fixes #1865 --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: iMicknl <1424596+iMicknl@users.noreply.github.com>

…prove module imports

Copilot

Pull request overview

This PR refactors the enum structure by introducing a shared UnknownEnumMixin class to eliminate duplicated _missing_ method implementations across multiple enum files. The refactoring consolidates common enum fallback behavior and logging into a reusable mixin.

Changes:

Introduces UnknownEnumMixin in pyoverkiz/enums/base.py to provide shared _missing_ and from_value methods
Migrates 8 enum classes across 5 files to use the new mixin (UIClass, UIWidget, Protocol, FailureType, EventName, GatewayType, GatewaySubType, ExecutionType, ExecutionState, ExecutionSubType)
Updates pyoverkiz/enums/__init__.py to explicitly construct __all__ by filtering Enum subclasses

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 20 comments.

Show a summary per file

File	Description
pyoverkiz/enums/base.py	New file introducing UnknownEnumMixin with shared missing and from_value methods
pyoverkiz/enums/ui.py	Adds UnknownEnumMixin to UIClass and UIWidget, removes logging imports and UIClass's missing method
pyoverkiz/enums/protocol.py	Adds UnknownEnumMixin to Protocol, removes logging imports and missing method, adds custom missing_message
pyoverkiz/enums/general.py	Adds UnknownEnumMixin to FailureType and EventName, removes logging imports and FailureType's missing method
pyoverkiz/enums/gateway.py	Adds UnknownEnumMixin to GatewayType and GatewaySubType, removes logging imports and their missing methods
pyoverkiz/enums/execution.py	Adds UnknownEnumMixin to ExecutionType, ExecutionState, and ExecutionSubType, removes logging imports and their missing methods
pyoverkiz/enums/init.py	Constructs explicit all list by filtering Enum subclasses from enum modules

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pyoverkiz/enums/base.py

pyoverkiz/enums/ui.py

pyoverkiz/enums/general.py

pyoverkiz/enums/__init__.py

pyoverkiz/enums/gateway.py

pyoverkiz/enums/general.py

pyoverkiz/enums/protocol.py

pyoverkiz/enums/ui.py

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 10 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pyoverkiz/utils.py

pyoverkiz/enums/__init__.py

pyoverkiz/enums/execution.py

pyoverkiz/enums/gateway.py

pyoverkiz/enums/general.py

pyoverkiz/enums/ui.py

…um with labels, and implement protocol enum generation script

…ved type hinting

…ng widgets

…type to list[str]

- Implemented `generate_ui_profiles` function to fetch and generate UIProfile enums. - Added error handling for fetching profile details. - Included detailed comments for commands and states in the generated enum. - Updated the main generation function to include UIProfile generation.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…improved type hinting

…t UI profile fetching in generate_enums

iMicknl · 2026-01-27T23:43:10Z

@copilot do a thorough review and fix all your suggestions in a new PR. Make sure the CI is green (so run uv run prek run --all-files to check this after your changes.

Copilot · 2026-01-27T23:43:20Z

@iMicknl I've opened a new pull request, #1926, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 16 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

utils/generate_enums.py

pyoverkiz/enums/base.py

pyoverkiz/enums/protocol.py

pyoverkiz/enums/__init__.py

pyoverkiz/enums/protocol.py

pyoverkiz/enums/ui_profile.py

pyoverkiz/enums/ui.py

…nt enum conversion (#1926) ## Progress Plan - [x] Add missing UIClassifier enum to exports - [x] Revert to simpler approach without explicit enum conversion (maintainer preference) - [x] Verify all linting and type checking passes - [x] Test functionality works correctly  --- ✨ Let Copilot coding agent [set things up for you](https://github.com/iMicknl/python-overkiz-api/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: iMicknl <1424596+iMicknl@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot · 2026-01-28T08:58:18Z

@iMicknl I've opened a new pull request, #1929, to work on those changes. Once the pull request is ready, I'll request review from you.

The `UnknownEnumMixin._missing_` method overrides `StrEnum._missing_` but lacked explicit acknowledgment, causing type checker ambiguity about the intentional override in the mixin pattern. ## Changes - Added `# type: ignore[override]` to `_missing_` method signature - Enhanced docstring to document the intentional override of `StrEnum._missing_` - Removed unused `Any` import ## Context Mixin classes can't use `@override` decorator since they don't directly inherit from the classes they'll be mixed with. The type ignore annotation is the standard pattern for acknowledging overrides in mixins. ```python class UnknownEnumMixin: @classmethod def _missing_(cls, value: object) -> Self: # type: ignore[override] """Return `UNKNOWN` and log unrecognized values. Intentionally overrides `StrEnum._missing_` to provide UNKNOWN fallback. """ # ... implementation ```  --- 💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: iMicknl <1424596+iMicknl@users.noreply.github.com> Co-authored-by: Mick Vleeshouwer <mick@imick.nl> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…eration

iMicknl and others added 13 commits January 26, 2026 18:24

Bump minimum required Python version to 3.12 (#1871)

091a53e

* Bump minimum required Python version to 3.12 * Update CI/CD

Bump version to 2.0

fb20206

Rename Scenario to ActionGroup (and relevant methods), reuse ActionGr…

d33beb1

…oup for Execution typing (#1864) * Rename scenario to action group * Rename test * Fix docstring formatting in ActionGroup class * Remove unnecessary assertions in ActionGroup initialization

Migrate pre-commit to prek (rust based) (#1887)

f7e3cda

Improve developer documentation (#1908)

a04e726

## Enhancement - Publish detailed developer documentation via GitHub Pages [imicknl.github.io/python-overkiz-api](https://imicknl.github.io/python-overkiz-api/). Fixes #190, #1522

Fix uv.lock after rebase

9d73c6a

Update test files to clarify ruff noqa comments and improve readabili…

faec9ae

…ty (#1917) Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Implement ActionQueue for batching actions in OverkizClient (#1866)

097af40

Fixes #1865 --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: iMicknl <1424596+iMicknl@users.noreply.github.com>

Redact

b3a8630

Add UnknownEnumMixin for consistent handling of unknown enum values

0c8f666

Refactor enums to use UnknownEnumMixin for consistent handling and im…

f2160c5

…prove module imports

iMicknl requested a review from tetienne as a code owner January 27, 2026 19:05

Copilot AI review requested due to automatic review settings January 27, 2026 19:05

Copilot started reviewing on behalf of iMicknl January 27, 2026 19:06 View session

Copilot AI reviewed Jan 27, 2026

View reviewed changes

iMicknl marked this pull request as draft January 27, 2026 19:12

iMicknl added 2 commits January 27, 2026 19:13

Add methods for retrieving reference data in OverkizClient

a6306bf

Add missing enum values and improve formatting in enums

f208497

iMicknl requested a review from Copilot January 27, 2026 19:41

Copilot started reviewing on behalf of iMicknl January 27, 2026 19:41 View session

Copilot AI reviewed Jan 27, 2026

View reviewed changes

iMicknl and others added 7 commits January 27, 2026 19:51

Enhance Protocol handling: add ProtocolType model, update Protocol en…

41c6f07

…um with labels, and implement protocol enum generation script

Change return type of get_reference_ui_classes to list[str] for impro…

5df60bb

…ved type hinting

Update UI enums: enhance documentation, reorder values, and add missi…

dc1c99c

…ng widgets

Fix UIClass and UIWidget enum UNKNOWN value capitalization

125d63d

Add UIClassifier enum and update get_reference_ui_classifiers return …

d36d26a

…type to list[str]

Apply suggestion from @Copilot

87e5341

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

iMicknl added 2 commits January 27, 2026 23:37

fix: change return type of get_reference_ui_widgets to list[str] for …

d60fc03

…improved type hinting

feat: add UIProfileDefinition model and related classes, and implemen…

b8a8369

…t UI profile fetching in generate_enums

iMicknl requested a review from Copilot January 27, 2026 23:42

Copilot started reviewing on behalf of iMicknl January 27, 2026 23:42 View session

Copilot AI mentioned this pull request Jan 27, 2026

Address code review feedback: fix import pollution and add missing UIClassifier enum #1926

Merged

4 tasks

Copilot AI reviewed Jan 27, 2026

View reviewed changes

Copilot AI and others added 3 commits January 28, 2026 09:42

Update utils/generate_enums.py

90641c9

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update pyoverkiz/enums/base.py

564ebbf

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI mentioned this pull request Jan 28, 2026

Explicitly acknowledge _missing_ override in UnknownEnumMixin #1929

Merged

Copilot AI and others added 2 commits January 29, 2026 12:48

Bugfix

2a7eb91

iMicknl marked this pull request as ready for review January 29, 2026 17:31

iMicknl added the v2 label Jan 29, 2026

iMicknl added 2 commits January 29, 2026 21:42

Add command extraction and enum generation from fixture files

d6fb955

Add state value extraction and update OverkizCommandParam in enum gen…

16a8224

…eration

iMicknl force-pushed the v2/main branch from bf67bd1 to 09c7700 Compare January 31, 2026 15:00

Improve enum structure #1925

Are you sure you want to change the base?

Improve enum structure #1925

Uh oh!

Conversation

iMicknl commented Jan 27, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iMicknl commented Jan 27, 2026

Uh oh!

Copilot AI commented Jan 27, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Jan 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants