salome.kernel 9.14.0__cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

salome/bin/salome/appli/python_test_driver.py

@@ -0,0 +1,148 @@
+#!/usr/bin/env python3
+# Copyright (C) 2015-2024  CEA, EDF, OPEN CASCADE
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+"""
+Usage: python_test_driver.py <timeout_delay> <test command> [test command arguments]
+"""
+
+import sys
+import os
+import subprocess
+import signal
+from contextlib import suppress
+
+# Run test
+def runTestBegin(command):
+  print("Running:", " ".join(command))
+  p = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+  return p
+
+def runTestEffective(process):
+  out, err = process.communicate()
+  res = process.returncode
+  # About res value:
+  # A negative value -N indicates that the child was terminated by signal N (Unix only).
+  # On Unix, the value 11 generally corresponds to a segmentation fault.
+  return res, out, err
+#
+
+# Display output and errors
+def processResult(res, out, err):
+  # Decode output
+  out = out.decode('utf_8', errors='ignore') if out else ''
+  err = err.decode('utf_8', errors='ignore') if err else ''
+
+  # Execute hook if it is installed
+  if getattr(processResult, '__hook', None):
+    res, out, err = getattr(processResult, '__hook')(res, out, err)
+
+  # Print standard output
+  if out:
+    print(out)
+
+  # Print standard error
+  if err:
+    print("    ** Detected error **")
+    print("Error code: ", res)
+    print(err, end=' \n')
+    print("    ** end of message **")
+
+  return res
+#
+
+def installHook(hook=None):
+  """Install custome hook to process test result."""
+  with suppress(AttributeError, IndexError):
+    hook = hook.split(',')
+    hook_path = hook.pop(0)
+    hook_func = hook.pop(0)
+    if os.path.exists(hook_path) and hook_func:
+      with open(hook_path, 'rb') as hook_script:
+        dic = {}
+        exec(hook_script.read(), dic)
+        processResult.__hook = dic.get(hook_func)
+        print("Custom hook has been installed")
+#
+
+subPIDToKill = None
+
+# Timeout management
+class TimeoutException(Exception):
+  """Exception raised when test timeout is reached."""
+#
+def timeoutHandler(signum, frame):
+  if subPIDToKill:
+    try:
+      os.kill(subPIDToKill, signal.SIGTERM)
+    except:
+      pass
+  raise TimeoutException()
+#
+
+if __name__ == "__main__":
+  timeout_delay = sys.argv[1]
+  args = sys.argv[2:]
+
+  # Install hook if supplied via command line
+  with suppress(IndexError, ValueError):
+    index = args.index('--hook')
+    args.pop(index)
+    hook = args.pop(index)
+    installHook(hook)
+
+  # Add explicit call to python executable if a Python script is passed as
+  # first argument
+  if not args:
+    print("Invalid arguments for python_test_driver.py. No command defined.")
+    sys.exit(1)
+  _, ext = os.path.splitext(args[0])
+  if ext == ".py":
+    test_and_args = [sys.executable] + args
+  else:
+    test_and_args = args
+
+  # Set timeout handler
+  print("Test timeout explicitly set to: %s seconds"%timeout_delay)
+  timeout_sec = abs(int(timeout_delay)-10)
+  if sys.platform == 'win32':
+    from threading import Timer
+    timer = Timer(timeout_sec, timeoutHandler)
+    timer.start()
+  else:
+    signal.alarm(timeout_sec)
+    signal.signal(signal.SIGALRM, timeoutHandler)
+
+  res = 1
+  try:
+    process = runTestBegin(test_and_args)
+    subPIDToKill = process.pid
+    res, out, err = runTestEffective(process)
+    res = processResult(res, out, err)
+  except TimeoutException:
+    print("FAILED : timeout(%s) is reached"%timeout_delay)
+  except:
+    import traceback
+    traceback.print_exc()
+    pass
+  if sys.platform == 'win32':
+    timer.cancel()
+  print("Exit test with status code:", res)
+  sys.exit(res)
+#

