3 # Copyright (C) 2010-2012 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
19 '''This file is the main entry file to salomeTools
32 # get path to salomeTools sources
33 satdir = os.path.dirname(os.path.realpath(__file__))
34 cmdsdir = os.path.join(satdir, 'commands')
36 # Make the src package accessible from all code
37 sys.path.append(satdir)
38 sys.path.append(cmdsdir)
42 # load resources for internationalization
43 #es = gettext.translation('salomeTools', os.path.join(satdir, 'src', 'i18n'))
45 gettext.install('salomeTools', os.path.join(satdir, 'src', 'i18n'))
47 def find_command_list(dirPath):
48 ''' Parse files in dirPath that end with .py : it gives commands list
50 :param dirPath str: The directory path where to search the commands
51 :return: cmd_list : the list containing the commands name
55 for item in os.listdir(dirPath):
56 if item.endswith('.py'):
57 cmd_list.append(item[:-len('.py')])
60 # The list of valid salomeTools commands
61 #lCommand = ['config', 'compile', 'prepare']
62 lCommand = find_command_list(cmdsdir)
64 # Define all possible option for salomeTools command : sat <option> <args>
65 parser = src.options.Options()
66 parser.add_option('h', 'help', 'boolean', 'help', _("shows global help or help on a specific command."))
67 parser.add_option('o', 'overwrite', 'list', "overwrite", _("overwrites a configuration parameters."))
68 parser.add_option('g', 'debug', 'boolean', 'debug_mode', _("run salomeTools in debug mode."))
71 '''The main class that stores all the commands of salomeTools
73 def __init__(self, opt='', dataDir=None):
76 :param opt str: The sat options
77 :param: dataDir str : the directory that contain all the external data (like software pyconf and software scripts)
79 # Read the salomeTools options (the list of possible options is at the beginning of this file)
81 (options, argus) = parser.parse_args(opt.split(' '))
82 except Exception as exc:
86 # initialization of class attributes
87 self.__dict__ = dict()
88 self.cfg = None # the config that will be read using pyconf module
89 self.options = options # the options passed to salomeTools
90 self.dataDir = dataDir # default value will be <salomeTools root>/data
91 # set the commands by calling the dedicated function
92 self.__setCommands__(cmdsdir)
94 # if the help option has been called, print help and exit
97 self.print_help(argus)
99 except Exception as exc:
103 def __getattr__(self, name):
104 ''' overwrite of __getattr__ function in order to display a customized message in case of a wrong call
106 :param name str: The name of the attribute
108 if name in self.__dict__:
109 return self.__dict__[name]
111 raise AttributeError(name + _(" is not a valid command"))
113 def __setCommands__(self, dirPath):
114 '''set class attributes corresponding to all commands that are in the dirPath directory
116 :param dirPath str: The directory path containing the commands
118 # loop on the commands name
119 for nameCmd in lCommand:
120 # load the module that has name nameCmd in dirPath
121 (file_, pathname, description) = imp.find_module(nameCmd, [dirPath])
122 module = imp.load_module(nameCmd, file_, pathname, description)
124 def run_command(args=''):
125 '''The function that will load the configuration (all pyconf)
126 and return the function run of the command corresponding to module
128 :param args str: The directory path containing the commands
130 argv = args.split(" ")
132 # if it is provided by the command line, get the application
134 if argv != [''] and argv[0][0] != "-":
135 appliToLoad = argv[0].rstrip('*')
138 # Read the config if it is not already done
140 # read the configuration from all the pyconf files
141 cfgManager = config.ConfigManager()
142 self.cfg = cfgManager.getConfig(dataDir=self.dataDir, application=appliToLoad, options=self.options, command=__nameCmd__)
144 return __module__.run(argv, self)
146 # Make sure that run_command will be redefined at each iteration of the loop
148 globals_up.update(run_command.__globals__)
149 globals_up.update({'__nameCmd__': nameCmd, '__module__' : module})
150 func = types.FunctionType(run_command.__code__, globals_up, run_command.__name__,run_command.__defaults__, run_command.__closure__)
152 # set the attribute corresponding to the command
153 self.__setattr__(nameCmd, func)
155 def print_help(self, opt):
156 '''Prints help for a command. Function called when "sat -h <command>"
158 :param argv str: the options passed (to get the command name)
160 # if no command as argument (sat -h)
166 # read the configuration from all the pyconf files
167 cfgManager = config.ConfigManager()
168 self.cfg = cfgManager.getConfig(dataDir=self.dataDir)
170 # Check if this command exists
171 if not hasattr(self, command):
172 raise src.SatException(_("Command '%s' does not exist") % command)
174 # Print salomeTools version
178 module = self.get_module(command)
180 # print the description of the command that is done in the command file
181 if hasattr( module, "description" ) :
182 print(src.printcolors.printcHeader( _("Description:") ))
183 print(module.description() + '\n')
185 # print the description of the command options
186 if hasattr( module, "parser" ) :
187 module.parser.print_help()
189 def get_module(self, module):
190 '''Loads a command. Function called only by print_help
192 :param module str: the command to load
194 # Check if this command exists
195 if not hasattr(self, module):
196 raise src.SatException(_("Command '%s' does not exist") % module)
199 (file_, pathname, description) = imp.find_module(module, [cmdsdir])
200 module = imp.load_module(module, file_, pathname, description)
204 '''prints salomeTools version (in src/internal_config/salomeTools.pyconf)
207 cfgManager = config.ConfigManager()
208 cfg = cfgManager.getConfig()
209 # print the key corresponding to salomeTools version
210 print(src.printcolors.printcHeader( _("Version: ") ) + cfg.INTERNAL.sat_version + '\n')
214 '''prints salomeTools general help
216 :param options str: the options
220 print(src.printcolors.printcHeader( _("Usage: ") ) + "sat [sat_options] <command> [product] [command_options]\n")
224 # display all the available commands.
225 print(src.printcolors.printcHeader(_("Available commands are:\n")))
226 for command in lCommand:
227 print(" - %s" % (command))
229 # Explain how to get the help for a specific command
230 print(src.printcolors.printcHeader(_("\nGetting the help for a specific command: ")) + "sat --help <command>\n")
232 def write_exception(exc):
233 '''write exception in case of error in a command
235 :param exc exception: the exception to print
237 sys.stderr.write("\n***** ")
238 sys.stderr.write(src.printcolors.printcError("salomeTools ERROR:"))
239 sys.stderr.write("\n" + str(exc) + "\n")
241 # ###############################
242 # MAIN : terminal command usage #
243 # ###############################
244 if __name__ == "__main__":
245 # Get the command line using sys.argv
246 cmd_line = " ".join(sys.argv)
247 # Initialize the code that will be returned by the terminal command
249 (options, args) = parser.parse_args(sys.argv[1:])
251 # no arguments : print general help
256 # instantiate the salomeTools class with correct options
257 sat = Sat(' '.join(sys.argv[1:]))
260 # get dynamically the command function to call
261 fun_command = sat.__getattr__(command)
262 # call the command with two cases : mode debug or not
263 if options.debug_mode:
264 # call classically the command and if it fails, show exception and stack (usual python mode)
265 code = fun_command(' '.join(args[1:]))
267 # catch exception in order to show less verbose but elegant message
269 code = fun_command(' '.join(args[1:]))
270 except Exception as exc:
274 # exit salomeTools with the right code (0 if no errors, else 1)
275 if code is None: code = 0