@zzzen/pyright-internal 1.2.0-dev.20231015 → 1.2.0-dev.20231022

package/dist/analyzer/typeUtils.js

@@ -8,8 +8,8 @@
  * Functions that operate on Type objects.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.replaceTypeVarsWithAny = exports.validateTypeVarDefault = exports.applyInScopePlaceholders = exports.applySourceContextTypeVarsToSignature = exports.applySourceContextTypeVars = exports.applySolvedTypeVars = exports.ensureFunctionSignaturesAreUnique = exports.populateTypeVarContextForSelfType = exports.partiallySpecializeType = exports.isTupleIndexUnambiguous = exports.isUnboundedTupleClass = exports.isTupleClass = exports.isMaybeDescriptorInstance = exports.isDescriptorInstance = exports.isCallableType = exports.isProperty = exports.isEllipsisType = exports.getUnionSubtypeCount = exports.getLiteralTypeClassName = exports.containsLiteralType = exports.isLiteralTypeOrUnion = exports.isLiteralType = exports.getSpecializedTupleType = exports.selfSpecializeClass = exports.specializeWithDefaultTypeArgs = exports.getTypeVarScopeIds = exports.getTypeVarScopeId = exports.transformPossibleRecursiveTypeAlias = exports.isTypeAliasRecursive = exports.isTypeAliasPlaceholder = exports.getTypeCondition = exports.addConditionToType = exports.getFullNameOfType = exports.derivesFromAnyOrUnknown = exports.isUnionableType = exports.preserveUnknown = exports.areTypesSame = exports.doForEachSignature = exports.doForEachSubtype = exports.sortTypes = exports.cleanIncompleteUnknown = exports.mapSubtypes = exports.makeInferenceContext = exports.isTypeVarSame = exports.isIncompleteUnknown = exports.isOptionalType = exports.UniqueSignatureTracker = exports.AssignTypeFlags = exports.ClassIteratorFlags = exports.ClassMemberLookupFlags = void 0;
-exports.convertParamSpecValueToType = exports.convertTypeToParamSpecValue = exports.getDeclaringModulesForType = exports.computeMroLinearization = exports.isVarianceOfTypeArgumentCompatible = exports.combineVariances = exports.requiresSpecialization = exports.requiresTypeArguments = exports.getGeneratorTypeArgs = exports.removeParamSpecVariadicsFromFunction = exports.removeParamSpecVariadicsFromSignature = exports.specializeTupleClass = exports.combineSameSizedTuples = exports.explodeGenericClass = exports.isPartlyUnknown = exports.containsAnyOrUnknown = exports.containsAnyRecursive = exports.getMembersForModule = exports.getMembersForClass = exports.convertToInstantiable = exports.convertToInstance = exports.isEffectivelyInstantiable = exports.isMetaclassInstance = exports.isInstantiableMetaclass = exports.getGeneratorYieldType = exports.getDeclaredGeneratorReturnType = exports.synthesizeTypeVarForSelfCls = exports.derivesFromClassRecursive = exports.derivesFromStdlibClass = exports.specializeForBaseClass = exports.buildTypeVarContext = exports.buildTypeVarContextFromSpecializedClass = exports.setTypeArgumentsRecursive = exports.specializeClassType = exports.isTypeVarLimitedToCallable = exports.getTypeVarArgumentsRecursive = exports.addTypeVarsToListIfUnique = exports.getClassFieldsRecursive = exports.getClassIterator = exports.getClassMemberIterator = exports.lookUpClassMember = exports.lookUpObjectMember = exports.getContainerDepth = exports.getProtocolSymbolsRecursive = exports.getProtocolSymbols = exports.transformExpectedType = void 0;
+exports.applySourceContextTypeVarsToSignature = exports.applySourceContextTypeVars = exports.applySolvedTypeVars = exports.ensureFunctionSignaturesAreUnique = exports.populateTypeVarContextForSelfType = exports.partiallySpecializeType = exports.isTupleIndexUnambiguous = exports.isUnboundedTupleClass = exports.isTupleClass = exports.isMaybeDescriptorInstance = exports.isDescriptorInstance = exports.isCallableType = exports.isProperty = exports.isEllipsisType = exports.getUnionSubtypeCount = exports.getLiteralTypeClassName = exports.containsLiteralType = exports.isLiteralTypeOrUnion = exports.isLiteralType = exports.getSpecializedTupleType = exports.selfSpecializeClass = exports.getUnknownTypeForParamSpec = exports.getUnknownTypeForTypeVar = exports.specializeWithUnknown = exports.specializeWithDefaultTypeArgs = exports.getTypeVarScopeIds = exports.getTypeVarScopeId = exports.transformPossibleRecursiveTypeAlias = exports.isTypeAliasRecursive = exports.isTypeAliasPlaceholder = exports.getTypeCondition = exports.addConditionToType = exports.getFullNameOfType = exports.derivesFromAnyOrUnknown = exports.isUnionableType = exports.preserveUnknown = exports.areTypesSame = exports.doForEachSignature = exports.doForEachSubtype = exports.sortTypes = exports.cleanIncompleteUnknown = exports.mapSubtypes = exports.makeInferenceContext = exports.isTypeVarSame = exports.isIncompleteUnknown = exports.isOptionalType = exports.UniqueSignatureTracker = exports.AssignTypeFlags = exports.ClassIteratorFlags = exports.ClassMemberLookupFlags = void 0;
+exports.convertParamSpecValueToType = exports.convertTypeToParamSpecValue = exports.getDeclaringModulesForType = exports.computeMroLinearization = exports.isVarianceOfTypeArgumentCompatible = exports.combineVariances = exports.requiresSpecialization = exports.requiresTypeArguments = exports.getGeneratorTypeArgs = exports.removeParamSpecVariadicsFromFunction = exports.removeParamSpecVariadicsFromSignature = exports.specializeTupleClass = exports.combineSameSizedTuples = exports.explodeGenericClass = exports.isPartlyUnknown = exports.containsAnyOrUnknown = exports.containsAnyRecursive = exports.getMembersForModule = exports.getMembersForClass = exports.convertToInstantiable = exports.convertToInstance = exports.isEffectivelyInstantiable = exports.isMetaclassInstance = exports.isInstantiableMetaclass = exports.getGeneratorYieldType = exports.getDeclaredGeneratorReturnType = exports.synthesizeTypeVarForSelfCls = exports.derivesFromClassRecursive = exports.derivesFromStdlibClass = exports.specializeForBaseClass = exports.buildTypeVarContext = exports.buildTypeVarContextFromSpecializedClass = exports.setTypeArgumentsRecursive = exports.specializeClassType = exports.isTypeVarLimitedToCallable = exports.getTypeVarArgumentsRecursive = exports.addTypeVarsToListIfUnique = exports.getClassFieldsRecursive = exports.getClassIterator = exports.getClassMemberIterator = exports.lookUpClassMember = exports.lookUpObjectMember = exports.getContainerDepth = exports.getProtocolSymbolsRecursive = exports.getProtocolSymbols = exports.transformExpectedType = exports.replaceTypeVarsWithAny = exports.validateTypeVarDefault = exports.applyInScopePlaceholders = void 0;
 const collectionUtils_1 = require("../common/collectionUtils");
 const debug_1 = require("../common/debug");
 const symbol_1 = require("./symbol");
@@ -671,11 +671,37 @@ function specializeWithDefaultTypeArgs(type) {
     if (type.details.typeParameters.length === 0 || type.typeArguments) {
         return type;
     }
-    return types_1.ClassType.cloneForSpecialization(type, type.details.typeParameters.map((param) => { var _a; return (_a = param.details.defaultType) !== null && _a !== void 0 ? _a : types_1.UnknownType.create(); }), 
+    return types_1.ClassType.cloneForSpecialization(type, type.details.typeParameters.map((param) => { var _a; return (_a = param.details.defaultType) !== null && _a !== void 0 ? _a : getUnknownTypeForTypeVar(param); }), 
     /* isTypeArgumentExplicit */ false, 
-    /* includeSubclasses */ true);
+    /* includeSubclasses */ type.includeSubclasses);
 }
 exports.specializeWithDefaultTypeArgs = specializeWithDefaultTypeArgs;
+// Specializes the class with "Unknown" type args (or the equivalent for ParamSpecs
+// or TypeVarTuples).
+function specializeWithUnknown(type) {
+    if (type.details.typeParameters.length === 0) {
+        return type;
+    }
+    return types_1.ClassType.cloneForSpecialization(type, type.details.typeParameters.map((param) => getUnknownTypeForTypeVar(param)), 
+    /* isTypeArgumentExplicit */ false, 
+    /* includeSubclasses */ type.includeSubclasses);
+}
+exports.specializeWithUnknown = specializeWithUnknown;
+// Returns "Unknown" for simple TypeVars or the equivalent for a ParamSpec.
+function getUnknownTypeForTypeVar(typeVar) {
+    if (typeVar.details.isParamSpec) {
+        return getUnknownTypeForParamSpec();
+    }
+    return types_1.UnknownType.create();
+}
+exports.getUnknownTypeForTypeVar = getUnknownTypeForTypeVar;
+// Returns the "Unknown" equivalent for a ParamSpec.
+function getUnknownTypeForParamSpec() {
+    const newFunction = types_1.FunctionType.createInstance('', '', '', 65536 /* ParamSpecValue */ | 32768 /* SkipArgsKwargsCompatibilityCheck */);
+    types_1.FunctionType.addDefaultParameters(newFunction);
+    return newFunction;
+}
+exports.getUnknownTypeForParamSpec = getUnknownTypeForParamSpec;
 // If the class is generic and not already specialized, this function
 // "self specializes" the class, filling in its own type parameters
 // as type arguments.
@@ -1501,9 +1527,7 @@ function setTypeArgumentsRecursive(destType, srcType, typeVarContext, recursionC
             if (destType.details.paramSpec) {
                 // Fill in an empty signature for a ParamSpec.
                 if (!typeVarContext.getPrimarySignature().getTypeVar(destType.details.paramSpec)) {
-                    const newFunction = types_1.FunctionType.createInstance('', '', '', 32768 /* SkipArgsKwargsCompatibilityCheck */ | 65536 /* ParamSpecValue */);
-                    types_1.FunctionType.addDefaultParameters(newFunction);
-                    typeVarContext.setTypeVarType(destType.details.paramSpec, newFunction);
+                    typeVarContext.setTypeVarType(destType.details.paramSpec, getUnknownTypeForTypeVar(destType.details.paramSpec));
                 }
             }
             break;
@@ -2168,18 +2192,18 @@ function requiresTypeArguments(classType) {
     return false;
 }
 exports.requiresTypeArguments = requiresTypeArguments;
-function requiresSpecialization(type, ignorePseudoGeneric = false, ignoreSelf = false, recursionCount = 0) {
+function requiresSpecialization(type, options, recursionCount = 0) {
     var _a;
     if (recursionCount > types_1.maxTypeRecursionCount) {
         return false;
     }
     recursionCount++;
     // Is the answer cached?
-    const canUseCache = !ignorePseudoGeneric && !ignoreSelf;
+    const canUseCache = !(options === null || options === void 0 ? void 0 : options.ignorePseudoGeneric) && !(options === null || options === void 0 ? void 0 : options.ignoreSelf);
     if (canUseCache && ((_a = type.cached) === null || _a === void 0 ? void 0 : _a.requiresSpecialization) !== undefined) {
         return type.cached.requiresSpecialization;
     }
-    const result = _requiresSpecialization(type, ignorePseudoGeneric, ignoreSelf, recursionCount);
+    const result = _requiresSpecialization(type, options, recursionCount);
     if (canUseCache) {
         if (type.cached === undefined) {
             type.cached = {};
@@ -2189,15 +2213,18 @@ function requiresSpecialization(type, ignorePseudoGeneric = false, ignoreSelf =
     return result;
 }
 exports.requiresSpecialization = requiresSpecialization;
-function _requiresSpecialization(type, ignorePseudoGeneric = false, ignoreSelf = false, recursionCount = 0) {
+function _requiresSpecialization(type, options, recursionCount = 0) {
     var _a;
     switch (type.category) {
         case 7 /* Class */: {
-            if (types_1.ClassType.isPseudoGenericClass(type) && ignorePseudoGeneric) {
+            if (types_1.ClassType.isPseudoGenericClass(type) && (options === null || options === void 0 ? void 0 : options.ignorePseudoGeneric)) {
+                return false;
+            }
+            if (!type.isTypeArgumentExplicit && (options === null || options === void 0 ? void 0 : options.ignoreImplicitTypeArgs)) {
                 return false;
             }
             if (type.typeArguments) {
-                return type.typeArguments.some((typeArg) => requiresSpecialization(typeArg, ignorePseudoGeneric, ignoreSelf, recursionCount));
+                return type.typeArguments.some((typeArg) => requiresSpecialization(typeArg, options, recursionCount));
             }
             return types_1.ClassType.getTypeParameters(type).length > 0;
         }
@@ -2206,7 +2233,7 @@ function _requiresSpecialization(type, ignorePseudoGeneric = false, ignoreSelf =
                 return true;
             }
             for (let i = 0; i < type.details.parameters.length; i++) {
-                if (requiresSpecialization(types_1.FunctionType.getEffectiveParameterType(type, i), ignorePseudoGeneric, ignoreSelf, recursionCount)) {
+                if (requiresSpecialization(types_1.FunctionType.getEffectiveParameterType(type, i), options, recursionCount)) {
                     return true;
                 }
             }
@@ -2214,27 +2241,27 @@ function _requiresSpecialization(type, ignorePseudoGeneric = false, ignoreSelf =
                 ? type.specializedTypes.returnType
                 : type.details.declaredReturnType;
             if (declaredReturnType) {
-                if (requiresSpecialization(declaredReturnType, ignorePseudoGeneric, ignoreSelf, recursionCount)) {
+                if (requiresSpecialization(declaredReturnType, options, recursionCount)) {
                     return true;
                 }
             }
             else if (type.inferredReturnType) {
-                if (requiresSpecialization(type.inferredReturnType, ignorePseudoGeneric, ignoreSelf, recursionCount)) {
+                if (requiresSpecialization(type.inferredReturnType, options, recursionCount)) {
                     return true;
                 }
             }
             return false;
         }
         case 6 /* OverloadedFunction */: {
-            return type.overloads.some((overload) => requiresSpecialization(overload, ignorePseudoGeneric, ignoreSelf, recursionCount));
+            return type.overloads.some((overload) => requiresSpecialization(overload, options, recursionCount));
         }
         case 9 /* Union */: {
-            return type.subtypes.some((subtype) => requiresSpecialization(subtype, ignorePseudoGeneric, ignoreSelf, recursionCount));
+            return type.subtypes.some((subtype) => requiresSpecialization(subtype, options, recursionCount));
         }
         case 10 /* TypeVar */: {
             // Most TypeVar types need to be specialized.
             if (!type.details.recursiveTypeAliasName) {
-                if (type.details.isSynthesizedSelf && ignoreSelf) {
+                if (type.details.isSynthesizedSelf && (options === null || options === void 0 ? void 0 : options.ignoreSelf)) {
                     return false;
                 }
                 return true;
@@ -2242,7 +2269,7 @@ function _requiresSpecialization(type, ignorePseudoGeneric = false, ignoreSelf =
             // If this is a recursive type alias, it may need to be specialized
             // if it has generic type arguments.
             if ((_a = type.typeAliasInfo) === null || _a === void 0 ? void 0 : _a.typeArguments) {
-                return type.typeAliasInfo.typeArguments.some((typeArg) => requiresSpecialization(typeArg, ignorePseudoGeneric, ignoreSelf, recursionCount));
+                return type.typeAliasInfo.typeArguments.some((typeArg) => requiresSpecialization(typeArg, options, recursionCount));
             }
         }
     }
@@ -2497,9 +2524,7 @@ function convertTypeToParamSpecValue(type) {
         newFunction.details.paramSpec = type.details.paramSpec;
         return newFunction;
     }
-    const newFunction = types_1.FunctionType.createInstance('', '', '', 65536 /* ParamSpecValue */ | 32768 /* SkipArgsKwargsCompatibilityCheck */);
-    types_1.FunctionType.addDefaultParameters(newFunction);
-    return newFunction;
+    return getUnknownTypeForParamSpec();
 }
 exports.convertTypeToParamSpecValue = convertTypeToParamSpecValue;
 function convertParamSpecValueToType(paramSpecValue, omitParamSpec = false) {
@@ -3007,9 +3032,7 @@ class TypeVarAnyReplacer extends TypeVarTransformer {
         return types_1.AnyType.create();
     }
     transformParamSpec(paramSpec) {
-        const paramSpecValue = types_1.FunctionType.createInstance('', '', '', 65536 /* ParamSpecValue */ | 32768 /* SkipArgsKwargsCompatibilityCheck */);
-        types_1.FunctionType.addDefaultParameters(paramSpecValue);
-        return paramSpecValue;
+        return getUnknownTypeForParamSpec();
     }
 }
 // For a TypeVar with a default type, validates whether the default type is using
@@ -3181,19 +3204,6 @@ class ApplySolvedTypeVarsTransformer extends TypeVarTransformer {
             }
             return types_1.UnknownType.create();
         }
-        // If we're solving a default type, handle type variables with no scope ID.
-        if (this._isSolvingDefaultType && !typeVar.scopeId) {
-            const replacementEntry = signatureContext
-                .getTypeVars()
-                .find((entry) => entry.typeVar.details.name === typeVar.details.name);
-            if (replacementEntry) {
-                return signatureContext.getTypeVarType(replacementEntry.typeVar);
-            }
-            if (typeVar.details.defaultType) {
-                return this.apply(typeVar.details.defaultType, recursionCount);
-            }
-            return types_1.UnknownType.create();
-        }
         return undefined;
     }
     transformUnionSubtype(preTransform, postTransform) {
@@ -3252,7 +3262,7 @@ class ApplySolvedTypeVarsTransformer extends TypeVarTransformer {
             if (paramSpec.details.defaultType) {
                 return convertTypeToParamSpecValue(this.apply(paramSpec.details.defaultType, recursionCount));
             }
-            return this._getUnknownParamSpec();
+            return getUnknownTypeForParamSpec();
         }
         if (!paramSpec.scopeId || !this._typeVarContext.hasSolveForScope(paramSpec.scopeId)) {
             return undefined;
@@ -3277,7 +3287,7 @@ class ApplySolvedTypeVarsTransformer extends TypeVarTransformer {
                 return convertTypeToParamSpecValue(this._solveDefaultType(paramSpec.details.defaultType, recursionCount));
             }
             // Convert to the ParamSpec equivalent of "Unknown".
-            return this._getUnknownParamSpec();
+            return getUnknownTypeForParamSpec();
         }
         return undefined;
     }
@@ -3312,11 +3322,6 @@ class ApplySolvedTypeVarsTransformer extends TypeVarTransformer {
         this._isSolvingDefaultType = wasSolvingDefaultType;
         return result;
     }
-    _getUnknownParamSpec() {
-        const paramSpecValue = types_1.FunctionType.createInstance('', '', '', 65536 /* ParamSpecValue */ | 32768 /* SkipArgsKwargsCompatibilityCheck */);
-        types_1.FunctionType.addDefaultParameters(paramSpecValue);
-        return paramSpecValue;
-    }
 }
 class ExpectedTypeTransformer extends TypeVarTransformer {
     constructor(_liveTypeVarScopes, _usageOffset) {