Added OmitTypeVarScopes flag to typePrinter. It's not currently used,…

… but we're considering switching to this.
microsoft · Oct 2, 2024 · 39a5a20 · 39a5a20
1 parent 03eda6e
commit 39a5a20
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 13 deletions.
diff --git a/packages/pyright-internal/src/analyzer/typePrinter.ts b/packages/pyright-internal/src/analyzer/typePrinter.ts
@@ -86,6 +86,9 @@ export const enum PrintTypeFlags {
     // Use the fully-qualified name of classes, type aliases, modules,
     // and functions rather than short names.
     UseFullyQualifiedNames = 1 << 12,
+
+    // Omit TypeVar scopes.
+    OmitTypeVarScopes = 1 << 13,
 }
 
 export type FunctionReturnTypeCallback = (type: FunctionType) => Type;
@@ -571,10 +574,13 @@ function printTypeInternal(
                         );
 
                         if (!isAnyOrUnknown(type.shared.boundType)) {
-                            if (printTypeFlags & PrintTypeFlags.PythonSyntax) {
-                                boundTypeString = `Self`;
-                            } else {
+                            if (
+                                (printTypeFlags & PrintTypeFlags.PythonSyntax) === 0 &&
+                                (printTypeFlags & PrintTypeFlags.OmitTypeVarScopes) === 0
+                            ) {
                                 boundTypeString = `Self@${boundTypeString}`;
+                            } else {
+                                boundTypeString = `Self`;
                             }
                         }
 
@@ -593,7 +599,8 @@ function printTypeInternal(
                 if (isParamSpec(type)) {
                     const paramSpecText = _getReadableTypeVarName(
                         type,
-                        (printTypeFlags & PrintTypeFlags.PythonSyntax) !== 0
+                        (printTypeFlags & PrintTypeFlags.PythonSyntax) === 0 &&
+                            (printTypeFlags & PrintTypeFlags.OmitTypeVarScopes) === 0
                     );
 
                     if (type.priv.paramSpecAccess) {
@@ -602,7 +609,11 @@ function printTypeInternal(
                     return paramSpecText;
                 }
 
-                let typeVarName = _getReadableTypeVarName(type, (printTypeFlags & PrintTypeFlags.PythonSyntax) !== 0);
+                let typeVarName = _getReadableTypeVarName(
+                    type,
+                    (printTypeFlags & PrintTypeFlags.PythonSyntax) === 0 &&
+                        (printTypeFlags & PrintTypeFlags.OmitTypeVarScopes) === 0
+                );
 
                 if (isTypeVarTuple(type)) {
                     if (type.priv.isUnpacked) {
@@ -1298,12 +1309,8 @@ function _printNestedInstantiable(type: Type, textToWrap: string) {
     return textToWrap;
 }
 
-function _getReadableTypeVarName(type: TypeVarType, usePythonSyntax: boolean) {
-    if (usePythonSyntax) {
-        return type.shared.name;
-    }
-
-    return TypeVarType.getReadableName(type);
+function _getReadableTypeVarName(type: TypeVarType, includeScope: boolean) {
+    return TypeVarType.getReadableName(type, includeScope);
 }
 
 function _getTypeVarVarianceText(type: TypeVarType) {

diff --git a/packages/pyright-internal/src/analyzer/types.ts b/packages/pyright-internal/src/analyzer/types.ts
@@ -3075,8 +3075,8 @@ export namespace TypeVarType {
         return typeVarType.priv.nameWithScope || typeVarType.shared.name;
     }
 
-    export function getReadableName(type: TypeVarType) {
-        if (type.priv.scopeName) {
+    export function getReadableName(type: TypeVarType, includeScope = true) {
+        if (type.priv.scopeName && includeScope) {
             return `${type.shared.name}@${type.priv.scopeName}`;
         }