-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Define Protocol as abstract to prevent abstract-method FP #7839
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
Fixes false positive ``abstract-method`` on Protocol classes. | ||
|
||
Closes #7209 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
"""Test that classes inheriting directly from Protocol should not warn about abstract-method.""" | ||
|
||
# pylint: disable=too-few-public-methods,disallowed-name,invalid-name | ||
|
||
from abc import abstractmethod, ABCMeta | ||
from typing import Protocol, Literal | ||
|
||
|
||
class FooProtocol(Protocol): | ||
"""Foo Protocol""" | ||
|
||
@abstractmethod | ||
def foo(self) -> Literal["foo"]: | ||
"""foo method""" | ||
|
||
def foo_no_abstract(self) -> Literal["foo"]: | ||
"""foo not abstract method""" | ||
|
||
|
||
class BarProtocol(Protocol): | ||
"""Bar Protocol""" | ||
@abstractmethod | ||
def bar(self) -> Literal["bar"]: | ||
"""bar method""" | ||
|
||
|
||
class FooBarProtocol(FooProtocol, BarProtocol, Protocol): | ||
DanielNoord marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"""FooBar Protocol""" | ||
|
||
class BarParent(BarProtocol): # [abstract-method] | ||
"""Doesn't subclass typing.Protocol directly""" | ||
|
||
class IndirectProtocol(FooProtocol): # [abstract-method] | ||
"""Doesn't subclass typing.Protocol directly""" | ||
|
||
class AbcProtocol(FooProtocol, metaclass=ABCMeta): | ||
"""Doesn't subclass typing.Protocol but uses metaclass directly""" | ||
|
||
class FooBar(FooBarProtocol): | ||
clavedeluna marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"""FooBar object""" | ||
|
||
def bar(self) -> Literal["bar"]: | ||
return "bar" | ||
|
||
def foo(self) -> Literal["foo"]: | ||
return "foo" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
[testoptions] | ||
min_pyver=3.8 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
abstract-method:30:0:30:15:BarParent:Method 'bar' is abstract in class 'BarProtocol' but is not overridden in child class 'BarParent':INFERENCE | ||
abstract-method:33:0:33:22:IndirectProtocol:Method 'foo' is abstract in class 'FooProtocol' but is not overridden in child class 'IndirectProtocol':INFERENCE |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Turns out
is_protocol_class
was incorrectly defined since it concluded that if any parent/grandparent class inherited from Protocol, this class was one too, but as we discussed the class has to inherit from Protocol itself. This definition was already in the code base so I just moved it here