@zzzen/pyright-internal 1.2.0-dev.20220703 → 1.2.0-dev.20220724

package/dist/analyzer/checker.js

@@ -51,6 +51,7 @@ const ParseTreeUtils = __importStar(require("./parseTreeUtils"));
 const parseTreeWalker_1 = require("./parseTreeWalker");
 const patternMatching_1 = require("./patternMatching");
 const scopeUtils_1 = require("./scopeUtils");
+const sourceFile_1 = require("./sourceFile");
 const sourceMapper_1 = require("./sourceMapper");
 const staticExpressions_1 = require("./staticExpressions");
 const SymbolNameUtils = __importStar(require("./symbolNameUtils"));
@@ -327,7 +328,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                 if (annotationNode && index < functionTypeResult.functionType.details.parameters.length) {
                     const paramType = functionTypeResult.functionType.details.parameters[index].type;
                     if ((0, types_1.isTypeVar)(paramType) &&
-                        paramType.details.declaredVariance === 2 /* Covariant */ &&
+                        paramType.details.declaredVariance === 3 /* Covariant */ &&
                         !paramType.details.isSynthesized &&
                         functionTypeResult.functionType.details.name !== '__init__') {
                         this._evaluator.addDiagnostic(this._fileInfo.diagnosticRuleSet.reportGeneralTypeIssues, diagnosticRules_1.DiagnosticRule.reportGeneralTypeIssues, localize_1.Localizer.Diagnostic.paramTypeCovariant(), annotationNode);
@@ -385,14 +386,19 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         }
         this._scopedNodes.push(node);
         if (functionTypeResult && (0, types_1.isOverloadedFunction)(functionTypeResult.decoratedType)) {
-            const overloads = functionTypeResult.decoratedType.overloads;
-            if (overloads.length > 1) {
-                const maxOverloadConsistencyCheckLength = 100;
-                // The check is n^2 in time, so if the number of overloads
-                // is very large (which can happen for some generated code),
-                // skip this check to avoid quadratic analysis time.
-                if (overloads.length < maxOverloadConsistencyCheckLength) {
-                    this._validateOverloadConsistency(node, overloads[overloads.length - 1], overloads.slice(0, overloads.length - 1));
+            // If this is the implementation for the overloaded function, skip
+            // overload consistency checks.
+            if (types_1.OverloadedFunctionType.getImplementation(functionTypeResult.decoratedType) !==
+                functionTypeResult.functionType) {
+                const overloads = types_1.OverloadedFunctionType.getOverloads(functionTypeResult.decoratedType);
+                if (overloads.length > 1) {
+                    const maxOverloadConsistencyCheckLength = 100;
+                    // The check is n^2 in time, so if the number of overloads
+                    // is very large (which can happen for some generated code),
+                    // skip this check to avoid quadratic analysis time.
+                    if (overloads.length < maxOverloadConsistencyCheckLength) {
+                        this._validateOverloadConsistency(node, overloads[overloads.length - 1], overloads.slice(0, overloads.length - 1));
+                    }
                 }
             }
         }
@@ -731,6 +737,12 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                 this._validateComparisonTypes(node);
             }
         }
+        else if (node.operator === 41 /* In */ || node.operator === 42 /* NotIn */) {
+            // Don't apply this rule if it's within an assert.
+            if (!ParseTreeUtils.isWithinAssertExpression(node)) {
+                this._validateContainmentTypes(node);
+            }
+        }
         this._evaluator.getType(node);
         return true;
     }
@@ -976,11 +988,46 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
             }
         }
     }
