Repository navigation
Expand file tree
/
Copy path__init__.py
More file actions
executable file
·1844 lines (1644 loc) · 80 KB
/
Copy path__init__.py
File metadata and controls
executable file
·1844 lines (1644 loc) · 80 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
"""
OMPython is a Python interface to OpenModelica.
To get started, create an OMCSession/OMCSessionZMQ object:
from OMPython import OMCSession/OMCSessionZMQ
omc = OMCSession()/OMCSessionZMQ()
omc.sendExpression(command)
Note: Conversion from OMPython 1.0 to OMPython 2.0 is very simple
1.0:
import OMPython
OMPython.execute(command)
2.0:
from OMPython import OMCSession
OMPython = OMCSession()
OMPython.execute(command)
OMPython 3.0 includes a new class OMCSessionZMQ uses PyZMQ to communicate
with OpenModelica. A new argument `useCorba=False` is added to ModelicaSystem
class which means it will use OMCSessionZMQ by default. If you want to use
OMCSession then create ModelicaSystem object like this,
obj = ModelicaSystem(useCorba=True)
The difference between execute and sendExpression is the type of the
returned expression. sendExpression maps Modelica types to Python types,
while execute tries to map also output that is not valid Modelica.
That format is harder to use.
"""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from future.utils import with_metaclass
from builtins import int, range
from copy import deepcopy
from distutils import spawn
import abc
import csv
import getpass
import logging
import json
import os
import platform
import psutil
import re
import shlex
import signal
import subprocess
import sys
import tempfile
import time
import uuid
import xml.etree.ElementTree as ET
from collections import OrderedDict
import numpy as np
import pyparsing
if sys.platform == 'darwin':
# On Mac let's assume omc is installed here and there might be a broken omniORB installed in a bad place
sys.path.append('/opt/local/lib/python2.7/site-packages/')
sys.path.append('/opt/openmodelica/lib/python2.7/site-packages/')
# TODO: replace this with the new parser
from OMPython import OMTypedParser, OMParser
__license__ = """
This file is part of OpenModelica.
Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
c/o Linköpings universitet, Department of Computer and Information Science,
SE-58183 Linköping, Sweden.
All rights reserved.
THIS PROGRAM IS PROVIDED UNDER THE TERMS OF THE BSD NEW LICENSE OR THE
GPL VERSION 3 LICENSE OR THE OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
ACCORDING TO RECIPIENTS CHOICE.
The OpenModelica software and the OSMC (Open Source Modelica Consortium)
Public License (OSMC-PL) are obtained from OSMC, either from the above
address, from the URLs: http://www.openmodelica.org or
http://www.ida.liu.se/projects/OpenModelica, and in the OpenModelica
distribution. GNU version 3 is obtained from:
http://www.gnu.org/copyleft/gpl.html. The New BSD License is obtained from:
http://www.opensource.org/licenses/BSD-3-Clause.
This program is distributed WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, EXCEPT AS
EXPRESSLY SET FORTH IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE
CONDITIONS OF OSMC-PL.
"""
# Logger Defined
logger = logging.getLogger('OMPython')
logger.setLevel(logging.DEBUG)
# create console handler with a higher log level
logger_console_handler = logging.StreamHandler()
logger_console_handler.setLevel(logging.INFO)
# create formatter and add it to the handlers
logger_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
logger_console_handler.setFormatter(logger_formatter)
# add the handlers to the logger
logger.addHandler(logger_console_handler)
logger.setLevel(logging.WARNING)
class DummyPopen():
def __init__(self, pid):
self.pid = pid
self.process = psutil.Process(pid)
self.returncode = 0
def poll(self):
return None if self.process.is_running() else True
def kill(self):
return os.kill(self.pid, signal.SIGKILL)
def wait(self, timeout):
return self.process.wait(timeout=timeout)
class OMCSessionHelper():
def __init__(self):
# Get the path to the OMC executable, if not installed this will be None
omc_env_home = os.environ.get('OPENMODELICAHOME')
if omc_env_home:
self.omhome = omc_env_home
else:
path_to_omc = spawn.find_executable("omc")
if path_to_omc is None:
raise ValueError("Cannot find OpenModelica executable, please install from openmodelica.org")
self.omhome = os.path.split(os.path.split(os.path.realpath(path_to_omc))[0])[0]
def _get_omc_path(self):
try:
return os.path.join(self.omhome, 'bin', 'omc')
except BaseException:
logger.error("The OpenModelica compiler is missing in the System path (%s), please install it" % os.path.join(self.omhome, 'bin', 'omc'))
raise
class OMCSessionBase(with_metaclass(abc.ABCMeta, object)):
def __init__(self, readonly=False):
self.readonly = readonly
self.omc_cache = {}
self._omc_process = None
self._omc_command = None
self._omc = None
self._dockerCid = None
self._serverIPAddress = "127.0.0.1"
self._interactivePort = None
# FIXME: this code is not well written... need to be refactored
self._temp_dir = tempfile.gettempdir()
# generate a random string for this session
self._random_string = uuid.uuid4().hex
# omc log file
self._omc_log_file = None
try:
self._currentUser = getpass.getuser()
if not self._currentUser:
self._currentUser = "nobody"
except KeyError:
# We are running as a uid not existing in the password database... Pretend we are nobody
self._currentUser = "nobody"
def __del__(self):
try:
self.sendExpression("quit()")
except:
pass
self._omc_log_file.close()
if sys.version_info.major >= 3:
try:
self._omc_process.wait(timeout=2.0)
except:
if self._omc_process:
self._omc_process.kill()
else:
for i in range(0,100):
time.sleep(0.02)
if self._omc_process and (self._omc_process.poll() is not None):
break
# kill self._omc_process process if it is still running/exists
if self._omc_process is not None and self._omc_process.returncode is None:
print("OMC did not exit after being sent the quit() command; killing the process with pid=%s" % str(self._omc_process.pid))
if sys.platform=="win32":
self._omc_process.kill()
self._omc_process.wait()
else:
os.killpg(os.getpgid(self._omc_process.pid), signal.SIGTERM)
self._omc_process.kill()
self._omc_process.wait()
def _create_omc_log_file(self, suffix):
if sys.platform == 'win32':
self._omc_log_file = open(os.path.join(self._temp_dir, "openmodelica.{0}.{1}.log".format(suffix, self._random_string)), 'w')
else:
# this file must be closed in the destructor
self._omc_log_file = open(os.path.join(self._temp_dir, "openmodelica.{0}.{1}.{2}.log".format(self._currentUser, suffix, self._random_string)), 'w')
def _start_omc_process(self, timeout):
if sys.platform == 'win32':
omhome_bin = os.path.join(self.omhome, 'bin').replace("\\", "/")
my_env = os.environ.copy()
my_env["PATH"] = omhome_bin + os.pathsep + my_env["PATH"]
self._omc_process = subprocess.Popen(self._omc_command, stdout=self._omc_log_file, stderr=self._omc_log_file, env=my_env)
else:
# set the user environment variable so omc running from wsgi has the same user as OMPython
my_env = os.environ.copy()
my_env["USER"] = self._currentUser
# Because we spawned a shell, and we need to be able to kill OMC, create a new process group for this
self._omc_process = subprocess.Popen(self._omc_command, shell=True, stdout=self._omc_log_file, stderr=self._omc_log_file, env=my_env, preexec_fn=os.setsid)
if self._docker:
for i in range(0,40):
try:
with open(self._dockerCidFile, "r") as fin:
self._dockerCid = fin.read().strip()
except:
pass
if self._dockerCid:
break
time.sleep(timeout / 40.0)
try:
os.remove(self._dockerCidFile)
except:
pass
if self._dockerCid is None:
logger.error("Docker did not start. Log-file says:\n%s" % (open(self._omc_log_file.name).read()))
raise Exception("Docker did not start (timeout=%f might be too short especially if you did not docker pull the image before this command)." % timeout)
if self._docker or self._dockerContainer:
if self._dockerNetwork == "separate":
self._serverIPAddress = json.loads(subprocess.check_output(["docker", "inspect", self._dockerCid]).decode().strip())[0]["NetworkSettings"]["IPAddress"]
for i in range(0,40):
if sys.platform == 'win32':
break
dockerTop = subprocess.check_output(["docker", "top", self._dockerCid]).decode().strip()
self._omc_process = None
for line in dockerTop.split("\n"):
columns = line.split()
if self._random_string in line:
try:
self._omc_process = DummyPopen(int(columns[1]))
except psutil.NoSuchProcess:
raise Exception("Could not find PID %d - is this a docker instance spawned without --pid=host?\nLog-file says:\n%s" % (self._random_string, dockerTop, open(self._omc_log_file.name).read()))
break
if self._omc_process is not None:
break
time.sleep(timeout / 40.0)
if self._omc_process is None:
raise Exception("Docker top did not contain omc process %s:\n%s\nLog-file says:\n%s" % (self._random_string, dockerTop, open(self._omc_log_file.name).read()))
return self._omc_process
def _getuid(self):
"""
The uid to give to docker.
On Windows, volumes are mapped with all files are chmod ugo+rwx,
so uid does not matter as long as it is not the root user.
"""
return 1000 if sys.platform == 'win32' else os.getuid()
def _set_omc_command(self, omc_path_and_args_list):
"""Define the command that will be called by the subprocess module.
On Windows, use the list input style of the subprocess module to
avoid problems resulting from spaces in the path string.
Linux, however, only works with the string version.
"""
if (self._docker or self._dockerContainer) and sys.platform == "win32":
extraFlags = ["-d=zmqDangerousAcceptConnectionsFromAnywhere"]
if not self._interactivePort:
raise Exception("docker on Windows requires knowing which port to connect to. For dockerContainer=..., the container needs to have already manually exposed this port when it was started (-p 127.0.0.1:n:n) or you get an error later.")
else:
extraFlags = []
if self._docker:
if sys.platform == "win32":
p = int(self._interactivePort)
dockerNetworkStr = ["-p", "127.0.0.1:%d:%d" % (p,p)]
elif self._dockerNetwork == "host" or self._dockerNetwork is None:
dockerNetworkStr = ["--network=host"]
elif self._dockerNetwork == "separate":
dockerNetworkStr = []
extraFlags = ["-d=zmqDangerousAcceptConnectionsFromAnywhere"]
else:
raise Exception('dockerNetwork was set to %s, but only \"host\" or \"separate\" is allowed')
self._dockerCidFile = self._omc_log_file.name + ".docker.cid"
omcCommand = ["docker", "run", "--cidfile", self._dockerCidFile, "--rm", "--env", "USER=%s" % self._currentUser, "--user", str(self._getuid())] + self._dockerExtraArgs + dockerNetworkStr + [self._docker, self._dockerOpenModelicaPath]
elif self._dockerContainer:
omcCommand = ["docker", "exec", "--env", "USER=%s" % self._currentUser, "--user", str(self._getuid())] + self._dockerExtraArgs + [self._dockerContainer, self._dockerOpenModelicaPath]
self._dockerCid = self._dockerContainer
else:
omcCommand = [self._get_omc_path()]
if self._interactivePort:
extraFlags = extraFlags + ["--interactivePort=%d" % int(self._interactivePort)]
omc_path_and_args_list = omcCommand + omc_path_and_args_list + extraFlags
if sys.platform == 'win32':
self._omc_command = omc_path_and_args_list
else:
self._omc_command = ' '.join([shlex.quote(a) if (sys.version_info > (3, 0)) else a for a in omc_path_and_args_list])
return self._omc_command
@abc.abstractmethod
def _connect_to_omc(self, timeout):
pass
# FIXME: we should have one function which interacts with OMC. Either execute OR sendExpression.
# Execute uses OMParser.check_for_values and sendExpression uses OMTypedParser.parseString.
# We should have one parser. Then we can get rid of one of these functions.
@abc.abstractmethod
def execute(self, command):
pass
def clearOMParserResult(self):
OMParser.result = {}
# FIXME: we should have one function which interacts with OMC. Either execute OR sendExpression.
# Execute uses OMParser.check_for_values and sendExpression uses OMTypedParser.parseString.
# We should have one parser. Then we can get rid of one of these functions.
@abc.abstractmethod
def sendExpression(self, command, parsed=True):
"""
Sends an expression to the OpenModelica. The return type is parsed as if the
expression was part of the typed OpenModelica API (see ModelicaBuiltin.mo).
* Integer and Real are returned as Python numbers
* Strings, enumerations, and typenames are returned as Python strings
* Arrays, tuples, and MetaModelica lists are returned as tuples
* Records are returned as dicts (the name of the record is lost)
* Booleans are returned as True or False
* NONE() is returned as None
* SOME(value) is returned as value
"""
pass
def ask(self, question, opt=None, parsed=True):
p = (question, opt, parsed)
if self.readonly and question != 'getErrorString':
# can use cache if readonly
if p in self.omc_cache:
return self.omc_cache[p]
if opt:
expression = '{0}({1})'.format(question, opt)
else:
expression = question
logger.debug('OMC ask: {0} - parsed: {1}'.format(expression, parsed))
try:
if parsed:
res = self.execute(expression)
else:
res = self.sendExpression(expression, parsed=False)
except Exception as e:
logger.error("OMC failed: {0}, {1}, parsed={2}".format(question, opt, parsed))
raise e
# save response
self.omc_cache[p] = res
return res
# TODO: Open Modelica Compiler API functions. Would be nice to generate these.
def loadFile(self, filename):
return self.ask('loadFile', '"{0}"'.format(filename))
def loadModel(self, className):
return self.ask('loadModel', className)
def isModel(self, className):
return self.ask('isModel', className)
def isPackage(self, className):
return self.ask('isPackage', className)
def isPrimitive(self, className):
return self.ask('isPrimitive', className)
def isConnector(self, className):
return self.ask('isConnector', className)
def isRecord(self, className):
return self.ask('isRecord', className)
def isBlock(self, className):
return self.ask('isBlock', className)
def isType(self, className):
return self.ask('isType', className)
def isFunction(self, className):
return self.ask('isFunction', className)
def isClass(self, className):
return self.ask('isClass', className)
def isParameter(self, className):
return self.ask('isParameter', className)
def isConstant(self, className):
return self.ask('isConstant', className)
def isProtected(self, className):
return self.ask('isProtected', className)
def getPackages(self, className="AllLoadedClasses"):
return self.ask('getPackages', className)
def getClassRestriction(self, className):
return self.ask('getClassRestriction', className)
def getDerivedClassModifierNames(self, className):
return self.ask('getDerivedClassModifierNames', className)
def getDerivedClassModifierValue(self, className, modifierName):
return self.ask('getDerivedClassModifierValue', '{0}, {1}'.format(className, modifierName))
def typeNameStrings(self, className):
return self.ask('typeNameStrings', className)
def getComponents(self, className):
return self.ask('getComponents', className)
def getClassComment(self, className):
try:
return self.ask('getClassComment', className)
except pyparsing.ParseException as ex:
logger.warning("Method 'getClassComment' failed for {0}".format(className))
logger.warning('OMTypedParser error: {0}'.format(ex.message))
return 'No description available'
def getNthComponent(self, className, comp_id):
""" returns with (type, name, description) """
return self.ask('getNthComponent', '{0}, {1}'.format(className, comp_id))
def getNthComponentAnnotation(self, className, comp_id):
return self.ask('getNthComponentAnnotation', '{0}, {1}'.format(className, comp_id))
def getImportCount(self, className):
return self.ask('getImportCount', className)
def getNthImport(self, className, importNumber):
# [Path, id, kind]
return self.ask('getNthImport', '{0}, {1}'.format(className, importNumber))
def getInheritanceCount(self, className):
return self.ask('getInheritanceCount', className)
def getNthInheritedClass(self, className, inheritanceDepth):
return self.ask('getNthInheritedClass', '{0}, {1}'.format(className, inheritanceDepth))
def getParameterNames(self, className):
try:
return self.ask('getParameterNames', className)
except KeyError as ex:
logger.warning('OMPython error: {0}'.format(ex))
# FIXME: OMC returns with a different structure for empty parameter set
return []
def getParameterValue(self, className, parameterName):
try:
return self.ask('getParameterValue', '{0}, {1}'.format(className, parameterName))
except pyparsing.ParseException as ex:
logger.warning('OMTypedParser error: {0}'.format(ex.message))
return ""
def getComponentModifierNames(self, className, componentName):
return self.ask('getComponentModifierNames', '{0}, {1}'.format(className, componentName))
def getComponentModifierValue(self, className, componentName):
try:
# FIXME: OMPython exception UnboundLocalError exception for 'Modelica.Fluid.Machines.ControlledPump'
return self.ask('getComponentModifierValue', '{0}, {1}'.format(className, componentName))
except pyparsing.ParseException as ex:
logger.warning('OMTypedParser error: {0}'.format(ex.message))
result = self.ask('getComponentModifierValue', '{0}, {1}'.format(className, componentName), parsed=False)
try:
answer = OMParser.check_for_values(result)
OMParser.result = {}
return answer[2:]
except (TypeError, UnboundLocalError) as ex:
logger.warning('OMParser error: {0}'.format(ex))
return result
def getExtendsModifierNames(self, className, componentName):
return self.ask('getExtendsModifierNames', '{0}, {1}'.format(className, componentName))
def getExtendsModifierValue(self, className, extendsName, modifierName):
try:
# FIXME: OMPython exception UnboundLocalError exception for 'Modelica.Fluid.Machines.ControlledPump'
return self.ask('getExtendsModifierValue', '{0}, {1}, {2}'.format(className, extendsName, modifierName))
except pyparsing.ParseException as ex:
logger.warning('OMTypedParser error: {0}'.format(ex.message))
result = self.ask('getExtendsModifierValue', '{0}, {1}, {2}'.format(className, extendsName, modifierName), parsed=False)
try:
answer = OMParser.check_for_values(result)
OMParser.result = {}
return answer[2:]
except (TypeError, UnboundLocalError) as ex:
logger.warning('OMParser error: {0}'.format(ex))
return result
def getNthComponentModification(self, className, comp_id):
# FIXME: OMPython exception Results KeyError exception
# get {$Code(....)} field
# \{\$Code\((\S*\s*)*\)\}
value = self.ask('getNthComponentModification', '{0}, {1}'.format(className, comp_id), parsed=False)
value = value.replace("{$Code(", "")
return value[:-3]
# return self.re_Code.findall(value)
# function getClassNames
# input TypeName class_ = $Code(AllLoadedClasses);
# input Boolean recursive = false;
# input Boolean qualified = false;
# input Boolean sort = false;
# input Boolean builtin = false "List also builtin classes if true";
# input Boolean showProtected = false "List also protected classes if true";
# output TypeName classNames[:];
# end getClassNames;
def getClassNames(self, className=None, recursive=False, qualified=False, sort=False, builtin=False,
showProtected=False):
if className:
value = self.ask('getClassNames',
'{0}, recursive={1}, qualified={2}, sort={3}, builtin={4}, showProtected={5}'.format(
className, str(recursive).lower(), str(qualified).lower(), str(sort).lower(),
str(builtin).lower(), str(showProtected).lower()))
else:
value = self.ask('getClassNames',
'recursive={0}, qualified={1}, sort={2}, builtin={3}, showProtected={4}'.format(
str(recursive).lower(), str(qualified).lower(), str(sort).lower(),
str(builtin).lower(), str(showProtected).lower()))
return value
class OMCSession(OMCSessionHelper, OMCSessionBase):
def __init__(self, readonly=False, serverFlag='--interactive=corba', timeout = 10.0, docker = None, dockerContainer = None, dockerExtraArgs = [], dockerOpenModelicaPath = "omc", dockerNetwork = None):
OMCSessionHelper.__init__(self)
OMCSessionBase.__init__(self, readonly)
self._create_omc_log_file("objid")
# Locating and using the IOR
if sys.platform != 'win32' or docker or dockerContainer:
self._port_file = "openmodelica." + self._currentUser + ".objid." + self._random_string
else:
self._port_file = "openmodelica.objid." + self._random_string
self._port_file = os.path.join("/tmp" if (docker or dockerContainer) else self._temp_dir, self._port_file).replace("\\", "/")
# set omc executable path and args
self._docker = docker
self._dockerContainer = dockerContainer
self._dockerExtraArgs = dockerExtraArgs
self._dockerOpenModelicaPath = dockerOpenModelicaPath
self._dockerNetwork = dockerNetwork
self._timeout = timeout
self._create_omc_log_file("port")
self._set_omc_command([serverFlag, "+c={0}".format(self._random_string)])
# start up omc executable, which is waiting for the CORBA connection
self._start_omc_process(timeout)
# connect to the running omc instance using CORBA
self._connect_to_omc(timeout)
def __del__(self):
OMCSessionBase.__del__(self)
def _connect_to_omc(self, timeout):
# add OPENMODELICAHOME\lib\python to PYTHONPATH so python can load omniORB imports
sys.path.append(os.path.join(self.omhome, 'lib', 'python'))
# import the skeletons for the global module
try:
from omniORB import CORBA
from OMPythonIDL import _OMCIDL
except ImportError:
self._omc_process.kill()
raise
self._omc_corba_uri = "file:///" + self._port_file
# See if the omc server is running
attempts = 0
while True:
if self._dockerCid:
try:
self._ior = subprocess.check_output(["docker", "exec", self._dockerCid, "cat", self._port_file], stderr=subprocess.DEVNULL if (sys.version_info > (3, 0)) else subprocess.STDOUT).decode().strip()
break
except subprocess.CalledProcessError:
pass
if os.path.isfile(self._port_file):
# Read the IOR file
with open(self._port_file, 'r') as f_p:
self._ior = f_p.readline()
break
attempts += 1
if attempts == 80:
name = self._omc_log_file.name
self._omc_log_file.close()
with open(name) as fin:
contents = fin.read()
self._omc_process.kill()
raise Exception("OMC Server is down (timeout=%f). Please start it! If the OMC version is old, try OMCSession(..., serverFlag='-d=interactiveCorba') or +d=interactiveCorba. Log-file says:\n%s" % (timeout, contents))
time.sleep(timeout / 80.0)
while True:
if self._dockerCid:
try:
self._port = subprocess.check_output(["docker", "exec", self._dockerCid, "cat", self._port_file]).decode().strip()
break
except:
pass
else:
if os.path.isfile(self._port_file):
# Read the port file
with open(self._port_file, 'r') as f_p:
self._port = f_p.readline()
os.remove(self._port_file)
break
attempts += 1
if attempts == 80.0:
name = self._omc_log_file.name
self._omc_log_file.close()
logger.error("OMC Server is down (timeout=%f). Please start it! Log-file says:\n%s" % open(name).read())
raise Exception("OMC Server is down. Could not open file %s" % (timeout,self._port_file))
time.sleep(timeout / 80.0)
logger.info("OMC Server is up and running at {0}".format(self._omc_corba_uri))
# initialize the ORB with maximum size for the ORB set
sys.argv.append("-ORBgiopMaxMsgSize")
sys.argv.append("2147483647")
self._orb = CORBA.ORB_init(sys.argv, CORBA.ORB_ID)
# Find the root POA
self._poa = self._orb.resolve_initial_references("RootPOA")
# Convert the IOR into an object reference
self._obj_reference = self._orb.string_to_object(self._ior)
# Narrow the reference to the OmcCommunication object
self._omc = self._obj_reference._narrow(_OMCIDL.OmcCommunication)
# Check if we are using the right object
if self._omc is None:
logger.error("Object reference is not valid")
raise Exception
def execute(self, command):
## check for process is running
p=self._omc_process.poll()
if (p == None):
result = self._omc.sendExpression(command)
if command == "quit()":
self._omc = None
return result
else:
answer = OMParser.check_for_values(result)
return answer
else:
raise Exception("Process Exited, No connection with OMC. Create a new instance of OMCSession")
def sendExpression(self, command, parsed=True):
## check for process is running
p=self._omc_process.poll()
if (p== None):
result = self._omc.sendExpression(str(command))
if command == "quit()":
self._omc = None
return result
else:
if parsed is True:
answer = OMTypedParser.parseString(result)
return answer
else:
return result
else:
raise Exception("Process Exited, No connection with OMC. Create a new instance of OMCSession")
try:
import zmq
except ImportError:
pass
class OMCSessionZMQ(OMCSessionHelper, OMCSessionBase):
def __init__(self, readonly=False, timeout = 10.00, docker = None, dockerContainer = None, dockerExtraArgs = [], dockerOpenModelicaPath = "omc", dockerNetwork = None, port = None):
OMCSessionHelper.__init__(self)
OMCSessionBase.__init__(self, readonly)
# Locating and using the IOR
if sys.platform != 'win32' or docker or dockerContainer:
self._port_file = "openmodelica." + self._currentUser + ".port." + self._random_string
else:
self._port_file = "openmodelica.port." + self._random_string
self._docker = docker
self._dockerContainer = dockerContainer
self._dockerExtraArgs = dockerExtraArgs
self._dockerOpenModelicaPath = dockerOpenModelicaPath
self._dockerNetwork = dockerNetwork
self._create_omc_log_file("port")
self._timeout = timeout
self._port_file = os.path.join("/tmp" if docker else self._temp_dir, self._port_file).replace("\\", "/")
self._interactivePort = port
# set omc executable path and args
self._set_omc_command([
"--interactive=zmq",
"--locale=C",
"-z={0}".format(self._random_string)
])
# start up omc executable, which is waiting for the ZMQ connection
self._start_omc_process(timeout)
# connect to the running omc instance using ZMQ
self._connect_to_omc(timeout)
def __del__(self):
OMCSessionBase.__del__(self)
def _connect_to_omc(self, timeout):
self._omc_zeromq_uri = "file:///" + self._port_file
# See if the omc server is running
attempts = 0
self._port = None
while True:
if self._dockerCid:
try:
self._port = subprocess.check_output(["docker", "exec", self._dockerCid, "cat", self._port_file], stderr=subprocess.DEVNULL if (sys.version_info > (3, 0)) else subprocess.STDOUT).decode().strip()
break
except:
pass
else:
if os.path.isfile(self._port_file):
# Read the port file
with open(self._port_file, 'r') as f_p:
self._port = f_p.readline()
os.remove(self._port_file)
break
attempts += 1
if attempts == 80.0:
name = self._omc_log_file.name
self._omc_log_file.close()
logger.error("OMC Server did not start. Please start it! Log-file says:\n%s" % open(name).read())
raise Exception("OMC Server did not start (timeout=%f). Could not open file %s" % (timeout,self._port_file))
time.sleep(timeout / 80.0)
self._port = self._port.replace("0.0.0.0", self._serverIPAddress)
logger.info("OMC Server is up and running at {0} pid={1} cid={2}".format(self._omc_zeromq_uri, self._omc_process.pid, self._dockerCid))
# Create the ZeroMQ socket and connect to OMC server
import zmq
context = zmq.Context.instance()
self._omc = context.socket(zmq.REQ)
self._omc.setsockopt(zmq.LINGER, 0) # Dismisses pending messages if closed
self._omc.setsockopt(zmq.IMMEDIATE, True) # Queue messages only to completed connections
self._omc.connect(self._port)
def execute(self, command):
## check for process is running
return self.sendExpression(command, parsed=False)
def sendExpression(self, command, parsed=True):
## check for process is running
p=self._omc_process.poll()
if (p == None):
attempts = 0
while True:
try:
self._omc.send_string(str(command), flags=zmq.NOBLOCK)
break
except zmq.error.Again:
pass
attempts += 1
if attempts == 50.0:
name = self._omc_log_file.name
self._omc_log_file.close()
raise Exception("No connection with OMC (timeout=%f). Log-file says: \n%s" % (self._timeout, open(name).read()))
time.sleep(self._timeout / 50.0)
if command == "quit()":
self._omc.close()
self._omc = None
return None
else:
result = self._omc.recv_string()
if parsed is True:
answer = OMTypedParser.parseString(result)
return answer
else:
return result
else:
raise Exception("Process Exited, No connection with OMC. Create a new instance of OMCSession")
class ModelicaSystem(object):
def __init__(self, fileName=None, modelName=None, lmodel=[], useCorba=False, commandLineOptions=None, variableFilter=None, customBuildDirectory=None, verbose=True): # 1
"""
"constructor"
It initializes to load file and build a model, generating object, exe, xml, mat, and json files. etc. It can be called :
•without any arguments: In this case it neither loads a file nor build a model. This is useful when a FMU needed to convert to Modelica model
•with two arguments as file name with ".mo" extension and the model name respectively
•with three arguments, the first and second are file name and model name respectively and the third arguments is Modelica standard library to load a model, which is common in such models where the model is based on the standard library. For example, here is a model named "dcmotor.mo" below table 4-2, which is located in the directory of OpenModelica at "C:\\OpenModelica1.9.4-dev.beta2\\share\\doc\\omc\\testmodels".
Note: If the model file is not in the current working directory, then the path where file is located must be included together with file name. Besides, if the Modelica model contains several different models within the same package, then in order to build the specific model, in second argument, user must put the package name with dot(.) followed by specific model name.
ex: myModel = ModelicaSystem("ModelicaModel.mo", "modelName")
"""
if fileName is None and modelName is None and not lmodel: # all None
if useCorba:
self.getconn = OMCSession()
else:
self.getconn = OMCSessionZMQ()
return
self.tree = None
self.quantitiesList=[]
self.paramlist={}
self.inputlist={}
self.outputlist={}
self.continuouslist={}
self.simulateOptions={}
self.overridevariables={}
self.simoptionsoverride={}
self.linearOptions={'startTime':0.0, 'stopTime': 1.0, 'stepSize':0.002, 'tolerance':1e-8}
self.optimizeOptions={'startTime':0.0, 'stopTime': 1.0, 'numberOfIntervals':500, 'stepSize':0.002, 'tolerance':1e-8}
self.linearinputs = [] # linearization input list
self.linearoutputs = [] # linearization output list
self.linearstates = [] # linearization states list
self.tempdir = ""
if useCorba:
self.getconn = OMCSession()
else:
self.getconn = OMCSessionZMQ()
## needed for properly deleting the OMCSessionZMQ
self._omc_log_file = self.getconn._omc_log_file
self._omc_process = self.getconn._omc_process
## set commandLineOptions if provided by users
if commandLineOptions is not None:
exp="".join(["setCommandLineOptions(","\"",commandLineOptions,"\"",")"])
self.getconn.sendExpression(exp)
self.xmlFile = None
self.lmodel = lmodel # may be needed if model is derived from other model
self.modelName = modelName # Model class name
self.fileName = fileName # Model file/package name
self.inputFlag = False # for model with input quantity
self.simulationFlag = False # if the model is simulated?
self.outputFlag = False
self.csvFile = '' # for storing inputs condition
self.resultfile="" # for storing result file
self.variableFilter = variableFilter
if fileName is not None and not os.path.exists(self.fileName): # if file does not eixt
print("File Error:" + os.path.abspath(self.fileName) + " does not exist!!!")
return
## set default command Line Options for linearization as
## linearize() will use the simulation executable and runtime
## flag -l to perform linearization
self.getconn.sendExpression("setCommandLineOptions(\"--linearizationDumpLanguage=python\")")
self.getconn.sendExpression("setCommandLineOptions(\"--generateSymbolicLinearization\")")
self.setTempDirectory(customBuildDirectory)
if fileName is not None:
self.loadFile(verbose)
self.loadLibrary(verbose)
## allow directly loading models from MSL without fileName
if fileName is None and modelName is not None:
self.loadLibrary(verbose)
self.buildModel(variableFilter, verbose)
def __del__(self):
OMCSessionBase.__del__(self)
def setCommandLineOptions(self):
## set commandLineOptions if provided by users
if commandLineOptions is not None:
exp="".join(["setCommandLineOptions(","\"",commandLineOptions,"\"",")"])
cmdexp = self.getconn.sendExpression(exp)
if not cmdexp:
return print(self.getconn.sendExpression("getErrorString()"))
def loadFile(self, verbose):
# load file
loadFileExp="".join(["loadFile(","\"",self.fileName,"\"",")"]).replace("\\","/")
loadMsg = self.getconn.sendExpression(loadFileExp)
## Show notification or warnings to the user when verbose=True OR if some error occurred i.e., not result
if verbose or not loadMsg:
return print(self.getconn.sendExpression("getErrorString()"))
# for loading file/package, loading model and building model
def loadLibrary(self, verbose):
# load Modelica standard libraries or Modelica files if needed
for element in self.lmodel:
if element is not None:
if isinstance(element, str):
if element.endswith(".mo"):
apiCall = "loadFile"
else:
apiCall = "loadModel"
result = self.requestApi(apiCall, element)
elif isinstance(element, tuple):
if not element[1]:
libname = "".join(["loadModel(", element[0], ")"])
else:
libname = "".join(["loadModel(", element[0], ", ", "{", "\"", element[1], "\"", "}", ")"])
result = self.sendExpression(libname)
else:
print("| info | loadLibrary() failed, Unknown type detected: ", element , " is of type ", type(element), ", The following patterns are supported\n1)[\"Modelica\"]\n2)[(\"Modelica\",\"3.2.3\"), \"PowerSystems\"]\n")
## Show notification or warnings to the user when verbose=True OR if some error occurred i.e., not result
if verbose or not result:
print(self.requestApi('getErrorString'))
def setTempDirectory(self, customBuildDirectory):
# create a unique temp directory for each session and build the model in that directory
if customBuildDirectory is not None:
if not os.path.exists(customBuildDirectory):
print(customBuildDirectory, " does not exist")
self.tempdir = customBuildDirectory
else:
self.tempdir = tempfile.mkdtemp()
if not os.path.exists(self.tempdir):
print(self.tempdir, " cannot be created")
exp="".join(["cd(","\"",self.tempdir,"\"",")"]).replace("\\","/")
self.getconn.sendExpression(exp)
def getWorkDirectory(self):
return self.tempdir
def buildModel(self, variableFilter=None, verbose=True):
if variableFilter is not None:
self.variableFilter = variableFilter
if self.variableFilter is not None:
varFilter = "variableFilter=" + "\"" + self.variableFilter + "\""
else:
varFilter = "variableFilter=" + "\".*""\""
# print(varFilter)
# buildModelResult=self.getconn.sendExpression("buildModel("+ mName +")")
buildModelResult = self.requestApi("buildModel", self.modelName, properties=varFilter)
buildModelError = self.requestApi("getErrorString")
if ('' in buildModelResult):
print(buildModelError)
# Issue #145. Always print the getErrorString since it might contains build warnings.
if verbose:
print(buildModelError)
self.xmlFile=os.path.join(os.path.dirname(buildModelResult[0]),buildModelResult[1]).replace("\\","/")
self.xmlparse()
def sendExpression(self,expr,parsed=True):
return self.getconn.sendExpression(expr,parsed)
# request to OMC
def requestApi(self, apiName, entity=None, properties=None): # 2
if (entity is not None and properties is not None):
exp = '{}({}, {})'.format(apiName, entity, properties)
elif entity is not None and properties is None:
if (apiName == "loadFile" or apiName == "importFMU"):
exp = '{}("{}")'.format(apiName, entity)
else:
exp = '{}({})'.format(apiName, entity)
else:
exp = '{}()'.format(apiName)
try:
res = self.getconn.sendExpression(exp)
except Exception as e:
print(e)
res = None
return res
def xmlparse(self):
if(os.path.exists(self.xmlFile)):
self.tree = ET.parse(self.xmlFile)
self.root = self.tree.getroot()
rootCQ = self.root
for attr in rootCQ.iter('DefaultExperiment'):
self.simulateOptions["startTime"]= attr.get('startTime')
self.simulateOptions["stopTime"] = attr.get('stopTime')
self.simulateOptions["stepSize"] = attr.get('stepSize')
self.simulateOptions["tolerance"] = attr.get('tolerance')
self.simulateOptions["solver"] = attr.get('solver')
self.simulateOptions["outputFormat"] = attr.get('outputFormat')
for sv in rootCQ.iter('ScalarVariable'):
scalar={}
scalar["name"] = sv.get('name')
scalar["changeable"] = sv.get('isValueChangeable')
scalar["description"] = sv.get('description')
scalar["variability"] = sv.get('variability')
scalar["causality"] = sv.get('causality')
scalar["alias"] = sv.get('alias')
scalar["aliasvariable"] = sv.get('aliasVariable')
ch = list(sv)
start = None
min = None
max = None