SALOME platform Git repositories - tools/sat.git/blob

1 #!/usr/bin/env python

2 #-*- coding:utf-8 -*-

4 #

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.

9 #

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.

14 #

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

18

19 '''This file is the main entry file to salomeTools

20 '''

21

22 # python imports

23 import os

24 import sys

25 import imp

26 import types

27 import gettext

28

29 # salomeTools imports

30 import src

31

32 # get path to salomeTools sources

33 satdir = os.path.dirname(os.path.realpath(__file__))

34 cmdsdir = os.path.join(satdir, 'commands')

35

36 # Make the src package accessible from all code

37 sys.path.append(satdir)

38 sys.path.append(cmdsdir)

39

40 import config

41

42 # load resources for internationalization

43 #es = gettext.translation('salomeTools', os.path.join(satdir, 'src', 'i18n'))

44 #es.install()

45 gettext.install('salomeTools', os.path.join(satdir, 'src', 'i18n'))

46

47 # The possible hooks :

48 # pre is for hooks to be executed before commands

49 # post is for hooks to be executed after commands

50 C_PRE_HOOK = "pre"

51 C_POST_HOOK = "post"

52

53 def find_command_list(dirPath):

54 ''' Parse files in dirPath that end with .py : it gives commands list

55

56 :param dirPath str: The directory path where to search the commands

57 :return: cmd_list : the list containing the commands name

58 :rtype: list

59 '''

60 cmd_list = []

61 for item in os.listdir(dirPath):

62 if item.endswith('.py'):

63 cmd_list.append(item[:-len('.py')])

64 return cmd_list

65

66 # The list of valid salomeTools commands

67 #lCommand = ['config', 'compile', 'prepare']

68 lCommand = find_command_list(cmdsdir)

69

70 # Define all possible option for salomeTools command : sat <option> <args>

71 parser = src.options.Options()

72 parser.add_option('h', 'help', 'boolean', 'help',

73 _("shows global help or help on a specific command."))

74 parser.add_option('o', 'overwrite', 'list', "overwrite",

75 _("overwrites a configuration parameters."))

76 parser.add_option('g', 'debug', 'boolean', 'debug_mode',

77 _("run salomeTools in debug mode."))

78 parser.add_option('l', 'level', 'int', "output_level",

79 _("change output level (default is 3)."))

80 parser.add_option('s', 'silent', 'boolean', 'silent',

81 _("do not write log or show errors."))

82

83 class Sat(object):

84 '''The main class that stores all the commands of salomeTools

85 '''

86 def __init__(self, opt='', dataDir=None):

87 '''Initialization

88

89 :param opt str: The sat options

90 :param: dataDir str : the directory that contain all the external

91 data (like software pyconf and software scripts)

92 '''

93 # Read the salomeTools options (the list of possible options is

94 # at the beginning of this file)

95 try:

96 (options, argus) = parser.parse_args(opt.split(' '))

97 except Exception as exc:

98 write_exception(exc)

99 sys.exit(-1)

100

101 # initialization of class attributes

102 self.__dict__ = dict()

103 self.cfg = None # the config that will be read using pyconf module

104 self.arguments = opt

105 self.options = options # the options passed to salomeTools

106 self.dataDir = dataDir # default value will be <salomeTools root>/data

107 # set the commands by calling the dedicated function

108 self._setCommands(cmdsdir)

109

110 # if the help option has been called, print help and exit

111 if options.help:

112 try:

113 self.print_help(argus)

114 sys.exit(0)

115 except Exception as exc:

116 write_exception(exc)

117 sys.exit(1)

118

119 def __getattr__(self, name):

120 ''' overwrite of __getattr__ function in order to display

121 a customized message in case of a wrong call

122

123 :param name str: The name of the attribute

124 '''

125 if name in self.__dict__:

126 return self.__dict__[name]

127 else:

128 raise AttributeError(name + _(" is not a valid command"))

129

130 def _setCommands(self, dirPath):

131 '''set class attributes corresponding to all commands that are

132 in the dirPath directory

133

134 :param dirPath str: The directory path containing the commands

135 '''

136 # loop on the commands name

137 for nameCmd in lCommand:

138 # load the module that has name nameCmd in dirPath

139 (file_, pathname, description) = imp.find_module(nameCmd, [dirPath])

140 module = imp.load_module(nameCmd, file_, pathname, description)

141

142 def run_command(args='', logger=None):

143 '''The function that will load the configuration (all pyconf)

144 and return the function run of the command corresponding to module

145

146 :param args str: The directory path containing the commands

147 '''

148 argv = args.split(" ")

149

150 # if it is provided by the command line, get the application

151 appliToLoad = None

152 if argv != [''] and argv[0][0] != "-":

153 appliToLoad = argv[0].rstrip('*')

154 argv = argv[1:]

155

156 # read the configuration from all the pyconf files

157 cfgManager = config.ConfigManager()

158 self.cfg = cfgManager.get_config(dataDir=self.dataDir,

159 application=appliToLoad,

160 options=self.options,

161 command=__nameCmd__)

162

163 # set output level

164 if self.options.output_level:

165 self.cfg.USER.output_level = self.options.output_level

166 if self.cfg.USER.output_level < 1:

167 self.cfg.USER.output_level = 1

168

169 # create log file, unless the command is called

170 # with a logger as parameter

171 logger_command = src.logger.Logger(self.cfg,

172 silent_sysstd=self.options.silent)

173 if logger:

174 logger_command = logger

175

176 try:

177 # Execute the hooks (if there is any)

178 # and run method of the command

179 self.run_hook(__nameCmd__, C_PRE_HOOK, logger_command)

180 res = __module__.run(argv, self, logger_command)

181 self.run_hook(__nameCmd__, C_POST_HOOK, logger_command)

182 finally:

183 # put final attributes in xml log file

184 # (end time, total time, ...) and write it

185 launchedCommand = ' '.join([self.cfg.VARS.salometoolsway +

186 os.path.sep +

187 'sat',

188 self.arguments.split(' ')[0],

189 args])

190 logger_command.end_write({"launchedCommand" : launchedCommand})

191

192 return res

193

194 # Make sure that run_command will be redefined

195 # at each iteration of the loop

196 globals_up = {}

197 globals_up.update(run_command.__globals__)

198 globals_up.update({'__nameCmd__': nameCmd, '__module__' : module})

199 func = types.FunctionType(run_command.__code__,

200 globals_up,

201 run_command.__name__,

202 run_command.__defaults__,

203 run_command.__closure__)

204

205 # set the attribute corresponding to the command

206 self.__setattr__(nameCmd, func)

207

208 def run_hook(self, cmd_name, hook_type, logger):

209 '''Execute a hook file for a given command regarding the fact

210 it is pre or post

211

212 :param cmd_name str: The the command on which execute the hook

213 :param hook_type str: pre or post

214 :param logger Logger: the logging instance to use for the prints

215 '''

216 # The hooks must be defined in the application pyconf

217 # So, if there is no application, do not do anything

218 if not src.config_has_application(self.cfg):

219 return

220

221 # The hooks must be defined in the application pyconf in the

222 # APPLICATION section, hook : { command : 'script_path.py'}

223 if "hook" not in self.cfg.APPLICATION \

224 or cmd_name not in self.cfg.APPLICATION.hook:

225 return

226

227 # Get the hook_script path and verify that it exists

228 hook_script_path = self.cfg.APPLICATION.hook[cmd_name]

229 if not os.path.exists(hook_script_path):

230 raise src.SatException(_("Hook script not found: %s") %

231 hook_script_path)

232

233 # Try to execute the script, catch the exception if it fails

234 try:

235 # import the module (in the sense of python)

236 pymodule = imp.load_source(cmd_name, hook_script_path)

237

238 # format a message to be printed at hook execution

239 msg = src.printcolors.printcWarning(_("Run hook script"))

240 msg = "%s: %s\n" % (msg,

241 src.printcolors.printcInfo(hook_script_path))

242

243 # run the function run_pre_hook if this function is called

244 # before the command, run_post_hook if it is called after

245 if hook_type == C_PRE_HOOK and "run_pre_hook" in dir(pymodule):

246 logger.write(msg, 1)

247 pymodule.run_pre_hook(self.cfg, logger)

248 elif hook_type == C_POST_HOOK and "run_post_hook" in dir(pymodule):

249 logger.write(msg, 1)

250 pymodule.run_post_hook(self.cfg, logger)

251

252 except Exception as exc:

253 msg = _("Unable to run hook script: %s") % hook_script_path

254 msg += "\n" + str(exc)

255 raise src.SatException(msg)

256

257 def print_help(self, opt):

258 '''Prints help for a command. Function called when "sat -h <command>"

259

260 :param argv str: the options passed (to get the command name)

261 '''

262 # if no command as argument (sat -h)

263 if len(opt)==0:

264 print_help()

265 return

266 # get command name

267 command = opt[0]

268 # read the configuration from all the pyconf files

269 cfgManager = config.ConfigManager()

270 self.cfg = cfgManager.get_config(dataDir=self.dataDir)

271

272 # Check if this command exists

273 if not hasattr(self, command):

274 raise src.SatException(_("Command '%s' does not exist") % command)

275

276 # Print salomeTools version

277 print_version()

278

279 # load the module

280 module = self.get_module(command)

281

282 # print the description of the command that is done in the command file

283 if hasattr( module, "description" ) :

284 print(src.printcolors.printcHeader( _("Description:") ))

285 print(module.description() + '\n')

286

287 # print the description of the command options

288 if hasattr( module, "parser" ) :

289 module.parser.print_help()

290

291 def get_module(self, module):

292 '''Loads a command. Function called only by print_help

293

294 :param module str: the command to load

295 '''

296 # Check if this command exists

297 if not hasattr(self, module):

298 raise src.SatException(_("Command '%s' does not exist") % module)

299

300 # load the module

301 (file_, pathname, description) = imp.find_module(module, [cmdsdir])

302 module = imp.load_module(module, file_, pathname, description)

303 return module

304

305 def print_version():

306 '''prints salomeTools version (in src/internal_config/salomeTools.pyconf)

307 '''

308 # read the config

309 cfgManager = config.ConfigManager()

310 cfg = cfgManager.get_config()

311 # print the key corresponding to salomeTools version

312 print(src.printcolors.printcHeader( _("Version: ") ) +

313 cfg.INTERNAL.sat_version + '\n')

314

315

316 def print_help():

317 '''prints salomeTools general help

318

319 :param options str: the options

320 '''

321 print_version()

322

323 print(src.printcolors.printcHeader( _("Usage: ") ) +

324 "sat [sat_options] <command> [product] [command_options]\n")

325

326 parser.print_help()

327

328 # display all the available commands.

329 print(src.printcolors.printcHeader(_("Available commands are:\n")))

330 for command in lCommand:

331 print(" - %s" % (command))

332

333 # Explain how to get the help for a specific command

334 print(src.printcolors.printcHeader(_("\nGetting the help for a specific"

335 " command: ")) + "sat --help <command>\n")

336

337 def write_exception(exc):

338 '''write exception in case of error in a command

339

340 :param exc exception: the exception to print

341 '''

342 sys.stderr.write("\n***** ")

343 sys.stderr.write(src.printcolors.printcError("salomeTools ERROR:"))

344 sys.stderr.write("\n" + str(exc) + "\n")

345

346 # ###############################

347 # MAIN : terminal command usage #

348 # ###############################

349 if __name__ == "__main__":

350 # Initialize the code that will be returned by the terminal command

351 code = 0

352 (options, args) = parser.parse_args(sys.argv[1:])

353

354 # no arguments : print general help

355 if len(args) == 0:

356 print_help()

357 sys.exit(0)

358

359 # instantiate the salomeTools class with correct options

360 sat = Sat(' '.join(sys.argv[1:]))

361 # the command called

362 command = args[0]

363 # get dynamically the command function to call

364 fun_command = sat.__getattr__(command)

365 # call the command with two cases : mode debug or not

366 if options.debug_mode:

367 # call classically the command and if it fails,

368 # show exception and stack (usual python mode)

369 code = fun_command(' '.join(args[1:]))

370 else:

371 # catch exception in order to show less verbose but elegant message

372 try:

373 code = fun_command(' '.join(args[1:]))

374 except Exception as exc:

375 code = 1

376 write_exception(exc)

377

378 # exit salomeTools with the right code (0 if no errors, else 1)

379 if code is None: code = 0

380 sys.exit(code)

381