sync: pyright 2023 04 03

.github/workflows/build.yml

@@ -0,0 +1,75 @@
+name: 'Build'
+
+env:
+  NODE_VERSION: '16' # Shipped with VS Code.
+  ARTIFACT_NAME_VSIX: vsix
+  VSIX_NAME: vscode-pyright.vsix
+
+on:
+  push:
+    tags:
+      - '1.1.[0-9][0-9][0-9]'
+
+jobs:
+  build:
+    if: github.repository == 'microsoft/pyright'
+    runs-on: ubuntu-latest
+    name: Build
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Get npm cache directory
+        id: npm-cache
+        run: |
+          echo "dir=$(npm config get cache)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v3
+        with:
+          path: ${{ steps.npm-cache.outputs.dir }}
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - run: npm run install:all
+
+      - name: Build VSIX
+        working-directory: packages/vscode-pyright
+        run: |
+          npm run package
+          mv pyright-*.vsix ${{ env.VSIX_NAME }}
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.ARTIFACT_NAME_VSIX }}
+          path: packages/vscode-pyright/${{ env.VSIX_NAME }}
+
+  create_release:
+    if: github.repository == 'microsoft/pyright'
+    runs-on: ubuntu-latest
+    name: Create release
+    needs: [build]
+
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v3
+        with:
+          path: artifacts
+
+      # TODO: If the release already exists (tag created via the GUI), reuse it.
+      - name: Create release
+        id: create_release
+        uses: ncipollo/release-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          name: Published ${{ github.ref_name }}
+          draft: true
+          artifacts: ./artifacts/${{ env.ARTIFACT_NAME_VSIX }}/${{ env.VSIX_NAME }}
+          artifactContentType: application/zip

.github/workflows/codeql.yml

@@ -32,7 +32,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL

.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: Publish Release
+
+on:
+  release:
+    types: [published]
+
+env:
+  VSIX_NAME: vscode-pyright.vsix
+  NODE_VERSION: '16' # Shipped with VS Code.
+
+jobs:
+  publish_extension:
+    if: ${{ github.repository == 'microsoft/pyright' }}
+    runs-on: ubuntu-latest
+    name: Publish extension to marketplace
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - run: npm install
+
+      - name: Download VSIX
+        uses: i3h/download-release-asset@v1
+        with:
+          owner: microsoft
+          repo: pyright
+          tag: ${{ github.event.release.tag_name }}
+          file: ${{ env.VSIX_NAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      # https://code.visualstudio.com/api/working-with-extensions/publishing-extension
+      - name: Install VSCE
+        run: |
+          npm install -g "vsce@$(jq -r '.dependencies.vsce.version' < packages/vscode-pyright/package-lock.json)"
+          npx vsce --version
+
+      # https://code.visualstudio.com/api/working-with-extensions/publishing-extension#get-a-personal-access-token
+      - name: Publish VSIX
+        run: npx vsce publish --packagePath ${{ env.VSIX_NAME }} --pat ${{ secrets.VSCE_TOKEN }} --noVerify

.github/workflows/validation.yml

@@ -18,17 +18,17 @@ jobs:
     name: Typecheck
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - uses: actions/setup-node@v2-beta
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Get npm cache directory
         id: npm-cache
         run: |
           echo "::set-output name=dir::$(npm config get cache)"
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: ${{ steps.npm-cache.outputs.dir }}
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -45,17 +45,17 @@ jobs:
     name: Style
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - uses: actions/setup-node@v2-beta
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Get npm cache directory
         id: npm-cache
         run: |
           echo "::set-output name=dir::$(npm config get cache)"
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: ${{ steps.npm-cache.outputs.dir }}
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -80,9 +80,9 @@ jobs:
     needs: typecheck
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - uses: actions/setup-node@v2-beta
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ env.NODE_VERSION }}
 
@@ -93,7 +93,7 @@ jobs:
         id: npm-cache
         run: |
           echo "::set-output name=dir::$(npm config get cache)"
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         if: runner.os != 'Windows'
         with:
           path: ${{ steps.npm-cache.outputs.dir }}
@@ -113,17 +113,17 @@ jobs:
     needs: typecheck
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - uses: actions/setup-node@v2-beta
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Get npm cache directory
         id: npm-cache
         run: |
           echo "::set-output name=dir::$(npm config get cache)"
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: ${{ steps.npm-cache.outputs.dir }}
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

.vscode/launch.json

@@ -47,6 +47,25 @@
                 "${workspaceRoot}/packages/vscode-pyright/dist/**/*.js"
             ]
         },
