3 # Copyright (C) 2010-2013 CEA/DEN
5 # This library is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU Lesser General Public
7 # License as published by the Free Software Foundation; either
8 # version 2.1 of the License.
10 # This library is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # Lesser General Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with this library; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 import src.debug as DBG
32 Class to manage the environment context
34 def __init__(self, environ=None):
35 """Initialization. If the environ argument is passed, the environment
36 will be add to it, else it is the external environment.
40 if environ is not None:
41 self.environ = environ
43 self.environ = os.environ
46 """easy non exhaustive quick resume for debug print"""
47 return "%s(\n%s\n)" % (self.__class__.__name__, PP.pformat(self.environ))
49 def _expandvars(self, value):
51 replace some $VARIABLE into its actual value in the environment
53 :param value str: the string to be replaced
54 :return: the replaced variable
57 if src.architecture.is_windows():
62 # The string.Template class is a string class
63 # for supporting $-substitutions
64 zt = string.Template(value)
67 value = zt.substitute(self.environ)
68 except KeyError as exc:
70 #raise src.SatException(_("Missing definition "
71 # "in environment: %s") % str(exc))
74 def append_value(self, key, value, sep=os.pathsep):
76 append value to key using sep,
77 if value contains ":" or ";" then raise error
79 :param key str: the environment variable to append
80 :param value str: the value to append to key
81 :param sep str: the separator string
83 # check that value so no contain the system separator
85 if separator in value:
86 raise Exception("Environ append key '%s' value '%s' contains forbidden character '%s'" % (key, value, separator))
88 # check if the key is already in the environment
89 if key in self.environ:
90 value_list = self.environ[key].split(sep)
91 # Check if the value is already in the key value or not
92 if not value in value_list:
93 value_list.append(value)
95 value_list.append(value_list.pop(value_list.index(value)))
96 self.set(key, sep.join(value_list))
100 def append(self, key, value, sep=os.pathsep):
102 Same as append_value but the value argument can be a list
104 :param key str: the environment variable to append
105 :param value str or list: the value(s) to append to key
106 :param sep str: the separator string
108 if isinstance(value, list):
110 self.append_value(key, v, sep)
112 self.append_value(key, value, sep)
114 def prepend_value(self, key, value, sep=os.pathsep):
116 prepend value to key using sep,
117 if value contains ":" or ";" then raise error
119 :param key str: the environment variable to prepend
120 :param value str: the value to prepend to key
121 :param sep str: the separator string
123 # check that value so no contain the system separator
125 if separator in value:
126 raise Exception("Environ append key '%s' value '%s' contains forbidden character '%s'" % (key, value, separator))
128 # check if the key is already in the environment
129 if key in self.environ:
130 value_list = self.environ[key].split(sep)
131 if not value in value_list:
132 value_list.insert(0, value)
134 value_list.insert(0, value_list.pop(value_list.index(value)))
135 self.set(key, sep.join(value_list))
139 def prepend(self, key, value, sep=os.pathsep):
141 Same as prepend_value but the value argument can be a list
143 :param key str: the environment variable to prepend
144 :param value str or list: the value(s) to prepend to key
145 :param sep str: the separator string
147 if isinstance(value, list):
148 for v in reversed(value): # prepend list, first item at last to stay first
149 self.prepend_value(key, v, sep)
151 self.prepend_value(key, value, sep)
153 def is_defined(self, key):
155 Check if the key exists in the environment
157 :param key str: the environment variable to check
159 return key in self.environ.keys()
161 def set(self, key, value):
163 Set the environment variable "key" to value "value"
165 :param key str: the environment variable to set
166 :param value str: the value
168 self.environ[key] = self._expandvars(value)
172 Get the value of the environment variable "key"
174 :param key str: the environment variable
176 if key in self.environ:
177 return self.environ[key]
181 def get_value(self, key):
183 Get the value of the environment variable "key"
184 This method is added for API compatibility with FileEnviron class
186 :param key str: the environment variable
194 Class to manage the environment of SALOME.
201 enable_simple_env_script = True):
205 :param cfg Config: the global config
206 :param environ Environ: the Environ instance where
207 to store the environment variables
208 :param forBuild bool: If true, it is a launch environment,
210 :param for_package str: If not None, produce a relative environment
211 designed for a package.
213 self.environ = environ
215 self.forBuild = forBuild
216 self.for_package = for_package
217 self.enable_simple_env_script = enable_simple_env_script
219 self.has_python = False
220 self.__set_sorted_products_list()
223 """easy almost exhaustive quick resume for debug print"""
225 "environ" : self.environ,
226 "forBuild" : self.forBuild,
227 "for_package" : self.for_package,
229 return "%s(\n%s\n)" % (self.__class__.__name__, PP.pformat(res))
231 def __set_sorted_products_list(self):
232 all_products_infos = src.product.get_products_infos(
233 self.cfg.APPLICATION.products,
236 from compile import get_dependencies_graph,depth_first_topo_graph
237 all_products_graph=get_dependencies_graph(all_products_infos, self.forBuild)
240 for n in all_products_graph:
241 if n not in visited_nodes:
242 visited_nodes,sorted_nodes=depth_first_topo_graph(
247 self.sorted_product_list=sorted_nodes
248 self.all_products_graph=all_products_graph
251 def append(self, key, value, sep=os.pathsep):
253 append value to key using sep
255 :param key str: the environment variable to append
256 :param value str: the value to append to key
257 :param sep str: the separator string
259 return self.environ.append(key, value, sep)
261 def prepend(self, key, value, sep=os.pathsep):
263 prepend value to key using sep
265 :param key str: the environment variable to prepend
266 :param value str: the value to prepend to key
267 :param sep str: the separator string
269 return self.environ.prepend(key, value, sep)
271 def is_defined(self, key):
273 Check if the key exists in the environment
275 :param key str: the environment variable to check
277 return self.environ.is_defined(key)
281 Get the value of the environment variable "key"
283 :param key str: the environment variable
285 return self.environ.get(key)
287 def get_value(self, key):
289 Get the real value of the environment variable "key"
290 This method is added for API compatibility with FileEnviron class
292 :param key str: the environment variable
294 if key in self.environ:
295 return self.environ[key]
299 def set(self, key, value):
301 Set the environment variable "key" to value "value"
303 :param key str: the environment variable to set
304 :param value str: the value
306 # check if value needs to be evaluated
307 if value is not None and value.startswith("`") and value.endswith("`"):
308 res = subprocess.Popen("echo %s" % value,
310 stdout=subprocess.PIPE).communicate()
311 value = res[0].strip()
313 return self.environ.set(key, value)
317 Write the environment to out
319 :param out file: the stream where to write the environment
321 for k in self.environ.environ.keys():
326 out.write("%s=%s\n" % (k, value))
328 def add_line(self, nb_line):
330 Add empty lines to the out stream (in case of file generation)
332 :param nb_line int: the number of empty lines to add
334 if 'add_line' in dir(self.environ):
335 self.environ.add_line(nb_line)
337 def add_comment(self, comment):
339 Add a commentary to the out stream (in case of file generation)
341 :param comment str: the commentary to add
343 if 'add_comment' in dir(self.environ):
344 self.environ.add_comment(comment)
346 def add_warning(self, warning):
348 Add a warning to the out stream (in case of file generation)
350 :param warning str: the warning to add
352 if 'add_warning' in dir(self.environ):
353 self.environ.add_warning(warning)
357 Add a final instruction in the out file (in case of file generation)
359 :param required bool: Do nothing if required is False
361 if 'finish' in dir(self.environ):
362 self.environ.add_line(1)
364 # self.environ.add_comment("clean all the path")
365 self.environ.finish()
367 def set_python_libdirs(self):
368 """Set some generic variables for python library paths"""
369 ver = self.get('PYTHON_VERSION')
370 self.set('PYTHON_LIBDIR', os.path.join('lib',
373 self.python_lib = self.get('PYTHON_LIBDIR')
374 self.has_python = True
376 def set_application_env(self, logger):
378 Sets the environment defined in the APPLICATION file.
380 :param logger Logger: The logger instance to display messages
384 if src.architecture.is_windows():
385 self.set("PRODUCT_ROOT_DIR", "%out_dir_Path%")
387 self.set("PRODUCT_ROOT_DIR", "out_dir_Path")
390 self.cfg.APPLICATION.environ.PRODUCT_ROOT_DIR = src.pyconf.Reference(self.cfg, src.pyconf.DOLLAR, "workdir")
393 # Set the variables defined in the "environ" section
394 if 'environ' in self.cfg.APPLICATION:
395 # we write PRODUCT environment it in order to conform to
397 self.add_comment("PRODUCT environment")
398 self.load_cfg_environment(self.cfg.APPLICATION.environ)
399 if self.forBuild and "build" in self.cfg.APPLICATION.environ:
400 self.load_cfg_environment(self.cfg.APPLICATION.environ.build)
401 if not self.forBuild and "launch" in self.cfg.APPLICATION.environ:
402 self.load_cfg_environment(self.cfg.APPLICATION.environ.launch)
406 def set_salome_minimal_product_env(self, product_info, logger):
408 Sets the minimal environment for a SALOME product.
409 xxx_ROOT_DIR and xxx_SRC_DIR
411 :param product_info Config: The product description
412 :param logger Logger: The logger instance to display messages
415 DBG.write("set_salome_minimal_product_env", product_info)
416 root_dir = product_info.name + "_ROOT_DIR"
417 if 'install_dir' in product_info and product_info.install_dir:
418 self.set(root_dir, product_info.install_dir)
419 elif not self.silent:
420 logger.write(" " + _("No install_dir for product %s\n") %
421 product_info.name, 5)
423 source_in_package = src.get_property_in_product_cfg(product_info,
424 "sources_in_package")
425 if not self.for_package or source_in_package == "yes":
426 # set source dir, unless no source dir
427 if not src.product.product_is_fixed(product_info):
428 src_dir = product_info.name + "_SRC_DIR"
429 if not self.for_package:
430 self.set(src_dir, product_info.source_dir)
432 self.set(src_dir, os.path.join("out_dir_Path",
434 os.path.basename(product_info.source_dir)))
436 def expand_salome_modules(self, pi):
437 if 'component_name' in pi:
438 compo_name = pi.component_name
441 self.append('SALOME_MODULES', compo_name, ',')
444 def set_salome_generic_product_env(self, pi):
446 Sets the generic environment for a SALOME product.
448 :param pi Config: The product description
450 # Construct XXX_ROOT_DIR
451 env_root_dir = self.get(pi.name + "_ROOT_DIR")
452 l_binpath_libpath = []
453 # create additional ROOT_DIR for CPP components
454 if 'component_name' in pi:
455 compo_name = pi.component_name
456 if compo_name + "CPP" == pi.name:
457 compo_root_dir = compo_name + "_ROOT_DIR"
458 envcompo_root_dir = os.path.join(
459 self.cfg.TOOLS.common.install_root, compo_name )
460 self.set(compo_root_dir , envcompo_root_dir)
461 bin_path = os.path.join(envcompo_root_dir, 'bin', 'salome')
462 lib_path = os.path.join(envcompo_root_dir, 'lib', 'salome')
463 l_binpath_libpath.append( (bin_path, lib_path) )
466 if src.get_property_in_product_cfg(pi, "fhs"):
467 lib_path = os.path.join(env_root_dir, 'lib')
468 bin_path = os.path.join(env_root_dir, 'bin')
470 # if the application doesn't include python, we don't need these two lines
471 pylib_path = os.path.join(env_root_dir, self.python_lib)
473 lib_path = os.path.join(env_root_dir, 'lib', 'salome')
474 bin_path = os.path.join(env_root_dir, 'bin', 'salome')
476 # if the application doesn't include python, we don't need these two lines
477 pylib_path = os.path.join(env_root_dir, self.python_lib, 'salome')
479 # Construct the paths to prepend to PATH and LD_LIBRARY_PATH and
481 l_binpath_libpath.append( (bin_path, lib_path) )
483 for bin_path, lib_path in l_binpath_libpath:
484 if not self.forBuild:
485 self.prepend('PATH', bin_path)
486 if src.architecture.is_windows():
487 self.prepend('PATH', lib_path)
489 self.prepend('LD_LIBRARY_PATH', lib_path)
491 l = [ bin_path, lib_path ]
492 if not src.product.product_is_wheel(pi):
495 self.prepend('PYTHONPATH', l)
497 def set_cpp_env(self, product_info):
499 Sets the generic environment for a SALOME cpp product.
501 :param product_info Config: The product description
503 # Construct XXX_ROOT_DIR
504 env_root_dir = self.get(product_info.name + "_ROOT_DIR")
505 l_binpath_libpath = []
507 # Construct the paths to prepend to PATH and LD_LIBRARY_PATH and
509 bin_path = os.path.join(env_root_dir, 'bin')
510 lib_path = os.path.join(env_root_dir, 'lib')
511 l_binpath_libpath.append( (bin_path, lib_path) )
513 for bin_path, lib_path in l_binpath_libpath:
514 if not self.forBuild:
515 self.prepend('PATH', bin_path)
516 if src.architecture.is_windows():
517 self.prepend('PATH', lib_path)
519 self.prepend('LD_LIBRARY_PATH', lib_path)
521 l = [ bin_path, lib_path ]
523 l.append(os.path.join(env_root_dir, self.python_lib))
524 self.prepend('PYTHONPATH', l)
526 def load_cfg_environment(self, cfg_env):
528 Loads environment defined in cfg_env
530 :param cfg_env Config: A config containing an environment
532 # Loop on cfg_env values
533 for env_def in cfg_env:
534 val = cfg_env[env_def]
536 # if it is env_script, do not do anything (reserved keyword)
537 if env_def == "env_script":
540 # if it is a dict, do not do anything
541 if isinstance(val, src.pyconf.Mapping):
544 # if it is a list, loop on its values
545 if isinstance(val, src.pyconf.Sequence):
546 # transform into list of strings
552 # "_" means that the value must be prepended
553 if env_def.startswith("_"):
554 # separator exception for PV_PLUGIN_PATH
555 if env_def[1:] == 'PV_PLUGIN_PATH':
556 self.prepend(env_def[1:], val, ';')
558 self.prepend(env_def[1:], val)
559 elif env_def.endswith("_"):
560 # separator exception for PV_PLUGIN_PATH
561 if env_def[:-1] == 'PV_PLUGIN_PATH':
562 self.append(env_def[:-1], val, ';')
564 self.append(env_def[:-1], val)
566 self.set(env_def, val)
568 def set_a_product(self, product, logger):
570 Sets the environment of a product.
572 :param product str: The product name
573 :param logger Logger: The logger instance to display messages
576 # Get the informations corresponding to the product
577 pi = src.product.get_product_config(self.cfg, product)
578 # skip compile time products at run time
579 if not self.forBuild:
580 if src.product.product_is_compile_time(pi):
583 # skip pip products when pip is activated and installation is done in python
584 #if (src.appli_test_property(self.cfg,"pip", "yes") and
585 # src.product.product_test_property(pi,"pip", "yes") and
586 # src.appli_test_property(self.cfg,"pip_install_dir", "python") ):
589 # skip mesa products (if any) at run time,
590 # unless use_mesa property was activated
591 if not self.forBuild:
592 if not ("APPLICATION" in self.cfg and
593 "properties" in self.cfg.APPLICATION and
594 "use_mesa" in self.cfg.APPLICATION.properties and
595 self.cfg.APPLICATION.properties.use_mesa == "yes") :
596 if ("properties" in pi and
597 "is_mesa" in pi.properties and
598 pi.properties.is_mesa == "yes") :
599 logger.write(_("Skip mesa product %s\n") % pi.name, 4)
604 prod_base_name=os.path.basename(pi.install_dir)
605 if prod_base_name.startswith("config"):
606 # case of a products installed in base. We remove "config-i"
607 prod_base_name=os.path.basename(os.path.dirname(pi.install_dir))
608 pi.install_dir = os.path.join(
614 logger.write(_("Setting environment for %s\n") % product, 4)
617 self.add_comment('setting environ for ' + product)
619 # Do not define environment if the product is native
620 if src.product.product_is_native(pi):
621 if src.product.product_has_env_script(pi):
622 self.run_env_script(pi, native=True)
625 # Set an additional environment for SALOME products
626 if src.product.product_is_salome(pi):
627 # set environment using definition of the product
628 self.set_salome_minimal_product_env(pi, logger)
629 self.set_salome_generic_product_env(pi)
632 # Expand SALOME_MODULES variable for products which have a salome gui
633 if src.product.product_has_salome_gui(pi):
634 self.expand_salome_modules(pi)
636 # use variable LICENCE_FILE to communicate the licence file name to the environment script
637 licence_file_name = src.product.product_has_licence(pi, self.cfg.PATHS.LICENCEPATH)
638 if licence_file_name:
639 logger.write("licence file found for product %s : %s\n" % (pi.name, licence_file_name), 5)
640 self.set("LICENCE_FILE", licence_file_name)
642 if src.product.product_is_cpp(pi):
643 # set a specific environment for cpp modules
644 self.set_salome_minimal_product_env(pi, logger)
647 if src.product.product_is_generated(pi):
648 if "component_name" in pi:
649 # hack the source and install directories in order to point
650 # on the generated product source install directories
651 install_dir_save = pi.install_dir
652 source_dir_save = pi.source_dir
654 pi.install_dir = os.path.join(self.cfg.APPLICATION.workdir,
655 self.cfg.INTERNAL.config.install_dir,
658 pi.install_dir = os.path.join("out_dir_Path",
661 pi.source_dir = os.path.join(self.cfg.APPLICATION.workdir,
664 pi.name = pi.component_name
665 self.set_salome_minimal_product_env(pi, logger)
666 self.set_salome_generic_product_env(pi)
668 # Put original values
669 pi.install_dir = install_dir_save
670 pi.source_dir = source_dir_save
673 # Put the environment define in the configuration of the product
675 self.load_cfg_environment(pi.environ)
676 if self.forBuild and "build" in pi.environ:
677 self.load_cfg_environment(pi.environ.build)
678 if not self.forBuild and "launch" in pi.environ:
679 self.load_cfg_environment(pi.environ.launch)
680 # if product_info defines a env_scripts, load it
681 if 'env_script' in pi.environ:
682 self.run_env_script(pi, logger)
687 def run_env_script(self, product_info, logger=None, native=False):
689 Runs an environment script.
691 :param product_info Config: The product description
692 :param logger Logger: The logger instance to display messages
693 :param native Boolean: if True load set_native_env instead of set_env
695 env_script = product_info.environ.env_script
696 # Check that the script exists
697 if not os.path.exists(env_script):
698 raise src.SatException(_("Environment script not found: %s") %
701 if not self.silent and logger is not None:
702 logger.write(" ** load %s\n" % env_script, 4)
704 # import the script and run the set_env function
707 pyproduct = imp.load_source(product_info.name + "_env_script",
710 if self.forBuild and "set_env_build" in dir(pyproduct):
711 pyproduct.set_env_build(self,
712 product_info.install_dir,
713 product_info.version)
714 elif (not self.forBuild) and "set_env_launch" in dir(pyproduct):
715 pyproduct.set_env_launch(self,
716 product_info.install_dir,
717 product_info.version)
719 # at least this one is mandatory,
720 # if set_env_build and set_env_build are not defined
721 pyproduct.set_env(self,
722 product_info.install_dir,
723 product_info.version)
725 # not mandatory, if set_nativ_env not defined, we do nothing
726 if "set_nativ_env" in dir(pyproduct):
727 pyproduct.set_nativ_env(self)
729 __, exceptionValue, exceptionTraceback = sys.exc_info()
730 print(exceptionValue)
732 traceback.print_tb(exceptionTraceback)
733 traceback.print_exc()
735 def set_products(self, logger, src_root=None):
737 Sets the environment for all the products.
739 :param logger Logger: The logger instance to display messages
740 :param src_root src: the application working directory
743 self.add_comment('setting environ for all products')
745 # Make sure that the python lib dirs are set after python
746 if "Python" in self.sorted_product_list:
747 self.set_a_product("Python", logger)
748 self.set_python_libdirs()
750 # The loop on the products
751 for product in self.sorted_product_list:
752 if product == "Python":
754 self.set_a_product(product, logger)
756 def set_full_environ(self, logger, env_info):
758 Sets the full environment for products, with their dependencies
759 specified in env_info dictionary.
761 :param logger Logger: The logger instance to display messages
762 :param env_info list: the list of products
764 DBG.write("set_full_environ for", env_info)
765 # DBG.write("set_full_environ config", self.cfg.APPLICATION.environ, True)
766 # set product environ
767 self.set_application_env(logger)
769 # use the sorted list of all products to sort the list of products
772 from compile import depth_search_graph # to get the dependencies
773 for p_name in env_info:
774 visited=depth_search_graph(self.all_products_graph, p_name, visited)
775 sorted_product_list=[]
776 for n in self.sorted_product_list:
778 sorted_product_list.append(n)
780 if "Python" in sorted_product_list:
781 self.set_a_product("Python", logger)
782 self.set_python_libdirs()
785 for product in sorted_product_list:
786 if product == "Python":
788 self.set_a_product(product, logger)
792 Class to dump the environment to a file.
794 def __init__(self, config, logger, out_dir, src_root, env_info=None):
798 :param cfg Config: the global config
799 :param logger Logger: The logger instance to display messages
800 :param out_dir str: The directory path where t put the output files
801 :param src_root str: The application working directory
802 :param env_info str: The list of products to add in the files.
806 self.out_dir = out_dir
807 self.src_root= src_root
809 self.env_info = env_info
811 def write_tcl_files(self,
816 additional_env = {}):
818 Create tcl environment files for environment module.
820 :param forBuild bool: if true, the build environment
821 :param shell str: the type of file wanted (.sh, .bat)
822 :param for_package bool: if true do specific stuff for required for packages
823 :param no_path_init bool: if true generate a environ file that do not reinitialise paths
824 :param additional_env dict: contains sat_ prefixed variables to help the génération,
825 and also variables to add in the environment.
826 :return: The path to the generated file
830 # get the products informations
831 all_products=self.config.APPLICATION.products
832 products_infos = src.product.get_products_infos(all_products, self.config)
834 # set a global environment (we need it to resolve variable references
835 # between dependent products
836 global_environ = src.environment.SalomeEnviron(self.config,
837 src.environment.Environ(additional_env),
839 global_environ.set_products(self.logger)
841 # The loop on the products
842 for product in all_products:
843 # create one file per product
844 pi = src.product.get_product_config(self.config, product)
845 if "base" not in pi: # we write tcl files only for products in base
848 # get the global environment, and complete it with sat_ prefixed
849 # prefixed variables which are used to transfer info to
850 # TclFileEnviron class
851 product_env = copy.deepcopy(global_environ.environ)
852 product_env.environ["sat_product_name"] = pi.name
853 product_env.environ["sat_product_version"] = pi.version
854 product_env.environ["sat_product_base_path"] = src.get_base_path(self.config)
855 product_env.environ["sat_product_base_name"] = pi.base
857 # store infos in sat_product_load_depend to set dependencies in tcl file
858 sat_product_load_depend=""
859 for p_name,p_info in products_infos:
860 if p_name in pi.depend:
861 sat_product_load_depend+="module load %s/%s/%s;" % (pi.base,
864 if len(sat_product_load_depend)>0:
865 # if there are dependencies, store the module to load (get rid of trailing ;)
866 product_env.environ["sat_product_load_depend"]=sat_product_load_depend[0:-1]
869 env_file_name = os.path.join(product_env.environ["sat_product_base_path"],
871 product_env.environ["sat_product_base_name"],
872 product_env.environ["sat_product_name"],
873 product_env.environ["sat_product_version"])
874 prod_dir_name=os.path.dirname(env_file_name)
875 if not os.path.isdir(prod_dir_name):
876 os.makedirs(prod_dir_name)
878 env_file = open(env_file_name, "w")
879 file_environ = src.fileEnviron.get_file_environ(env_file,
881 env = SalomeEnviron(self.config,
884 for_package=for_package)
885 if "Python" in pi.depend:
886 # short cut, env.python_lib is required by set_a_product for salome modules
887 env.has_python="True"
888 env.python_lib=global_environ.get("PYTHON_LIBDIR")
889 env.set_a_product(product, self.logger)
892 self.logger.write(_(" Create tcl module environment file %s\n") %
893 src.printcolors.printcLabel(env_file_name), 3)
896 def write_env_file(self,
902 additional_env = {}):
904 Create an environment file.
906 :param filename str: the file path
907 :param forBuild bool: if true, the build environment
908 :param shell str: the type of file wanted (.sh, .bat)
909 :param for_package bool: if true do specific stuff for required for packages
910 :param no_path_init bool: if true generate a environ file that do not reinitialise paths
911 :param additional_env dict: contains sat_ prefixed variables to help the génération,
912 and also variables to add in the environment.
913 :return: The path to the generated file
916 additional_env["sat_dist"]=self.config.VARS.dist
918 self.logger.write(_("Create environment file %s\n") %
919 src.printcolors.printcLabel(filename), 3)
920 # create then env object
921 env_file = open(os.path.join(self.out_dir, filename), "w")
923 # we duplicate additional_env, and transmit it to fileEnviron, which will use its sat_ prefixed variables.
924 # the other variables of additional_env are added to the environement file at the end of this function.
925 salome_env = copy.deepcopy(additional_env)
926 file_environ = src.fileEnviron.get_file_environ(env_file,
928 src.environment.Environ(salome_env))
930 # specify we don't want to reinitialise paths
931 # path will keep the inherited value, which will be appended with new values.
932 file_environ.set_no_init_path()
934 env = SalomeEnviron(self.config,
937 for_package=for_package)
939 env.silent = self.silent
941 # Set the environment
942 if self.env_info is not None:
943 env.set_full_environ(self.logger, self.env_info)
945 # set env from the APPLICATION
946 env.set_application_env(self.logger)
948 env.set_products(self.logger,
949 src_root=self.src_root)
950 # Add the additional environment if it is not empty
951 if len(additional_env) != 0:
953 env.add_comment("[APPLI variables]")
954 for variable in additional_env:
955 if not variable.startswith("sat_"):
956 # by convention variables starting with sat_ are used to transfer information,
957 # not to be written in env
958 env.set(variable, additional_env[variable])
960 # finalise the writing and close the file
969 Definition of a Shell.
971 def __init__(self, name, extension):
975 :param name str: the shell name
976 :param extension str: the shell extension
979 self.extension = extension
981 def load_environment(config, build, logger):
983 Loads the environment (used to run the tests, for example).
985 :param config Config: the global config
986 :param build bool: build environement if True
987 :param logger Logger: The logger instance to display messages
989 environ = SalomeEnviron(config, Environ(os.environ), build)
990 environ.set_application_env(logger)
991 environ.set_products(logger)