Add pyright type checker (#8279)

* Add pyright type checker

* Update ci-additional.yaml

* Update ci-additional.yaml

Author: Illviljan

.github/workflows/ci-additional.yaml

@@ -188,6 +188,126 @@ jobs:
 
 
 
+  pyright:
+    name: Pyright
+    runs-on: "ubuntu-latest"
+    needs: detect-ci-trigger
+    if: |
+        always()
+        && (
+            contains( github.event.pull_request.labels.*.name, 'run-pyright')
+        )
+    defaults:
+      run:
+        shell: bash -l {0}
+    env:
+      CONDA_ENV_FILE: ci/requirements/environment.yml
+      PYTHON_VERSION: "3.10"
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch all history for all branches and tags.
+
+      - name: set environment variables
+        run: |
+          echo "TODAY=$(date +'%Y-%m-%d')" >> $GITHUB_ENV
+      - name: Setup micromamba
+        uses: mamba-org/setup-micromamba@v1
+        with:
+          environment-file: ${{env.CONDA_ENV_FILE}}
+          environment-name: xarray-tests
+          create-args: >-
+            python=${{env.PYTHON_VERSION}}
+            conda
+          cache-environment: true
+          cache-environment-key: "${{runner.os}}-${{runner.arch}}-py${{env.PYTHON_VERSION}}-${{env.TODAY}}-${{hashFiles(env.CONDA_ENV_FILE)}}"
+      - name: Install xarray
+        run: |
+          python -m pip install --no-deps -e .
+      - name: Version info
+        run: |
+          conda info -a
+          conda list
+          python xarray/util/print_versions.py
+      - name: Install pyright
+        run: |
+          python -m pip install pyright --force-reinstall
+
+      - name: Run pyright
+        run: |
+          python -m pyright xarray/
+
+      - name: Upload pyright coverage to Codecov
+        uses: codecov/codecov-action@v3.1.4
+        with:
+          file: pyright_report/cobertura.xml
+          flags: pyright
+          env_vars: PYTHON_VERSION
+          name: codecov-umbrella
+          fail_ci_if_error: false
+
+  pyright39:
+    name: Pyright 3.9
+    runs-on: "ubuntu-latest"
+    needs: detect-ci-trigger
+    if: |
+        always()
+        && (
+            contains( github.event.pull_request.labels.*.name, 'run-pyright')
+        )
+    defaults:
+      run:
+        shell: bash -l {0}
+    env:
+      CONDA_ENV_FILE: ci/requirements/environment.yml
+      PYTHON_VERSION: "3.9"
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch all history for all branches and tags.
+
+      - name: set environment variables
+        run: |
+          echo "TODAY=$(date +'%Y-%m-%d')" >> $GITHUB_ENV
+      - name: Setup micromamba
+        uses: mamba-org/setup-micromamba@v1
+        with:
+          environment-file: ${{env.CONDA_ENV_FILE}}
+          environment-name: xarray-tests
+          create-args: >-
+            python=${{env.PYTHON_VERSION}}
+            conda
+          cache-environment: true
+          cache-environment-key: "${{runner.os}}-${{runner.arch}}-py${{env.PYTHON_VERSION}}-${{env.TODAY}}-${{hashFiles(env.CONDA_ENV_FILE)}}"
+      - name: Install xarray
+        run: |
+          python -m pip install --no-deps -e .
+      - name: Version info
+        run: |
+          conda info -a
+          conda list
+          python xarray/util/print_versions.py
+      - name: Install pyright
+        run: |
+          python -m pip install pyright --force-reinstall
+
+      - name: Run pyright
+        run: |
+          python -m pyright xarray/
+
+      - name: Upload pyright coverage to Codecov
+        uses: codecov/codecov-action@v3.1.4
+        with:
+          file: pyright_report/cobertura.xml
+          flags: pyright39
+          env_vars: PYTHON_VERSION
+          name: codecov-umbrella
+          fail_ci_if_error: false
+
+
+
   min-version-policy:
     name: Minimum Version Policy
     runs-on: "ubuntu-latest"

pyproject.toml

@@ -198,6 +198,31 @@ warn_return_any = true
 
 module = ["xarray.namedarray.*", "xarray.tests.test_namedarray"]
 
+[tool.pyright]
+# include = ["src"]
+# exclude = ["**/node_modules",
+    # "**/__pycache__",
+    # "src/experimental",
+    # "src/typestubs"
+# ]
+# ignore = ["src/oldstuff"]
+defineConstant = { DEBUG = true }
+# stubPath = "src/stubs"
+# venv = "env367"
+
+reportMissingImports = true
+reportMissingTypeStubs = false
+
+# pythonVersion = "3.6"
+# pythonPlatform = "Linux"
+
+# executionEnvironments = [
+  # { root = "src/web", pythonVersion = "3.5", pythonPlatform = "Windows", extraPaths = [ "src/service_libs" ] },
+  # { root = "src/sdk", pythonVersion = "3.0", extraPaths = [ "src/backend" ] },
+  # { root = "src/tests", extraPaths = ["src/tests/e2e", "src/sdk" ]},
+  # { root = "src" }
+# ]
+
 [tool.ruff]
 builtins = ["ellipsis"]
 exclude = [