KEMBAR78
fix: Mismatched signature between checker plugin API and implementation by bzoracler · Pull Request #17343 · python/mypy · GitHub
Skip to content

fix: Mismatched signature between checker plugin API and implementation #17343

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 24, 2024
Merged

fix: Mismatched signature between checker plugin API and implementation #17343

merged 2 commits into from
Jul 24, 2024

Conversation

bzoracler
Copy link
Contributor

This PR changes the fail method's signature to be positional-only for the first two parameters, due to a mismatch between the CheckerPluginInterface signature and the implementation class (TypeChecker).

class CheckerPluginInterface:
    ...
    @abstractmethod
    def fail(
        self, msg: str | ErrorMessage, ctx: Context, *, code: ErrorCode | None = None
    ) -> None: ...
class TypeChecker(NodeVisitor[None], CheckerPluginInterface):
    ...
    def fail(
        self, msg: str | ErrorMessage, context: Context, *, code: ErrorCode | None = None
    ) -> None:

An alternative fix would be to change TypeChecker.fail's parameter name to ctx, but that has a greater disruption potential.

@github-actions

This comment has been minimized.

Sign in to view
@bzoracler
Copy link
Contributor Author

Fixes #17442

@github-actions
Copy link
Contributor

github-actions bot commented Jul 1, 2024

According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅

@hauntsaninja hauntsaninja merged commit db9837f into python:master Jul 24, 2024
@bzoracler bzoracler deleted the fix-checker-api-fail-signature branch July 24, 2024 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hauntsaninja hauntsaninja hauntsaninja approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bzoracler @hauntsaninja