CI: run pyright with mypy (#43747)

Author: twoertwein

.github/workflows/ci.yml

@@ -45,6 +45,15 @@ jobs:
         environment-file: ${{ env.ENV_FILE }}
         use-only-tar-bz2: true
 
+    - name: Install node.js (for pyright)
+      uses: actions/setup-node@v2
+      with:
+        node-version: "16"
+
+    - name: Install pyright
+      # note: keep version in sync with .pre-commit-config.yaml
+      run: npm install -g pyright@1.1.171
+
     - name: Build Pandas
       uses: ./.github/actions/build_pandas
 

.github/workflows/pre-commit.yml

@@ -13,6 +13,8 @@ jobs:
     concurrency:
       group: ${{ github.ref }}-pre-commit
       cancel-in-progress: ${{github.event_name == 'pull_request'}}
+    env:
+      SKIP: pyright
     steps:
     - uses: actions/checkout@v2
     - uses: actions/setup-python@v2

.pre-commit-config.yaml

@@ -89,7 +89,8 @@ repos:
         language: node
         pass_filenames: false
         types: [python]
-        additional_dependencies: ['pyright@1.1.170']
+        # note: keep version in sync with .github/workflows/ci.yml
+        additional_dependencies: ['pyright@1.1.171']
 -   repo: local
     hooks:
     -   id: flake8-rst

ci/code_checks.sh

@@ -104,6 +104,13 @@ if [[ -z "$CHECK" || "$CHECK" == "typing" ]]; then
     MSG='Performing static analysis using mypy' ; echo $MSG
     mypy pandas
     RET=$(($RET + $?)) ; echo $MSG "DONE"
+
+    # run pyright, if it is installed
+    if command -v pyright &> /dev/null ; then
+        MSG='Performing static analysis using pyright' ; echo $MSG
+        pyright
+        RET=$(($RET + $?)) ; echo $MSG "DONE"
+    fi
 fi
 
 exit $RET

doc/source/development/contributing_codebase.rst

@@ -395,12 +395,17 @@ This module will ultimately house types for repeatedly used concepts like "path-
 Validating type hints
 ~~~~~~~~~~~~~~~~~~~~~
 
-pandas uses `mypy <http://mypy-lang.org>`_ to statically analyze the code base and type hints. After making any change you can ensure your type hints are correct by running
+pandas uses `mypy <http://mypy-lang.org>`_ and `pyright <https://github.com/microsoft/pyright>`_ to statically analyze the code base and type hints. After making any change you can ensure your type hints are correct by running
 
 .. code-block:: shell
 
    mypy pandas
 
+   # let pre-commit setup and run pyright
+   pre-commit run --all-files pyright
+   # or if pyright is installed (requires node.js)
+   pyright
+
 .. _contributing.ci:
 
 Testing with continuous integration

pyproject.toml

@@ -138,7 +138,6 @@ reportOptionalIterable = false
 reportOptionalMemberAccess = false
 reportOptionalOperand = false
 reportOptionalSubscript = false
-reportOverlappingOverload = false
 reportPrivateImportUsage = false
 reportPrivateUsage = false
 reportPropertyTypeMismatch = false