1 # -*- coding: iso-8859-1 -*-
2 # Copyright (C) 2007-2022 CEA/DEN, EDF R&D, OPEN CASCADE
4 # This library is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU Lesser General Public
6 # License as published by the Free Software Foundation; either
7 # version 2.1 of the License, or (at your option) any later version.
9 # This library is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 # Lesser General Public License for more details.
14 # You should have received a copy of the GNU Lesser General Public
15 # License along with this library; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 # File : SALOME_PyNode.py
22 # Author : Christian CAREMOLI, EDF
33 class Generic(SALOME__POA.GenericObj):
34 """A Python implementation of the GenericObj CORBA IDL"""
35 def __init__(self,poa):
40 #print("Register called : %d"%self.cnt)
44 #print("UnRegister called : %d"%self.cnt)
47 oid=self.poa.servant_to_id(self)
48 self.poa.deactivate_object(oid)
51 print("WARNING SALOME::GenericObj::Destroy() function is obsolete! Use UnRegister() instead.")
55 #print("Destuctor called")
58 class PyNode_i (Engines__POA.PyNode,Generic):
59 """The implementation of the PyNode CORBA IDL"""
60 def __init__(self, nodeName,code,poa,my_container):
61 """Initialize the node : compilation in the local context"""
62 Generic.__init__(self,poa)
63 self.nodeName=nodeName
65 self.my_container=my_container._container
66 linecache.cache[nodeName]=0,None,code.split('\n'),nodeName
67 ccode=compile(code,nodeName,'exec')
69 self.context["my_container"] = self.my_container
70 exec(ccode, self.context)
72 def getContainer(self):
73 return self.my_container
81 def defineNewCustomVar(self,varName,valueOfVar):
82 self.context[varName] = pickle.loads(valueOfVar)
85 def executeAnotherPieceOfCode(self,code):
86 """Called for initialization of container lodging self."""
88 ccode=compile(code,self.nodeName,'exec')
89 exec(ccode, self.context)
91 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"","PyScriptNode (%s) : code to be executed \"%s\"" %(self.nodeName,code),0))
93 def execute(self,funcName,argsin):
94 """Execute the function funcName found in local context with pickled args (argsin)"""
96 argsin,kws=pickle.loads(argsin)
97 func=self.context[funcName]
98 argsout=func(*argsin,**kws)
99 argsout=pickle.dumps(argsout,-1)
102 exc_typ,exc_val,exc_fr=sys.exc_info()
103 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
104 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyNode: %s, function: %s" % (self.nodeName,funcName),0))
106 class SenderByte_i(SALOME__POA.SenderByte,Generic):
107 def __init__(self,poa,bytesToSend):
108 Generic.__init__(self,poa)
109 self.bytesToSend = bytesToSend
112 return len(self.bytesToSend)
114 def sendPart(self,n1,n2):
115 return self.bytesToSend[n1:n2]
117 SALOME_FILE_BIG_OBJ_DIR = "SALOME_FILE_BIG_OBJ_DIR"
119 SALOME_BIG_OBJ_ON_DISK_THRES_VAR = "SALOME_BIG_OBJ_ON_DISK_THRES"
122 SALOME_BIG_OBJ_ON_DISK_THRES_DFT = 50000000
124 def GetBigObjectOnDiskThreshold():
126 if SALOME_BIG_OBJ_ON_DISK_THRES_VAR in os.environ:
127 return int( os.environ[SALOME_BIG_OBJ_ON_DISK_THRES_VAR] )
129 return SALOME_BIG_OBJ_ON_DISK_THRES_DFT
131 def GetBigObjectDirectory():
133 if SALOME_FILE_BIG_OBJ_DIR not in os.environ:
134 raise RuntimeError("An object of size higher than limit detected and no directory specified to dump it in file !")
135 return os.path.expandvars( os.path.expandvars( os.environ[SALOME_FILE_BIG_OBJ_DIR] ) )
137 def GetBigObjectFileName():
139 Return a filename in the most secure manner (see tempfile documentation)
142 with tempfile.NamedTemporaryFile(dir=GetBigObjectDirectory(),prefix="mem_",suffix=".pckl") as f:
146 class BigObjectOnDiskBase:
147 def __init__(self, fileName, objSerialized):
149 :param fileName: the file used to dump into.
150 :param objSerialized: the object in pickeled form
151 :type objSerialized: bytes
153 self._filename = fileName
154 self._destroy = False
155 self.__dumpIntoFile(objSerialized)
157 def getDestroyStatus(self):
160 def unlinkOnDestructor(self):
163 def doNotTouchFile(self):
165 Method called slave side. The life cycle management of file is client side not slave side.
167 self._destroy = False
172 os.unlink( self._filename )
174 def getFileName(self):
175 return self._filename
177 def __dumpIntoFile(self, objSerialized):
178 with open(self._filename,"wb") as f:
179 f.write(objSerialized)
183 with open(self._filename,"rb") as f:
184 return pickle.load(f)
186 class BigObjectOnDisk(BigObjectOnDiskBase):
187 def __init__(self, fileName, objSerialized):
188 BigObjectOnDiskBase.__init__(self, fileName, objSerialized)
190 class BigObjectOnDiskListElement(BigObjectOnDiskBase):
191 def __init__(self, pos, length, fileName):
192 self._filename = fileName
193 self._destroy = False
195 self._length = length
198 fullObj = BigObjectOnDiskBase.get(self)
199 return fullObj[ self._pos ]
201 class BigObjectOnDiskSequence(BigObjectOnDiskBase):
202 def __init__(self, length, fileName, objSerialized):
203 BigObjectOnDiskBase.__init__(self, fileName, objSerialized)
204 self._length = length
206 def __getitem__(self, i):
207 return BigObjectOnDiskListElement(i, self._length, self.getFileName())
212 class BigObjectOnDiskList(BigObjectOnDiskSequence):
213 def __init__(self, length, fileName, objSerialized):
214 BigObjectOnDiskSequence.__init__(self, length, fileName, objSerialized)
216 class BigObjectOnDiskTuple(BigObjectOnDiskSequence):
217 def __init__(self, length, fileName, objSerialized):
218 BigObjectOnDiskSequence.__init__(self, length, fileName, objSerialized)
220 def SpoolPickleObject( obj ):
222 pickleObjInit = pickle.dumps( obj , pickle.HIGHEST_PROTOCOL )
223 if len(pickleObjInit) < GetBigObjectOnDiskThreshold():
226 if isinstance( obj, list):
227 proxyObj = BigObjectOnDiskList( len(obj), GetBigObjectFileName() , pickleObjInit )
228 elif isinstance( obj, tuple):
229 proxyObj = BigObjectOnDiskTuple( len(obj), GetBigObjectFileName() , pickleObjInit )
231 proxyObj = BigObjectOnDisk( GetBigObjectFileName() , pickleObjInit )
232 pickleProxy = pickle.dumps( proxyObj , pickle.HIGHEST_PROTOCOL )
235 def UnProxyObject( obj ):
236 if isinstance(obj,BigObjectOnDiskBase):
239 if isinstance(obj,list) or isinstance(obj,tuple):
241 if isinstance(elt,BigObjectOnDiskBase):
246 class SeqByteReceiver:
247 # 2GB limit to trigger split into chunks
248 CHUNK_SIZE = 2000000000
249 def __init__(self,sender):
252 self._obj.UnRegister()
255 size = self._obj.getSize()
256 if size <= SeqByteReceiver.CHUNK_SIZE:
257 return self.fetchOneShot( size )
259 return self.fetchByChunks( size )
260 def fetchOneShot(self,size):
261 return self._obj.sendPart(0,size)
262 def fetchByChunks(self,size):
264 To avoid memory peak parts over 2GB are sent using EFF_CHUNK_SIZE size.
266 data_for_split_case = bytes(0)
267 EFF_CHUNK_SIZE = SeqByteReceiver.CHUNK_SIZE // 8
268 iStart = 0 ; iEnd = EFF_CHUNK_SIZE
269 while iStart!=iEnd and iEnd <= size:
270 part = self._obj.sendPart(iStart,iEnd)
271 data_for_split_case = bytes(0).join( [data_for_split_case,part] )
272 iStart = iEnd; iEnd = min(iStart + EFF_CHUNK_SIZE,size)
273 return data_for_split_case
275 class PyScriptNode_i (Engines__POA.PyScriptNode,Generic):
276 """The implementation of the PyScriptNode CORBA IDL that executes a script"""
277 def __init__(self, nodeName,code,poa,my_container):
278 """Initialize the node : compilation in the local context"""
279 Generic.__init__(self,poa)
280 self.nodeName=nodeName
282 self.my_container=my_container._container
283 linecache.cache[nodeName]=0,None,code.split('\n'),nodeName
284 self.ccode=compile(code,nodeName,'exec')
286 self.context["my_container"] = self.my_container
288 def getContainer(self):
289 return self.my_container
297 def defineNewCustomVar(self,varName,valueOfVar):
298 self.context[varName] = pickle.loads(valueOfVar)
301 def executeAnotherPieceOfCode(self,code):
302 """Called for initialization of container lodging self."""
304 ccode=compile(code,self.nodeName,'exec')
305 exec(ccode, self.context)
307 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"","PyScriptNode (%s) : code to be executed \"%s\"" %(self.nodeName,code),0))
309 def assignNewCompiledCode(self,codeStr):
312 self.ccode=compile(codeStr,self.nodeName,'exec')
314 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"","PyScriptNode.assignNewCompiledCode (%s) : code to be executed \"%s\"" %(self.nodeName,codeStr),0))
316 def execute(self,outargsname,argsin):
317 """Execute the script stored in attribute ccode with pickled args (argsin)"""
319 argsname,kws=pickle.loads(argsin)
320 self.context.update(kws)
321 exec(self.ccode, self.context)
323 for arg in outargsname:
324 if arg not in self.context:
325 raise KeyError("There is no variable %s in context" % arg)
326 argsout.append(self.context[arg])
327 argsout=pickle.dumps(tuple(argsout),-1)
330 exc_typ,exc_val,exc_fr=sys.exc_info()
331 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
332 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s, outargsname: %s" % (self.nodeName,outargsname),0))
334 def executeFirst(self,argsin):
335 """ Same than first part of self.execute to reduce memory peak."""
339 if True: # to force call of SeqByteReceiver's destructor
340 argsInPy = SeqByteReceiver( argsin )
341 data = argsInPy.data()
342 _,kws=pickle.loads(data)
344 # fetch real data if necessary
345 kws[elt] = UnProxyObject( kws[elt] )
346 self.context.update(kws)
348 exc_typ,exc_val,exc_fr=sys.exc_info()
349 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
350 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode:First %s" % (self.nodeName),0))
352 def executeSecond(self,outargsname):
353 """ Same than second part of self.execute to reduce memory peak."""
355 exec(self.ccode, self.context)
357 for arg in outargsname:
358 if arg not in self.context:
359 raise KeyError("There is no variable %s in context" % arg)
360 argsout.append(self.context[arg])
363 # the proxy mecanism is catched here
364 argPickle = SpoolPickleObject( arg )
365 retArg = SenderByte_i( self.poa,argPickle )
366 id_o = self.poa.activate_object(retArg)
367 retObj = self.poa.id_to_reference(id_o)
368 ret.append( retObj._narrow( SALOME.SenderByte ) )
371 exc_typ,exc_val,exc_fr=sys.exc_info()
372 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
373 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode:Second %s, outargsname: %s" % (self.nodeName,outargsname),0))
375 def listAllVarsInContext(self):
377 pat = re.compile("^__([a-z]+)__$")
378 return [elt for elt in self.context if not pat.match(elt)]
380 def removeAllVarsInContext(self):
381 for elt in self.listAllVarsInContext():
382 del self.context[elt]
384 def getValueOfVarInContext(self,varName):
386 return pickle.dumps(self.context[varName],-1)
388 exc_typ,exc_val,exc_fr=sys.exc_info()
389 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
390 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" %self.nodeName,0))
393 def assignVarInContext(self, varName, value):
395 self.context[varName][0] = pickle.loads(value)
397 exc_typ,exc_val,exc_fr=sys.exc_info()
398 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
399 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" %self.nodeName,0))
402 def callMethodOnVarInContext(self, varName, methodName, args):
404 return pickle.dumps( getattr(self.context[varName][0],methodName)(*pickle.loads(args)),-1 )
406 exc_typ,exc_val,exc_fr=sys.exc_info()
407 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
408 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" %self.nodeName,0))