Skip to content

Define data flow result type#49260

Merged
bdraco merged 4 commits intohome-assistant:devfrom
KapJI:typed-dataflow
Apr 15, 2021
Merged

Define data flow result type#49260
bdraco merged 4 commits intohome-assistant:devfrom
KapJI:typed-dataflow

Conversation

@KapJI
Copy link
Copy Markdown
Member

@KapJI KapJI commented Apr 15, 2021

Proposed change

Motivation

This is another step of my initiative to make it possible to annotate components with types without using Any.
This allows to completely get rid of Any in config flow of the component.

Another advantages:

  • More type safety. TypedDict verifies that only listed keys are accessed and their types match.
  • Get rid of many dict[str, Any], dict[Any, Any] or even just Any.
  • Developers of components can know what to expect from result value of data flow methods.
  • Remove multiple # type: ignore annotations.

Only type hints are changed, behaviour remains exactly the same as before.

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:

@probot-home-assistant
Copy link
Copy Markdown

Hey there @dermotduffy, mind taking a look at this pull request as its been labeled with an integration (hyperion) you are listed as a codeowner for? Thanks!
(message by CodeOwnersMention)

@probot-home-assistant
Copy link
Copy Markdown

Hey there @home-assistant/supervisor, mind taking a look at this pull request as its been labeled with an integration (hassio) you are listed as a codeowner for? Thanks!
(message by CodeOwnersMention)

Comment thread homeassistant/components/zwave_js/config_flow.py Outdated
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.

Looks good!

Copy link
Copy Markdown
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@bdraco bdraco merged commit 80f66f3 into home-assistant:dev Apr 15, 2021
@KapJI KapJI deleted the typed-dataflow branch April 15, 2021 17:25
bdraco added a commit to bdraco/home-assistant that referenced this pull request Apr 15, 2021
@bdraco bdraco mentioned this pull request Apr 15, 2021
21 tasks
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 16, 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.

5 participants