DX: switch to `ty` as type checker #309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

pre-commit-ci wants to merge 6 commits into main from pre-commit-ci-update-config

.cspell.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -26,6 +26,7 @@ @@
         "*.svg",
         ".editorconfig",
         ".envrc",
+        ".github/dependabot.yml",
         ".gitignore",
         ".pre-commit-config.yaml",
         ".prettierignore",
@@ Expand All / @@ -38,7 +39,6 @@ @@
         "pyproject.toml"
       ],
       "ignoreWords": [
-        "MAINT",
         "codemirror",
         "commitlint",
         "cxxcode",
@@ Expand All / @@ -64,6 +64,7 @@ @@
         "nbmake",
         "nbsp",
         "nopython",
+        "poethepoet",
         "prereleased",
         "pycode",
         "pygments",
@@ Expand Down @@

.github/dependabot.yml

-Original file line number
+Diff line change
@@ -0,0 +1,19 @@
+    version: 2
+    multi-ecosystem-groups:
+      lock:
+        assignees: [redeboer]
+        commit-message: { prefix: MAINT }
+        schedule: { interval: quarterly }
+    updates:
+      - package-ecosystem: github-actions
+        directory: "/"
+        labels: [⬆️ Lock]
+        multi-ecosystem-group: lock
+        patterns: ["*"]
+      - package-ecosystem: uv
+        directory: "/"
+        labels: [⬆️ Lock]
+        multi-ecosystem-group: lock
+        patterns: ["*"]

.github/workflows/cd.yml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -9,8 +9,8 @@ on:
  
    jobs:

      milestone:

        if: startsWith(github.ref, 'refs/tags')

        uses: ComPWA/actions/.github/workflows/close-milestone.yml@v3

        uses: ComPWA/actions/.github/workflows/close-milestone.yml@v4

      push:

        if: startsWith(github.ref, 'refs/tags') && !github.event.release.prerelease

        secrets: inherit

        uses: ComPWA/actions/.github/workflows/push-to-version-branches.yml@v3

        uses: ComPWA/actions/.github/workflows/push-to-version-branches.yml@v4

.github/workflows/ci.yml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -17,24 +17,17 @@ on:
  
          - epic/*

          - "[0-9]+.[0-9]+.x"

      workflow_dispatch:

        inputs:

          specific-pip-packages:

            description: Run CI with specific pip packages

            required: false

            type: string

    jobs:

      doc:

        uses: ComPWA/actions/.github/workflows/ci-docs.yml@v3.0

        uses: ComPWA/actions/.github/workflows/ci-docs.yml@v4.0

        permissions:

          pages: write

          id-token: write

        with:

          apt-packages: graphviz

          gh-pages: true

          specific-pip-packages: ${{ inputs.specific-pip-packages }}

      style:

        if: inputs.specific-pip-packages == ''

        secrets:

          token: ${{ secrets.PAT }}

        uses: ComPWA/actions/.github/workflows/pre-commit.yml@v3.0

        uses: ComPWA/actions/.github/workflows/pre-commit.yml@v4.0

.github/workflows/clean-caches.yml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -14,9 +14,9 @@ on:
  
    jobs:

      cleanup:

        name: Remove caches

        runs-on: ubuntu-24.04

        runs-on: ubuntu-slim

        steps:

          - uses: ComPWA/actions/clean-caches@v3

          - uses: ComPWA/actions/clean-caches@v4

            with:

              GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

              ref: ${{ inputs.ref }}

.github/workflows/lock.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -17,6 +17,6 @@ on: @@
     jobs:
       lock:
-        uses: ComPWA/actions/.github/workflows/lock.yml@v3
+        uses: ComPWA/actions/.github/workflows/lock.yml@v4
         secrets:
           token: ${{ secrets.PAT }}

.github/workflows/pr-linting.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -11,4 +11,4 @@ on: @@
     jobs:
       lint-pr:
-        uses: ComPWA/actions/.github/workflows/pr-linting.yml@v3
+        uses: ComPWA/actions/.github/workflows/pr-linting.yml@v4

.github/workflows/release-drafter.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -9,7 +9,7 @@ on: @@
     jobs:
       update_release_draft:
-        runs-on: ubuntu-24.04
+        runs-on: ubuntu-slim
         steps:
           - uses: release-drafter/release-drafter@v6
             env:
@@ Expand Down @@

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -25,7 +25,6 @@ version.py @@
     .coverage.*
     .ipynb_checkpoints/
     .jupyter_ystore.db
-    .mypy*/
     .pytest_cache/
     .virtual_documents/
     __pycache__/
@@ Expand All / @@ -50,5 +49,4 @@ pyvenv*/ @@
     !.vscode/*.json
     !.zenodo.json
     !codecov.yml
-    !pyrightconfig.json
     .jupyter_ystore.db

.pre-commit-config.yaml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,10 +1,9 @@
  
    ci:

      autofix_commit_msg: "MAINT: implement pre-commit autofixes"

      autoupdate_commit_msg: "MAINT: upgrade lock files"

      autoupdate_schedule: quarterly

      skip:

        - check-jsonschema

        - pyright

        - ty

        - uv-lock

    repos:

    @@ -14,7 +13,7 @@ repos:
  
          - id: check-useless-excludes

      - repo: https://github.com/ComPWA/policy

        rev: 0.7.3

        rev: 0.8.2rc15

        hooks:

          - id: check-dev-files

            args:

    @@ -23,13 +22,15 @@ repos:
  
              - --no-pypi

              - --repo-name=compwa.github.io

              - --repo-title=ComPWA Organization

              - --type-checker=ty

          - id: colab-toc-visible

          - id: fix-nbformat-version

          - id: remove-empty-tags

          - id: set-nb-display-name

          - id: strip-nb-whitespace

      - repo: https://github.com/kynan/nbstripout

        rev: 0.8.1

        rev: 0.9.0

        hooks:

          - id: nbstripout

            args:

    @@ -57,7 +58,7 @@ repos:
  
                metadata.vscode

      - repo: https://github.com/astral-sh/ruff-pre-commit

        rev: v0.14.0

        rev: v0.15.0

        hooks:

          - id: ruff-check

            args: [--fix]

    @@ -91,7 +92,7 @@ repos:
  
              )$

      - repo: https://github.com/ComPWA/prettier-pre-commit

        rev: v3.4.2

        rev: v3.8.1

        hooks:

          - id: prettier

    @@ -107,7 +108,7 @@ repos:
  
            args: [--in-place]

      - repo: https://github.com/python-jsonschema/check-jsonschema

        rev: 0.34.1

        rev: 0.36.1

        hooks:

          - id: check-jsonschema

            name: Check CITATION.cff

    @@ -120,12 +121,12 @@ repos:
  
            pass_filenames: false

      - repo: https://github.com/streetsidesoftware/cspell-cli

        rev: v9.2.0

        rev: v9.6.0

        hooks:

          - id: cspell

      - repo: https://github.com/editorconfig-checker/editorconfig-checker.python

        rev: 3.4.0

        rev: 3.6.0

        hooks:

          - id: editorconfig-checker

            name: editorconfig

    @@ -145,12 +146,18 @@ repos:
  
                docs/favicon.ico

              )$

      - repo: https://github.com/ComPWA/pyright-pre-commit

        rev: v1.1.406

      - repo: local

        hooks:

          - id: pyright

          - id: ty

            name: ty

            entry: ty check

            args: [--no-progress, --output-format=concise]

            pass_filenames: false

            require_serial: true

            language: system

            types_or: [python, pyi, jupyter]

      - repo: https://github.com/astral-sh/uv-pre-commit

        rev: 0.9.2

        rev: 0.9.30

        hooks:

          - id: uv-lock

.readthedocs.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -11,11 +11,7 @@ build: @@
           pixi global install graphviz uv
         - |-
           export UV_LINK_MODE=copy
-          uv run \
-            --group doc \
-            --no-dev \
-            --with poethepoet \
-            poe doc
+          uvx --from poethepoet poe doc
           mkdir -p $READTHEDOCS_OUTPUT
           mv docs/_build/html $READTHEDOCS_OUTPUT
@@ Expand Down @@

.vscode/extensions.json

-Original file line number
+Diff line change
@@ -1,5 +1,6 @@
     {
       "recommendations": [
+        "astral-sh.ty",
         "charliermarsh.ruff",
         "christian-kohler.path-intellisense",
         "eamodio.gitlens",
@@ Expand All / @@ -10,7 +11,6 @@ @@
         "github.vscode-pull-request-github",
         "mhutchie.git-graph",
         "ms-python.python",
-        "ms-python.vscode-pylance",
         "ms-toolsai.jupyter",
         "ms-toolsai.vscode-jupyter-cell-tags",
         "ms-vscode.live-server",
@@ Expand All / @@ -33,6 +33,7 @@ @@
         "ms-python.isort",
         "ms-python.mypy-type-checker",
         "ms-python.pylint",
+        "ms-python.vscode-pylance",
         "ms-toolsai.vscode-jupyter-slideshow",
         "travisillig.vscode-json-stable-stringify",
         "tyriar.sort-lines"
@@ Expand Down @@

.vscode/settings.json

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -27,8 +27,8 @@
  
      "diffEditor.experimental.showMoves": true,

      "editor.formatOnSave": true,

      "editor.unicodeHighlight.allowedCharacters": {

        "\u03bd": true,

        "\u03c3": true

        "ν": true,

        "σ": true

      },

      "git.rebaseWhenSync": true,

      "github-actions.workflows.pinned.workflows": [".github/workflows/ci.yml"],

    @@ -46,7 +46,6 @@
  
      },

      "notebook.formatOnSave.enabled": true,

      "notebook.gotoSymbols.showAllSymbols": true,

      "python.analysis.autoImportCompletions": false,

      "python.defaultInterpreterPath": ".venv/bin/python",

      "python.terminal.activateEnvironment": false,

      "python.testing.pytestEnabled": false,

    @@ -59,6 +58,9 @@
  
        "**/uv.lock": true

      },

      "telemetry.telemetryLevel": "off",

      "ty.completions.autoImport": false,

      "ty.diagnosticMode": "workspace",

      "ty.importStrategy": "fromEnvironment",

      "yaml.schemas": {

        "https://citation-file-format.github.io/1.2.0/schema.json": "CITATION.cff",

        "https://json.schemastore.org/github-workflow.json": "./.github/workflows/requirements.yml"

CONTRIBUTING.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -22,7 +22,7 @@ source .venv/bin/activate @@
     Formatting and linting checks are automatically performed when committing changes. This is done with [pre-commit](https://pre-commit.com). To install the hooks in your local repository, run install `pre-commit` with `uv`:
     ```shell
-    uv tool install pre-commit --with pre-commit-uv --force-reinstall
+    uv tool install pre-commit --with pre-commit-uv --force-reinstall --python=3.13
     ```
     and [`pre-commit install`](https://pre-commit.com/#3-install-the-git-hook-scripts) **once**:
@@ Expand All @@
     pre-commit install --install-hooks
     ```
-    [Poe the Poet](https://poethepoet.natn.io) is used as a task runner. You can see which local CI checks it defines by running
+    [Poe the Poet](https://poethepoet.natn.io) is used as a task runner. Install it globally (within your home folder) with `uv`:
+    ```shell
+    uv tool install poethepoet --force-reinstall --python=3.13
+    ```
+    You can see which local CI checks it defines by running
     ```shell
     poe
@@ Expand Down @@

README.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -8,9 +8,10 @@ @@
     [![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ComPWA/compwa.github.io/blob/main)
     [![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/compwa.github.io)
     [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/compwa.github.io/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/compwa.github.io/main)
-    [![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
+    [![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell)
     [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
     [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
     [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+    [![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
     This repository contains the source code for the [compwa.github.io](https://compwa.github.io) pages.

docs/adr/001/operators.ipynb

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -169,11 +169,11 @@
  
       "source": [

        "import operator\n",

        "\n",

        "MAKE_BINARY = lambda opfn: lambda self, other: BinaryOp(  # noqa: E731\n",

        "    self, asMagicNumber(other), opfn\n",

        "MAKE_BINARY = lambda opfn: (\n",

        "    lambda self, other: BinaryOp(self, asMagicNumber(other), opfn)\n",

        ")\n",

        "MAKE_RBINARY = lambda opfn: lambda self, other: BinaryOp(  # noqa: E731\n",

        "    asMagicNumber(other), self, opfn\n",

        "MAKE_RBINARY = lambda opfn: (\n",

        "    lambda self, other: BinaryOp(asMagicNumber(other), self, opfn)\n",

        ")\n",

        "\n",

        "\n",

    @@ -234,9 +234,7 @@
  
        "        return self.opn(self.op1.eval())\n",

        "\n",

        "\n",

        "asMagicNumber = lambda x: (  # noqa: E731\n",

        "    x if isinstance(x, MagicNumber) else Constant(x)\n",

        ")\n",

        "asMagicNumber = lambda x: x if isinstance(x, MagicNumber) else Constant(x)\n",

        "asMagicNumber(2).eval()"

       ]

      },

    @@ -386,7 +384,7 @@
  
       "name": "python",

       "nbconvert_exporter": "python",

       "pygments_lexer": "ipython3",

       "version": "3.10.13"

       "version": "3.13.11"

      }

     },

     "nbformat": 4,

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DX: switch to `ty` as type checker #309

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

DX: switch to ty as type checker #309

Are you sure you want to change the base?

Uh oh!

DX: switch to ty as type checker #309

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

DX: switch to `ty` as type checker #309

DX: switch to `ty` as type checker #309