Skip to content

update docstrings and more linter based fixes #379

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
adeas31 merged 18 commits into from
Nov 21, 2025
Merged

update docstrings and more linter based fixes #379

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
af0c186
rename DummyPopen to DockerPopen and add docstring
syntron Nov 16, 2025
eca3fd1
docstring for OMCSessionException
syntron Nov 16, 2025
f49b695
docstring for OMCSessionCmd - depreciated!
syntron Nov 16, 2025
99d4db8
docstring for OMCPathCompatibility*
syntron Nov 16, 2025
bbfeda3
improve documentation for OMCSessionZMQ
syntron Nov 16, 2025
91ec45c
docstring for OMCSessionZMQ
syntron Nov 16, 2025
7c64063
improve documentation of OMCProcess*.omc_run_data_update() and OMCSes…
syntron Nov 16, 2025
0aac4d9
[OMCSessionZMQ] small fixes based on pylint
syntron Nov 16, 2025
bc21fcf
docstring for OMCProcess
syntron Nov 16, 2025
d115693
update docstring for ModelicaSystemCmd
syntron Nov 16, 2025
0b2665d
[ModelicaSystem] fix varable names - use snake_case naming style
syntron Nov 16, 2025
00b6737
[ModelicaSystem] add docstring for isParameterChangeable
syntron Nov 16, 2025
14d7695
[OMCSessionZMQ] fix another not needed else
syntron Nov 16, 2025
669acad
fix exception string
syntron Nov 16, 2025
5e94d08
fix pylint hints about (internal) variable names
syntron Nov 16, 2025
007a498
reorder imports in tests based on pylint
syntron Nov 16, 2025
3029b84
[OMCSessionCmd] update exception string
syntron Nov 16, 2025
438453e
[ModelicaSystemCmd] fix docstring
syntron Nov 21, 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
Prev Previous commit
Next Next commit
docstring for OMCSessionZMQ
  • Loading branch information
@syntron
syntron committed Nov 20, 2025
commit 91ec45c101aadaabb773ebd3e25593a9887712e8
14 changes: 14 additions & 0 deletions OMPython/OMCSession.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,20 @@ class OMCSessionZMQ:
This class is handling an OMC session.

The main method is sendExpression() which is used to send commands to the OMC process.

The class expects an OMCProcess* on initialisation. It defines the type of OMC process to use:

* OMCProcessLocal

* OMCProcessPort

* OMCProcessDocker

* OMCProcessDockerContainer

* OMCProcessWSL

If no OMC process is defined, a local OMC process is initialized.
"""

def __init__(
Expand Down