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
174 KernelBasis.setSSLMode(False)
176 def salome_init(path=None, embedded=False):
178 if KernelBasis.getSSLMode():
179 if KernelBasis.getIOROfEmbeddedNS() == "":
180 salome_init_without_session(path, embedded)
182 salome_init_without_session_attached(path, embedded)
184 salome_init_with_session(path, embedded)
186 def salome_init_without_session_common(path=None, embedded=False):
187 from ORBConfigFile import writeORBConfigFileSSL
188 OMNIORB_USER_PATH = "OMNIORB_USER_PATH"
189 def RemoveOmniorbConfigFile():
191 if "OMNIORB_CONFIG" in os.environ:
192 fileToRemove = os.environ["OMNIORB_CONFIG"]
193 if os.path.exists(fileToRemove):
194 os.unlink(fileToRemove)
196 if OMNIORB_USER_PATH in os.environ:
198 writeORBConfigFileSSL(os.environ[OMNIORB_USER_PATH],kwargs={"with_pid":True})
199 atexit.register(RemoveOmniorbConfigFile)
201 global lcc,naming_service,myStudy,orb,modulcat,sg
203 KernelBasis.setSSLMode(True)
205 myStudy = KernelDS.myStudy()
207 orb=CORBA.ORB_init([''])
208 import KernelModuleCatalog
209 import SALOME_ModuleCatalog
210 from salome_kernel import list_of_catalogs_regarding_environement
211 modulcat = KernelModuleCatalog.myModuleCatalog( list_of_catalogs_regarding_environement() )
213 poa = orb.resolve_initial_references("RootPOA")
214 poaManager = poa._get_the_POAManager()
215 poaManager.activate()
217 sg = salome_iapp_init(embedded)
218 salome_study_init_without_session(path)
220 from NamingService import NamingService
221 naming_service = NamingService()
223 def salome_init_without_session(path=None, embedded=False):
224 salome_init_without_session_common(path,embedded)
225 global lcc,cm,dsm,esm
226 import KernelLauncher
227 cm = KernelLauncher.myContainerManager()
228 from LifeCycleCORBA import LifeCycleCORBASSL
229 lcc = LifeCycleCORBASSL()
230 # create a FactoryServer Container servant
231 import KernelContainer
232 KernelContainer.myContainer()
233 # activate poaManager to accept co-localized CORBA calls.
234 from KernelSDS import GetDSMInstance
236 if hasattr(sys, 'argv'):
240 dsm = GetDSMInstance(argv)
241 # esm inherits from SALOME_CPythonHelper singleton already initialized by GetDSMInstance
242 # esm inherits also from SALOME_ResourcesManager creation/initialization (concerning SingleThreadPOA POA) when KernelLauncher.GetContainerManager() has been called
243 esm = KernelLauncher.GetExternalServer()
245 def salome_init_without_session_attached(path=None, embedded=False):
247 Configuration SSL inside a python interpretor launched in the SALOME_Container_No_NS_Serv.
248 In this configuration,
250 salome_init_without_session_common(path,embedded)
251 global lcc,cm,dsm,esm
253 orb=CORBA.ORB_init([''])
256 nsAbroad = orb.string_to_object( KernelBasis.getIOROfEmbeddedNS() )
258 CM_NAME_IN_NS = "/ContainerManager"
259 cm = orb.string_to_object( nsAbroad.Resolve(CM_NAME_IN_NS).decode() )
260 naming_service.Register(cm,CM_NAME_IN_NS)
261 RM_NAME_IN_NS = "/ResourcesManager"
262 rm = orb.string_to_object( nsAbroad.Resolve(RM_NAME_IN_NS).decode() )
263 naming_service.Register(rm,RM_NAME_IN_NS)
265 from LifeCycleCORBA import LifeCycleCORBASSL
266 lcc = LifeCycleCORBASSL()
267 DSM_NAME_IN_NS = "/DataServerManager"
268 dsm = orb.string_to_object( nsAbroad.Resolve(DSM_NAME_IN_NS).decode() )
269 naming_service.Register(dsm,DSM_NAME_IN_NS)
271 ESM_NAME_IN_NS = "/ExternalServers"
272 esm = orb.string_to_object( nsAbroad.Resolve(ESM_NAME_IN_NS).decode() )
273 naming_service.Register(esm,ESM_NAME_IN_NS)
275 def salome_init_with_session(path=None, embedded=False):
277 Performs only once SALOME general purpose initialisation for scripts.
279 orb reference to CORBA
280 lcc a LifeCycleCorba instance
281 naming_service a naming service instance
282 cm reference to the container manager
283 esm reference to external server manager
284 dsm reference to shared dataserver manager
285 modulcat reference to modulecatalog instance
286 sg access to SALOME GUI (when linked with IAPP GUI)
287 myStudy active study itself (CORBA reference)
288 myStudyName active study name
290 global salome_initial
291 global orb, lcc, naming_service, cm, esm, dsm, modulcat
293 global myStudy, myStudyName
295 KernelBasis.setSSLMode(False)
299 sg = salome_iapp_init(embedded)
300 orb, lcc, naming_service, cm, esm, dsm, modulcat = salome_kernel_init()
301 myStudy, myStudyName = salome_study_init(path)
304 except RuntimeError as inst:
305 # wait a little to avoid trace mix
309 print("salome.salome_init():", x)
311 ============================================
312 May be there is no running SALOME session
313 salome.salome_init() is intended to be used
314 within an already running session
315 ============================================
320 global salome_initial, myStudy, myStudyName
322 # study can be clear either from GUI or directly with salome.myStudy.Clear()
329 myStudy, myStudyName = None, None
331 if KernelBasis.getSSLMode() and not KernelBasis.getGUIMode():
333 KernelDS.KillGlobalSessionInstance()
335 KernelSDS.KillCPythonHelper()
341 orb = CORBA.ORB_init()
342 ns0 = orb.resolve_initial_references("NameService")
343 return ns0._narrow(CosNaming.NamingContext)
345 def salome_walk_on_containers(ns,root):
352 cont,obj = it.next_one()
354 if obj.binding_name[0].kind == "object":
356 corbaObj = ns.resolve(obj.binding_name)
357 if isinstance(corbaObj,Engines._objref_Container):
358 yield corbaObj,(root,obj.binding_name[0].id)
360 father = ns.resolve([obj.binding_name[0]])
361 for elt,elt2 in salome_walk_on_containers(father,root+[obj.binding_name[0].id]):
367 def salome_shutdown_containers_with_session():
370 li = [elt for elt in salome_walk_on_containers(ns,[""])]
371 print("Number of containers in NS : {}".format(len(li)))
372 for cont,(root,cont_name) in li:
377 ref_in_ns = "/".join(root+[cont_name])
378 naming_service.Destroy_Name(ref_in_ns)
379 print("Number of containers in NS after clean : {}".format( len( list(salome_walk_on_containers(ns,[""])) )))
381 def salome_shutdown_containers_without_session():
382 containersEntries = [elt for elt in naming_service.repr() if "/Containers/" == elt[:12]]
383 for containerEntry in containersEntries:
384 cont = naming_service.Resolve(containerEntry)
390 def salome_shutdown_containers():
392 if KernelBasis.getSSLMode():
393 salome_shutdown_containers_without_session()
395 salome_shutdown_containers_with_session()
397 class SessionContextManager:
401 def __exit__(self, type, value, traceback):
404 #to expose all objects to pydoc