Fix type stub for async_unsubscribe_topics

[TurnrDev]

Breaking change

Proposed change

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 fixes an issue introduced in #118092 (9be829ba) where async_unsubscribe_topics became a partial for async_prepare_subscribe_topics, but async_prepare_subscribe_topics expects new_state not sub_state - a typing stub was added but was not updated to reflect the new name for the keyword argument. This meant that anything that used async_unsubscribe_topics with keyword arguments has been broken since 2024.6.0b0 - this doesn't fix that, but instead adjusts the stub so people can at least know it's different.

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 Ruff (ruff format 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.

To help with the load of incoming pull requests:

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

[home-assistant]

Hey there @emontnemery, @jbouwh, @bdraco, mind taking a look at this pull request as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of mqtt can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign mqtt Removes the current integration label and assignees on the pull request, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

[jbouwh]

I suggest we correct the signature for async_prepare_subscribe_topics

[TurnrDev]

But things use async_prepare_subscribe_topics too, also by keyword argument

[jbouwh]

But things use async_prepare_subscribe_topics too, also by keyword argument

#130866

May be: But the consequent name is sub_state. MQTT used it as a positional argument does and does not use the parameter as a keyword argument.

If you known of certain integrations that would break, then we could contact the maintainers. I think changing to new_state will have a higher breaking chance then switching back back to sub_state. In fact the current subscription state is input. The supplied topics will determine the new subscription state.

[TurnrDev]

Cool, I am happy to search github and fix any broken third party integrations :)

[jbouwh]

Cool, I am happy to search github and fix any broken third party integrations :)

I think #130866 should take away the confusion, do you agree?

[TurnrDev]

It sure can! I've left a question on the PR

[TurnrDev]

Cool, I'm happy for that. I'll close this PR and send out some PRs to integrations which I know use async_unsubscribe_topics or async_prepare_subscribe_topics