Skip to content

Add mypy CI and config (ref #358) #518

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.

Sign up for GitHub

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

Merged
acolomb merged 10 commits into from
Jun 9, 2025
Merged

Add mypy CI and config (ref #358) #518

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6201f60
gh-358: Add mypy CI and config
erlend-aasland Jul 11, 2024
88d1765
Also install project
erlend-aasland Jul 11, 2024
4efb9d9
Don't have to run mypy on 3.8 in order to enforce 3.8 annotations
erlend-aasland Jul 11, 2024
b84a5d9
Pull in main
erlend-aasland Aug 11, 2024
8321c23
Merge branch 'master' into typing/ci-and-config
erlend-aasland Oct 15, 2024
933d8dd
Sync with PR
erlend-aasland Oct 15, 2024
5b8d3e9
Add newline at EOF
erlend-aasland Oct 15, 2024
b84ba2d
Reorder to have continue-on-error honored correctly.
acolomb Apr 28, 2025
35f04a2
Try with returning true, avoiding commit to be marked with red X.
acolomb Apr 28, 2025
cc4dc96
Move mypy linter to a separate workflow, only for PRs.
acolomb Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/workflows/pythonpackage.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,18 @@ jobs:
run: python3 -m pip install -r doc/requirements.txt -e .
- name: Build docs
run: make -C doc html

mypy:
continue-on-error: true
Copy link
Member

@acolomb acolomb Apr 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks a little strange to see "Python package / mypy (pull_request)" as the title for this check. I'm leaning towards moving it to a separate workflow file. Or is there any particular reason why it should be linked with the pythonpackage.yml?

Either way, we should give it a more appealing name such as - name: Run mypy static type checker

For the possibly new workflow file, we could use a more generic name / title and keep in mind that more checkers / linters might be added there later. Something like "Check correctness" or "Static code analysis".

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'
'requirements-dev.txt'
- run: pip install -r requirements-dev.txt -e .
- run: mypy --config-file pyproject.toml .
8 changes: 8 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,11 @@ testpaths = [
filterwarnings = [
"ignore::DeprecationWarning",
]

[tool.mypy]
python_version = "3.8"
exclude = [
"^examples*",
"^test*",
"^setup.py*",
]
1 change: 1 addition & 0 deletions requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
mypy~=1.10
pytest~=8.3
pytest-cov~=5.0