1 # -*- coding: iso-8859-1 -*-
2 # Copyright (C) 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
4 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
7 # This library is free software; you can redistribute it and/or
8 # modify it under the terms of the GNU Lesser General Public
9 # License as published by the Free Software Foundation; either
10 # version 2.1 of the License, or (at your option) any later version.
12 # This library is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # Lesser General Public License for more details.
17 # You should have received a copy of the GNU Lesser General Public
18 # License along with this library; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
24 # File : salome.py renamed as __init__.py for python packaging (gboulant)
25 # Author : Paul RASCLE, EDF
29 Module salome gives access to Salome resources.
34 - salome.naming_service : instance of naming Service class
36 - Resolve(name) : find a CORBA object (ior) by its pathname
37 - Register(name) : register a CORBA object under a pathname
39 - salome.lcc : instance of lifeCycleCORBA class
41 - FindOrLoadComponent(server,name) :
42 obtain an Engine (CORBA object)
43 or launch the Engine if not found,
44 with a Server name and an Engine name
46 - salome.sg : salome object to communicate with the graphical user interface (if any)
50 - SelectedCount(): returns number of selected objects
51 - getSelected(i): returns entry of selected object number i
52 - getAllSelected(): returns list of entry of selected objects
53 - AddIObject(Entry): select an existing Interactive object
54 - RemoveIObject(Entry): remove object from selection
55 - ClearIObjects(): clear selection
63 - IDToObject(Entry): returns CORBA reference from entry
65 - salome.myStudyName : active Study Name
66 - salome.myStudy : the active Study itself (CORBA ior)
67 - methods : defined in SALOMEDS.idl
71 # Module salome gives access to Salome resources.
73 # \param salome.orb : CORBA orb object
74 # \param salome.naming_service : instance of naming Service class (SALOME_NamingServicePy::SALOME_NamingServicePy_i)
75 # \param salome.lcc : instance of lifeCycleCORBA class (SALOME_LifeCycleCORBA)
76 # \param salome.sg : Salome object to communicate with the graphical user interface, if running (see interface in salome_iapp::SalomeOutsideGUI)
77 # \param salome.myStudyName : active Study Name
78 # \param salome.myStudy : the active Study (interface SALOMEDS::Study)
81 # ==========================================================================
83 # The function extend_path is used here to aggregate in a single
84 # virtual python package all the python sub-packages embedded in each
85 # SALOME modules (python "namespace" pattern).
87 ROOT_PYTHONPACKAGE_NAME="salome"
89 # This root package name is expected to be found as a directory in
90 # some paths of the sys.path variable, especially the paths
91 # <MODULE_ROOT_DIR>/lib/pythonX.Y/site-packages/salome where are
92 # installed the python files. These paths are theorically appended by
93 # the SALOME main runner and should be in the sys.path at this point
94 # of the application. The extend_path is looking then for directories
97 # <MODULE_ROOT_DIR>/lib/pythonX.Y/site-packages/salome/<ROOT_PYTHONPACKAGE_NAME>
99 # And append them to the sys.path. These directories are supposed to
100 # be the pieces to be aggregated as a single virtual python package.
103 from salome_utils import verbose
105 MATCH_ENDING_PATTERN="site-packages" + os.path.sep + "salome"
107 def extend_path(pname):
109 if not isinstance(dir, str) or not os.path.isdir(dir) or not dir.endswith(MATCH_ENDING_PATTERN):
111 subdir = os.path.join(dir, pname)
112 # XXX This may still add duplicate entries to path on
113 # case-insensitive filesystems
114 if os.path.isdir(subdir) and subdir not in __path__:
115 if verbose(): print("INFO - The directory %s is appended to sys.path" % subdir)
116 __path__.append(subdir)
118 extend_path(ROOT_PYTHONPACKAGE_NAME)
119 # ==========================================================================
122 from salome_kernel import *
123 from salome_study import *
124 from salome_iapp import *
128 # The next block is workaround for the problem of shared symbols loading for the extension modules (e.g. SWIG-generated)
129 # that causes RTTI unavailable in some cases. To solve this problem, sys.setdlopenflags() function is used.
130 # Depending on the Python version and platform, the dlopen flags can be defined in the dl, DLFUN or ctypes module.
136 # dl module can be unavailable
138 flags = dl.RTLD_NOW | dl.RTLD_GLOBAL
144 # DLFCN module can be unavailable
146 flags = DLFCN.RTLD_NOW | DLFCN.RTLD_GLOBAL
152 # ctypes module can be unavailable
154 flags = ctypes.RTLD_GLOBAL
159 # Disable -> bug with scipy, seems very dangerous to do that
161 # sys.setdlopenflags(flags)
164 orb, lcc, naming_service, cm, sg, esm, dsm, modulcat = None,None,None,None,None,None,None,None
165 myStudy, myStudyName = None,None
169 __EMB_SERVANT_ENV_VAR_NAME = "SALOME_EMB_SERVANT"
173 os.environ[__EMB_SERVANT_ENV_VAR_NAME] = "1"
175 KernelBasis.setSSLMode(True)
177 def salome_init(path=None, embedded=False):
180 if __EMB_SERVANT_ENV_VAR_NAME in os.environ:
181 KernelBasis.setSSLMode(True)
183 if KernelBasis.getSSLMode():
184 if KernelBasis.getIOROfEmbeddedNS() == "":
185 salome_init_without_session(path, embedded)
187 salome_init_without_session_attached(path, embedded)
189 salome_init_with_session(path, embedded)
191 class StandAloneLifecyle:
192 def __init__(self, containerManager, resourcesManager):
193 self._cm = containerManager
194 self._rm = resourcesManager
196 def FindOrLoadComponent(self,contName,moduleName):
199 builder_name = moduleName + "_SalomeSessionless"
200 moduleObj = importlib.import_module(builder_name)
201 result, orb = moduleObj.buildInstance(orb)
203 #raise RuntimeError("Undealed situation cont = {} module = {}".format(contName,moduleName))
205 def getContainerManager(self):
208 def getResourcesManager(self):
211 def salome_init_without_session_common(path=None, embedded=False):
212 global lcc,naming_service,myStudy,orb,modulcat,sg
214 KernelBasis.setSSLMode(True)
216 myStudy = KernelDS.myStudy()
218 orb=CORBA.ORB_init([''])
219 import KernelModuleCatalog
220 import SALOME_ModuleCatalog
221 from salome_kernel import list_of_catalogs_regarding_environement
222 modulcat = KernelModuleCatalog.myModuleCatalog( list_of_catalogs_regarding_environement() )
224 poa = orb.resolve_initial_references("RootPOA")
225 poaManager = poa._get_the_POAManager()
226 poaManager.activate()
228 sg = salome_iapp_init(embedded)
229 salome_study_init_without_session(path)
231 from NamingService import NamingService
232 naming_service = NamingService()
234 def salome_init_without_session(path=None, embedded=False):
235 salome_init_without_session_common(path,embedded)
236 global lcc,cm,dsm,esm
237 import KernelLauncher
238 cm = KernelLauncher.myContainerManager()
239 lcc = StandAloneLifecyle(cm, KernelLauncher.myResourcesManager())
240 # activate poaManager to accept co-localized CORBA calls.
241 from KernelSDS import GetDSMInstance
243 if hasattr(sys, 'argv'):
247 dsm = GetDSMInstance(argv)
248 # esm inherits from SALOME_CPythonHelper singleton already initialized by GetDSMInstance
249 # esm inherits also from SALOME_ResourcesManager creation/initialization (concerning SingleThreadPOA POA) when KernelLauncher.GetContainerManager() has been called
250 esm = KernelLauncher.GetExternalServer()
252 def salome_init_without_session_attached(path=None, embedded=False):
254 Configuration SSL inside a python interpretor launched in the SALOME_Container_No_NS_Serv.
255 In this configuration,
257 salome_init_without_session_common(path,embedded)
258 global lcc,cm,dsm,esm
260 orb=CORBA.ORB_init([''])
263 nsAbroad = orb.string_to_object( KernelBasis.getIOROfEmbeddedNS() )
265 cm = orb.string_to_object( nsAbroad.Resolve("/ContainerManager").decode() )
266 rm = orb.string_to_object( nsAbroad.Resolve("/ResourcesManager").decode() )
267 lcc = StandAloneLifecyle(cm,rm)
268 dsm = orb.string_to_object( nsAbroad.Resolve("/DataServerManager").decode() )
269 esm = orb.string_to_object( nsAbroad.Resolve("/ExternalServers").decode() )
271 def salome_init_with_session(path=None, embedded=False):
273 Performs only once SALOME general purpose initialisation for scripts.
275 orb reference to CORBA
276 lcc a LifeCycleCorba instance
277 naming_service a naming service instance
278 cm reference to the container manager
279 esm reference to external server manager
280 dsm reference to shared dataserver manager
281 modulcat reference to modulecatalog instance
282 sg access to SALOME GUI (when linked with IAPP GUI)
283 myStudy active study itself (CORBA reference)
284 myStudyName active study name
286 global salome_initial
287 global orb, lcc, naming_service, cm, esm, dsm, modulcat
289 global myStudy, myStudyName
291 KernelBasis.setSSLMode(False)
295 sg = salome_iapp_init(embedded)
296 orb, lcc, naming_service, cm, esm, dsm, modulcat = salome_kernel_init()
297 myStudy, myStudyName = salome_study_init(path)
300 except RuntimeError as inst:
301 # wait a little to avoid trace mix
305 print("salome.salome_init():", x)
307 ============================================
308 May be there is no running SALOME session
309 salome.salome_init() is intended to be used
310 within an already running session
311 ============================================
316 global salome_initial, myStudy, myStudyName
318 # study can be clear either from GUI or directly with salome.myStudy.Clear()
325 myStudy, myStudyName = None, None
327 if KernelBasis.getSSLMode():
329 KernelDS.KillGlobalSessionInstance()
331 KernelSDS.KillCPythonHelper()
337 orb = CORBA.ORB_init()
338 ns0 = orb.resolve_initial_references("NameService")
339 return ns0._narrow(CosNaming.NamingContext)
341 def salome_walk_on_containers(ns,root):
348 cont,obj = it.next_one()
350 if obj.binding_name[0].kind == "object":
352 corbaObj = ns.resolve(obj.binding_name)
353 if isinstance(corbaObj,Engines._objref_Container):
354 yield corbaObj,(root,obj.binding_name[0].id)
356 father = ns.resolve([obj.binding_name[0]])
357 for elt,elt2 in salome_walk_on_containers(father,root+[obj.binding_name[0].id]):
363 def salome_shutdown_containers():
366 li = [elt for elt in salome_walk_on_containers(ns,[""])]
367 print("Number of containers in NS : {}".format(len(li)))
368 for cont,(root,cont_name) in li:
373 ref_in_ns = "/".join(root+[cont_name])
374 naming_service.Destroy_Name(ref_in_ns)
375 print("Number of containers in NS after clean : {}".format( len( list(salome_walk_on_containers(ns,[""])) )))
377 class SessionContextManager:
381 def __exit__(self, type, value, traceback):
384 #to expose all objects to pydoc