1 #! /usr/bin/env python3
2 # Copyright (C) 2013-2019 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
26 from parseConfigFile import parseConfigFile
33 from salomeContextUtils import SalomeContextException
37 Usage: salome [command] [options] [--config=<file,folder,...>]
41 start Start a new SALOME instance.
42 context Initialize SALOME context. Current environment is extended.
43 shell Initialize SALOME context, attached to the last created SALOME
44 instance if any, and executes scripts passed as command arguments.
45 User works in a Shell terminal. SALOME environment is set but
46 application is not started.
47 connect Connect a Python console to the active SALOME instance.
48 remote run command in SALOME environment from remote call, ssh or rsh.
49 kill <port(s)> Terminate SALOME instances running on given ports for current user.
50 Port numbers must be separated by blank characters.
51 killall Terminate *all* SALOME running instances for current user.
52 Do not start a new one.
53 test Run SALOME tests.
54 info Display some information about SALOME.
55 doc <module(s)> Show online module documentation (if available).
56 Module names must be separated by blank characters.
57 help Show this message.
59 If no command is given, default is start.
63 Use salome <command> --help to show help on command. Available for the
64 following commands: start, shell, connect, test, info.
66 --config=<file,folder,...>
67 ==========================
68 Initialize SALOME context from a list of context files and/or a list
69 of folders containing context files. The list is comma-separated, without
77 The SalomeContext class in an API to configure SALOME context then
78 start SALOME using a single python command.
83 Initialize context from a list of configuration files
84 identified by their names.
85 These files should be in appropriate .cfg format.
87 def __init__(self, configFileNames=0):
88 self.getLogger().setLevel(logging.INFO)
89 #it could be None explicitly (if user use multiples setVariable...for standalone)
90 if configFileNames is None:
92 configFileNames = configFileNames or []
93 if len(configFileNames) == 0:
94 raise SalomeContextException("No configuration files given")
96 reserved=['PATH', 'DYLD_FALLBACK_LIBRARY_PATH', 'DYLD_LIBRARY_PATH', 'LD_LIBRARY_PATH', 'PYTHONPATH', 'MANPATH', 'PV_PLUGIN_PATH', 'INCLUDE', 'LIBPATH', 'SALOME_PLUGINS_PATH', 'LIBRARY_PATH', 'QT_PLUGIN_PATH']
97 for filename in configFileNames:
98 basename, extension = os.path.splitext(filename)
99 if extension == ".cfg":
100 self.__setContextFromConfigFile(filename, reserved)
102 self.getLogger().error("Unrecognized extension for configuration file: %s", filename)
105 def __loadEnvModules(self, env_modules):
106 modulecmd = os.getenv('LMOD_CMD')
108 raise SalomeContextException("Module environment not present")
111 out, err = subprocess.Popen([modulecmd, "python", "load"] + env_modules, stdout=subprocess.PIPE).communicate()
112 exec(out) # define specific environment variables
114 raise SalomeContextException("Failed to load env modules: %s ..." % ' '.join(env_modules))
118 def runSalome(self, args):
120 # Run this module as a script, in order to use appropriate Python interpreter
121 # according to current path (initialized from context files).
122 env_modules_option = "--with-env-modules="
123 env_modules_l = [x for x in args if x.startswith(env_modules_option)]
125 env_modules = env_modules_l[-1][len(env_modules_option):].split(',')
126 self.__loadEnvModules(env_modules)
127 args = [x for x in args if not x.startswith(env_modules_option)]
129 env_modules = os.getenv("SALOME_ENV_MODULES", None)
131 self.__loadEnvModules(env_modules.split(','))
133 absoluteAppliPath = os.getenv('ABSOLUTE_APPLI_PATH','')
134 env_copy = os.environ.copy()
135 selfBytes= pickle.dumps(self, protocol=0)
136 argsBytes= pickle.dumps(args, protocol=0)
137 proc = subprocess.Popen(['python3', os.path.join(absoluteAppliPath,"bin","salome","salomeContext.py"), selfBytes.decode(), argsBytes.decode()], shell=False, close_fds=True, env=env_copy)
138 out, err = proc.communicate()
139 return out, err, proc.returncode
142 """Append value to PATH environment variable"""
143 def addToPath(self, value):
144 self.addToVariable('PATH', value)
147 """Append value to LD_LIBRARY_PATH environment variable"""
148 def addToLdLibraryPath(self, value):
149 if platform.system() == 'Windows':
150 self.addToVariable('PATH', value)
151 elif platform.system() == 'Darwin':
152 if "LAPACK" in value:
153 self.addToVariable('DYLD_FALLBACK_LIBRARY_PATH', value)
155 self.addToVariable('DYLD_LIBRARY_PATH', value)
157 self.addToVariable('LD_LIBRARY_PATH', value)
160 """Append value to DYLD_LIBRARY_PATH environment variable"""
161 def addToDyldLibraryPath(self, value):
162 self.addToVariable('DYLD_LIBRARY_PATH', value)
165 """Append value to PYTHONPATH environment variable"""
166 def addToPythonPath(self, value):
167 self.addToVariable('PYTHONPATH', value)
170 """Set environment variable to value"""
171 def setVariable(self, name, value, overwrite=False):
172 env = os.getenv(name, '')
173 if env and not overwrite:
174 self.getLogger().error("Environment variable already existing (and not overwritten): %s=%s", name, value)
178 self.getLogger().debug("Overwriting environment variable: %s=%s", name, value)
180 value = os.path.expandvars(value) # expand environment variables
181 self.getLogger().debug("Set environment variable: %s=%s", name, value)
182 os.environ[name] = value
185 """Unset environment variable"""
186 def unsetVariable(self, name):
187 if os.environ.has_key(name):
191 """Append value to environment variable"""
192 def addToVariable(self, name, value, separator=os.pathsep):
196 value = os.path.expandvars(value) # expand environment variables
197 self.getLogger().debug("Add to %s: %s", name, value)
198 env = os.getenv(name, None)
200 os.environ[name] = value
202 os.environ[name] = value + separator + env
205 ###################################
206 # This begins the private section #
207 ###################################
209 def __parseArguments(self, args):
210 if len(args) == 0 or args[0].startswith("-"):
216 availableCommands = {
217 'start' : '_runAppli',
218 'context' : '_setContext',
219 'shell' : '_runSession',
220 'remote' : '_runRemote',
221 'connect' : '_runConsole',
223 'killall' : '_killAll',
224 'test' : '_runTests',
225 'info' : '_showInfo',
228 'coffee' : '_makeCoffee',
232 if command not in availableCommands:
236 return availableCommands[command], options
241 Args consist in a mandatory command followed by optional parameters.
242 See usage for details on commands.
244 def _startSalome(self, args):
248 from setenv import add_path
249 absoluteAppliPath = os.getenv('ABSOLUTE_APPLI_PATH')
250 path = os.path.realpath(os.path.join(absoluteAppliPath, "bin", "salome"))
251 add_path(path, "PYTHONPATH")
252 path = os.path.realpath(os.path.join(absoluteAppliPath, "bin", "salome", "appliskel"))
253 add_path(path, "PYTHONPATH")
258 command, options = self.__parseArguments(args)
262 if args and args[0] in ["-h","--help","help"]:
265 # try to default to "start" command
266 command = "_runAppli"
269 res = getattr(self, command)(options) # run appropriate method
271 except SystemExit as ex:
273 self.getLogger().error("SystemExit %s in method %s.", ex.code, command)
275 except SalomeContextException as e:
276 self.getLogger().error(e)
279 self.getLogger().error("Unexpected error:")
281 traceback.print_exc()
285 def __setContextFromConfigFile(self, filename, reserved=None):
289 unsetVars, configVars, reservedDict = parseConfigFile(filename, reserved)
290 except SalomeContextException as e:
292 self.getLogger().error(msg)
296 for var in unsetVars:
297 self.unsetVariable(var)
300 for reserved in reservedDict:
301 a = [_f for _f in reservedDict[reserved] if _f] # remove empty elements
302 a = [ os.path.realpath(x) for x in a ]
303 reformattedVals = os.pathsep.join(a)
304 if reserved in ["INCLUDE", "LIBPATH"]:
305 self.addToVariable(reserved, reformattedVals, separator=' ')
307 self.addToVariable(reserved, reformattedVals)
310 for key,val in configVars:
311 self.setVariable(key, val, overwrite=True)
314 pythonpath = os.getenv('PYTHONPATH','').split(os.pathsep)
315 pythonpath = [ os.path.realpath(x) for x in pythonpath ]
316 sys.path[:0] = pythonpath
319 def _runAppli(self, args=None):
322 # Initialize SALOME environment
323 sys.argv = ['runSalome'] + args
325 setenv.main(True, exeName="salome start")
328 runSalome.runSalome()
332 def _setContext(self, args=None):
333 salome_context_set = os.getenv("SALOME_CONTEXT_SET")
334 if salome_context_set:
336 print("*** SALOME context has already been set.")
337 print("*** Enter 'exit' (only once!) to leave SALOME context.")
341 os.environ["SALOME_CONTEXT_SET"] = "yes"
343 print("*** SALOME context is now set.")
344 print("*** Enter 'exit' (only once!) to leave SALOME context.")
348 proc = subprocess.Popen(cmd, shell=False, close_fds=True)
350 return proc.returncode
353 def _runSession(self, args=None):
356 sys.argv = ['runSession'] + args
358 params, args = runSession.configureSession(args, exe="salome shell")
360 sys.argv = ['runSession'] + args
364 return runSession.runSession(params, args)
367 def _runRemote(self, args=None):
370 # complete salome environment
371 sys.argv = ['runRemote']
376 return runRemote.runRemote(args)
379 def _runConsole(self, args=None):
382 # Initialize SALOME environment
383 sys.argv = ['runConsole']
388 return runConsole.connect(args)
391 def _kill(self, args=None):
396 print("Port number(s) not provided to command: salome kill <port(s)>")
403 if os.getenv("NSHOST") == "no_host":
404 os.unsetenv("NSHOST")
406 proc = subprocess.Popen(["killSalomeWithPort.py", port])
412 def _killAll(self, unused=None):
413 sys.argv = ['killAll']
416 if os.getenv("NSHOST") == "no_host":
417 os.unsetenv("NSHOST")
419 import PortManager # mandatory
421 ports = PortManager.getBusyPorts()['this']
425 proc = subprocess.Popen(["killSalomeWithPort.py", str(port)])
428 # :TODO: should be declared obsolete
429 from killSalome import killAllPorts
435 def _runTests(self, args=None):
438 sys.argv = ['runTests']
443 return runTests.runTests(args, exe="salome test")
446 def _showSoftwareVersions(self, softwares=None):
447 config = configparser.SafeConfigParser()
448 absoluteAppliPath = os.getenv('ABSOLUTE_APPLI_PATH')
449 filename = os.path.join(absoluteAppliPath, "sha1_collections.txt")
452 with open(filename) as f:
455 software, version, sha1 = line.split()
456 versions[software.upper()] = version
457 if len(software) > max_len:
458 max_len = len(software)
464 for soft in softwares:
465 if soft.upper() in versions:
466 print(soft.upper().rjust(max_len), versions[soft.upper()])
469 od = collections.OrderedDict(sorted(versions.items()))
470 for name, version in od.items():
471 print(name.rjust(max_len), versions[name])
474 def _showInfo(self, args=None):
478 usage = "Usage: salome info [options]"
480 Display some information about SALOME.\n
481 Available options are:
482 -p,--ports Show the list of busy ports (running SALOME instances).
483 -s,--softwares [software(s)] Show the list and versions of SALOME softwares.
484 Software names must be separated by blank characters.
485 If no software is given, show version of all softwares.
486 -v,--version Show running SALOME version.
487 -h,--help Show this message.
492 if "-h" in args or "--help" in args:
493 print(usage + epilog)
496 if "-p" in args or "--ports" in args:
498 ports = PortManager.getBusyPorts()
499 this_ports = ports['this']
500 other_ports = ports['other']
501 if this_ports or other_ports:
502 print("SALOME instances are running on the following ports:")
504 print(" This application:", this_ports)
506 print(" No SALOME instances of this application")
508 print(" Other applications:", other_ports)
510 print(" No SALOME instances of other applications")
512 print("No SALOME instances are running")
514 if "-s" in args or "--softwares" in args:
516 index = args.index("-s")
518 index = args.index("--softwares")
520 while indexEnd < len(args) and args[indexEnd][0] != "-":
521 indexEnd = indexEnd + 1
522 self._showSoftwareVersions(softwares=args[index+1:indexEnd])
524 if "-v" in args or "--version" in args:
525 print("Running with python", platform.python_version())
526 return self._runAppli(["--version"])
531 def _showDoc(self, args=None):
537 print("Module(s) not provided to command: salome doc <module(s)>")
540 appliPath = os.getenv("ABSOLUTE_APPLI_PATH")
542 raise SalomeContextException("Unable to find application path. Please check that the variable ABSOLUTE_APPLI_PATH is set.")
543 baseDir = os.path.join(appliPath, "share", "doc", "salome")
544 for module in modules:
545 docfile = os.path.join(baseDir, "gui", module.upper(), "index.html")
546 if not os.path.isfile(docfile):
547 docfile = os.path.join(baseDir, "tui", module.upper(), "index.html")
548 if not os.path.isfile(docfile):
549 docfile = os.path.join(baseDir, "dev", module.upper(), "index.html")
550 if os.path.isfile(docfile):
551 out, err = subprocess.Popen(["xdg-open", docfile]).communicate()
553 print("Online documentation is not accessible for module:", module)
555 def _usage(self, unused=None):
559 def _makeCoffee(self, unused=None):
562 print(" ___...(-------)-....___")
563 print(" .-\"\" ) ( \"\"-.")
564 print(" .-\'``\'|-._ ) _.-|")
565 print(" / .--.| `\"\"---...........---\"\"` |")
569 print(" `\\ `\\ | |")
570 print(" `\\ `| SALOME |")
571 print(" _/ /\\ 4 EVER /")
572 print(" (__/ \\ <3 /")
573 print(" _..---\"\"` \\ /`\"\"---.._")
574 print(" .-\' \\ / \'-.")
575 print(" : `-.__ __.-\' :")
576 print(" : ) \"\"---...---\"\" ( :")
577 print(" \'._ `\"--...___...--\"` _.\'")
578 print(" \\\"\"--..__ __..--\"\"/")
579 print(" \'._ \"\"\"----.....______.....----\"\"\" _.\'")
580 print(" `\"\"--..,,_____ _____,,..--\"\"`")
581 print(" `\"\"\"----\"\"\"`")
583 print(" SALOME is working for you; what else?")
587 def _getCar(self, unused=None):
588 print(" _____________")
589 print(" ..---:::::::-----------. ::::;;.")
590 print(" .\'\"\"\"\"\"\" ;; \\ \":.")
591 print(" .\'\' ; \\ \"\\__.")
592 print(" .\' ;; ; \\\\\";")
593 print(" .\' ; _____; \\\\/")
594 print(" .\' :; ;\" \\ ___:\'.")
595 print(" .\'--........................... : = ____:\" \\ \\")
596 print(" ..-\"\" \"\"\"\' o\"\"\" ; ; :")
597 print(" .--\"\" .----- ..----... _.- --. ..-\" ; ; ; ;")
598 print(" .\"\"_- \"--\"\"-----\'\"\" _-\" .-\"\" ; ; .-.")
599 print(" .\' .\' SALOME .\" .\" ; ; /. |")
600 print(" /-./\' 4 EVER <3 .\" / _.. ; ; ;;;|")
601 print(" : ;-.______ / _________==. /_ \\ ; ; ;;;;")
602 print(" ; / | \"\"\"\"\"\"\"\"\"\"\".---.\"\"\"\"\"\"\" : /\" \". |; ; _; ;;;")
603 print(" /\"-/ | / / / / ;|; ;-\" | ;\';")
604 print(":- : \"\"\"----______ / / ____. . .\"\'. ;; .-\"..T\" .")
605 print("\'. \" ___ \"\": \'\"\"\"\"\"\"\"\"\"\"\"\"\"\" . ; ; ;; ;.\" .\" \'--\"")
606 print(" \", __ \"\"\" \"\"---... :- - - - - - - - - \' \' ; ; ; ;;\" .\"")
607 print(" /. ; \"\"\"---___ ; ; ; ;|.\"\"")
608 print(" : \": \"\"\"----. .-------. ; ; ; ;:")
609 print(" \\ \'--__ \\ \\ \\ / | ; ;;")
610 print(" \'-.. \"\"\"\"---___ : .______..\\ __/..-\"\"| ; ; ;")
611 print(" \"\"--.. \"\"\"--\" m l s . \". . ;")
612 print(" \"\"------... ..--\"\" \" :")
613 print(" \"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\" \\ /")
616 print(" Drive your simulation properly with SALOME!")
620 # Add the following two methods since logger is not pickable
621 # Ref: http://stackoverflow.com/questions/2999638/how-to-stop-attributes-from-being-pickled-in-python
622 def __getstate__(self):
623 d = dict(self.__dict__)
624 if hasattr(self, '_logger'):
628 def __setstate__(self, d):
629 self.__dict__.update(d) # I *think* this is a safe way to do it
631 # Excluding self._logger from pickle operation imply using the following method to access logger
633 if not hasattr(self, '_logger'):
634 self._logger = logging.getLogger(__name__)
635 #self._logger.setLevel(logging.DEBUG)
636 #self._logger.setLevel(logging.WARNING)
637 self._logger.setLevel(logging.ERROR)
641 if __name__ == "__main__":
642 if len(sys.argv) == 3:
643 context = pickle.loads(sys.argv[1].encode())
644 args = pickle.loads(sys.argv[2].encode())
646 status = context._startSalome(args)