Skip to content

Deprecate verify_domain_control service helper #2688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

Deprecate verify_domain_control service helper #2688

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f03dc5b
Deprecate verify_domain_control service helper
epenet Jun 3, 2025
cfd99af
Tweak
epenet Jun 3, 2025
dbc3b12
Apply suggestions from code review
epenet Jun 3, 2025
e238903
Update 2025-06-03-deprecate-verify-domain-control.md
epenet Jun 3, 2025
ba727f2
Update 2025-06-03-deprecate-verify-domain-control.md
epenet Jun 3, 2025
a108d3d
Update blog/2025-06-03-deprecate-verify-domain-control.md
frenck Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions blog/2025-06-03-deprecate-verify-domain-control.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
author: epenet
authorURL: https://github.com/epenet
title: "Deprecate verify_domain_control service helper"
---

### Summary of changes

The `homeassistant.helpers.service.verify_domain_control` service helper is deprecated,
and has been replaced with `verify_domain_entity_control`.

Since release `2025.1` (via core PR [#133062](https://github.com/home-assistant/core/pull/133062)),
a reference to `HomeAssistant` is available as a property of the `ServiceCall` object,
and it became redundant to pass the `hass` object to `verify_domain_control`.

To update your integration:
1. Replace the decorator (as shown in the first example below).
2. Move the nested functions to be module-level (Optional - as shown in the second example below).
3. Test the changes.

The old `verify_domain_control` decorator will be removed in Home Assistant 2026.7.


### Examples

The minimum change is to adjust the decorator

```python
# Old
# def register_services(hass: HomeAssistant) -> None:
# @verify_domain_control(hass, DOMAIN)
# async def do_action(call: ServiceCall) -> None:
# entries = hass.config_entries.async_entries(DOMAIN)
# ...
# hass.services.async_register(...)

# New
def register_services(hass: HomeAssistant) -> None:
@verify_domain_entity_control(DOMAIN)
async def do_action(call: ServiceCall) -> None:
entries = hass.config_entries.async_entries(DOMAIN)
...

hass.services.async_register(...)
```

Move the service functions to module-level functions to reduce code complexity.

```python
# Old
# def register_services(hass: HomeAssistant) -> None:
# @verify_domain_control(hass, DOMAIN)
# async def do_action(call: ServiceCall) -> None:
# entries = hass.config_entries.async_entries(DOMAIN)
# ...
# hass.services.async_register(...)

# New
@verify_domain_entity_control(DOMAIN)
async def do_action(call: ServiceCall) -> None:
entries = call.hass.config_entries.async_entries(DOMAIN)
...

def register_services(hass: HomeAssistant) -> None:
hass.services.async_register(...)
```