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

Don't override methods marked as final #57477

Merged
merged 2 commits into from
Oct 11, 2021

Conversation

cdce8p
Copy link
Member

@cdce8p cdce8p commented Oct 11, 2021

Proposed change

Preview for the next pylint version which adds a new check overridden-final-method to detect methods that override a method decorated with @final.

For Home Assistant there are a few integrations which overwrite the state method at the moment.

Pylint PR which added the check: pylint-dev/pylint#5133

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)
  • 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
  • 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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@@ -211,7 +211,7 @@ def __init__(
)

@property
def state(self):
def state(self): # pylint: disable=overridden-final-method
Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not quite sure what to do with this one. The base class for Alert -> ToogleEntity already provides a state method. That one however will only return STATE_OFF or STATE_ON depending on self.is_on. Thus by removing this method, we would loose STATE_IDLE.

Copy link
Member

Choose a reason for hiding this comment

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

The alert integration can use some love, let's keep that out the scope for this PR 👍

@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Oct 11, 2021
@frenck frenck merged commit 748d915 into home-assistant:dev Oct 11, 2021
@cdce8p cdce8p deleted the overridden-final-method branch October 11, 2021 13:33
@github-actions github-actions bot locked and limited conversation to collaborators Oct 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed code-quality Hacktoberfest small-pr PRs with less than 30 lines. smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants