Merge pull request #16 from chrishavlin/enable_type_checking

add a type check workflow

Author: chrishavlin

.github/workflows/type_checking.yaml

@@ -0,0 +1,45 @@
+name: type checking
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+      - yt_experiments/**/*.py
+      - pyproject.toml
+      - .github/workflows/type-checking.yaml
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: type check
+    timeout-minutes: 60
+
+    concurrency:
+      # auto-cancel any in-progress job *on the same branch*
+      group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        # run with oldest supported python version
+        # so that we always get compatible versions of
+        # core dependencies at type-check time
+        python-version: '3.10'
+
+    - name: Build
+      run: |
+        python3 -m pip install --upgrade pip
+        python3 -m pip install "mypy==1.11.2"
+
+    - run: python -m pip list
+
+    - name: Run mypy
+      run: mypy yt_experiments

pyproject.toml

@@ -106,3 +106,14 @@ archs = "auto"
 
 [tool.cibuildwheel.windows]
 archs = "auto64"
+
+[tool.mypy]
+files = ["yt_experiments",]
+python_version = "3.10"
+warn_unused_configs = true
+strict = true
+enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
+warn_unreachable = true
+disallow_untyped_defs = false
+disallow_incomplete_defs = false
+disable_error_code = ["import-untyped", "import-not-found"]