DO NOT MERGE: Sync changes from upstream main branch

.eslintrc.json

@@ -23,39 +23,24 @@
         "no-inner-declarations": 0,
         "no-unused-vars": "off",
         "no-undef": 0,
-        "simple-import-sort/imports": [
-            "error",
-            {
-                "groups": [
-                    // Defaults from simple-import-sort, but with local packages between third-party and relative imports.
-                    [
-                        "^\\u0000"
-                    ],
-                    [
-                        "^@?\\w"
-                    ],
-                    [
-                        "^[^.]"
-                    ],
-                    [
-                        "^pyright"
-                    ],
-                    [
-                        "^\\."
-                    ]
-                ]
-            }
-        ],
         "simple-import-sort/exports": "error",
         "@typescript-eslint/explicit-function-return-type": 0,
         "@typescript-eslint/explicit-module-boundary-types": 0,
         "@typescript-eslint/ban-types": 0,
         "@typescript-eslint/camelcase": 0,
+        "@typescript-eslint/member-ordering": [
+            "error",
+            {
+                "classes": ["field", "constructor", ["public-get", "public-set"], "public-method", ["protected-get", "protected-set"], "protected-method", ["private-get", "private-set"], "private-method"],
+                "interfaces": []
+            }
+        ],
         "@typescript-eslint/no-empty-interface": 0,
         "@typescript-eslint/no-explicit-any": 0,
         "@typescript-eslint/no-namespace": 0,
         "@typescript-eslint/no-non-null-assertion": 0,
         "@typescript-eslint/no-this-alias": 0,
