Make tts options of type list (such as profiles in google_cloud) work
Breaking change
Proposed change
One of the TTS options of Google Cloud is profiles which is a list. Currently if you specify multiple profiles only one will be used. yarl.URL.query is a MultiDict which is converted to a regular dict. Another TTS integration might want to allow dict as a value for one of its options. To handle this, only if there is at least one option of type not str, int, float, or bool, json dump params in a _json query param in generate_media_source_id and reverse in media_source_id_to_kwargs to be able to reconstruct the options exactly as provided in the tts.speak service.
Type of change
- [ ] Dependency upgrade
- [x] 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:
Checklist
- [x] The code change is tested and works locally.
- [x] Local tests pass. Your PR cannot be merged unless tests pass
- [x] There is no commented out code in this PR.
- [x] I have followed the development checklist
- [x] I have followed the perfect PR recommendations
- [x] The code has been formatted using Ruff (
ruff format homeassistant tests) - [x] 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 runningpython3 -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.
Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (tts) you are listed as a code owner for? Thanks!
Code owner commands
Code owners of tts can trigger bot actions by commenting:
@home-assistant closeCloses the pull request.@home-assistant rename Awesome new titleRenames the pull request.@home-assistant reopenReopen the pull request.@home-assistant unassign ttsRemoves the current integration label and assignees on the pull request, add the integration domain after the command.@home-assistant add-label needs-more-informationAdd a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.@home-assistant remove-label needs-more-informationRemove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.
I'm not sure we need two formats for the TTS URL, are there any cases where either of these need to be supported:
- An old media source URL needs to be valid after an upgrade of Home Assistant Core
- We need to keep generating old media source URL after an upgrade of Home Assistant Core
If this is not needed, we should make the query string always be a JSON serialized dictionary instead of having two schemas
I discussed the PR with @balloob, the conclusion is that we should only generate URLs with the new schema (JSON encoded tts options), but consume with both old and new schema for the sake of backwards compatibility. I'll update the PR accordingly.
@tronikos There are a few approvals, but there is a merge conflict. Could you rebase this PR?
Thanks!
../Frenck