salome/bin/salome/appli/salome

@@ -0,0 +1,193 @@
+#! /usr/bin/env python3
+#  -*- coding: utf-8 -*-
+# Copyright (C) 2025  CEA, EDF
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+import os
+import sys
+import subprocess
+import os.path
+import logging
+from pathlib import Path
+import glob
+import re
+
+# Add the pwdPath to able to run the launcher after unpacking a package
+# Used only in case of a salomeTools package
+out_dir_Path = Path( os.path.realpath(__file__) ).parent.absolute()
+# from /lib/python*/site-packages/salome/bin/salome/appli to /lib
+main_site_packages_tmp = out_dir_Path.parents[5]
+pythonDirInLibCandidate = [ os.path.basename(elt) for elt in glob.glob( f"{main_site_packages_tmp}/python*" ) ]
+if len(pythonDirInLibCandidate) != 1:
+  raise RuntimeError( f"Fail to locate python* in {main_site_packages_tmp}" )
+pythonDir = pythonDirInLibCandidate[0]
+pat = re.compile("^python([\d])\.([\d]+)$")
+if not pat.match(pythonDir):
+  raise RuntimeError( f"Fail to locate pythonX.Y in {main_site_packages_tmp}" )
+main_site_packages = main_site_packages_tmp / pythonDir / "site-packages"
+# Preliminary work to initialize path to SALOME Python modules
+def __initialize():
+
+  # relative to __file__ supposed to be located on bin/salome/appli/salome (see CdC §2.1)
+  sys.path[:0] = [
+    f"{main_site_packages}",
+    f"{out_dir_Path}" # parent directory of the current directory
+]
+
+  # define folder to store omniorb config (initially in virtual application folder)
+  try:
+    from salome.kernel.salomeContextUtils import setOmniOrbUserPath
+    setOmniOrbUserPath()
+  except Exception as e:
+    print(e)
+    sys.exit(1)
+# End of preliminary work
+
+# salome doc only works for virtual applications. Therefore we overwrite it with this function
+def _showDoc(modules):
+    for module in modules:
+      modulePath = os.getenv(module+"_ROOT_DIR")
+      if modulePath != None:
+        baseDir = os.path.join(modulePath, "share", "doc", "salome")
+        docfile = os.path.join(baseDir, "gui", module.upper(), "index.html")
+        if not os.path.isfile(docfile):
+          docfile = os.path.join(baseDir, "tui", module.upper(), "index.html")
+        if not os.path.isfile(docfile):
+          docfile = os.path.join(baseDir, "dev", module.upper(), "index.html")
+        if os.path.isfile(docfile):
+          out, err = subprocess.Popen(["xdg-open", docfile]).communicate()
+        else:
+          print("Online documentation is not accessible for module:", module)
+      else:
+        print(module+"_ROOT_DIR not found!")
+
+def main(args):
+  # Identify application path then locate configuration files
+  __initialize()
+
+  if args == ['--help']:
+    from salomeContext import usage
+    usage()
+    sys.exit(0)
+
+  #from salomeContextUtils import getConfigFileNames
+  #configFileNames, args, unexisting = getConfigFileNames( args, checkExistence=True )
+  #if len(unexisting) > 0:
+  #  print("ERROR: unexisting configuration file(s): " + ', '.join(unexisting))
+  #  sys.exit(1)
+
+  # Create a SalomeContext which parses configFileNames to initialize environment
+  try:
+    from salome.kernel.salomeContext_impl import SalomeContext, SalomeContextException
+    if 'appendVariable' not in dir(SalomeContext):
+      # check whether the appendVariable method is implemented
+      def appendVariable(self, name, value, separator=os.pathsep):
+        if value == '':
+          return
+        value = os.path.expandvars(value) # expand environment variables
+        env = os.getenv(name, None)
+        if env is None:
+          os.environ[name] = value
+        else:
+          os.environ[name] = env + separator + value
+        return
+      SalomeContext.appendVariable = appendVariable
+
+    context = SalomeContext(None)
+    # Here set specific variables, if needed
+    # context.addToPath('mypath')
+    # context.addToLdLibraryPath('myldlibrarypath')
+    # context.addToPythonPath('mypythonpath')
+    # context.setVariable('myvarname', 'value')
+
+    # Logger level error
+    context.getLogger().setLevel( logging.INFO )
+
+    # change this variable to not reset the PATHS"
+    reinitialise_paths=True
+
+    context.setVariable(r"PRODUCT_ROOT_DIR", f"{out_dir_Path}" + r"", overwrite=True)
+
+    # Set the absolute path to the KERNEL root directory
+    appli_path = "{}".format( out_dir_Path.parents[2] )
+    context.getLogger().info( f'appli_path: {appli_path}' )
+    context.setVariable(r"ABSOLUTE_APPLI_PATH", appli_path, overwrite=True)
+    context.setVariable(r"KERNEL_ROOT_DIR", appli_path, overwrite=True)
+
+    # PRODUCT environment
+    context.setVariable(r"SALOME_trace", r"local", overwrite=True)
+    context.setVariable(r"SALOME_MODULES", r"SHAPER,SHAPERSTUDY,GEOM,SMESH,PARAVIS,YACS,JOBMANAGER", overwrite=True)
+    context.setVariable(r"PYTHONIOENCODING", r"UTF_8", overwrite=True)
+    context.setVariable(r"SALOME_MODULES_ORDER", r"SHAPER:SHAPERSTUDY:GEOM:SMESH", overwrite=True)
+    context.setVariable(r"ROOT_SALOME_INSTALL", r"$PRODUCT_ROOT_DIR", overwrite=True)
+    context.setVariable(r"SALOME_ON_DEMAND", r"HIDE", overwrite=True)
+
+
+    #[all products]
+
+    #[Python]
+    context.setVariable(r"PYTHON_ROOT_DIR", r"/usr", overwrite=True)
+    context.setVariable(r"PYTHON_INCLUDE", r"/usr/include/python3.9", overwrite=True)
+    context.setVariable(r"PYTHON_VERSION", r"3.9", overwrite=True)
+    context.setVariable(r"PYTHONBIN", r"/usr/bin/python3", overwrite=True)
+    context.setVariable(r"PYTHON_LIBDIR", r"lib/python${PYTHON_VERSION}/site-packages", overwrite=True)
+
+    #[setuptools]
+    context.setVariable(r"SETUPTOOLS_ROOT_DIR", r"/usr", overwrite=True)
+    context.setVariable(r"SETUPTOOLDIR", r"/usr", overwrite=True)
+
+    #[hook to integrate in launcher additionnal user modules]
+    
+    # Load all files extra.env.d/*.py and call the module's init routine]
+
+    extradir = "{}".format( out_dir_Path / "extra.env.d" )
+
+    if os.path.exists(extradir):
+        import importlib
+        import importlib.util
+        sys.path.insert(0, os.path.join(os.getcwd(), extradir))
+        for filename in sorted(
+            filter(lambda x: os.path.isfile(os.path.join(extradir, x)),
+                   os.listdir(extradir))):
+
+            if filename.endswith(".py"):
+                f = os.path.join(extradir, filename)
+                module_name = os.path.splitext(os.path.basename(f))[0]
+                _specs = importlib.util.find_spec(module_name)
+                _module = importlib.util.module_from_spec(_specs)
+                _specs.loader.exec_module(_module)
+                _module.init(context, out_dir_Path)
+    #[manage salome doc command]
+    if len(args) >1 and args[0]=='doc':
+        _showDoc(args[1:])
+        return
+
+    # Start SALOME, parsing command line arguments
+    out, err, status = context.runSalome(args)
+    sys.exit(status)
+
+  except SalomeContextException as e:
+    logging.getLogger("salome").error(e)
+    sys.exit(1)
+ 
+
+if __name__ == "__main__":
+  args = sys.argv[1:]
+  main(args)
+#

