Skip to content

Type the Loop base class as generic #9418

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

Merged
merged 1 commit into from
Sep 10, 2021
Merged

Conversation

carmocca
Copy link
Contributor

@carmocca carmocca commented Sep 9, 2021

What does this PR do?

Signal that the return type of run is the same as the return type of on_run_end.

Minimal example:

from dataclasses import dataclass
from typing import TypeVar, Generic

T = TypeVar("T")


class Base(Generic[T]):
    def run(self) -> T:
        return self.end()

    def end(self) -> T:
        ...


@dataclass
class Foo:
    ...


class Child(Base[Foo]):
    def end(self) -> Foo:
        ...

without this, when result = self.a_loop.run(...), mypy doesn't know the type of result even if its annotated in the on_run_end signature.

Does your PR introduce any breaking changes? If yes, please list them.

None

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • [n/a] Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • [n/a] Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

@carmocca carmocca added this to the v1.5 milestone Sep 9, 2021
@carmocca carmocca requested a review from awaelchli as a code owner September 9, 2021 20:00
@carmocca carmocca self-assigned this Sep 9, 2021
@mergify mergify bot added the ready PRs ready to be merged label Sep 10, 2021
@mergify mergify bot requested a review from a team September 10, 2021 02:14
Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

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

LGTM !

@kaushikb11 kaushikb11 enabled auto-merge (squash) September 10, 2021 08:58
@carmocca carmocca force-pushed the refactor/loops-generic-type branch from 5a1daa0 to 7b8cb6e Compare September 10, 2021 11:41
@codecov
Copy link

codecov bot commented Sep 10, 2021

Codecov Report

Merging #9418 (7b8cb6e) into master (e0f2e04) will increase coverage by 0%.
The diff coverage is 100%.

@@          Coverage Diff           @@
##           master   #9418   +/-   ##
======================================
  Coverage      93%     93%           
======================================
  Files         179     179           
  Lines       14922   14923    +1     
======================================
+ Hits        13861   13862    +1     
  Misses       1061    1061           

@kaushikb11 kaushikb11 merged commit 4f8c3ba into master Sep 10, 2021
@kaushikb11 kaushikb11 deleted the refactor/loops-generic-type branch September 10, 2021 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready PRs ready to be merged refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants