@zzzen/pyright-internal 1.2.0-dev.20240218 → 1.2.0-dev.20240225

package/dist/analyzer/checker.js

@@ -62,7 +62,6 @@ const ParseTreeUtils = __importStar(require("./parseTreeUtils"));
 const parseTreeWalker_1 = require("./parseTreeWalker");
 const patternMatching_1 = require("./patternMatching");
 const protocols_1 = require("./protocols");
-const regions_1 = require("./regions");
 const scopeUtils_1 = require("./scopeUtils");
 const sourceFile_1 = require("./sourceFile");
 const sourceMapper_1 = require("./sourceMapper");
@@ -73,6 +72,7 @@ const typeEvaluator_1 = require("./typeEvaluator");
 const typeGuards_1 = require("./typeGuards");
 const typeUtils_1 = require("./typeUtils");
 const typeVarContext_1 = require("./typeVarContext");
+const typedDicts_1 = require("./typedDicts");
 const types_1 = require("./types");
 // When enabled, this debug flag causes the code complexity of
 // functions to be emitted.
@@ -116,7 +116,6 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         // defined in this module for things like unaccessed variables.
         this._validateSymbolTables();
         this._reportDuplicateImports();
-        this._checkRegions();
     }
     walk(node) {
         if (!AnalyzerNodeInfo.isCodeUnreachable(node)) {
@@ -181,6 +180,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                 this._validateSlotsClassVarConflict(classTypeResult.classType);
             }
             this._validateBaseClassOverrides(classTypeResult.classType);
+            this._validateTypedDictOverrides(classTypeResult.classType);
             this._validateOverloadDecoratorConsistency(classTypeResult.classType);
             this._validateMultipleInheritanceBaseClasses(classTypeResult.classType, node.name);
             this._validateMultipleInheritanceCompatibility(classTypeResult.classType, node.name);
@@ -288,7 +288,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                 const kwargsType = types_1.FunctionType.getEffectiveParameterType(functionTypeResult.functionType, kwargsIndex);
                 if ((0, types_1.isClass)(kwargsType) && kwargsType.details.typedDictEntries) {
                     const overlappingEntries = new Set();
-                    kwargsType.details.typedDictEntries.forEach((_, name) => {
+                    kwargsType.details.typedDictEntries.knownItems.forEach((_, name) => {
                         if (keywordNames.has(name)) {
                             overlappingEntries.add(name);
                         }
@@ -383,7 +383,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
             }
             // Verify common dunder signatures.
             this._validateDunderSignatures(node, functionTypeResult.functionType, containingClassNode !== undefined);
-            // Verify TypeGuard functions.
+            // Verify TypeGuard and TypeIs functions.
             this._validateTypeGuardFunction(node, functionTypeResult.functionType, containingClassNode !== undefined);
             this._validateFunctionTypeVarUsage(node, functionTypeResult);
             this._validateGeneratorReturnType(node, functionTypeResult.functionType);
@@ -3272,6 +3272,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         });
     }
     _validateTypeGuardFunction(node, functionType, isMethod) {
+        var _a;
         const returnType = functionType.details.declaredReturnType;
         if (!returnType) {
             return;
@@ -3279,7 +3280,9 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         if (!(0, types_1.isClassInstance)(returnType) || !returnType.typeArguments || returnType.typeArguments.length < 1) {
             return;
         }
-        if (!types_1.ClassType.isBuiltIn(returnType, 'TypeGuard')) {
+        const isTypeGuard = types_1.ClassType.isBuiltIn(returnType, 'TypeGuard');
+        const isTypeIs = types_1.ClassType.isBuiltIn(returnType, 'TypeIs');
+        if (!isTypeGuard && !isTypeIs) {
             return;
         }
         // Make sure there's at least one input parameter provided.
@@ -3294,6 +3297,25 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         if (paramCount < 1) {
             this._evaluator.addDiagnostic(diagnosticRules_1.DiagnosticRule.reportGeneralTypeIssues, localize_1.LocMessage.typeGuardParamCount(), node.name);
         }
+        if (isTypeIs) {
+            const typeGuardType = returnType.typeArguments[0];
+            // Determine the type of the first parameter.
+            const paramIndex = isMethod && !types_1.FunctionType.isStaticMethod(functionType) ? 1 : 0;
+            if (paramIndex >= functionType.details.parameters.length) {
+                return;
+            }
+            const paramType = types_1.FunctionType.getEffectiveParameterType(functionType, paramIndex);
+            // Verify that the typeGuardType is a narrower type than the paramType.
+            if (!this._evaluator.assignType(paramType, typeGuardType)) {
+                const returnAnnotation = node.returnTypeAnnotation || ((_a = node.functionAnnotationComment) === null || _a === void 0 ? void 0 : _a.returnTypeAnnotation);
+                if (returnAnnotation) {
+                    this._evaluator.addDiagnostic(diagnosticRules_1.DiagnosticRule.reportGeneralTypeIssues, localize_1.LocMessage.typeIsReturnType().format({
+                        type: this._evaluator.printType(paramType),
+                        returnType: this._evaluator.printType(typeGuardType),
+                    }), returnAnnotation);
+                }
+            }
+        }
     }
     _validateDunderSignatures(node, functionType, isMethod) {
         var _a;
@@ -3639,7 +3661,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         // variables. We need to make sure these are initialized.
         const abstractSymbols = new Map();
         if (types_1.ClassType.isFinal(classType)) {
-            (0, typeUtils_1.getProtocolSymbolsRecursive)(classType, abstractSymbols, 1024 /* ClassTypeFlags.SupportsAbstractMethods */);
+            (0, typeUtils_1.getProtocolSymbolsRecursive)(classType, abstractSymbols, 2048 /* ClassTypeFlags.SupportsAbstractMethods */);
         }
         classType.details.fields.forEach((localSymbol, name) => {
             abstractSymbols.delete(name);
@@ -4042,6 +4064,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         }
     }
     _validateMultipleInheritanceOverride(overriddenClassAndSymbol, overrideClassAndSymbol, childClassType, memberName, errorNode) {
+        var _a, _b, _c, _d;
         if (!(0, types_1.isClass)(overriddenClassAndSymbol.classType) || !(0, types_1.isClass)(overrideClassAndSymbol.classType)) {
             return;
         }
@@ -4122,14 +4145,16 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                 }
                 let overriddenTDEntry;
                 if (overriddenClassAndSymbol.classType.details.typedDictEntries) {
-                    overriddenTDEntry = overriddenClassAndSymbol.classType.details.typedDictEntries.get(memberName);
+                    overriddenTDEntry =
+                        (_b = (_a = overriddenClassAndSymbol.classType.details.typedDictEntries.knownItems.get(memberName)) !== null && _a !== void 0 ? _a : overriddenClassAndSymbol.classType.details.typedDictEntries.extraItems) !== null && _b !== void 0 ? _b : (0, typedDicts_1.getEffectiveExtraItemsEntryType)(this._evaluator, overriddenClassAndSymbol.classType);
                     if (overriddenTDEntry === null || overriddenTDEntry === void 0 ? void 0 : overriddenTDEntry.isReadOnly) {
                         isInvariant = false;
                     }
                 }
                 let overrideTDEntry;
                 if (overrideClassAndSymbol.classType.details.typedDictEntries) {
-                    overrideTDEntry = overrideClassAndSymbol.classType.details.typedDictEntries.get(memberName);
+                    overrideTDEntry =
+                        (_d = (_c = overrideClassAndSymbol.classType.details.typedDictEntries.knownItems.get(memberName)) !== null && _c !== void 0 ? _c : overrideClassAndSymbol.classType.details.typedDictEntries.extraItems) !== null && _d !== void 0 ? _d : (0, typedDicts_1.getEffectiveExtraItemsEntryType)(this._evaluator, overrideClassAndSymbol.classType);
                 }
                 if (!this._evaluator.assignType(overriddenType, childOverrideType !== null && childOverrideType !== void 0 ? childOverrideType : overrideType, 
                 /* diag */ undefined, 
@@ -4222,6 +4247,84 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
             }
         });
     }
+    // For a TypedDict class that derives from another TypedDict class
+    // that is closed, verify that any new keys are compatible with the
+    // base class.
+    _validateTypedDictOverrides(classType) {
+        if (!types_1.ClassType.isTypedDictClass(classType)) {
+            return;
+        }
+        const typedDictEntries = (0, typedDicts_1.getTypedDictMembersForClass)(this._evaluator, classType, /* allowNarrowed */ false);
+        for (const baseClass of classType.details.baseClasses) {
+            const diag = new diagnostic_1.DiagnosticAddendum();
+            if (!(0, types_1.isClass)(baseClass) ||
+                !types_1.ClassType.isTypedDictClass(baseClass) ||
+                !types_1.ClassType.isTypedDictEffectivelyClosed(baseClass)) {
+                continue;
+            }
+            const baseTypedDictEntries = (0, typedDicts_1.getTypedDictMembersForClass)(this._evaluator, baseClass, 
+            /* allowNarrowed */ false);
+            const typeVarContext = (0, typeUtils_1.buildTypeVarContextFromSpecializedClass)(baseClass);
+            const baseExtraItemsType = baseTypedDictEntries.extraItems
+                ? (0, typeUtils_1.applySolvedTypeVars)(baseTypedDictEntries.extraItems.valueType, typeVarContext)
+                : types_1.UnknownType.create();
+            for (const [name, entry] of typedDictEntries.knownItems) {
+                const baseEntry = baseTypedDictEntries.knownItems.get(name);
+                if (!baseEntry) {
+                    if (!baseTypedDictEntries.extraItems || (0, types_1.isNever)(baseTypedDictEntries.extraItems.valueType)) {
+                        diag.addMessage(localize_1.LocAddendum.typedDictClosedExtraNotAllowed().format({
+                            name,
+                        }));
+                    }
+                    else if (!this._evaluator.assignType(baseExtraItemsType, entry.valueType, 
+                    /* diag */ undefined, 
+                    /* destTypeVarContext */ undefined, 
+                    /* srcTypeVarContext */ undefined, !baseTypedDictEntries.extraItems.isReadOnly
+                        ? 1 /* AssignTypeFlags.EnforceInvariance */
+                        : 0 /* AssignTypeFlags.Default */)) {
+                        diag.addMessage(localize_1.LocAddendum.typedDictClosedExtraTypeMismatch().format({
+                            name,
+                            type: this._evaluator.printType(entry.valueType),
+                        }));
+                    }
+                    else if (!baseTypedDictEntries.extraItems.isReadOnly && entry.isRequired) {
+                        diag.addMessage(localize_1.LocAddendum.typedDictClosedFieldNotRequired().format({
+                            name,
+                        }));
+                    }
+                }
+            }
+            if (typedDictEntries.extraItems && baseTypedDictEntries.extraItems) {
+                if (!this._evaluator.assignType(baseExtraItemsType, typedDictEntries.extraItems.valueType, 
+                /* diag */ undefined, 
+                /* destTypeVarContext */ undefined, 
+                /* srcTypeVarContext */ undefined, !baseTypedDictEntries.extraItems.isReadOnly
+                    ? 1 /* AssignTypeFlags.EnforceInvariance */
+                    : 0 /* AssignTypeFlags.Default */)) {
+                    diag.addMessage(localize_1.LocAddendum.typedDictClosedExtraTypeMismatch().format({
+                        name: '__extra_items__',
+                        type: this._evaluator.printType(typedDictEntries.extraItems.valueType),
+                    }));
+                }
+            }
+            if (!diag.isEmpty() && classType.details.declaration) {
+                const declNode = (0, declarationUtils_1.getNameNodeForDeclaration)(classType.details.declaration);
+                if (declNode) {
+                    if (baseTypedDictEntries.extraItems) {
+                        this._evaluator.addDiagnostic(diagnosticRules_1.DiagnosticRule.reportIncompatibleVariableOverride, localize_1.LocMessage.typedDictClosedExtras().format({
+                            name: baseClass.details.name,
+                            type: this._evaluator.printType(baseExtraItemsType),
+                        }) + diag.getString(), declNode);
+                    }
+                    else {
+                        this._evaluator.addDiagnostic(diagnosticRules_1.DiagnosticRule.reportIncompatibleVariableOverride, localize_1.LocMessage.typedDictClosedNoExtras().format({
+                            name: baseClass.details.name,
+                        }) + diag.getString(), declNode);
+                    }
+                }
+            }
+        }
+    }
     // Validates that any overridden methods or variables contain the same
     // types as the original method. Also marks the class as abstract if one
     // or more abstract methods are not overridden.
@@ -4341,7 +4444,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
         this._evaluator.addDiagnostic(diagnosticRules_1.DiagnosticRule.reportGeneralTypeIssues, localize_1.LocMessage.overriddenMethodNotFound().format({ name: funcNode.name.value }), funcNode.name);
     }
     _validateBaseClassOverride(baseClassAndSymbol, overrideSymbol, overrideType, childClassType, memberName) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
         if (!(0, types_1.isInstantiableClass)(baseClassAndSymbol.classType)) {
             return;
         }
@@ -4533,15 +4636,28 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                         }
                     }
                     let overriddenTDEntry;
-                    if (baseClass.details.typedDictEntries) {
-                        overriddenTDEntry = baseClass.details.typedDictEntries.get(memberName);
-                        if (overriddenTDEntry === null || overriddenTDEntry === void 0 ? void 0 : overriddenTDEntry.isReadOnly) {
-                            isInvariant = false;
-                        }
-                    }
                     let overrideTDEntry;
-                    if (childClassType.details.typedDictEntries) {
-                        overrideTDEntry = childClassType.details.typedDictEntries.get(memberName);
+                    if (!overrideSymbol.isIgnoredForProtocolMatch()) {
+                        if (baseClass.details.typedDictEntries) {
+                            overriddenTDEntry =
+                                (_e = (_d = baseClass.details.typedDictEntries.knownItems.get(memberName)) !== null && _d !== void 0 ? _d : baseClass.details.typedDictEntries.extraItems) !== null && _e !== void 0 ? _e : (0, typedDicts_1.getEffectiveExtraItemsEntryType)(this._evaluator, baseClass);
+                            if (overriddenTDEntry === null || overriddenTDEntry === void 0 ? void 0 : overriddenTDEntry.isReadOnly) {
+                                isInvariant = false;
+                            }
+                        }
+                        if (childClassType.details.typedDictEntries) {
+                            // Exempt __extra_items__ here. We'll check this separately
+                            // in _validateTypedDictOverrides. If we don't skip it here,
+                            // redundant errors will be produced.
+                            if (types_1.ClassType.isTypedDictMarkedClosed(childClassType) && memberName === '__extra_items__') {
+                                overrideTDEntry = overriddenTDEntry;
+                                overrideType = baseType;
+                            }
+                            else {
+                                overrideTDEntry =
+                                    (_g = (_f = childClassType.details.typedDictEntries.knownItems.get(memberName)) !== null && _f !== void 0 ? _f : childClassType.details.typedDictEntries.extraItems) !== null && _g !== void 0 ? _g : (0, typedDicts_1.getEffectiveExtraItemsEntryType)(this._evaluator, childClassType);
+                            }
+                        }
                     }
                     let diagAddendum = new diagnostic_1.DiagnosticAddendum();
                     if (!this._evaluator.assignType(baseType, overrideType, diagAddendum, 
@@ -4558,7 +4674,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                         const diag = this._evaluator.addDiagnostic(diagnosticRules_1.DiagnosticRule.reportIncompatibleVariableOverride, localize_1.LocMessage.symbolOverridden().format({
                             name: memberName,
                             className: baseClass.details.name,
-                        }) + diagAddendum.getString(), (_d = (0, declarationUtils_1.getNameNodeForDeclaration)(lastDecl)) !== null && _d !== void 0 ? _d : lastDecl.node);
+                        }) + diagAddendum.getString(), (_h = (0, declarationUtils_1.getNameNodeForDeclaration)(lastDecl)) !== null && _h !== void 0 ? _h : lastDecl.node);
                         const origDecl = (0, symbolUtils_1.getLastTypedDeclaredForSymbol)(baseClassAndSymbol.symbol);
                         if (diag && origDecl) {
                             diag.addRelatedInfo(localize_1.LocAddendum.overriddenSymbol(), origDecl.uri, origDecl.range);
@@ -4579,14 +4695,14 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                             const message = overrideTDEntry.isRequired
                                 ? localize_1.LocMessage.typedDictFieldRequiredRedefinition
                                 : localize_1.LocMessage.typedDictFieldNotRequiredRedefinition;
-                            this._evaluator.addDiagnostic(diagnosticRules_1.DiagnosticRule.reportGeneralTypeIssues, message().format({ name: memberName }), (_e = (0, declarationUtils_1.getNameNodeForDeclaration)(lastDecl)) !== null && _e !== void 0 ? _e : lastDecl.node);
+                            this._evaluator.addDiagnostic(diagnosticRules_1.DiagnosticRule.reportGeneralTypeIssues, message().format({ name: memberName }), (_j = (0, declarationUtils_1.getNameNodeForDeclaration)(lastDecl)) !== null && _j !== void 0 ? _j : lastDecl.node);
                         }
                         // Make sure that the derived class isn't marking a previously writable
                         // entry as read-only.
                         if (!overriddenTDEntry.isReadOnly && overrideTDEntry.isReadOnly) {
                             this._evaluator.addDiagnostic(diagnosticRules_1.DiagnosticRule.reportGeneralTypeIssues, localize_1.LocMessage.typedDictFieldReadOnlyRedefinition().format({
                                 name: memberName,
-                            }), (_f = (0, declarationUtils_1.getNameNodeForDeclaration)(lastDecl)) !== null && _f !== void 0 ? _f : lastDecl.node);
+                            }), (_k = (0, declarationUtils_1.getNameNodeForDeclaration)(lastDecl)) !== null && _k !== void 0 ? _k : lastDecl.node);
                         }
                     }
                     // Verify that there is not a Final mismatch.