salome/bin/salome/appli/salome_instance.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python3
+# Copyright (C) 2015-2024  CEA, EDF, OPEN CASCADE
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+from salome_instance_impl import SalomeInstance
+
+if __name__ == "__main__":
+  print("##### Start instance...")
+  salome_instance = SalomeInstance.start()
+  port = salome_instance.get_port()
+  print("#####    ...instance started on port %s"%port)
+
+  print("##### Terminate instance running on port %s"%port)
+  salome_instance.stop()
+#

salome/bin/salome/appli/salome_test_driver.py

@@ -0,0 +1,150 @@
+#!/usr/bin/env python3
+# Copyright (C) 2015-2024  CEA, EDF, OPEN CASCADE
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+"""
+Usage: salome_test_driver.py <timeout_delay> <test command> [test command arguments]
+"""
+
+import sys
+import os
+import subprocess
+import signal
+from contextlib import suppress
+
+# Run test
+def runTest(command):
+  print("Running:", " ".join(command))
+  p = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+  out, err = p.communicate()
+  res = p.returncode
+  # About res value:
+  # A negative value -N indicates that the child was terminated by signal N (Unix only).
+  # On Unix, the value 11 generally corresponds to a segmentation fault.
+  return res, out, err
+#
+
+# Display output and errors
+def processResult(res, out, err):
+  # Decode output
+  out = out.decode('utf_8', errors='ignore') if out else ''
+  err = err.decode('utf_8', errors='ignore') if err else ''
+
+  # Execute hook if it is installed
+  if getattr(processResult, '__hook', None):
+    res, out, err = getattr(processResult, '__hook')(res, out, err)
+
+  # Print standard output
+  if out:
+    print(out)
+
+  # Print standard error
+  if err:
+    print("    ** Detected error **")
+    print("Error code: ", res)
+    print(err, end=' \n')
+    print("    ** end of message **")
+
+  return res
+#
+
+def installHook(hook=None):
+  """Install custome hook to process test result."""
+  with suppress(AttributeError, IndexError):
+    hook = hook.split(',')
+    hook_path = hook.pop(0)
+    hook_func = hook.pop(0)
+    if os.path.exists(hook_path) and hook_func:
+      with open(hook_path, 'rb') as hook_script:
+        dic = {}
+        exec(hook_script.read(), dic)
+        processResult.__hook = dic.get(hook_func)
+        print("Custom hook has been installed")
+#
+
+# Timeout management
+class TimeoutException(Exception):
+  """Exception raised when test timeout is reached."""
+#
+def timeoutHandler(signum, frame):
+  raise TimeoutException()
+#
+
+if __name__ == "__main__":
+  print('salome_test_driver.py  sys.argv:', sys.argv)
+  timeout_delay = sys.argv[1]
+  args = sys.argv[2:]
+
+  # Install hook if supplied via command line
+  with suppress(IndexError, ValueError):
+    index = args.index('--hook')
+    args.pop(index)
+    hook = args.pop(index)
+    installHook(hook)
+
+  # Add explicit call to python executable if a Python script is passed as
+  # first argument
+  if not args:
+    print("Invalid arguments for salome_test_driver.py. No command defined.")
+    sys.exit(1)
+  _, ext = os.path.splitext(args[0])
+  if ext == ".py":
+    test_and_args = [sys.executable] + args
+  else:
+    test_and_args = args
+
+  # Ensure OMNIORB_USER_PATH is set
+  from salome.kernel.salomeContextUtils import setOmniOrbUserPath
+  setOmniOrbUserPath()
+
+  # Set timeout handler
+  print("Test timeout explicitly set to: %s seconds"%timeout_delay)
+  timeout_sec = abs(int(timeout_delay)-10)
+  if sys.platform == 'win32':
+    from threading import Timer
+    timer = Timer(timeout_sec, timeoutHandler)
+    timer.start()
+  else:
+    signal.alarm(timeout_sec)
+    signal.signal(signal.SIGALRM, timeoutHandler)
+
+  # Run test in a new SALOME instance
+  from salome.kernel.salome_instance_impl import SalomeInstance
+  res = 1
+  try:
+    salome_instance = SalomeInstance.start(shutdown_servers=True)
+    port = salome_instance.get_port()
+    res, out, err = runTest(test_and_args)
+    res = processResult(res, out, err)
+  except TimeoutException:
+    print("FAILED : timeout(%s) is reached"%timeout_delay)
+  except Exception:
+    import traceback
+    traceback.print_exc()
+    pass
+  try:
+    salome_instance.stop()
+    os.kill(pid, signal.SIGTERM)
+  except Exception:
+    pass
+  if sys.platform == 'win32':
+    timer.cancel()
+  print("Exit test with status code:", res)
+  sys.exit(res)
+#

