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 floor registry event typing #110844

Merged
merged 1 commit into from
Feb 18, 2024
Merged

Improve floor registry event typing #110844

merged 1 commit into from
Feb 18, 2024

Conversation

frenck
Copy link
Member

@frenck frenck commented Feb 18, 2024

Proposed change

Improves the typing of floor registry events.

needs #110843

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@frenck frenck requested a review from a team as a code owner February 18, 2024 10:47
@frenck frenck marked this pull request as draft February 18, 2024 10:47
@frenck frenck marked this pull request as ready for review February 18, 2024 12:22
Copy link
Member

@jpbede jpbede left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@@ -358,8 +360,8 @@ def _handle_floor_registry_update(event: Event) -> None:

self.hass.bus.async_listen(
event_type=fr.EVENT_FLOOR_REGISTRY_UPDATED,
event_filter=_floor_removed_from_registry_filter,
listener=_handle_floor_registry_update,
event_filter=_floor_removed_from_registry_filter, # type: ignore[arg-type]
Copy link
Member

Choose a reason for hiding this comment

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

Why do we need the type ignores, I don't remember?

Copy link
Member Author

@frenck frenck Feb 18, 2024

Choose a reason for hiding this comment

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

Little bit of context to what made me do this (and the adjustment of typing of fire event data):

#110821 (review)

More context around EventType (instead of Event being a generic):

#97071

Specifically this discussion: https://github.com/home-assistant/core/pull/97071/files#r1271450383

I personally don't prefer the ignores either, but... if support for defaults in typevar is landing/added, all these ignores will go away (and be caught by the linters as obsolete).

Copy link
Member

Choose a reason for hiding this comment

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

I've already added the basic support for TypeVar defaults to Mypy. That's all that we would need here. Just waiting for a new release now before I can start to update the typing. Should have been out a week ago, so hopefully next week 🤞🏻

I suggest to use type: ignore until then. Will be simple to remove.

python/mypy#16843

@MartinHjelmare MartinHjelmare merged commit 70d1bbb into dev Feb 18, 2024
53 checks passed
@MartinHjelmare MartinHjelmare deleted the frenck-2024-0232 branch February 18, 2024 13:57
@github-actions github-actions bot locked and limited conversation to collaborators Feb 19, 2024
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.

None yet

4 participants