Add mypy CI and config (ref #358) #562
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This workflow will install Python dependencies, run tests and lint with a variety of Python versions | |
| # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python | |
| name: Python package | |
| on: | |
| push: | |
| branches: | |
| - 'master' | |
| paths-ignore: | |
| - 'README.rst' | |
| - 'LICENSE.txt' | |
| pull_request: | |
| branches: | |
| - 'master' | |
| paths-ignore: | |
| - 'README.rst' | |
| - 'LICENSE.txt' | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ['3.x'] | |
| features: ['', '[db_export]'] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: 'pip' | |
| cache-dependency-path: | | |
| 'pyproject.toml' | |
| 'requirements-dev.txt' | |
| - name: Install dependencies | |
| run: python3 -m pip install -e '.${{ matrix.features }}' -r requirements-dev.txt | |
| - name: Test with pytest | |
| run: pytest -v --cov=canopen --cov-report=xml --cov-branch | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| cache: 'pip' | |
| cache-dependency-path: | | |
| 'pyproject.toml' | |
| 'doc/requirements.txt' | |
| - name: Install dependencies | |
| run: python3 -m pip install -r doc/requirements.txt -e . | |
| - name: Build docs | |
| run: make -C doc html | |
| mypy: | |
| name: Run mypy static type checker (optional) | |
| runs-on: ubuntu-latest | |
| continue-on-error: true | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| cache: pip | |
| cache-dependency-path: | | |
| 'pyproject.toml' | |
| 'requirements-dev.txt' | |
| - run: pip install -r requirements-dev.txt -e . | |
| - name: Run mypy and report but do not fail | |
| run: mypy --config-file pyproject.toml . || true |