Advanced Chore: Implement strict static type checking with Mypy #1383

Activity

1. Exodus2004 commented on May 30, 2026

   

   Exodus2004

   on May 30, 2026

   More actions

   Proposed Implementation Plan: Strict Static Type Checking with Mypy

   Hello Maintainers! I would love to work on this static type-checking integration under GSSoC '26. Here is my proposed step-by-step implementation plan:

   1. Setup Configuration File (mypy.ini / pyproject.toml)

   • Add a mypy.ini file in the root directory to establish type-checking standards:

     [mypy]
     python_version = 3.10
     warn_return_any = True
     warn_unused_configs = True
     disallow_untyped_defs = True
     disallow_incomplete_defs = True
     check_untyped_defs = True
     ignore_missing_imports = True

   2. Introduce Type Hints to Core Utility Scripts

   • Annotate core utilities, module entries, and helpers. For example, add type signatures (def example_func(param: int) -> str:) to enforce explicit input/output definitions.
   • Leverage Python's typing module (or standard collection types in Python 3.10+) for typing complex structures (like List, Dict, Any, Callable, or Optional).

   3. Setup Automated Type-Checking GitHub Action

   • Create a lightweight CI step under .github/workflows/static-analysis.yml:

     name: Static Type Analysis
     on: [push, pull_request]
     jobs:
       mypy:
         runs-on: ubuntu-latest
         steps:
           - uses: actions/checkout@v4
           - uses: actions/setup-python@v5
             with:
               python-version: "3.10"
           - name: Install dependencies
             run: pip install mypy
           - name: Run Mypy
             run: mypy .

   Please assign this issue to me. I'm ready to open a PR right away!