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

Avoid import dhcp, ssdp, zeroconf in config_flow.py when only used for type checking #135373

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

stefdude
Copy link

Proposed change

Some users might not use the default_config and avoid loading dhcp, ssdp or zeroconf. Currently, due to type checking, dhcp, ssdp or zeroconf will still be imported. This patch avoids this import (while keeping the annotation).

This is my first PR, and because I applied the same fix to all integrations, this patch might be bigger and touching a lot of integrations. I'm willing to split it up (but would prefer to avoid creating one PR per integration...)

Methodology used:

  • make sure that future.annotations and typing.TYPE_CHECKING are imported
  • check no other objects of the imported module are being used
  • move the import to a conditional import (if TYPE_CHECKING:)
  • only import the {Dhcp,Ssdp,Zeroconf}ServiceInfo item

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

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:

…ssdp,zeroconf

Some users might not use the default_config and avoid loading dhcp, ssdp or zeroconf.
Currently, due to type checking, dhcp, ssdp or zeroconf will still be imported.
This patch avoids this import (while keeping the annotation)

Methodology:
- make sure that __future__.annotations and typing.TYPE_CHECKING are imported
- check no other objects of the imported module are being used
- move the import to a conditional import (if TYPE_CHECKING:)
- only import homeassistant.components.{dhcp,ssdp,zeroconf}.{Dhcp,Ssdp,Zeroconf}ServiceInfo

Signed-off-by: Stef Simoens <stef.github@bisse.be>
Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hi @stefdude

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@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.

@stefdude stefdude requested a review from tronikos as a code owner January 11, 2025 14:17
@stefdude stefdude marked this pull request as ready for review January 11, 2025 14:24
@MartinHjelmare MartinHjelmare changed the title avoid import dhcp,ssdp,zeroconf in config_flow.py when only used for type checking Avoid import dhcp, ssdp, zeroconf in config_flow.py when only used for type checking Jan 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant