Add tokens for builtin constants (microsoft#1787)

heejaechang · Aug 30, 2021 · adaf6c4 · adaf6c4
1 parent a599380
commit adaf6c4
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 1 deletion.
diff --git a/packages/pylance-client/package.json b/packages/pylance-client/package.json
@@ -228,6 +228,11 @@
                 "id": "magicFunction",
                 "description": "magic aka dunder function",
                 "superType": "function"
+            },
+            {
+                "id": "builtinConstant",
+                "description": "constants like True, False, None, or __debug__",
+                "superType": "constant"
             }
         ],
         "semanticTokenModifiers": [
@@ -269,6 +274,9 @@
                     ],
                     "class.decorator": [
                         "meta.function.decorator.python"
+                    ],
+                    "builtinConstant": [
+                        "constant.language.python"
                     ]
                 }
             }

diff --git a/packages/pylance-internal/src/languageService/semanticTokenProvider.ts b/packages/pylance-internal/src/languageService/semanticTokenProvider.ts
@@ -24,6 +24,7 @@ import { convertOffsetsToRange, convertOffsetToPosition } from 'pyright-internal
 import { doRangesOverlap, Range } from 'pyright-internal/common/textRange';
 import {
     CaseNode,
+    ConstantNode,
     DecoratorNode,
     MatchNode,
     ModuleNameNode,
@@ -62,7 +63,8 @@ enum TokenTypes {
     selfParameter = 18,
     clsParameter = 19,
     magicFunction = 20,
-    _ = 21,
+    builtinConstant = 21,
+    _ = 22,
 }
 
 enum TokenModifiers {
@@ -235,6 +237,12 @@ class TokenWalker extends ParseTreeWalker {
         return true;
     }
 
+    // Emit tokens for builtin constants so that they are colored properly in string-based annotations.
+    override visitConstant(node: ConstantNode) {
+        this._pushToken(node, TokenTypes.builtinConstant, TokenModifiers.builtin | TokenModifiers.readonly);
+        return true;
+    }
+
     private _isNodeInRange(node: ParseNode) {
         if (this._range === undefined) {
             return true;

diff --git a/packages/pylance-internal/src/tests/fourslash/semantic.all.builtin.fourslash.ts b/packages/pylance-internal/src/tests/fourslash/semantic.all.builtin.fourslash.ts
@@ -5,6 +5,11 @@
 //// [|print|]('hello')
 //// [|NotImplemented|]
 //// raise [|Exception|]()
+//// [|None|]
+//// [|True|]
+//// [|False|]
+//// [|__debug__|]
+//// x: '[|None|]'
 
 // Covers a few cases of builtins that aren't part of other semantic tests
 helper.verifySemanticTokens([
@@ -14,6 +19,11 @@ helper.verifySemanticTokens([
             { type: 'function', modifiers: ['builtin'] },
             { type: 'variable', modifiers: ['builtin'] },
             { type: 'class', modifiers: ['builtin'] },
+            { type: 'builtinConstant', modifiers: ['builtin', 'readonly'] },
+            { type: 'builtinConstant', modifiers: ['builtin', 'readonly'] },
+            { type: 'builtinConstant', modifiers: ['builtin', 'readonly'] },
+            { type: 'builtinConstant', modifiers: ['builtin', 'readonly'] },
+            { type: 'builtinConstant', modifiers: ['builtin', 'readonly'] },
         ],
     },
 ]);
diff --git a/packages/vscode-pylance/package.json b/packages/vscode-pylance/package.json
@@ -757,6 +757,11 @@
                 "id": "magicFunction",
                 "description": "magic aka dunder function",
                 "superType": "function"
+            },
+            {
+                "id": "builtinConstant",
+                "description": "constants like True, False, None, or __debug__",
+                "superType": "constant"
             }
         ],
         "semanticTokenModifiers": [
@@ -798,6 +803,9 @@
                     ],
                     "class.decorator": [
                         "meta.function.decorator.python"
+                    ],
+                    "builtinConstant": [
+                        "constant.language.python"
                     ]
                 }
             }