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

Relax typing on cached_property to accept subclasses #95407

Merged
merged 7 commits into from
Jul 24, 2023

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jun 27, 2023

Proposed change

This might need to be adjusted some more. That can happen here or in a future PR (this is new and we are still figuring out how its going to be fit in).

The goal was to get it working with #95315

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

@home-assistant home-assistant bot added cla-signed core small-pr PRs with less than 30 lines. labels Jun 27, 2023
@bdraco bdraco marked this pull request as ready for review July 4, 2023 19:16
@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Jul 5, 2023
@bdraco bdraco requested a review from cdce8p July 23, 2023 23:32
Copy link
Member

@cdce8p cdce8p left a comment

Choose a reason for hiding this comment

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

@bdraco bdraco requested a review from a team as a code owner July 23, 2023 23:58
@bdraco
Copy link
Member Author

bdraco commented Jul 23, 2023

Adjusted to match. Will wait for CI run and than pull out the entity changes if it passes

@cdce8p
Copy link
Member

cdce8p commented Jul 24, 2023

Adjusted to match. Will wait for CI run and than pull out the entity changes if it passes

Doesn't look like it, unfortunately. Let's just change _T to _T_co then and test it again.

@bdraco
Copy link
Member Author

bdraco commented Jul 24, 2023

Adjusted to match. Will wait for CI run and than pull out the entity changes if it passes

Doesn't look like it, unfortunately. Let's just change _T to _T_co then and test it again.

👍
6eeaa51

@bdraco
Copy link
Member Author

bdraco commented Jul 24, 2023

I think the current errors are ok as we want everything downstream to be a cached_property or explicitly have to add an ignore if they want to opt out

@cdce8p
Copy link
Member

cdce8p commented Jul 24, 2023

I think the current errors are ok as we want everything downstream to be a cached_property or explicitly have to add an ignore if they want to opt out

In that case, T can probably be changed back to invariant? I tested it locally and when I add backports.functools.cached_property downstream, it still seems to work.

This reverts commit 6eeaa51.
@bdraco
Copy link
Member Author

bdraco commented Jul 24, 2023

I think the current errors are ok as we want everything downstream to be a cached_property or explicitly have to add an ignore if they want to opt out

In that case, T can probably be changed back to invariant? I tested it locally and when I add backports.functools.cached_property downstream, it still seems to work.

Sounds good. I reverted the covar.

This is good because it means it should work 1:1 when we no longer have the backport and can use the cpython 3.12 version as it matches typeshed

@bdraco
Copy link
Member Author

bdraco commented Jul 24, 2023

Thanks. Checking typeshed was a good call

@bdraco bdraco merged commit 19b0a6e into dev Jul 24, 2023
31 checks passed
@bdraco bdraco deleted the relax_typing_cached_property branch July 24, 2023 01:47
@github-actions github-actions bot locked and limited conversation to collaborators Jul 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed core small-pr PRs with less than 30 lines. smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants