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

Use ServiceValidationError for invalid fan preset_mode and move check to fan entity component #104560

Merged
merged 23 commits into from Nov 29, 2023
Merged

Use ServiceValidationError for invalid fan preset_mode and move check to fan entity component #104560

merged 23 commits into from Nov 29, 2023

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Nov 26, 2023 •
edited

Proposed change

Move fan preset_mode validation to entity component platform.
Validation is done prior to call the integration methods async_turn_off or async_set_preset_mode.
NotValidPresetModeError is a subclass of ServiceValidationError instead of ValueError for invalid fan preset_mode through self._valid_preset_mode_or_raise(preset_mode).
A translation_key is linked now for localization.

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:

@jbouwh jbouwh requested a review from a team as a code owner November 26, 2023 18:34
@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 (demo) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of demo 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 demo 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
Copy link
Contributor Author

jbouwh commented Nov 26, 2023

Other chalenge is the UI. Possible we need an update for the Developers tools:

afbeelding

@jbouwh jbouwh changed the title Use ServiceValidationError for invalid demo fan preset_mode Use ServiceValidationError for invalid demo preset_mode Nov 26, 2023
@jbouwh jbouwh changed the title Use ServiceValidationError for invalid demo preset_mode Use ServiceValidationError for invalid preset_mode Nov 26, 2023
@jbouwh jbouwh changed the title Use ServiceValidationError for invalid preset_mode Use ServiceValidationError for invalid fan preset_mode Nov 26, 2023
MartinHjelmare
MartinHjelmare requested changes Nov 27, 2023
View reviewed changes
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Some comments left to address.

@home-assistant home-assistant bot marked this pull request as draft November 27, 2023 09:01
@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.

jbouwh and others added 2 commits November 27, 2023 23:15
@jbouwh
Remove unreachable code
65f5c15
@jbouwh @gjohansson-ST
Update homeassistant/components/fan/__init__.py
6335fd8 
Co-authored-by: G Johansson <goran.johansson@shiftit.se>
gjohansson-ST
gjohansson-ST approved these changes Nov 28, 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 @jbouwh 👍

@emontnemery emontnemery marked this pull request as draft November 28, 2023 09:55
@jbouwh jbouwh marked this pull request as ready for review November 28, 2023 13:20
@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 (fan) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of fan 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 fan 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.

emontnemery
emontnemery requested changes Nov 29, 2023
View reviewed changes
homeassistant/components/fan/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/fan/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/fan/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/fan/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/fan/__init__.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft November 29, 2023 10:23
MartinHjelmare
MartinHjelmare approved these changes Nov 29, 2023
View reviewed changes
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Looks good, when Erik's comments are addressed. 👍

jbouwh and others added 2 commits November 29, 2023 10:34
@jbouwh
Follow up comments
01af2ff
@jbouwh @emontnemery
Update homeassistant/components/fan/__init__.py
aad8a86 
Co-authored-by: Erik Montnemery <erik@montnemery.com>
@jbouwh jbouwh marked this pull request as ready for review November 29, 2023 10:35
emontnemery
emontnemery approved these changes Nov 29, 2023
View reviewed changes
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

Nice! Thanks @jbouwh 👍

@emontnemery emontnemery merged commit 953a212 into dev Nov 29, 2023
53 checks passed
@emontnemery emontnemery deleted the jbouwh-demo-fan-preset_mode-exc branch November 29, 2023 12:56
@github-actions github-actions bot locked and limited conversation to collaborators Nov 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@frenck frenck frenck left review comments

@emontnemery emontnemery emontnemery approved these changes

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

@dmulcahey dmulcahey Awaiting requested review from dmulcahey dmulcahey is a code owner

@Adminiuga Adminiuga Awaiting requested review from Adminiuga Adminiuga is a code owner

@puddly puddly Awaiting requested review from puddly puddly is a code owner

@rytilahti rytilahti Awaiting requested review from rytilahti rytilahti is a code owner

@syssi syssi Awaiting requested review from syssi syssi is a code owner

@starkillerOG starkillerOG Awaiting requested review from starkillerOG starkillerOG is a code owner

@elupus elupus Awaiting requested review from elupus elupus is a code owner

@bdraco bdraco Awaiting requested review from bdraco bdraco is a code owner

@MartinHjelmare MartinHjelmare Awaiting requested review from MartinHjelmare

Assignees
No one assigned
Labels
cla-signed code-quality core has-tests integration: demo integration: fan Quality Scale: internal small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@jbouwh @frenck @MartinHjelmare @emontnemery @gjohansson-ST