src/KERNEL_PY/__init__.py

   1 #  -*- coding: iso-8859-1 -*-
   2 # Copyright (C) 2007-2021  CEA/DEN, EDF R&D, OPEN CASCADE
   3 #
   4 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   6 #
   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.
  11 #
  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.
  16 #
  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
  20 #
  21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  22 #
  23
  24 #  File   : salome.py renamed as __init__.py for python packaging (gboulant)
  25 #  Author : Paul RASCLE, EDF
  26 #  Module : SALOME
  27 #
  28 """
  29 Module salome gives access to Salome resources.
  30
  31 variables:
  32
  33   - salome.orb             : CORBA
  34   - salome.naming_service  : instance of naming Service class
  35       - methods:
  36           - Resolve(name)  : find a CORBA object (ior) by its pathname
  37           - Register(name) : register a CORBA object under a pathname
  38
  39   - salome.lcc             : instance of lifeCycleCORBA class
  40       - methods:
  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
  45
  46   - salome.sg              : salome object to communicate with the graphical user interface (if any)
  47       - methods:
  48          - updateObjBrowser():
  49
  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
  56
  57          - Display(*Entry):
  58          - DisplayOnly(Entry):
  59          - Erase(Entry):
  60          - DisplayAll():
  61          - EraseAll():
  62
  63          - IDToObject(Entry):    returns CORBA reference from entry
  64
  65   - salome.myStudyName     : active Study Name
  66   - salome.myStudy         : the active Study itself (CORBA ior)
  67       - methods : defined in SALOMEDS.idl
  68
  69 """
  70 ## @package salome
  71 # Module salome gives access to Salome resources.
  72 #
  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)
  79
  80 #
  81 # ==========================================================================
  82 #
  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).
  86 #
  87 ROOT_PYTHONPACKAGE_NAME="salome"
  88 #
  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
  95 # of the type:
  96 #
  97 # <MODULE_ROOT_DIR>/lib/pythonX.Y/site-packages/salome/<ROOT_PYTHONPACKAGE_NAME>
  98 #
  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.
 101 #
 102 import os, sys
 103 from salome_utils import verbose
 104
 105 MATCH_ENDING_PATTERN="site-packages" + os.path.sep + "salome"
 106
 107 def extend_path(pname):
 108     for dir in sys.path:
 109         if not isinstance(dir, str) or not os.path.isdir(dir) or not dir.endswith(MATCH_ENDING_PATTERN):
 110             continue
 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)
 117
 118 extend_path(ROOT_PYTHONPACKAGE_NAME)
 119 # ==========================================================================
 120 #
 121
 122 from salome_kernel import *
 123 from salome_study import *
 124 from salome_iapp import *
 125 import salome_study
 126
 127 #
 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.
 131 #
 132 import sys
 133 flags = None
 134 if not flags:
 135     try:
 136         # dl module can be unavailable
 137         import dl
 138         flags = dl.RTLD_NOW | dl.RTLD_GLOBAL
 139     except:
 140         pass
 141     pass
 142 if not flags:
 143     try:
 144         # DLFCN module can be unavailable
 145         import DLFCN
 146         flags = DLFCN.RTLD_NOW | DLFCN.RTLD_GLOBAL
 147     except:
 148         pass
 149     pass
 150 if not flags:
 151     try:
 152         # ctypes module can be unavailable
 153         import ctypes
 154         flags = ctypes.RTLD_GLOBAL
 155     except:
 156         pass
 157     pass
 158
 159 # Disable -> bug with scipy, seems very dangerous to do that
 160 #if flags:
 161 #    sys.setdlopenflags(flags)
 162 #    pass
 163
 164 orb, lcc, naming_service, cm, sg, esm, dsm, modulcat = None,None,None,None,None,None,None,None
 165 myStudy, myStudyName = None,None
 166
 167 salome_initial=True
 168
 169 __EMB_SERVANT_ENV_VAR_NAME = "SALOME_EMB_SERVANT"
 170
 171 def standalone():
 172     import os
 173     os.environ[__EMB_SERVANT_ENV_VAR_NAME] = "1"
 174     import KernelBasis
 175     KernelBasis.setSSLMode(True)
 176
 177 def salome_init(path=None, embedded=False):
 178     import os
 179     import KernelBasis
 180     if __EMB_SERVANT_ENV_VAR_NAME in os.environ:
 181         KernelBasis.setSSLMode(True)
 182     #
 183     if KernelBasis.getSSLMode():
 184         if KernelBasis.getIOROfEmbeddedNS() == "":
 185             salome_init_without_session(path, embedded)
 186         else:
 187             salome_init_without_session_attached(path, embedded)
 188     else:
 189         salome_init_with_session(path, embedded)
 190
 191 class StandAloneLifecyle:
 192     def __init__(self, containerManager, resourcesManager):
 193         self._cm = containerManager
 194         self._rm = resourcesManager
 195
 196     def FindOrLoadComponent(self,contName,moduleName):
 197         global orb
 198         import importlib
 199         builder_name = moduleName + "_SalomeSessionless"
 200         moduleObj = importlib.import_module(builder_name)
 201         result, orb = moduleObj.buildInstance(orb)
 202         return result
 203         #raise RuntimeError("Undealed situation cont = {} module = {}".format(contName,moduleName))
 204
 205     def getContainerManager(self):
 206       return self._cm
 207
 208     def getResourcesManager(self):
 209       return self._rm
 210
 211 def salome_init_without_session_common(path=None, embedded=False):
 212     global lcc,naming_service,myStudy,orb,modulcat,sg
 213     import KernelBasis
 214     KernelBasis.setSSLMode(True)
 215     import KernelDS
 216     myStudy = KernelDS.myStudy()
 217     import CORBA
 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() )
 223     #
 224     poa = orb.resolve_initial_references("RootPOA")
 225     poaManager = poa._get_the_POAManager()
 226     poaManager.activate()
 227     #
 228     sg = salome_iapp_init(embedded)
 229     salome_study_init_without_session(path)
 230     #
 231     from NamingService import NamingService
 232     naming_service = NamingService()
 233
 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
 242     import sys
 243     if hasattr(sys, 'argv'):
 244       argv = sys.argv
 245     else:
 246       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()
 251
 252 def salome_init_without_session_attached(path=None, embedded=False):
 253     """
 254     Configuration SSL inside a python interpretor launched in the SALOME_Container_No_NS_Serv.
 255     In this configuration,
 256     """
 257     salome_init_without_session_common(path,embedded)
 258     global lcc,cm,dsm,esm
 259     import CORBA
 260     orb=CORBA.ORB_init([''])
 261     import Engines
 262     import KernelBasis
 263     nsAbroad = orb.string_to_object( KernelBasis.getIOROfEmbeddedNS() )
 264     import SALOME
 265     CM_NAME_IN_NS = "/ContainerManager"
 266     cm = orb.string_to_object( nsAbroad.Resolve(CM_NAME_IN_NS).decode() )
 267     naming_service.Register(cm,CM_NAME_IN_NS)
 268     RM_NAME_IN_NS = "/ResourcesManager"
 269     rm = orb.string_to_object( nsAbroad.Resolve(RM_NAME_IN_NS).decode() )
 270     naming_service.Register(rm,RM_NAME_IN_NS)
 271     #
 272     DSM_NAME_IN_NS = "/DataServerManager"
 273     lcc = StandAloneLifecyle(cm,rm)
 274     dsm = orb.string_to_object( nsAbroad.Resolve(DSM_NAME_IN_NS).decode() )
 275     naming_service.Register(dsm,DSM_NAME_IN_NS)
 276     #
 277     ESM_NAME_IN_NS = "/ExternalServers"
 278     esm = orb.string_to_object( nsAbroad.Resolve(ESM_NAME_IN_NS).decode() )
 279     naming_service.Register(esm,ESM_NAME_IN_NS)
 280
 281 def salome_init_with_session(path=None, embedded=False):
 282     """
 283     Performs only once SALOME general purpose initialisation for scripts.
 284     Provides:
 285     orb             reference to CORBA
 286     lcc             a LifeCycleCorba instance
 287     naming_service  a naming service instance
 288     cm              reference to the container manager
 289     esm             reference to external server manager
 290     dsm             reference to shared dataserver manager
 291     modulcat        reference to modulecatalog instance
 292     sg              access to SALOME GUI (when linked with IAPP GUI)
 293     myStudy         active study itself (CORBA reference)
 294     myStudyName     active study name
 295     """
 296     global salome_initial
 297     global orb, lcc, naming_service, cm, esm, dsm, modulcat
 298     global sg
 299     global myStudy, myStudyName
 300     import KernelBasis
 301     KernelBasis.setSSLMode(False)
 302     try:
 303         if salome_initial:
 304             salome_initial=False
 305             sg = salome_iapp_init(embedded)
 306             orb, lcc, naming_service, cm, esm, dsm, modulcat = salome_kernel_init()
 307             myStudy, myStudyName = salome_study_init(path)
 308             pass
 309         pass
 310     except RuntimeError as inst:
 311         # wait a little to avoid trace mix
 312         import time
 313         time.sleep(0.2)
 314         x = inst
 315         print("salome.salome_init():", x)
 316         print("""
 317         ============================================
 318         May be there is no running SALOME session
 319         salome.salome_init() is intended to be used
 320         within an already running session
 321         ============================================
 322         """)
 323         raise
 324
 325 def salome_close():
 326     global salome_initial, myStudy, myStudyName
 327     try:
 328         # study can be clear either from GUI or directly with salome.myStudy.Clear()
 329         myStudy.Clear()
 330     except:
 331         pass
 332     salome_initial=True
 333     salome_iapp_close()
 334     salome_study_close()
 335     myStudy, myStudyName = None, None
 336     import KernelBasis
 337     if KernelBasis.getSSLMode() and not KernelBasis.getGUIMode():
 338         import KernelDS
 339         KernelDS.KillGlobalSessionInstance()
 340         import KernelSDS
 341         KernelSDS.KillCPythonHelper()
 342     pass
 343
 344 def salome_NS():
 345     import CORBA
 346     import CosNaming
 347     orb = CORBA.ORB_init()
 348     ns0 = orb.resolve_initial_references("NameService")
 349     return ns0._narrow(CosNaming.NamingContext)
 350
 351 def salome_walk_on_containers(ns,root):
 352     import CosNaming
 353     it = ns.list(0)[1]
 354     if not it:
 355         return
 356     cont = True
 357     while cont:
 358         cont,obj = it.next_one()
 359         if cont:
 360             if obj.binding_name[0].kind == "object":
 361                 import Engines
 362                 corbaObj = ns.resolve(obj.binding_name)
 363                 if isinstance(corbaObj,Engines._objref_Container):
 364                     yield corbaObj,(root,obj.binding_name[0].id)
 365             else:
 366                 father = ns.resolve([obj.binding_name[0]])
 367                 for elt,elt2 in salome_walk_on_containers(father,root+[obj.binding_name[0].id]):
 368                     yield elt,elt2
 369             pass
 370         pass
 371     pass
 372
 373 def salome_shutdown_containers_with_session():
 374     salome_init()
 375     ns=salome_NS()
 376     li = [elt for elt in salome_walk_on_containers(ns,[""])]
 377     print("Number of containers in NS : {}".format(len(li)))
 378     for cont,(root,cont_name) in li:
 379         try:
 380             cont.Shutdown()
 381         except:
 382             pass
 383         ref_in_ns = "/".join(root+[cont_name])
 384         naming_service.Destroy_Name(ref_in_ns)
 385     print("Number of containers in NS after clean : {}".format( len( list(salome_walk_on_containers(ns,[""])) )))
 386
 387 def salome_shutdown_containers_without_session():
 388     containersEntries = [elt for elt in naming_service.repr() if "/Containers/" == elt[:12]]
 389     for containerEntry in containersEntries:
 390         cont = naming_service.Resolve(containerEntry)
 391         try:
 392             cont.Shutdown()
 393         except:
 394             pass
 395
 396 def salome_shutdown_containers():
 397     import KernelBasis
 398     if KernelBasis.getSSLMode():
 399         salome_shutdown_containers_without_session()
 400     else:
 401         salome_shutdown_containers_with_session()
 402
 403 class SessionContextManager:
 404     def __enter__(self):
 405         standalone()
 406         salome_init()
 407     def __exit__(self, type, value, traceback):
 408         salome_close()
 409
 410 #to expose all objects to pydoc
 411 __all__=dir()