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('v', 'verbose', 'int', "output_verbose_level",

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

80 parser.add_option('b', 'batch', 'boolean', "batch",

81 _("batch mode (no question)."))

82 parser.add_option('t', 'all_in_terminal', 'boolean', "all_in_terminal",

83 _("All traces in the terminal (for example compilation logs)."))

84

85 class Sat(object):

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

87 '''

88 def __init__(self, opt='', datadir=None):

89 '''Initialization

90

91 :param opt str: The sat options

92 :param: datadir str : the directory that contain all the external

93 data (like software pyconf and software scripts)

94 '''

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

96 # at the beginning of this file)

97 try:

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

99 except Exception as exc:

100 write_exception(exc)

101 sys.exit(-1)

102

103 # initialization of class attributes

104 self.__dict__ = dict()

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

106 self.arguments = opt

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

108 self.datadir = datadir # default value will be <salomeTools root>/data

109 # set the commands by calling the dedicated function

110 self._setCommands(cmdsdir)

111

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

113 if options.help:

114 try:

115 self.print_help(argus)

116 sys.exit(0)

117 except Exception as exc:

118 write_exception(exc)

119 sys.exit(1)

120

121 def __getattr__(self, name):

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

123 a customized message in case of a wrong call

124

125 :param name str: The name of the attribute

126 '''

127 if name in self.__dict__:

128 return self.__dict__[name]

129 else:

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

131

132 def _setCommands(self, dirPath):

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

134 in the dirPath directory

135

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

137 '''

138 # loop on the commands name

139 for nameCmd in lCommand:

140 # load the module that has name nameCmd in dirPath

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

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

143

144 def run_command(args='', batch = False, verbose = -1, logger_add_link = None):

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

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

147

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

149 '''

150 # Make sure the internationalization is available

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

152

153 # Get the arguments in a list and remove the empty elements

154 argv = args.split(" ")

155 if argv != ['']:

156 while "" in argv: argv.remove("")

157

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

159 appliToLoad = None

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

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

162 argv = argv[1:]

163

164 # read the configuration from all the pyconf files

165 cfgManager = config.ConfigManager()

166 self.cfg = cfgManager.get_config(datadir=self.datadir,

167 application=appliToLoad,

168 options=self.options,

169 command=__nameCmd__)

170

171 # Set the verbose mode if called

172 if verbose > -1:

173 verbose_save = self.options.output_verbose_level

174 self.options.__setattr__("output_verbose_level", verbose)

175

176 # Set batch mode if called

177 if batch:

178 batch_save = self.options.batch

179 self.options.__setattr__("batch", True)

180

181 # set output level

182 if self.options.output_verbose_level is not None:

183 self.cfg.USER.output_verbose_level = self.options.output_verbose_level

184 if self.cfg.USER.output_verbose_level < 1:

185 self.cfg.USER.output_verbose_level = 0

186 silent = (self.cfg.USER.output_verbose_level == 0)

187

188 # create log file, unless the command is called

189 # with a logger as parameter

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

191 silent_sysstd=silent,

192 all_in_terminal=self.options.all_in_terminal)

193

194 if logger_add_link is not None:

195 logger_add_link.xmlFile.append_node_attrib("Links", attrib={__nameCmd__ : logger_command.logFilePath})

196

197 try:

198 # Execute the hooks (if there is any)

199 # and run method of the command

200 self.run_hook(__nameCmd__, C_PRE_HOOK, logger_command)

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

202 self.run_hook(__nameCmd__, C_POST_HOOK, logger_command)

203

204 # set res if it is not set in the command

205 if res is None:

206 res = 0

207

208 # come back in the original batch mode if

209 # batch argument was called

210 if batch:

211 self.options.__setattr__("batch", batch_save)

212

213 # come back in the original verbose mode if

214 # verbose argument was called

215 if verbose > -1:

216 self.options.__setattr__("output_verbose_level",

217 verbose_save)

218

219 finally:

220 # put final attributes in xml log file

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

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

223 os.path.sep +

224 'sat',

225 __nameCmd__,

226 args])

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

228

229 return res, logger_command.logFilePath

230

231 # Make sure that run_command will be redefined

232 # at each iteration of the loop

233 globals_up = {}

234 globals_up.update(run_command.__globals__)

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

236 func = types.FunctionType(run_command.__code__,

237 globals_up,

238 run_command.__name__,

239 run_command.__defaults__,

240 run_command.__closure__)

241

242 # set the attribute corresponding to the command

243 self.__setattr__(nameCmd, func)

244

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

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

247 it is pre or post

248

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

250 :param hook_type str: pre or post

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

252 '''

253 # The hooks must be defined in the application pyconf

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

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

256 return

257

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

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

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

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

262 return

263

264 # Get the hook_script path and verify that it exists

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

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

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

268 hook_script_path)

269

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

271 try:

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

273 pymodule = imp.load_source(cmd_name, hook_script_path)

274

275 # format a message to be printed at hook execution

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

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

278 src.printcolors.printcInfo(hook_script_path))

279

280 # run the function run_pre_hook if this function is called

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

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

283 logger.write(msg, 1)

284 pymodule.run_pre_hook(self.cfg, logger)

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

286 logger.write(msg, 1)

287 pymodule.run_post_hook(self.cfg, logger)

288

289 except Exception as exc:

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

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

292 raise src.SatException(msg)

293

294 def print_help(self, opt):

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

296

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

298 '''

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

300 if len(opt)==0:

301 print_help()

302 return

303 # get command name

304 command = opt[0]

305 # read the configuration from all the pyconf files

306 cfgManager = config.ConfigManager()

307 self.cfg = cfgManager.get_config(datadir=self.datadir)

308

309 # Check if this command exists

310 if not hasattr(self, command):

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

312

313 # Print salomeTools version

314 print_version()

315

316 # load the module

317 module = self.get_module(command)

318

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

320 if hasattr( module, "description" ) :

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

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

323

324 # print the description of the command options

325 if hasattr( module, "parser" ) :

326 module.parser.print_help()

327

328 def get_module(self, module):

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

330

331 :param module str: the command to load

332 '''

333 # Check if this command exists

334 if not hasattr(self, module):

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

336

337 # load the module

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

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

340 return module

341

342 def print_version():

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

344 '''

345 # read the config

346 cfgManager = config.ConfigManager()

347 cfg = cfgManager.get_config()

348 # print the key corresponding to salomeTools version

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

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

351

352

353 def print_help():

354 '''prints salomeTools general help

355

356 :param options str: the options

357 '''

358 print_version()

359

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

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

362

363 parser.print_help()

364

365 # display all the available commands.

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

367 for command in lCommand:

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

369

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

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

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

373

374 def write_exception(exc):

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

376

377 :param exc exception: the exception to print

378 '''

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

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

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

382

383 # ###############################

384 # MAIN : terminal command usage #

385 # ###############################

386 if __name__ == "__main__":

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

388 code = 0

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

390

391 # no arguments : print general help

392 if len(args) == 0:

393 print_help()

394 sys.exit(0)

395

396 # instantiate the salomeTools class with correct options

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

398 # the command called

399 command = args[0]

400 # get dynamically the command function to call

401 fun_command = sat.__getattr__(command)

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

403 if options.debug_mode:

404 # call classically the command and if it fails,

405 # show exception and stack (usual python mode)

406 code, __ = fun_command(' '.join(args[1:]))

407 else:

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

409 try:

410 code, __ = fun_command(' '.join(args[1:]))

411 except Exception as exc:

412 code = 1

413 write_exception(exc)

414

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

416 if code is None: code = 0

417 sys.exit(code)

418