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.

Sign up for GitHub

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

Jump to bottom

Deprecate calendar.list_events #102481

Merged
merged 6 commits into from Nov 19, 2023
Merged

Deprecate calendar.list_events #102481

merged 6 commits into from Nov 19, 2023

Conversation

eifinger
Copy link
Contributor

@eifinger eifinger commented Oct 21, 2023 •
edited

Breaking change

calendar.list_events uses an outdated response data format It is deprecated and will be removed in 2024.6.
Please use calendar.get_events which supports multiple entities instead.

Proposed change

As discussed in home-assistant/architecture#948.

Deprecates calendar.list_events and introduces new service calendar.get_events with the new response format instead.

Depends on: #96370

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:

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 @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (calendar) you are listed as a code owner for? Thanks!

Code owner commands

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

@home-assistant
Copy link

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

Code owner commands

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

@eifinger eifinger mentioned this pull request Oct 21, 2023
Merged
20 tasks
@eifinger eifinger force-pushed the migrate_calendar_service_calls branch 7 times, most recently from 3486ca5 to 0eef0c5 Compare October 22, 2023 22:26
@eifinger eifinger mentioned this pull request Nov 3, 2023
Merged
20 tasks
@eifinger eifinger force-pushed the migrate_calendar_service_calls branch from 0eef0c5 to d123dda Compare November 3, 2023 09:10
@eifinger eifinger marked this pull request as ready for review November 3, 2023 09:19
@eifinger eifinger requested a review from a team as a code owner November 3, 2023 09:19
@eifinger eifinger force-pushed the migrate_calendar_service_calls branch 3 times, most recently from 9c1d6ed to 9d3c716 Compare November 4, 2023 10:41
@eifinger eifinger force-pushed the migrate_calendar_service_calls branch from 9d3c716 to 7f4ce26 Compare November 14, 2023 07:32
@home-assistant home-assistant bot marked this pull request as draft November 16, 2023 07:55
@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.

@eifinger eifinger force-pushed the migrate_calendar_service_calls branch from 7f4ce26 to 8c21cc8 Compare November 16, 2023 08:39
@eifinger eifinger marked this pull request as ready for review November 16, 2023 08:45
@home-assistant home-assistant bot marked this pull request as draft November 16, 2023 08:52
@eifinger eifinger marked this pull request as ready for review November 16, 2023 12:16
gjohansson-ST
gjohansson-ST approved these changes Nov 18, 2023
View reviewed changes
Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

Thanks @eifinger 👍

gjohansson-ST
gjohansson-ST requested changes Nov 18, 2023
View reviewed changes
Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

Noticed it's missing an addition of the service in services.yaml and the translations then in strings.json

@home-assistant home-assistant bot marked this pull request as draft November 18, 2023 22:04
@eifinger eifinger force-pushed the migrate_calendar_service_calls branch from 15138de to 3242c07 Compare November 19, 2023 09:12
@eifinger eifinger marked this pull request as ready for review November 19, 2023 09:13
gjohansson-ST
gjohansson-ST approved these changes Nov 19, 2023
View reviewed changes
Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

Thanks @eifinger 👍

CI failure is unrelated

@allenporter allenporter merged commit 51385dc into home-assistant:dev Nov 19, 2023
48 of 49 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Nov 20, 2023
@MartinHjelmare
Copy link
Member

This PR is missing a docs PR for the new service and removal of the old service.

@home-assistant home-assistant unlocked this conversation Dec 6, 2023
c0ffeeca7 added a commit to home-assistant/home-assistant.io that referenced this pull request Dec 7, 2023
@c0ffeeca7
Deprecate service list_events in favor of get_events
60bad05 
- The service `calendar.list_events` is deprecated in favor or `calendar.get_events`
- in 2023.12. Scheduled to be removed in 2024.6
- This PR adds a note that this service is deprecated
- The docs for `get_events` are a topic for a separate PR
- Unlike list_events, get_events supports multiple responses
- related parent PR in core: home-assistant/core#102481
@c0ffeeca7 c0ffeeca7 mentioned this pull request Dec 7, 2023
Merged
8 tasks
@github-actions github-actions bot locked and limited conversation to collaborators Dec 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@allenporter allenporter allenporter approved these changes

@gjohansson-ST gjohansson-ST gjohansson-ST approved these changes

Assignees
No one assigned
Labels
breaking-change cla-signed core Hacktoberfest has-tests integration: calendar integration: weather Quality Scale: internal
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@eifinger @MartinHjelmare @allenporter @gjohansson-ST