salome/bin/salome/appli/salome_test_driver_gui.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+# Copyright (C) 2015-2024  CEA, EDF, OPEN CASCADE
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+"""
+Usage: salome_test_driver_gui.py <timeout_delay> <test command> [test command arguments]
+"""
+
+import os
+import signal
+import sys
+
+# Timeout management
+class TimeoutException(Exception):
+  """Exception raised when test timeout is reached."""
+#
+def timeoutHandler(signum, frame):
+  raise TimeoutException()
+#
+
+if __name__ == "__main__":
+  timeout_delay = sys.argv[1]
+  args = sys.argv[2:]
+
+  # Add explicit call to python executable if a Python script is passed as
+  # first argument
+  if not args:
+    print("Invalid arguments for salome_test_driver_gui.py. No command defined.")
+    sys.exit(1)
+  _, ext = os.path.splitext(args[0])
+  test_and_args = args
+
+  # Ensure OMNIORB_USER_PATH is set
+  from salomeContextUtils import setOmniOrbUserPath
+  setOmniOrbUserPath()
+
+  # Set timeout handler
+  print("Test timeout explicitly set to: %s seconds"%timeout_delay)
+  timeout_sec = abs(int(timeout_delay)-10)
+  if sys.platform == 'win32':
+    from threading import Timer
+    timer = Timer(timeout_sec, timeoutHandler)
+    timer.start()
+  else:
+    signal.alarm(timeout_sec)
+    signal.signal(signal.SIGALRM, timeoutHandler)
+
+  # Run test in a new SALOME instance
+  from salome_instance import SalomeInstance
+  try:
+    salome_instance = SalomeInstance.start(with_gui=True, args=test_and_args)
+  except TimeoutException:
+    print("FAILED : timeout(%s) is reached"%timeout_delay)
+  except Exception:
+    import traceback
+    traceback.print_exc()
+    pass
+  try:
+    salome_instance.stop()
+  except Exception:
+    pass
+  if sys.platform == 'win32':
+    timer.cancel()
+#  print("Exit test with status code:", res)
+#  sys.exit(res)
+#

salome/bin/salome/appli_clean.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+# Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
+#
+# Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+# CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+#clean appli
+
+DELCOM="rm -rf bin lib share doc idl env.d envd venv USERS getAppliPath.py runRemote.sh SalomeApp.xml update_catalogs.py kill_remote_containers.py salome .salome_run salome_common.py salome_mesa __pycache__ *.pyc *~ .bashrc"
+DOIT="false"
+
+if [ $# -gt 0 ]
+then
+  if [ "x$1" == "x-f" ]
+  then
+     DOIT="true"
+  fi
+fi
+
+if [ $DOIT == "false" ]
+then
+  echo "Do you want to delete a SALOME application in this directory ? " `pwd`
+  echo "command to execute: " $DELCOM
+  echo "enter yes or no"
+  read ANSWER
+  echo "ANSWER="$ANSWER
+  if [ "x$ANSWER" == "xyes" ]
+  then
+    DOIT="true"
+  fi
+fi
+
+if [ $DOIT == "true" ]
+then
+  $DELCOM
+fi