+        {
+            "name": "Pyright extension (watch)",
+            "type": "extensionHost",
+            "request": "launch",
+            "runtimeExecutable": "${workspaceRoot}/packages/vscode-pyright/dist/extension.js",
+            "preLaunchTask": "Watch extension",
+            "args": [
+                "--extensionDevelopmentPath=${workspaceFolder}/packages/vscode-pyright",
+                // The published extension is named "ms-pyright.pyright", but in debug mode it's "ms-pyright.vscode-pyright"
+                // to allow the extension code to participate in the lerna monorepo. Make sure that the published extension
+                // isn't enabled, otherwise both are loaded and conflict.
+                "--disable-extension=ms-pyright.pyright"
+            ],
+            "smartStep": true,
+            "sourceMaps": true,
+            "outFiles": [
+                "${workspaceRoot}/packages/vscode-pyright/dist/**/*.js"
+            ]
+        },
         {
             "name": "Pyright attach server",
             "type": "node",

.vscode/tasks.json

@@ -18,18 +18,17 @@
                 "fileLocation": "absolute",
                 "pattern": [
                     {
-                        "kind": "location",
-                        "regexp": "(ERROR|WARNING) in (.*?):(\\d+):(\\d+)",
-                        "severity": 1,
-                        "file": 2,
-                        "line": 3,
-                        "column": 4
-                    },
-                    {
-                        "regexp": "\\s*(@typescript-eslint\\/.+):\\s*(.*)$",
-                        "code": 1,
-                        "message": 2
-                    }
+						"regexp": "\\[tsl\\] (ERROR|WARNING) in (.*)?\\((\\d+),(\\d+)\\)",
+						"severity": 1,
+						"file": 2,
+						"line": 3,
+						"column": 4
+					},
+					{
+						"regexp": "\\s*TS(\\d+):\\s*(.*)$",
+						"code": 1,
+						"message": 2
+					}
                 ],
                 "background": {
                     "activeOnStart": true,

build/checkLockIndent.js

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 //@ts-check
 
-// Lerna doesn't do a good job preserving the indention in lock files.
+// Lerna doesn't do a good job preserving the indentation in lock files.
 // Check that the lock files are still indented correctly, otherwise
 // the change will cause problems with merging and the updateDeps script.
 

build/skipBootstrap.js

@@ -2,7 +2,7 @@
 // This can be used to write npm script like:
 //     node ./build/skipBootstrap.js || lerna bootstrap
 // Which means "skip lerna bootstrap if SKIP_LERNA_BOOTSTRAP is set".
-// This prevents suprious bootstraps in nested lerna repos.
+// This prevents spurious bootstraps in nested lerna repos.
 
 if (!process.env.SKIP_LERNA_BOOTSTRAP) {
     process.exit(1);

docs/README.md

@@ -0,0 +1,9 @@
+![Pyright](img/PyrightLarge.png)
+
+# Static type checker for Python
+
+Pyright is a full-featured, standards-based static type checker for Python. It is designed for high performance and can be used with large Python source bases.
+
+Pyright includes both a [command-line tool](command-line.md) and an [extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-pyright.pyright).
+
+

docs/_navbar.md

@@ -0,0 +1 @@
+[Github Site](https://github.com/Microsoft/pyright)

docs/_sidebar.md

@@ -0,0 +1,39 @@
+- Getting Started
+
+  - [Installing Pyright](installation.md)
+  - [Getting Started](getting-started.md)
+  - [Static Typing](type-concepts.md)
+  - [Features](features.md)
+
+- Customization
+
+  - [Configuration](configuration.md)
+    - [Configuration Options](configuration.md#main-configuration-options)
+    - [Diagnostic Rules](configuration.md#type-check-diagnostics-settings)
+    - [Execution Environments](configuration.md#execution-environment-options)
+    - [Sample pyrightconfig.json](configuration.md#sample-config-file)
+    - [Sample pyproject.toml](configuration.md#sample-pyprojecttoml-file)
+    - [Diagnostic Rule Defaults](configuration.md#diagnostic-rule-defaults)
+  - [Language Server Settings](settings.md)
+  - [Command Line Interface](command-line.md)
+  - [Controlling Behavior With Comments](comments.md)
+  - [Continuous Integration](ci-integration.md)
+
+- Usage
+
+  - [Advanced Type Concepts](type-concepts-advanced.md)
+  - [Type Inference](type-inference.md)
+  - [Import Statements](import-statements.md)
+  - [Import Resolution](import-resolution.md)
+  - [Extending Builtins](builtins.md)
+  - [Type Stubs](type-stubs.md)
+  - [Types in Libraries](typed-libraries.md)
+  - [Differences from Mypy](mypy-comparison.md)
+  - [Commands](commands.md)
+
+- Development
+
+  - [Building & Debugging](build-debug.md)
+  - [Pyright Internals](internals.md)
+
+

docs/build-debug.md

@@ -1,9 +1,9 @@
 ## Building Pyright
 
 To install the dependencies for all packages in the repo:
-1. Install [nodejs](https://nodejs.org/en/) version 14.x
+1. Install [nodejs](https://nodejs.org/en/) version 16.x
 2. Open terminal window in main directory of cloned source
-3. Execute `npm install` to install dependencies
+3. Execute `npm run install:all` to install dependencies for projects and sub-projects
 
 
 ## Building the CLI

docs/builtins.md

@@ -1,4 +1,4 @@
-# Extending Builtins
+## Extending Builtins
 
 The Python interpreter implicitly adds a set of symbols that are available within every module even though they are not explicitly imported. These so-called “built in” symbols include commonly-used types and functions such as “list”, “dict”, “int”, “float”, “min”, and “len”.