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

Fixed a bug that results in incorrect type narrowing when using `isin… #8675

Merged
merged 1 commit into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions packages/pyright-internal/src/analyzer/typeGuards.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ import {
isUnboundedTupleClass,
lookUpClassMember,
lookUpObjectMember,
makeTypeVarsFree,
mapSubtypes,
MemberAccessFlags,
specializeTupleClass,
Expand Down Expand Up @@ -1355,6 +1356,17 @@ function narrowTypeForIsInstanceInternal(

expandedTypes = evaluator.expandPromotionTypes(errorNode, expandedTypes);

const convertVarTypeToFree = (varType: Type): Type => {
// If this is a TypeIs check, type variables should remain bound.
if (isTypeIsCheck) {
return varType;
}

// If this is an isinstance or issubclass check, the type variables
// should be converted to "free" type variables.
return makeTypeVarsFree(varType, ParseTreeUtils.getTypeVarScopesForNode(errorNode));
};

// Filters the varType by the parameters of the isinstance
// and returns the list of types the varType could be after
// applying the filter.
Expand Down Expand Up @@ -1443,7 +1455,7 @@ function narrowTypeForIsInstanceInternal(
} else if (filterIsSubclass) {
if (
evaluator.assignType(
convertToInstance(concreteVarType),
convertToInstance(convertVarTypeToFree(concreteVarType)),
convertToInstance(concreteFilterType),
/* diag */ undefined,
/* destConstraints */ undefined,
Expand Down Expand Up @@ -1597,7 +1609,7 @@ function narrowTypeForIsInstanceInternal(
}
} else if (
evaluator.assignType(
concreteVarType,
convertVarTypeToFree(concreteVarType),
filterType,
/* diag */ undefined,
/* destConstraints */ undefined,
Expand Down Expand Up @@ -1653,7 +1665,7 @@ function narrowTypeForIsInstanceInternal(

if (filterMetaclass && isInstantiableClass(filterMetaclass)) {
let isMetaclassOverlap = evaluator.assignType(
metaclassType,
convertVarTypeToFree(metaclassType),
ClassType.cloneAsInstance(filterMetaclass)
);

Expand Down Expand Up @@ -1711,7 +1723,7 @@ function narrowTypeForIsInstanceInternal(
for (const filterType of filterTypes) {
const concreteFilterType = evaluator.makeTopLevelTypeVarsConcrete(filterType);

if (evaluator.assignType(varType, convertToInstance(concreteFilterType))) {
if (evaluator.assignType(convertVarTypeToFree(varType), convertToInstance(concreteFilterType))) {
// If the filter type is a Callable, use the original type. If the
// filter type is a callback protocol, use the filter type.
if (isFunction(filterType)) {
Expand All @@ -1730,7 +1742,7 @@ function narrowTypeForIsInstanceInternal(
return false;
}

return evaluator.assignType(varType, convertToInstance(concreteFilterType));
return evaluator.assignType(convertVarTypeToFree(varType), convertToInstance(concreteFilterType));
})
) {
filteredTypes.push(unexpandedType);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
# This sample exercises the type analyzer's isinstance type narrowing logic.

from types import NoneType
from typing import Any, Generic, Iterable, Iterator, Protocol, Sized, TypeVar, Union, runtime_checkable
from typing import (
Any,
Generic,
Iterable,
Iterator,
Protocol,
Sized,
TypeVar,
Union,
runtime_checkable,
)

S = TypeVar("S")
T = TypeVar("T")
Expand Down Expand Up @@ -233,3 +243,21 @@ def func13(x: object | type[object]) -> None:
def func14(x: Iterable[T]):
if isinstance(x, Iterator):
reveal_type(x, expected_text="Iterator[T@func14]")


class Base15(Generic[T]):
value: T


class Child15(Base15[int]):
value: int


def func15(x: Base15[T]):
if isinstance(x, Child15):
# This should generate an error. It's here just to ensure that
# this code branch isn't marked unreachable.
reveal_type(x, expected_text="Never")

reveal_type(x, expected_text="Child15")
reveal_type(x.value, expected_text="int")
12 changes: 6 additions & 6 deletions packages/pyright-internal/src/tests/typeEvaluator1.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -288,12 +288,6 @@ test('TypeNarrowing7', () => {
TestUtils.validateResults(analysisResults, 0);
});

test('TypeNarrowingIsinstance1', () => {
const analysisResults = TestUtils.typeAnalyzeSampleFiles(['typeNarrowingIsinstance1.py']);

TestUtils.validateResults(analysisResults, 8);
});

test('TypeNarrowingAssert1', () => {
const analysisResults = TestUtils.typeAnalyzeSampleFiles(['typeNarrowingAssert1.py']);

Expand Down Expand Up @@ -372,6 +366,12 @@ test('TypeNarrowingEnum2', () => {
TestUtils.validateResults(analysisResults, 2);
});

test('TypeNarrowingIsinstance1', () => {
const analysisResults = TestUtils.typeAnalyzeSampleFiles(['typeNarrowingIsinstance1.py']);

TestUtils.validateResults(analysisResults, 9);
});

test('TypeNarrowingIsinstance2', () => {
const analysisResults = TestUtils.typeAnalyzeSampleFiles(['typeNarrowingIsinstance2.py']);

Expand Down
Loading