@@ -4596,7 +4712,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                         const diag = this._evaluator.addDiagnostic(diagnosticRules_1.DiagnosticRule.reportIncompatibleVariableOverride, localize_1.LocMessage.variableFinalOverride().format({
                             name: memberName,
                             className: baseClass.details.name,
-                        }), (_g = (0, declarationUtils_1.getNameNodeForDeclaration)(lastDecl)) !== null && _g !== void 0 ? _g : lastDecl.node);
+                        }), (_l = (0, declarationUtils_1.getNameNodeForDeclaration)(lastDecl)) !== null && _l !== void 0 ? _l : lastDecl.node);
                         if (diag) {
                             diag.addRelatedInfo(localize_1.LocAddendum.overriddenSymbol(), overrideFinalVarDecl.uri, overrideFinalVarDecl.range);
                         }
@@ -4625,7 +4741,7 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
                         const diag = this._evaluator.addDiagnostic(diagnosticRules_1.DiagnosticRule.reportIncompatibleVariableOverride, unformattedMessage.format({
                             name: memberName,
                             className: baseClass.details.name,
-                        }), (_h = (0, declarationUtils_1.getNameNodeForDeclaration)(lastDecl)) !== null && _h !== void 0 ? _h : lastDecl.node);
+                        }), (_m = (0, declarationUtils_1.getNameNodeForDeclaration)(lastDecl)) !== null && _m !== void 0 ? _m : lastDecl.node);
                         const origDecl = (0, symbolUtils_1.getLastTypedDeclaredForSymbol)(baseClassAndSymbol.symbol);
                         if (diag && origDecl) {
                             diag.addRelatedInfo(localize_1.LocAddendum.overriddenSymbol(), origDecl.uri, origDecl.range);
@@ -4999,33 +5115,6 @@ class Checker extends parseTreeWalker_1.ParseTreeWalker {
             }
         });
     }
-    _checkRegions() {
-        const regionComments = (0, regions_1.getRegionComments)(this._parseResults);
-        const regionStack = [];
-        regionComments.forEach((regionComment) => {
-            if (regionComment.type === 0 /* RegionCommentType.Region */) {
-                regionStack.push(regionComment);
-            }
-            else {
-                if (regionStack.length > 0) {
-                    regionStack.pop();
-                }
-                else {
-                    this._addDiagnosticForRegionComment(regionComment, localize_1.LocMessage.unmatchedEndregionComment());
-                }
-            }
-        });
-        regionStack.forEach((regionComment) => {
-            this._addDiagnosticForRegionComment(regionComment, localize_1.LocMessage.unmatchedRegionComment());
-        });
-    }
-    _addDiagnosticForRegionComment(regionComment, message) {
-        return this._evaluator.addDiagnosticForTextRange(this._fileInfo, 'error', '', message, {
-            // extend range to include # character
-            start: regionComment.comment.start - 1,
-            length: regionComment.comment.length + 1,
-        });
-    }
 }
 exports.Checker = Checker;
 //# sourceMappingURL=checker.js.map