+    _validateContainmentTypes(node) {
+        const leftType = this._evaluator.getType(node.leftExpression);
+        const containerType = this._evaluator.getType(node.rightExpression);
+        if (!leftType || !containerType) {
+            return;
+        }
+        if ((0, types_1.isNever)(leftType) || (0, types_1.isNever)(containerType)) {
+            return;
+        }
+        // Use the common narrowing logic for containment.
+        const elementType = (0, typeGuards_1.getElementTypeForContainerNarrowing)(containerType);
+        if (!elementType) {
+            return;
+        }
+        const narrowedType = (0, typeGuards_1.narrowTypeForContainerElementType)(this._evaluator, leftType, this._evaluator.makeTopLevelTypeVarsConcrete(elementType));
+        if ((0, types_1.isNever)(narrowedType)) {
+            const getMessage = () => {
+                return node.operator === 41 /* In */
+                    ? localize_1.Localizer.Diagnostic.containmentAlwaysFalse()
+                    : localize_1.Localizer.Diagnostic.containmentAlwaysTrue();
+            };
+            this._evaluator.addDiagnostic(this._fileInfo.diagnosticRuleSet.reportUnnecessaryContains, diagnosticRules_1.DiagnosticRule.reportUnnecessaryContains, getMessage().format({
+                leftType: this._evaluator.printType(leftType, /* expandTypeAlias */ true),
+                rightType: this._evaluator.printType(elementType, /* expandTypeAlias */ true),
+            }), node);
+        }
+    }
     // Determines whether the types of the two operands for an == or != operation
     // have overlapping types.
     _validateComparisonTypes(node) {
+        let rightExpression = node.rightExpression;
+        // Check for chained comparisons.
+        if (rightExpression.nodeType === 7 /* BinaryOperation */ &&
+            !rightExpression.parenthesized &&
+            ParseTreeUtils.operatorSupportsChaining(rightExpression.operator)) {
+            // Use the left side of the right expression for comparison purposes.
+            rightExpression = rightExpression.leftExpression;
+        }
         const leftType = this._evaluator.getType(node.leftExpression);
-        const rightType = this._evaluator.getType(node.rightExpression);
+        const rightType = this._evaluator.getType(rightExpression);
         if (!leftType || !rightType) {
             return;
         }
@@ -1284,9 +1331,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
     _validateOverloadConsistency(node, functionType, prevOverloads) {
         for (let i = 0; i < prevOverloads.length; i++) {
             const prevOverload = prevOverloads[i];
-            if (types_1.FunctionType.isOverloaded(functionType) &&
-                types_1.FunctionType.isOverloaded(prevOverload) &&
-                this._isOverlappingOverload(functionType, prevOverload)) {
+            if (this._isOverlappingOverload(functionType, prevOverload)) {
                 this._evaluator.addDiagnostic(this._fileInfo.diagnosticRuleSet.reportOverlappingOverload, diagnosticRules_1.DiagnosticRule.reportOverlappingOverload, localize_1.Localizer.Diagnostic.overlappingOverload().format({
                     name: node.name.value,
                     obscured: prevOverloads.length + 1,
@@ -1297,9 +1342,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         }
         for (let i = 0; i < prevOverloads.length; i++) {
             const prevOverload = prevOverloads[i];
-            if (types_1.FunctionType.isOverloaded(functionType) &&
-                types_1.FunctionType.isOverloaded(prevOverload) &&
-                this._isOverlappingOverload(prevOverload, functionType)) {
+            if (this._isOverlappingOverload(prevOverload, functionType)) {
                 const prevReturnType = types_1.FunctionType.getSpecializedReturnType(prevOverload);
                 const returnType = types_1.FunctionType.getSpecializedReturnType(functionType);
                 if (prevReturnType &&
@@ -1387,7 +1430,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                     const start = statement.start;
                     const lastStatement = statements[statements.length - 1];
                     const end = textRange_1.TextRange.getEnd(lastStatement);
-                    this._evaluator.addUnusedCode(statement, { start, length: end - start });
+                    this._evaluator.addUnreachableCode(statement, { start, length: end - start });
                     reportedUnreachable = true;
                 }
             }
@@ -1577,8 +1620,11 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
             const primaryDecl = typedDecls[0];
             if (primaryDecl.type === 5 /* Function */) {
                 const type = this._evaluator.getEffectiveTypeOfSymbol(symbol);
-                const functions = (0, types_1.isOverloadedFunction)(type) ? type.overloads : (0, types_1.isFunction)(type) ? [type] : [];
-                const overloadedFunctions = functions.filter((func) => types_1.FunctionType.isOverloaded(func));
+                const overloadedFunctions = (0, types_1.isOverloadedFunction)(type)
+                    ? types_1.OverloadedFunctionType.getOverloads(type)
+                    : (0, types_1.isFunction)(type) && types_1.FunctionType.isOverloaded(type)
+                        ? [type]
+                        : [];
                 if (overloadedFunctions.length === 1) {
                     // There should never be a single overload.
                     this._evaluator.addDiagnostic(this._fileInfo.diagnosticRuleSet.reportGeneralTypeIssues, diagnosticRules_1.DiagnosticRule.reportGeneralTypeIssues, localize_1.Localizer.Diagnostic.singleOverload().format({ name }), primaryDecl.node.name);
@@ -1595,9 +1641,8 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                 // verify that there is an implementation.
                 if (!this._fileInfo.isStubFile && overloadedFunctions.length > 0) {
                     let implementationFunction;
-                    if ((0, types_1.isOverloadedFunction)(type) &&
-                        !types_1.FunctionType.isOverloaded(type.overloads[type.overloads.length - 1])) {
-                        implementationFunction = type.overloads[type.overloads.length - 1];
+                    if ((0, types_1.isOverloadedFunction)(type) && types_1.OverloadedFunctionType.getImplementation(type)) {
+                        implementationFunction = types_1.OverloadedFunctionType.getImplementation(type);
                     }
                     else if ((0, types_1.isFunction)(type) && !types_1.FunctionType.isOverloaded(type)) {
                         implementationFunction = type;
@@ -1621,11 +1666,8 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                     }
                     else if ((0, types_1.isOverloadedFunction)(type)) {
                         // Verify that all overload signatures are assignable to implementation signature.
-                        type.overloads.forEach((overload, index) => {
+                        types_1.OverloadedFunctionType.getOverloads(type).forEach((overload, index) => {
                             var _a, _b, _c, _d;
-                            if (overload === implementationFunction || !types_1.FunctionType.isOverloaded(overload)) {
-                                return;
-                            }
                             const diag = new diagnostic_1.DiagnosticAddendum();
                             if (!this._isLegalOverloadImplementation(overload, implementationFunction, diag)) {
                                 if (implementationFunction.details.declaration) {
@@ -1894,7 +1936,9 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
     }
     _conditionallyReportUnusedSymbol(name, symbol, scopeType) {
         const accessedSymbolSet = this._fileInfo.accessedSymbolSet;
-        if (symbol.isIgnoredForProtocolMatch() || accessedSymbolSet.has(symbol.id)) {
+        if (symbol.isIgnoredForProtocolMatch() ||
+            accessedSymbolSet.has(symbol.id) ||
+            this._fileInfo.ipythonMode === sourceFile_1.IPythonMode.CellDocs) {
             return;
         }
         // A name of "_" means "I know this symbol isn't used", so
@@ -2549,7 +2593,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                 }
                 const diag = new diagnostic_1.DiagnosticAddendum();
                 if ((0, types_1.isTypeVar)(declaredReturnType) &&
-                    declaredReturnType.details.declaredVariance === 3 /* Contravariant */) {
+                    declaredReturnType.details.declaredVariance === 4 /* Contravariant */) {
                     diag.addMessage(localize_1.Localizer.DiagnosticAddendum.typeVarIsContravariant().format({
                         name: types_1.TypeVarType.getReadableName(declaredReturnType),
                     }));
@@ -2910,26 +2954,26 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
             const isDestSubtypeOfSrc = this._evaluator.assignClassToSelf(srcType, destType);
             let expectedVariance;
             if (isDestSubtypeOfSrc) {
-                expectedVariance = 2 /* Covariant */;
+                expectedVariance = 3 /* Covariant */;
             }
             else {
                 const isSrcSubtypeOfDest = this._evaluator.assignClassToSelf(destType, srcType);
                 if (isSrcSubtypeOfDest) {
-                    expectedVariance = 3 /* Contravariant */;
+                    expectedVariance = 4 /* Contravariant */;
                 }
                 else {
-                    expectedVariance = 1 /* Invariant */;
+                    expectedVariance = 2 /* Invariant */;
                 }
             }
             if (expectedVariance !== classType.details.typeParameters[paramIndex].details.declaredVariance) {
                 let message;
-                if (expectedVariance === 2 /* Covariant */) {
+                if (expectedVariance === 3 /* Covariant */) {
                     message = localize_1.Localizer.Diagnostic.protocolVarianceCovariant().format({
                         variable: param.details.name,
                         class: classType.details.name,
                     });
                 }
-                else if (expectedVariance === 3 /* Contravariant */) {
+                else if (expectedVariance === 4 /* Contravariant */) {
                     message = localize_1.Localizer.Diagnostic.protocolVarianceContravariant().format({
                         variable: param.details.name,
                         class: classType.details.name,
@@ -3009,7 +3053,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         }
         if ((0, types_1.isOverloadedFunction)(newMemberType)) {
             // Find the implementation, not the overloaded signatures.
-            newMemberType = newMemberType.overloads.find((func) => !types_1.FunctionType.isOverloaded(func));
+            newMemberType = types_1.OverloadedFunctionType.getImplementation(newMemberType);
             if (!newMemberType) {
                 return;
             }
@@ -3024,7 +3068,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         }
         if ((0, types_1.isOverloadedFunction)(initMemberType)) {
             // Find the implementation, not the overloaded signatures.
-            initMemberType = initMemberType.overloads.find((func) => !types_1.FunctionType.isOverloaded(func));
+            initMemberType = types_1.OverloadedFunctionType.getImplementation(initMemberType);
             if (!initMemberType) {
                 return;
             }
@@ -3162,9 +3206,9 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
             }
             else if ((0, types_1.isOverloadedFunction)(overrideType)) {
                 // Use the last overload.
-                overrideFunction = overrideType.overloads[overrideType.overloads.length - 1];
+                overrideFunction = types_1.OverloadedFunctionType.getImplementation(overrideType);
                 // If the last overload isn't an implementation, skip the check for this symbol.
-                if (types_1.FunctionType.isOverloaded(overrideFunction)) {
+                if (!overrideFunction) {
                     return;
                 }
             }
@@ -3232,7 +3276,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
             }
             // If the symbol has no declaration, and the type is inferred,
             // skip this check.
-            if (!symbol.hasTypedDeclarations()) {
+            if (!symbol.hasTypedDeclarations() && !(0, symbolUtils_1.isFinalVariable)(symbol)) {
                 return;
             }
             // Get the symbol type defined in this class.
@@ -3260,7 +3304,6 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         });
     }
     _validateBaseClassOverride(baseClassAndSymbol, overrideSymbol, overrideType, childClassType, memberName) {
-        var _a;
         if (!(0, types_1.isInstantiableClass)(baseClassAndSymbol.classType)) {
             return;
         }
@@ -3278,15 +3321,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         const baseType = (0, typeUtils_1.partiallySpecializeType)(this._evaluator.getEffectiveTypeOfSymbol(baseClassAndSymbol.symbol), baseClassAndSymbol.classType);
         if ((0, types_1.isFunction)(baseType) || (0, types_1.isOverloadedFunction)(baseType)) {
             const diagAddendum = new diagnostic_1.DiagnosticAddendum();
-            let overrideFunction;
-            if ((0, types_1.isFunction)(overrideType)) {
-                overrideFunction = overrideType;
-            }
-            else if ((0, types_1.isOverloadedFunction)(overrideType)) {
-                // Use the last overload.
-                overrideFunction = overrideType.overloads[overrideType.overloads.length - 1];
-            }
-            if (overrideFunction) {
+            if ((0, types_1.isFunction)(overrideType) || (0, types_1.isOverloadedFunction)(overrideType)) {
                 const exemptMethods = ['__init__', '__new__', '__init_subclass__'];
                 // Don't enforce parameter names for dundered methods. Many of them
                 // are misnamed in typeshed stubs, so this would result in many
@@ -3295,8 +3330,10 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                 // Don't check certain magic functions or private symbols.
                 if (!exemptMethods.some((exempt) => exempt === memberName) &&
                     !SymbolNameUtils.isPrivateName(memberName)) {
-                    if (!this._evaluator.validateOverrideMethod(baseType, overrideFunction, diagAddendum, enforceParamNameMatch)) {
-                        const decl = (_a = overrideFunction.details.declaration) !== null && _a !== void 0 ? _a : (0, symbolUtils_1.getLastTypedDeclaredForSymbol)(overrideSymbol);
+                    if (!this._evaluator.validateOverrideMethod(baseType, overrideType, diagAddendum, enforceParamNameMatch)) {
+                        const decl = (0, types_1.isFunction)(overrideType) && overrideType.details.declaration
+                            ? overrideType.details.declaration
+                            : (0, symbolUtils_1.getLastTypedDeclaredForSymbol)(overrideSymbol);
                         if (decl) {
                             const diag = this._evaluator.addDiagnostic(this._fileInfo.diagnosticRuleSet.reportIncompatibleMethodOverride, diagnosticRules_1.DiagnosticRule.reportIncompatibleMethodOverride, localize_1.Localizer.Diagnostic.incompatibleMethodOverride().format({
                                 name: memberName,
@@ -3433,6 +3470,18 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                             diag.addRelatedInfo(localize_1.Localizer.DiagnosticAddendum.overriddenSymbol(), origDecl.path, origDecl.range);
                         }
                     }
+                    // Verify that there is not a Final mismatch.
+                    const isBaseVarFinal = (0, symbolUtils_1.isFinalVariable)(baseClassAndSymbol.symbol);
+                    const overrideFinalVarDecl = decls.find((d) => (0, declarationUtils_1.isFinalVariableDeclaration)(d));
+                    if (!isBaseVarFinal && overrideFinalVarDecl) {
+                        const diag = this._evaluator.addDiagnostic(this._fileInfo.diagnosticRuleSet.reportIncompatibleVariableOverride, diagnosticRules_1.DiagnosticRule.reportIncompatibleVariableOverride, localize_1.Localizer.Diagnostic.variableFinalOverride().format({
+                            name: memberName,
+                            className: baseClassAndSymbol.classType.details.name,
+                        }), lastDecl.node);
+                        if (diag) {
+                            diag.addRelatedInfo(localize_1.Localizer.DiagnosticAddendum.overriddenSymbol(), overrideFinalVarDecl.path, overrideFinalVarDecl.range);
+                        }
+                    }
                     // Verify that a class variable isn't overriding an instance
                     // variable or vice versa.
                     const isBaseClassVar = baseClassAndSymbol.symbol.isClassVar();
@@ -3767,7 +3816,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                 // Were all of the exception types overridden?
                 if (typesOfThisExcept.length === overriddenExceptionCount) {
                     this._evaluator.addDiagnostic(this._fileInfo.diagnosticRuleSet.reportGeneralTypeIssues, diagnosticRules_1.DiagnosticRule.reportGeneralTypeIssues, localize_1.Localizer.Diagnostic.unreachableExcept() + diagAddendum.getString(), except.typeExpression);
-                    this._evaluator.addUnusedCode(except, except.exceptSuite);
+                    this._evaluator.addUnreachableCode(except, except.exceptSuite);
                 }
             }
             exceptionTypesSoFar.push(...typesOfThisExcept);