+        "@typescript-eslint/explicit-member-accessibility": ["error", { "accessibility": "no-public" }],
         "@typescript-eslint/no-unused-vars": [
             "error",
             {
@@ -92,7 +77,7 @@
                     "accessor"
                 ],
                 "modifiers": ["protected"],
-                "leadingUnderscore": "allow",
+                "leadingUnderscore": "forbid",
                 "format": ["camelCase"],
                 "filter": {
                     "regex": "^(test_| )",

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Report incorrect or unintended behaviors
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+Note: if you are reporting a wrong signature of a function or a class in the standard library, then the typeshed tracker is better suited for this report: https://github.com/python/typeshed/issues.
+
+If you have a question about typing or a behavior that you’re seeing in Pyright (as opposed to a bug report or enhancement request), consider posting to the [Pyright discussion forum](https://github.com/microsoft/pyright/discussions).
+
+**Describe the bug**
+A clear and concise description of the behavior you are seeing and the expected behavior along with steps to reproduce it.
+
+**Code or Screenshots**
+If possible, provide a minimal, self-contained code sample (surrounded by triple back ticks) to demonstrate the issue. The code should define or import all referenced symbols.
+
+```python
+def foo(self) -> str:
+    return 3
+```
+
+If your code relies on symbols that are imported from a third-party library, include the associated import statements and specify which versions of those libraries you have installed.
+
+**VS Code extension or command-line**
+Are you running pyright as a VS Code extension, a language server in another editor, integrated into Pylance, or the command-line tool? Which version?

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea or improvement
+title: ''
+labels: enhancement request
+assignees: ''
+
+---
+
+If you have a question about a behavior that you’re seeing in pyright, consider posting to the [Pyright discussion forum](https://github.com/microsoft/pyright/discussions).
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of the problem.
+
+**Describe the solution you’d like**
+A clear and concise description of the solution you would like to see.
+

.github/workflows/mypy_primer_comment.yaml

@@ -0,0 +1,101 @@
+# This workflow runs when the "Run mypy_primer on PR" workflow completes.
+# It downloads the diff from the other workflow instances and creates
+# a summary comment in the PR.
+name: Comment with mypy_primer diff
+
+on:
+  workflow_run:
+    workflows:
+      - Run mypy_primer on PR
+    types:
+      - completed
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  comment:
+    name: Comment PR from mypy_primer
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Download diffs
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const fs = require('fs');
+            const artifacts = await github.rest.actions.listWorkflowRunArtifacts({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               run_id: ${{ github.event.workflow_run.id }},
+            });
+            const [matchArtifact] = artifacts.data.artifacts.filter((artifact) =>
+              artifact.name == "mypy_primer_diffs");
+
+            const download = await github.rest.actions.downloadArtifact({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               artifact_id: matchArtifact.id,
+               archive_format: "zip",
+            });
+            fs.writeFileSync("diff.zip", Buffer.from(download.data));
+
+      - run: unzip diff.zip
+      - run: |
+          cat diff_*.txt | tee fulldiff.txt
+
+      - name: Post comment
+        id: post-comment
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const MAX_CHARACTERS = 30000
+            const MAX_CHARACTERS_PER_PROJECT = MAX_CHARACTERS / 3
+
+            const fs = require('fs')
+            let data = fs.readFileSync('fulldiff.txt', { encoding: 'utf8' })
+
+            function truncateIfNeeded(original, maxLength) {
+              if (original.length <= maxLength) {
+                return original
+              }
+              let truncated = original.substring(0, maxLength)
+              // further, remove last line that might be truncated
+              truncated = truncated.substring(0, truncated.lastIndexOf('\n'))
+              let lines_truncated = original.split('\n').length - truncated.split('\n').length
+              return `${truncated}\n\n... (truncated ${lines_truncated} lines) ...`
+            }
+
+            const projects = data.split('\n\n')
+            // don't let one project dominate
+            data = projects.map(project => truncateIfNeeded(project, MAX_CHARACTERS_PER_PROJECT)).join('\n\n')
+            // posting comment fails if too long, so truncate
+            data = truncateIfNeeded(data, MAX_CHARACTERS)
+
+            console.log("Diff from mypy_primer:")
+            console.log(data)
+
+            let body
+            if (data.trim()) {
+              body = 'Diff from [mypy_primer](https://github.com/hauntsaninja/mypy_primer), showing the effect of this PR on open source code:\n```diff\n' + data + '```'
+            } else {
+              body = "According to [mypy_primer](https://github.com/hauntsaninja/mypy_primer), this change doesn't affect type check results on a corpus of open source code. ✅"
+            }
+            const prNumber = parseInt(fs.readFileSync("pr_number.txt", { encoding: "utf8" }))
+            await github.rest.issues.createComment({
+              issue_number: prNumber,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body
+            })
+            return prNumber
+
+      - name: Hide old comments
+        # v0.4.0
+        uses: kanga333/comment-hider@c12bb20b48aeb8fc098e35967de8d4f8018fffdf
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          leave_visible: 1
+          issue_number: ${{ steps.post-comment.outputs.result }}

.github/workflows/mypy_primer_pr.yaml

@@ -0,0 +1,91 @@
+# This workflow runs mypy_primer, a tool that runs pyright on a variety
+# of open-source Python projects that are known to type check with pyright.
+# It builds pyright from the latest PR commit and the merge base of the PR
+# and compares the output of both. It uploads the diffs as an artifact and
+# creates a PR comment with the results (with the help of the
+# mypy_primer_comment action).
+
+# This workflow definition borrows liberally from the mypy repo. The original
+# workflow was designed to work in a sharded manner where n copies of
+# mypy_primer are started in parallel. Each instance runs 1/n of the projects.
+# For now, we run only one instance because pyright is fast, and the number
+# of projects that use pyright for type checking is small. To change this in
+# the future, change the 'shard_index' matrix to [0, 1, ..., n-1] and set
+# 'num-shards' to n.
+
+name: Run mypy_primer on PR
+
+on:
+  # Run on the creation or update of a PR.
+  pull_request:
+    paths:
+      - 'packages/pyright/**'
+      - 'packages/pyright-internal/src/**'
+      - 'packages/pyright-internal/typeshed-fallback/**'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  mypy_primer:
+    name: Run mypy_primer on PR
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    strategy:
+      matrix:
+        shard-index: [0, 1]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          path: pyright_to_test
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip
+          pip install git+https://github.com/hauntsaninja/mypy_primer.git
+      - name: Run mypy_primer
+        shell: bash
+        run: |
+          cd pyright_to_test
+          echo "new commit"
+          git rev-list --format=%s --max-count=1 $GITHUB_SHA
+
+          MERGE_BASE=$(git merge-base $GITHUB_SHA origin/$GITHUB_BASE_REF)
+          git checkout -b base_commit $MERGE_BASE
+          echo "base commit"
+          git rev-list --format=%s --max-count=1 base_commit
+
+          echo ''
+          cd ..
+          # fail action if exit code isn't zero or one
+          (
+            mypy_primer \
+            --repo pyright_to_test \
+            --type-checker pyright \
+            --new $GITHUB_SHA --old base_commit \
+            --num-shards 2 --shard-index ${{ matrix.shard-index }} \
+            --debug \
+            --output concise \
+            | tee diff_${{ matrix.shard-index }}.txt
+          ) || [ $? -eq 1 ]
+      - name: Upload mypy_primer diff
+        uses: actions/upload-artifact@v3
+        with:
+          name: mypy_primer_diffs
+          path: diff_${{ matrix.shard-index }}.txt
+      - if: ${{ matrix.shard-index }} == 0
+        name: Save PR number
+        run: |
+          echo ${{ github.event.pull_request.number }} | tee pr_number.txt
+      - if: ${{ matrix.shard-index }} == 0
+        name: Upload PR number
+        uses: actions/upload-artifact@v3
+        with:
+          name: mypy_primer_diffs
+          path: pr_number.txt

.github/workflows/mypy_primer_push.yaml

@@ -0,0 +1,65 @@
+# This workflow runs mypy_primer, a tool that runs pyright on a variety
+# of open-source Python projects that are known to type check with pyright.
+# It builds pyright from the latest commit and the last release tag and
+# compares the output of both. It uploads the diffs as an artifact.
+name: Run mypy_primer on push
+
+on:
+  # Run on all pushes to main.
+  push:
+    branches:
+      - main
+    paths:
+      - 'packages/pyright/**'
+      - 'packages/pyright-internal/src/**'
+      - 'packages/pyright-internal/typeshed-fallback/**'
+  # Also run manually if requested.
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  mypy_primer:
+    name: Run mypy_primer on push
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          path: pyright_to_test
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip
+          pip install git+https://github.com/hauntsaninja/mypy_primer.git
+      - name: Run mypy_primer
+        shell: bash
+        run: |
+          cd pyright_to_test
+          echo "new commit"
+          git rev-list --format=%s --max-count=1 $GITHUB_SHA
+
+          cd ..
+          # fail action if exit code isn't zero or one
+          (
+            mypy_primer \
+            --repo pyright_to_test \
+            --type-checker pyright \
+            --new $GITHUB_SHA \
+            --debug \
+            --output concise \
+            | tee diff.txt
+          ) || [ $? -eq 1 ]
+      - name: Upload mypy_primer diff
+        uses: actions/upload-artifact@v3
+        with:
+          name: mypy_primer_diffs
+          path: diff.txt

.github/workflows/validation.yml

@@ -35,7 +35,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-
 
-      - run: npm install
+      - run: npm run install:all
 
       - run: npx lerna exec --stream --no-bail -- tsc --noEmit
 
@@ -101,7 +101,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-
 
-      - run: npm install
+      - run: npm run install:all
 
       - name: npm test (pyright-internal)
         run: npm test
@@ -130,7 +130,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-
 
-      - run: npm install
+      - run: npm run install:all
 
       - run: npm publish --dry-run
         working-directory: packages/pyright