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

Improve readability in hass_imports pylint plugin #126252

Merged
merged 4 commits into from
Sep 20, 2024

Conversation

epenet
Copy link
Contributor

@epenet epenet commented Sep 19, 2024

Proposed change

visit_importfrom has 5 different checks - and it is becoming quite difficult to follow what it is doing.

With no change in functionnality, this moves 3 of those checks to separate methods:

  • one for hass-relative-import
  • one for hass-component-root-import
  • one for hass-import-constant-alias

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 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:

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:

@home-assistant home-assistant bot added cla-signed code-quality small-pr PRs with less than 30 lines. labels Sep 19, 2024
@epenet epenet marked this pull request as ready for review September 19, 2024 10:47
@epenet epenet requested a review from a team as a code owner September 19, 2024 10:47

return True

def _check_for_relative_import(
Copy link
Member

Choose a reason for hiding this comment

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

This sounds like it could be a ruff rule, as it doesn't seem specific to Home Assistant.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As discussed, I'll take a look at TID252 rule in a follow-up to see if/what it could replace.
https://docs.astral.sh/ruff/rules/relative-imports/

@epenet epenet merged commit 2062e49 into home-assistant:dev Sep 20, 2024
44 checks passed
@epenet epenet deleted the 20240919-0936 branch September 20, 2024 09:10
sarog pushed a commit to sarog/hass-core that referenced this pull request Sep 20, 2024
)

* Improve readability in hass_imports pylint plugin

* One more

* docstring

* docstring
@github-actions github-actions bot locked and limited conversation to collaborators Sep 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed code-quality small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants