Skip to content

Explicitly define all methods in ConfigFlow#49341

Merged
MartinHjelmare merged 1 commit intohome-assistant:devfrom
KapJI:configflow-methods
Apr 17, 2021
Merged

Explicitly define all methods in ConfigFlow#49341
MartinHjelmare merged 1 commit intohome-assistant:devfrom
KapJI:configflow-methods

Conversation

@KapJI
Copy link
Copy Markdown
Member

@KapJI KapJI commented Apr 17, 2021

Proposed change

Unfortunately, mypy and pylint are unable to analyse such aliased methods. This causes # type: ignore was needed in some places and some pylint warnings were hidden.

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


async def async_step_zeroconf(
self, user_input: ConfigType | None = None
self, discovery_info: ConfigType | None = None
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The discovery info should never be None.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We can address this in a follow up too if wanted.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes, I know. The typing in that component is already pretty broken and it's not checked anyway. So I think right now it's not worth fixing it before we can enable type checks here. That I'm trying to do in #49270

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

But yeah, let's annotate this method correctly at least.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ok, let's fix this separately then.

Copy link
Copy Markdown
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.

Nice!

@MartinHjelmare MartinHjelmare merged commit 7a9385d into home-assistant:dev Apr 17, 2021
@KapJI KapJI deleted the configflow-methods branch April 17, 2021 10:43
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants