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
25 from . import architecture
26 from . import printcolors
29 from . import ElementTree
32 from . import environment
33 from . import fileEnviron
39 class SatException(Exception):
40 '''rename Exception Class
44 def ensure_path_exists(p):
45 '''Create a path if not existing
47 :param p str: The path.
49 if not os.path.exists(p):
52 def check_config_has_application( config, details = None ):
53 '''check that the config has the key APPLICATION. Else raise an exception.
55 :param config class 'common.pyconf.Config': The config.
57 if 'APPLICATION' not in config:
58 message = _("An APPLICATION is required. Use 'config --list' to get"
59 " the list of available applications.\n")
61 details.append(message)
62 raise SatException( message )
64 def config_has_application( config ):
65 return 'APPLICATION' in config
67 def get_cfg_param(config, param_name, default):
68 '''Search for param_name value in config.
69 If param_name is not in config, then return default,
70 else, return the found value
72 :param config class 'common.pyconf.Config': The config.
73 :param param_name str: the name of the parameter to get the value
74 :param default str: The value to return if param_name is not in config
75 :return: see initial description of the function
78 if param_name in config:
79 return config[param_name]
82 def print_info(logger, info):
83 '''Prints the tuples that are in info variable in a formatted way.
85 :param logger Logger: The logging instance to use for the prints.
86 :param info list: The list of tuples to display
88 # find the maximum length of the first value of the tuples in info
89 smax = max(map(lambda l: len(l[0]), info))
90 # Print each item of info with good indentation
92 sp = " " * (smax - len(i[0]))
93 printcolors.print_value(logger, sp + i[0], i[1], 2)
96 def get_base_path(config):
97 '''Returns the path of the product base.
99 :param config Config: The global Config instance.
100 :return: The path of the product base.
103 if "base" in config.APPLICATION:
104 base_name = config.APPLICATION.base
105 base_path = config.USER.bases[base_name]
108 base_path = config.USER.bases.base
112 # Utils class to simplify path manipulations.
114 def __init__(self, path):
115 self.path = str(path)
117 def __add__(self, other):
118 return Path(os.path.join(self.path, str(other)))
121 return Path(os.path.abspath(self.path))
126 def __eq__(self, other):
127 return self.path == other.path
130 return self.islink() or os.path.exists(self.path)
133 return os.path.islink(self.path)
136 return os.path.isdir(self.path)
139 return [Path(p) for p in os.listdir(self.path)]
142 return Path(os.path.dirname(self.path))
145 return Path(os.path.basename(self.path))
147 def make(self, mode=None):
148 os.makedirs(self.path)
150 os.chmod(self.path, mode)
152 def chmod(self, mode):
153 os.chmod(self.path, mode)
159 shutil.rmtree( self.path, onerror = handleRemoveReadonly )
161 def copy(self, path, smart=False):
162 if not isinstance(path, Path):
165 if os.path.islink(self.path):
166 return self.copylink(path)
167 elif os.path.isdir(self.path):
168 return self.copydir(path, smart)
170 return self.copyfile(path)
172 def smartcopy(self, path):
173 return self.copy(path, True)
177 return os.readlink(self.path)
181 def symlink(self, path):
183 os.symlink(str(path), self.path)
188 def copylink(self, path):
190 os.symlink(os.readlink(self.path), str(path))
195 def copydir(self, dst, smart=False):
205 if smart and (str(name) in [".git", "CVS", ".svn"]):
207 srcname = self + name
209 srcname.copy(dstname, smart)
214 def copyfile(self, path):
216 shutil.copy2(self.path, str(path))
221 def handleRemoveReadonly(func, path, exc):
223 if func in (os.rmdir, os.remove) and excvalue.errno == errno.EACCES:
224 os.chmod(path, stat.S_IRWXU| stat.S_IRWXG| stat.S_IRWXO) # 0777