Add python_script response

[rikroe]

Breaking change

Service calls to python_script no longer silently fail and will raise an exception instead of being logged. This will stop scripts or automations instead of ignoring the error. continue_on_error must be set for scripts and automations using python_script that may fail.

Proposed change

Adds the new ServiceResponse to python_script services to allow for cases where we don't need to persist data from a python script.

The changes in core.ServiceRegistry.register where required as python_script discovers the files and registers the services in a non-async function.

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: Add python_script response documentation home-assistant.io#28477

Checklist

• 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 Black (black --fast homeassistant tests)
• Tests have been added to verify that the new code works.

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

• Documentation added/updated for www.home-assistant.io

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 link to the changelog, or at minimum a diff between library versions is added to the PR description.
• Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[rikroe]

Thanks for the hint. I have adjusted the code to comply with the service rules for the Silver integration quality: ValueError on invalid inputs (assuming an invalid script is also invalid input) and HomeAssistantError for everything else.

[RoboMagus]

LGTM

[rikroe]

Added a breaking changes paragraph as raising exceptions will stop scripts/automations.

[RoboMagus]

Added a breaking changes paragraph as raising exceptions will stop scripts/automations.

Now that you mention it. That would best be handled as it always has. I.e. the exceptions should only be passed on when providing service responses (service.return_response).

[rikroe]

That could be an option as well. I'll leave that for the core team to decide, as it would be easy to implement (but from my understanding the raising exceptions is the desired path, even when not returning a response).

[home-assistant]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

[MartinHjelmare]

I suggest we keep the existing behavior around logging and exceptions for the existing features in this PR and only raise when a service response is requested.

Then in another PR we can make a breaking change. It's good to limit breaking changes PRs to as little scope as possible.

[rikroe]

I have added some additional code to keep the existing logging possible if no response is required.

I am now also creating an issue to point users to the new behavior. Is 3 releases a good timeframe for this?

The issue has been removed

[emontnemery]

Looks great, thanks @RoboMagus 👍