Skip to content

Require local_only to be a boolean on webhook#169296

Merged
edenhaus merged 2 commits into
devfrom
edenhaus/webhook_local_only
Apr 28, 2026
Merged

Require local_only to be a boolean on webhook#169296
edenhaus merged 2 commits into
devfrom
edenhaus/webhook_local_only

Conversation

@edenhaus
Copy link
Copy Markdown
Member

Breaking change

The local_only argument on async_register for webhooks needs to be a boolean

Proposed change

Removed deprecation of the local_only argument in webhooks to be not a boolean

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Co-authored-by: Copilot <copilot@github.com>
Copilot AI review requested due to automatic review settings April 27, 2026 14:32
@edenhaus edenhaus requested a review from a team as a code owner April 27, 2026 14:32
@home-assistant
Copy link
Copy Markdown
Contributor

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (webhook) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of webhook can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign webhook Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR tightens the webhook registration API by enforcing that local_only must be a real boolean, removing the legacy None behavior and its associated deprecation path.

Changes:

  • Change async_register(..., local_only=...) type contract from bool | None to bool and enforce it at runtime with a TypeError.
  • Remove the local_only=None deprecation/warning behavior during webhook handling and treat local_only as a strict boolean.

Comment thread homeassistant/components/webhook/__init__.py
Comment thread homeassistant/components/webhook/__init__.py
Comment thread homeassistant/components/webhook/__init__.py
@MartinHjelmare MartinHjelmare marked this pull request as draft April 27, 2026 14:54
Co-authored-by: Copilot <copilot@github.com>
@edenhaus edenhaus marked this pull request as ready for review April 27, 2026 15:05
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@edenhaus edenhaus merged commit 6663717 into dev Apr 28, 2026
51 of 52 checks passed
@edenhaus edenhaus deleted the edenhaus/webhook_local_only branch April 28, 2026 09:40
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 29, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants