Skip to content
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.

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

Apple TV: Use replacement commands for deprecated ones #102056

Merged
merged 3 commits into from
Oct 26, 2023

Conversation

amitfin
Copy link
Contributor

@amitfin amitfin commented Oct 15, 2023

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

pyatv is the underline library of the Apple TV integration.

The library exposes RemoteControl interface which has 5 deprecated methods: wakeup, suspend, volume_up, volume_down, home_hold.

The PR translates the deprecated methods to their new implementation. It also suppresses the warning log entry which occurred with the old implementation:

/usr/src/homeassistant/homeassistant/components/apple_tv/remote.py:69: DeprecationWarning: Call to deprecated function wakeup. await attr_value()
  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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:

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:

@home-assistant
Copy link

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

Code owner commands

Code owners of apple_tv 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 apple_tv Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Oct 25, 2023
@home-assistant home-assistant bot marked this pull request as draft October 25, 2023 13:48
@home-assistant
Copy link

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.

Co-authored-by: Robert Resch <robert@resch.dev>
@amitfin amitfin marked this pull request as ready for review October 25, 2023 19:28
@home-assistant home-assistant bot requested a review from edenhaus October 25, 2023 19:28
Copy link
Contributor

@edenhaus edenhaus left a comment

Choose a reason for hiding this comment

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

Thanks @amitfin 👍

@edenhaus edenhaus changed the title Apple TV remote: translate deprecated commands Apple TV: Use replacement commands for deprecated ones Oct 26, 2023
@edenhaus edenhaus added this to the 2023.11.0 milestone Oct 26, 2023
@edenhaus edenhaus merged commit edf2e42 into home-assistant:dev Oct 26, 2023
20 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Oct 27, 2023
@amitfin amitfin deleted the apple_tv_commands branch October 31, 2023 09:06
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants