Set up pre-commit #289

ondras12345 · 2025-05-27T21:32:01Z

Proposal

pre-commit is a nice tool that can be used to run various linters before each commit is made.
This PR adds a .pre-commit-config.yaml with a basic set of checks and linters. It also fixes typos detected by the codespell check.

Currently, the mypy check fails:

$ pre-commit run --all-files
trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
check for case conflicts.................................................Passed
check docstring is first.................................................Passed
check that executables have shebangs.................(no files to check)Skipped
check that scripts with shebangs are executable..........................Passed
mixed line ending........................................................Passed
debug statements (python)................................................Passed
detect destroyed symlinks................................................Passed
fix utf-8 byte order marker..............................................Passed
check for merge conflicts................................................Passed
python tests naming......................................................Passed
flake8...................................................................Passed
codespell................................................................Passed
mypy.....................................................................Failed
- hook id: mypy
- exit code: 1

OMPython/OMParser.py:37: error: Need type annotation for "result" (hint: "result: dict[<type>, <type>] = ...")  [var-annotated]
OMPython/OMTypedParser.py:112: error: Argument 1 has incompatible type "bool"; expected "str"  [arg-type]
OMPython/OMTypedParser.py:113: error: Argument 1 has incompatible type "bool"; expected "str"  [arg-type]
OMPython/OMTypedParser.py:114: error: Argument 1 has incompatible type "None"; expected "str"  [arg-type]
OMPython/OMCSession.py:92: error: Need type annotation for "_omc_cache" (hint: "_omc_cache: dict[<type>, <type>] = ...")  [var-annotated]
OMPython/OMCSession.py:278: error: Incompatible default for argument "omhome" (default has type "None", argument has type "str")  [assignment]
OMPython/OMCSession.py:278: note: PEP 484 prohibits implicit Optional. Accordingly, mypy has changed its default to no_implicit_optional=True
OMPython/OMCSession.py:278: note: Use https://github.com/hauntsaninja/no_implicit_optional to automatically upgrade your codebase
OMPython/OMCSession.py:462: error: Incompatible default for argument "omhome" (default has type "None", argument has type "str")  [assignment]
OMPython/OMCSession.py:462: note: PEP 484 prohibits implicit Optional. Accordingly, mypy has changed its default to no_implicit_optional=True
OMPython/OMCSession.py:462: note: Use https://github.com/hauntsaninja/no_implicit_optional to automatically upgrade your codebase
OMPython/ModelicaSystem.py:44: error: Cannot find implementation or library stub for module named "numpy"  [import-not-found]
OMPython/ModelicaSystem.py:44: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
OMPython/ModelicaSystem.py:366: error: Need type annotation for "quantitiesList" (hint: "quantitiesList: list[<type>] = ...")  [var-annotated]
OMPython/ModelicaSystem.py:367: error: Need type annotation for "paramlist" (hint: "paramlist: dict[<type>, <type>] = ...")  [var-annotated]
OMPython/ModelicaSystem.py:368: error: Need type annotation for "inputlist" (hint: "inputlist: dict[<type>, <type>] = ...")  [var-annotated]
OMPython/ModelicaSystem.py:369: error: Need type annotation for "outputlist" (hint: "outputlist: dict[<type>, <type>] = ...")  [var-annotated]
OMPython/ModelicaSystem.py:370: error: Need type annotation for "continuouslist" (hint: "continuouslist: dict[<type>, <type>] = ...")  [var-annotated]
OMPython/ModelicaSystem.py:371: error: Need type annotation for "simulateOptions" (hint: "simulateOptions: dict[<type>, <type>] = ...")  [var-annotated]
OMPython/ModelicaSystem.py:372: error: Need type annotation for "overridevariables" (hint: "overridevariables: dict[<type>, <type>] = ...")  [var-annotated]
OMPython/ModelicaSystem.py:373: error: Need type annotation for "simoptionsoverride" (hint: "simoptionsoverride: dict[<type>, <type>] = ...")  [var-annotated]
OMPython/ModelicaSystem.py:377: error: Need type annotation for "linearinputs" (hint: "linearinputs: list[<type>] = ...")  [var-annotated]
OMPython/ModelicaSystem.py:378: error: Need type annotation for "linearoutputs" (hint: "linearoutputs: list[<type>] = ...")  [var-annotated]
OMPython/ModelicaSystem.py:379: error: Need type annotation for "linearstates" (hint: "linearstates: list[<type>] = ...")  [var-annotated]
OMPython/ModelicaSystem.py:386: error: Argument "omhome" to "OMCSessionZMQ" has incompatible type "str | None"; expected "str"  [arg-type]
OMPython/ModelicaSystem.py:389: error: Argument "commandLineOptions" to "setCommandLineOptions" of "ModelicaSystem" has incompatible type "str | None"; expected "str"  [arg-type]
OMPython/ModelicaSystem.py:826: error: Argument "modelname" to "ModelicaSystemCmd" has incompatible type "str | None"; expected "str"  [arg-type]
OMPython/ModelicaSystem.py:830: error: Incompatible types in assignment (expression has type "Path", variable has type "None")  [assignment]
OMPython/ModelicaSystem.py:832: error: Incompatible types in assignment (expression has type "Path", variable has type "None")  [assignment]
OMPython/ModelicaSystem.py:834: error: Incompatible types in assignment (expression has type "Path", variable has type "None")  [assignment]
OMPython/ModelicaSystem.py:836: error: "None" has no attribute "as_posix"  [attr-defined]
OMPython/ModelicaSystem.py:868: error: Incompatible types in assignment (expression has type "Path", variable has type "str")  [assignment]
OMPython/ModelicaSystem.py:870: error: "str" has no attribute "as_posix"  [attr-defined]
OMPython/ModelicaSystem.py:873: error: "None" has no attribute "is_file"  [attr-defined]
OMPython/ModelicaSystem.py:874: error: "None" has no attribute "unlink"  [attr-defined]
OMPython/ModelicaSystem.py:878: error: "None" has no attribute "is_file"  [attr-defined]
Found 31 errors in 4 files (checked 5 source files)

I think @syntron has fixed at least some of these in his fork. I think we should wait for them to be merged before proceeding with this PR.

In the future, we could configure the github actions test workflow to also run linters via pre-commit.

syntron · 2025-05-28T09:26:12Z

See status in #279 (comment) - 14 errors left:

3 in OMTypedParser - Argument 1 has incompatible type ...
11 in ModelicaSystem - Need type annotation for ...

I will prepare the needed changes as PR(s)

syntron · 2025-05-28T19:14:26Z

I will prepare the needed changes as PR(s)

Please see PR #290, #291, #292 and #294 to reach this point

ondras12345 · 2025-06-11T21:01:42Z

Rebased and fixed remaining mypy warnings. All tests in pre-commit run --all-files pass in 1.7 seconds on my PC. Seems reasonable.

ondras12345 · 2025-06-11T22:05:54Z

Updated to run pre-commit run --all-files in Github actions CI.

syntron · 2025-06-14T20:17:31Z

@ondras12345 Would you consider to modify this PR such that it comes without the following parts (changes to OMCSession.py) - these clash with PR #295 such that there are big merge conflicts; both points (mypy warning and spelling fix) are included ...

5cddad2 (change in OMCSession.py)
52e86a0

ondras12345 · 2025-06-14T21:17:29Z

@syntron I could do that, but it would cause this PR to fail its CI test run. It might be better to get your PR merged first and let me handle the conflicts here.

ondras12345 · 2025-06-14T21:45:17Z

@syntron Btw, I tried to rebase #295 onto this PR, and it wasn't that bad. Only two of your commits had conflicts, and it was enough to just accept your version. Rebased branch: https://github.com/ondras12345/OMPython/tree/pr_295_rebased

ondras12345 · 2025-06-16T17:59:58Z

Rebased to fix merge conflict.

syntron · 2025-06-16T20:33:19Z

@syntron Btw, I tried to rebase #295 onto this PR, and it wasn't that bad. Only two of your commits had conflicts, and it was enough to just accept your version. Rebased branch: https://github.com/ondras12345/OMPython/tree/pr_295_rebased

