-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Fix exhaustive match checking for final class objects #11683
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
Open
Piyush Kulkarni (piy-ushk)
wants to merge
4
commits into
microsoft:main
Choose a base branch
from
piy-ushk:fix-match-type-coverage
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+120
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
9f9dd61
Fix exhaustive match checking for final class objects
piy-ushk c5499be
Address PR feedback: fix formatting and add regression test
piy-ushk 460963d
Address PR feedback: add custom metaclass check for class matching
piy-ushk ad68a05
Address PR feedback: use lookUpClassMember to resolve __eq__ in metac…
piy-ushk 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 hidden or 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 |
|---|---|---|
|
|
@@ -1334,6 +1334,31 @@ function narrowTypeBasedOnValuePattern( | |
| (subjectSubtypeExpanded) => { | ||
| // If this is a negative test, see if it's an enum value. | ||
| if (!isPositiveTest) { | ||
| if ( | ||
| isInstantiableClass(subjectSubtypeExpanded) && | ||
| isInstantiableClass(valueSubtypeExpanded) && | ||
| isSameWithoutLiteralValue(subjectSubtypeExpanded, valueSubtypeExpanded) | ||
| ) { | ||
| const metaclass = subjectSubtypeExpanded.shared.effectiveMetaclass; | ||
| let eqClass: ClassType | undefined; | ||
| if (metaclass && isInstantiableClass(metaclass)) { | ||
| const eqMember = lookUpClassMember(metaclass, '__eq__'); | ||
| if (eqMember && isClass(eqMember.classType)) { | ||
| eqClass = eqMember.classType; | ||
| } | ||
| } | ||
|
|
||
| const isStandardEquality = | ||
| !eqClass || ClassType.isBuiltIn(eqClass, ['type', 'object', 'ABCMeta', 'EnumMeta']); | ||
|
|
||
| if ( | ||
| isStandardEquality && | ||
| (ClassType.isFinal(subjectSubtypeExpanded) || | ||
| !subjectSubtypeExpanded.priv.includeSubclasses) | ||
| ) { | ||
| return undefined; | ||
| } | ||
| } | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Add regression coverage showing that a final class-object match is exhaustive and an equivalent non-final class remains non-exhaustive. This analyzer behavior change currently has no test specification. |
||
| if ( | ||
| isClassInstance(subjectSubtypeExpanded) && | ||
| isClassInstance(valueSubtypeExpanded) && | ||
|
|
||
87 changes: 87 additions & 0 deletions
87
packages/pyright-internal/src/tests/samples/matchClassFinal.py
This file contains hidden or 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,87 @@ | ||
| # pyright: reportMatchNotExhaustive=true | ||
|
|
||
| from typing import final | ||
|
|
||
| class Base: | ||
| pass | ||
|
|
||
| @final | ||
| class A1(Base): | ||
| pass | ||
|
|
||
| @final | ||
| class B1(Base): | ||
| pass | ||
|
|
||
| class NS1: | ||
| A1 = A1 | ||
| B1 = B1 | ||
|
|
||
| def exhaustive_final(inst: A1 | B1): | ||
| match type(inst): | ||
| case NS1.A1: | ||
| pass | ||
| case NS1.B1: | ||
| pass | ||
|
|
||
| class A2(Base): | ||
| pass | ||
|
|
||
| class B2(Base): | ||
| pass | ||
|
|
||
| class NS2: | ||
| A2 = A2 | ||
| B2 = B2 | ||
|
|
||
| def non_exhaustive_non_final(inst: A2 | B2): | ||
| match type(inst): | ||
| case NS2.A2: | ||
| pass | ||
| case NS2.B2: | ||
| pass | ||
|
|
||
| class Meta(type): | ||
| def __eq__(self, other): | ||
| return False | ||
|
|
||
| @final | ||
| class C1(metaclass=Meta): | ||
| pass | ||
|
|
||
| @final | ||
| class D1(metaclass=Meta): | ||
| pass | ||
|
|
||
| class NS3: | ||
| C1 = C1 | ||
| D1 = D1 | ||
|
|
||
| def non_exhaustive_custom_meta(inst: C1 | D1): | ||
| match type(inst): | ||
| case NS3.C1: | ||
| pass | ||
| case NS3.D1: | ||
| pass | ||
|
|
||
| class MetaNoOverride(type): | ||
| pass | ||
|
|
||
| @final | ||
| class E1(metaclass=MetaNoOverride): | ||
| pass | ||
|
|
||
| @final | ||
| class F1(metaclass=MetaNoOverride): | ||
| pass | ||
|
|
||
| class NS4: | ||
| E1 = E1 | ||
| F1 = F1 | ||
|
|
||
| def exhaustive_custom_meta_no_override(inst: E1 | F1): | ||
| match type(inst): | ||
| case NS4.E1: | ||
| pass | ||
| case NS4.F1: | ||
| pass |
This file contains hidden or 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
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.
Could this guard account for final classes with metaclasses that override
__eq__? A value pattern compares with==, not identity, sotype(inst)can fail to match the class at runtime even when its nominal type is exact; removing it here could incorrectly suppress an exhaustive-match diagnostic. Please add coverage and retain the subtype when equality semantics are nonstandard.