@ondras12345 I think the renames would conflict with any changes in these classes; perhaps I should stop working on ModelicaSystem.py such that it could settle and you do not have so much work ...

@adeas31 Do you know that the numbers at the ModelicaSystem methods refer to, i.e. # 21 and similar?

adeas31 · 2025-06-17T07:18:02Z

@adeas31 Do you know that the numbers at the ModelicaSystem methods refer to, i.e. # 21 and similar?

No idea. @arun3688 might know.

arun3688 · 2025-06-17T07:33:03Z

@adeas31 Do you know that the numbers at the ModelicaSystem methods refer to, i.e. # 21 and similar?

That does not have any meaning just to count the number of API i guess which was done by a student as part of this thesis, so you can ignore that or you can even remove those numbers

This should make workflow runs with linter errors fail faster.

ondras12345 · 2025-06-18T21:50:11Z

Rebased, should be ready for review & merge.

ondras12345 mentioned this pull request Jun 10, 2025

next release? #254

Open

adeas31 added this to the 3.8.0 milestone Jun 11, 2025

ondras12345 force-pushed the pre-commit branch from f15d94d to 976da26 Compare June 11, 2025 20:59

ondras12345 marked this pull request as ready for review June 11, 2025 21:02

ondras12345 mentioned this pull request Jun 13, 2025

Rename internal variables and methods to start with _ #304

Merged

ondras12345 force-pushed the pre-commit branch from 52e86a0 to 8376302 Compare June 16, 2025 17:59

adeas31 modified the milestones: 3.8.0, 4.0.0 Jun 17, 2025

ondras12345 added 6 commits June 18, 2025 23:24

Add pre-commit config

bcd5898

Fix codespell warnings

6939378

Add mypy as pre-commit hook

02eeadb

Fix remaining mypy errors

405e5b7

Run pre-commit in github CI

8127daf

Run linters before setting up OpenModelica in CI

100e119

This should make workflow runs with linter errors fail faster.

ondras12345 force-pushed the pre-commit branch from 8376302 to 100e119 Compare June 18, 2025 21:26

Fix mypy warning on Windows

06ec3e8

adeas31 approved these changes Jun 18, 2025

View reviewed changes

adeas31 merged commit d87e46e into OpenModelica:master Jun 18, 2025
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Set up pre-commit #289

Set up pre-commit #289

Uh oh!

ondras12345 commented May 27, 2025

Uh oh!

syntron commented May 28, 2025

Uh oh!

syntron commented May 28, 2025 •

edited

Loading

Uh oh!

ondras12345 commented Jun 11, 2025

Uh oh!

ondras12345 commented Jun 11, 2025

Uh oh!

syntron commented Jun 14, 2025

Uh oh!

ondras12345 commented Jun 14, 2025

Uh oh!

ondras12345 commented Jun 14, 2025

Uh oh!

ondras12345 commented Jun 16, 2025

Uh oh!

syntron commented Jun 16, 2025

Uh oh!

adeas31 commented Jun 17, 2025

Uh oh!

arun3688 commented Jun 17, 2025

Uh oh!

ondras12345 commented Jun 18, 2025

Uh oh!

Uh oh!

Uh oh!

Set up pre-commit #289

Set up pre-commit #289

Uh oh!

Conversation

ondras12345 commented May 27, 2025

Proposal

Uh oh!

syntron commented May 28, 2025

Uh oh!

syntron commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ondras12345 commented Jun 11, 2025

Uh oh!

ondras12345 commented Jun 11, 2025

Uh oh!

syntron commented Jun 14, 2025

Uh oh!

ondras12345 commented Jun 14, 2025

Uh oh!

ondras12345 commented Jun 14, 2025

Uh oh!

ondras12345 commented Jun 16, 2025

Uh oh!

syntron commented Jun 16, 2025

Uh oh!

adeas31 commented Jun 17, 2025

Uh oh!

arun3688 commented Jun 17, 2025

Uh oh!

ondras12345 commented Jun 18, 2025

Uh oh!

Uh oh!

Uh oh!

syntron commented May 28, 2025 •

edited

Loading