CreateProdScripts.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
 
 
 
#  create an mc production file from a decay file
#  warning: this script is under development
 
from optparse import OptionParser, OptionValueError
import glob
import time
import sys
import logging
import re
import os
version = 'v1'
 
bkk_first = True
eventid_inbkk = []
sql_first = True
eventid_insql = []
list_of_obsoletes = []
exit_status = 0
list_of_wg = ['SL', 'EWP', 'TCPV', 'HAD', 'CHARM', 'ONIA', 'TAU']
 
 
class GenericOptionFile(object):
 
    """
    Class to write in an option file
    """
 
    def __init__(self):
        """
        Constructor.
        Parameters:
             filename   name of the file
             f          alternative name of the file
        """
        
        self.filenamefilename = None
        
        self.ff = None
 
    def __del__(self):
        """
        Destructor.
        """
        self.CloseClose()
 
    def Close(self):
        """
        Close file.
        """
        if self.ff:
            self.ff.close()
 
    def OptionFileName(self):
        """
        Set option file name.
        """
        return self.filenamefilename
 
    def SetFileName(self, filename):
        """
        Set file name.
        """
        self.filenamefilename = os.path.normpath(filename + self.suffix)
 
    def Open(self):
        """
        Open file.
        """
        if self.filenamefilename:
            self.ff = open(self.filenamefilename, 'w')
 
    def Write(self, lines):
        """
        Write the lines in the file.
        """
 
        self.ff.writelines([line + '\n' for line in lines])
 
    def WriteHeader(self, eventtype, descriptor):
        """
        Write header of .dec file.
        """
        timeString = time.strftime("%a, %d %b %Y %H:%M:%S", time.localtime())
        lines = [
            f"{self.comment} file {self.filename} generated: {timeString}",
            self.comment,
            f"{self.comment} Event Type: {eventtype}",
            self.comment,
            f"{self.comment} ASCII decay Descriptor: {descriptor}",
            self.comment
        ]
 
        self.WriteWrite(lines)
 
    def AddExtraOptions(self, eventtype):
        """
        Adds extra options.
        """
        self.AddInclude(eventtype.ExtraOptions())
 
    def AddEventTypeNumber(self, eventtype):
        """
        Adds the Event Type Number.
        """
        self.AddOptionValue('GenerationEventType', eventtype.EventTypeNumber())
 
    def AddEvtGenUserDecayFile(self, eventtype):
        """
        Set the EvtGen .dec file.
        """
        self.AddOptionValue('EvtGenUserDecayFile',
                            '"$DECFILESROOT/dec/{0}.dec"'.format(eventtype.DecayName()))
 
    def AddDecayOptions(self, eventtype):
        """
        Specify options for .dec file.
        """
        [self.AddOptionValue('ToolSvc.{0}Decay.{1}'.format(
            eventtype.DecayEngine(), eventtype.DecayOptions().split()[2 * i]),
            eventtype.DecayOptions().split()[2 * i + 1])
         for i in range(len(eventtype.DecayOptions().split()) / 2)]
 
 
class TextOptionFile(GenericOptionFile):
 
    """
    Class to read generic option file in .txt format.
 
    Attributes:
         comment     comment string
         suffix      suffix string
         true_string true string
         list_begin  open list parenthesis
         list_end    close list parenthesis
 
    """
    
    comment = '//'
    
    suffix = '.opts'
    
    true_string = 'true'
    
    list_begin = '{'
    
    list_end = '}'
 
    def AddOptionValue(self, option, value, substitute=False):
        """
        Set the value of option.
        """
        self.WriteWrite(['{0} = {1};'.format(option, value)])
 
    def AddInclude(self, filename):
        """
        Add include statements.
        """
        self.WriteWrite(['#include "$DECFILESROOT/prod/{0}.py"'.format(filename)])
 
    def IncreaseOptionValue(self, option, value):
        """
        Add option string.
        """
        self.WriteWrite(['{0} += {1};'.format(option, value)])
 
 
class PythonOptionFile(GenericOptionFile):
 
    """
    Class to read generic option file in .py format.
 
    Attributes:
         comment     comment string
         suffix      suffix string
         true_string true string
         list_begin  open list parenthesis
         list_end    close list parenthesis
 
    """
    
    comment = '#'
    
    suffix = '.py'
    
    true_string = 'True'
    
    list_begin = '['
    
    list_end = ']'
 
    def __init__(self):
        """
        Constructor.
 
        Attributes:
             list_algorithm list of algorithms
             list_tool      list of tools
        """
        
        self.list_algorithmlist_algorithm = []
        
        self.list_toollist_tool = []
        super(PythonOptionFile, self).__init__()
 
    def AddOptionValue(self, option, value, substitute=False):
        """
        Add option string.
        """
        value = value.replace('{', '[')
        value = value.replace('}', ']')
        if substitute:
            value = value.replace('true', 'True')
            value = value.replace('false', 'False')
        self.WriteWrite(['{0} = {1}'.format(option, value)])
 
    def IncreaseOptionValue(self, option, value):
        """
        Add option string.
        """
        option = self.ConfigureToolAndAlgo(option)
        self.WriteWrite(['{0} += {1}'.format(option, value)])
 
 
class EventType:
 
    """
    Class to hold event type information.
 
    Attributes:
         MandatoryKeywords list of mandatory keywords for file description
         OptionalKeywords  list of optional keywords for file description
    """
    
    MandatoryKeywords = [
        'EventType',
        'Descriptor',
        'NickName',
        'Cuts',
        'Documentation',
        'PhysicsWG',
        'Tested',
        'Responsible',
        'Email',
        'Date',
    ]
    
    OptionalKeywords = [
        'Sample',
        'ExtraOptions',
        'DecayOptions',
        'DecayEngine',
        'CutsOptions',
        'Configuration',
        'ParticleType',
        'Momentum',
        'MomentumRange',
        'Id',
        'Production',
        'FullEventCuts',
        'ParticleValue',
        'ParticleTable',
        'InsertPythonCode',
    ]
 
    def __init__(self, filename, remove, technology):
        """
        Constructor.
 
        Attributes:
             DecayFileName     name of decay file
             KeywordDictionary dictionary of keywords
             remove            "remove file" flag - force removing the option file and create a new one
             OptionFile        flag for existence of option file
             technology        specify the langauge of the script
        """
 
        
        self.DecayFileNameDecayFileName = os.path.normpath(filename)
        
        self.KeywordDictionaryKeywordDictionary = {}
        
        self.removeremove = remove
        
        self.OptionFileOptionFile = None
        
        self.technologytechnology = technology
 
    def DecodeDecayFile(self):
        """
        Operates deconding of decay file.
        """
        fullstring = ''
        with open(self.DecayFileNameDecayFileName, 'rb') as f:
            for line in f:
                # Keep only lines starting with '#'
                if line.startswith('# '):
                    line = line.replace('# ', '', 1)
                    fullstring += line
                elif line.startswith('#'):
                    line = line.lstrip('#')
                    fullstring += line
 
        pattern1 = r'(?m)(\w+): (.+)'
        pattern2 = r'(Documentation):((?s).*)EndDocumentation'
        pattern3 = r'(InsertPythonCode):((?s).*)EndInsertPythonCode'
        matchObj1 = re.findall(pattern1, fullstring)
        matchObj2 = re.findall(pattern2, fullstring)
        matchObj3 = re.findall(pattern3, fullstring)
        if matchObj1 or matchObj2 or matchObj3:
            for matchobj in matchObj1 + matchObj2 + matchObj3:
                self.KeywordDictionaryKeywordDictionary[matchobj[0]] = matchobj[1]
        keystodelete = []
        # delete keys found if Python Code
        if matchObj3:
            matchObj = re.findall(pattern1,
                                  self.KeywordDictionaryKeywordDictionary['InsertPythonCode'])
            if matchObj:
                for matchobj in matchObj:
                    keystodelete.append(matchobj[0])
        # remove leading and ending spaces, except for python code
        for (k, v) in self.KeywordDictionaryKeywordDictionary.items():
            if k != 'InsertPythonCode':
                self.KeywordDictionaryKeywordDictionary[k] = v.rstrip(' \n').lstrip(' \n')
                if self.KeywordDictionaryKeywordDictionary[k] == '':
                    keystodelete.append(k)
        for k in keystodelete:
            del self.KeywordDictionaryKeywordDictionary[k]
 
    def Validate(self, obsoletes):
        """
        Check for the presence of mandatory keywords.
        """
        missing_mandatory = set(self.MandatoryKeywordsMandatoryKeywords) \
            - set(self.KeywordDictionaryKeywordDictionary.keys())
        if len(missing_mandatory) != 0:
            logging.error('%s.dec is missing mandatory keywords: %s',
                          self.DecayNameDecayName(), [key for key in missing_mandatory])
            raise SyntaxWarning
        unknown_keywords = set(self.KeywordDictionaryKeywordDictionary.keys()) \
            - (set(self.MandatoryKeywordsMandatoryKeywords) | set(self.OptionalKeywordsOptionalKeywords))
        if len(unknown_keywords) != 0:
            logging.error('%s.dec contains unknown keywords: %s',
                          self.DecayNameDecayName(), [key for key in unknown_keywords])
            raise SyntaxWarning
 
        # check if the nickname is correct
        if self.NickNameNickName() != self.DecayNameDecayName():
            logging.error(
                'In %s, the nickname %s is not equal to the name of the file %s.',
                self.DecayFileNameDecayFileName,
                self.KeywordDictionaryKeywordDictionary['NickName'],
                self.DecayNameDecayName())
            raise UserWarning
 
        # check if the date format is correct
        try:
            time.strptime(self.DateDate(), '%Y%m%d')
        except ValueError:
            logging.error(
                'In %s, the date format is not correct, it should be YYYYMMDD instead of %s.',
                self.DecayFileNameDecayFileName,
                self.DateDate())
            raise UserWarning
 
        # check physics wg name
        if self.PhysicsWGPhysicsWG() not in list_of_wg:
            logging.error('In %s, the name of the WG is not correct: %s.',
                          self.DecayFileNameDecayFileName, self.PhysicsWGPhysicsWG())
 
        # check the event type does not start with 0
        if self.EventTypeNumberEventTypeNumber()[0] == '0':
            logging.error('The EventType is not correct in %s.',
                          self.DecayFileNameDecayFileName)
            logging.error('It cannot start with 0.')
            raise UserWarning
 
        # check the event type has at least 8 digits
        if len(self.EventTypeNumberEventTypeNumber()) < 8:
            logging.error('The EventType is not correct in %s.',
                          self.DecayFileNameDecayFileName)
            logging.error('It must have at least 8 digits.')
            raise UserWarning
 
        # check if the event is obsolete
        if self.EventTypeNumberEventTypeNumber() in obsoletes:
            logging.error(
                'The EventType %s is in use in the obsolete list, please change it.',
                self.EventTypeNumberEventTypeNumber())
            raise UserWarning
 
        # check Tested is equal to Yes or No
        self.KeywordDictionaryKeywordDictionary['Tested'] = self.KeywordDictionaryKeywordDictionary['Tested'].lower(
        )
        if self.KeywordDictionaryKeywordDictionary['Tested'] != 'yes' and self.KeywordDictionaryKeywordDictionary['Tested'] != 'no':
            logging.error(
                'In %s, Tested should be equal to Yes or No',
                self.DecayNameDecayName())
            raise UserWarning
 
        # check that the file has been tested (check can be disabled with
        # --force option)
        if self.KeywordDictionaryKeywordDictionary['Tested'] == 'no':
            logging.error('The decay file %s has not been tested',
                          self.DecayNameDecayName())
            raise SyntaxWarning
 
    def EventTypeNumber(self):
        """
        Returns event type number.
        """
        return self.KeywordDictionaryKeywordDictionary['EventType'].replace(' ', '')
 
    def G(self):
        """
        Returns general flag of event type.
        """
        return self.EventTypeNumberEventTypeNumber()[0]
 
    def S(self):
        """
        Returns selection flag of event type.
        """
        return self.EventTypeNumberEventTypeNumber()[1]
 
    def D(self):
        """
        Returns the decay flag of even type.
        """
        return self.EventTypeNumberEventTypeNumber()[2]
 
    def C(self):
        """
        Returns the charm flag of even type.
        """
        return self.EventTypeNumberEventTypeNumber()[3]
 
    def L(self):
        """
        Returns the lepton flag of even type.
        """
        return self.EventTypeNumberEventTypeNumber()[4]
 
    def T(self):
        """
        Returns the track flag of even type.
        """
        return self.EventTypeNumberEventTypeNumber()[5]
 
    def N(self):
        """
        Returns the neutral flag of even type.
        """
        return self.EventTypeNumberEventTypeNumber()[6]
 
    def K(self):
        """
        Returns the neutral Kaons flag of even type.
        """
        return self.EventTypeNumberEventTypeNumber()[7]
 
    def E(self):
        """
        Returns the extra flag of even type.
        """
        return self.EventTypeNumberEventTypeNumber()[8]
 
    def U(self):
        """
        Returns the user flag of even type.
        """
        return self.EventTypeNumberEventTypeNumber()[9]
 
    def IsSpecialSource(self):
        """
        Check whether it is a special source.
        """
        return self.EventTypeNumberEventTypeNumber()[0] == '6' and self.EventTypeNumberEventTypeNumber()[3] \
            == '5' or self.EventTypeNumberEventTypeNumber()[0] == '6' \
            and self.EventTypeNumberEventTypeNumber()[3] == '4'
 
    def SetOptionFileName(self, filename=None):
        """
        Set name of option file.
        """
        if 'Text' in self.technologytechnology:
            self.OptionFileOptionFile = TextOptionFile()
        else:
            self.OptionFileOptionFile = PythonOptionFile()
 
        if not filename:
            filename = '{0}/prod/{1}'.format(
                os.environ['DECFILESROOT'], self.EventTypeNumberEventTypeNumber())
 
        self.OptionFileOptionFile.SetFileName(filename)
        if os.path.exists(self.OptionFileOptionFile.OptionFileName()):
            if self.removeremove:
                os.remove(self.OptionFileOptionFile.OptionFileName())
            else:
                logging.warning('The file %s already exists.',
                                self.OptionFileOptionFile.OptionFileName())
                logging.warning(
                    'To overwrite it, you should remove it first or run with the --remove option.')
                raise UserWarning
        self.OptionFileOptionFile.Open()
 
    def DecayDescriptor(self):
        """
        Returns decay descriptor.
        """
        return self.KeywordDictionaryKeywordDictionary['Descriptor']
 
    def HasPythonCodeToInsert(self):
        """
        Check if there is python code to be inserted.
        """
        return 'InsertPythonCode' in self.KeywordDictionaryKeywordDictionary
 
    def PythonCodeToInsert(self):
        """
        Returns the python code to be inserted.
        """
        return self.KeywordDictionaryKeywordDictionary['InsertPythonCode']
 
    def HasExtraOptions(self):
        """
        Check if it has extra options.
        """
        return 'ExtraOptions' in self.KeywordDictionaryKeywordDictionary
 
    def ExtraOptions(self):
        """
        Returns the extra options.
        """
        return self.KeywordDictionaryKeywordDictionary['ExtraOptions']
 
    def HasDecayEngine(self):
        """
        Check if decay engine has been specified.
        """
        return 'DecayEngine' in self.KeywordDictionaryKeywordDictionary
 
    def DecayEngine(self):
        """
        Returns the decay engine.
        """
        return self.KeywordDictionaryKeywordDictionary['DecayEngine']
 
    def HasDecayOptions(self):
        """
        Check if decay options have been specified.
        """
        return 'DecayOptions' in self.KeywordDictionaryKeywordDictionary
 
    def DecayOptions(self):
        """
        Returns the decay options.
        """
        return self.KeywordDictionaryKeywordDictionary['DecayOptions']
 
    def HasParticleTable(self):
        """
        Check whether particle table already exists.
        """
        return 'ParticleTable' in self.KeywordDictionaryKeywordDictionary
 
    def ParticleTable(self):
        """
        Return particle table.
        """
        return self.KeywordDictionaryKeywordDictionary['ParticleTable']
 
    def HasParticleValue(self):
        """
        Check if particle value parameter has been specified.
        """
        return 'ParticleValue' in self.KeywordDictionaryKeywordDictionary
 
    def ParticleValue(self):
        """
        Returns particle value.
        """
        return self.KeywordDictionaryKeywordDictionary['ParticleValue']
 
    def HasConfiguration(self):
        """
        Check if configuration is present in keyword dictionary.
        """
        return 'Configuration' in self.KeywordDictionaryKeywordDictionary
 
    def Configuration(self):
        """
        Returns configuration.
        """
        return self.KeywordDictionaryKeywordDictionary['Configuration'].split()
 
    def HasParticleType(self):
        """
        Check if Particle Type is present in keyword dictionary.
        """
        return 'ParticleType' in self.KeywordDictionaryKeywordDictionary
 
    def ParticleType(self):
        """
        Returns Particle Type.
        """
        return self.KeywordDictionaryKeywordDictionary['ParticleType'].split()
 
    def HasMomentum(self):
        """
        Check if momentum is present in keyword dictionary.
        """
        return 'Momentum' in self.KeywordDictionaryKeywordDictionary
 
    def Momentum(self):
        """
        Returns momentum.
        """
        return self.KeywordDictionaryKeywordDictionary['Momentum'].split()
 
    def HasMomentumRange(self):
        """
        Check if momentum range is present in keyword dictionary.
        """
        return 'MomentumRange' in self.KeywordDictionaryKeywordDictionary
 
    def MomentumRange(self):
        """
        Returns momentum range.
        """
        return self.KeywordDictionaryKeywordDictionary['MomentumRange'].split()
 
    def NickName(self):
        """
        Return decay NickName.
        """
        return self.KeywordDictionaryKeywordDictionary['NickName'].replace(' ', '')
 
    def Date(self):
        """
        Return date.
        """
        return self.KeywordDictionaryKeywordDictionary['Date']
 
    def PhysicsWG(self):
        """
        Return mode WG.
        """
        return self.KeywordDictionaryKeywordDictionary['PhysicsWG']
 
    def DecayName(self):
        """
        Return decay name string.
        """
        return os.path.splitext(os.path.split(self.DecayFileNameDecayFileName)[1])[0]
 
    def Sample(self):
        """
        Check if overriden.
        """
        if 'Sample' in self.KeywordDictionaryKeywordDictionary:
            sample = self.KeywordDictionaryKeywordDictionary['Sample']
        elif int(self.EventTypeNumberEventTypeNumber()[0]) in (1, 2, 3, 7):
            if int(self.EventTypeNumberEventTypeNumber()[1]) in (0, 9):
                sample = 'Inclusive'
            elif int(self.EventTypeNumberEventTypeNumber()[0]) == 1 and int(self.EventTypeNumberEventTypeNumber()[1]) in (1, 2, 3, 6, 7):
                sample = 'Signal'
        else:
            sample = 'otherTreatment'
        return sample
 
    def Production(self):
        """
        Checks for production algorithm.
        """
        production = 'Pythia'
        if 'Production' in self.KeywordDictionaryKeywordDictionary:
            production = self.KeywordDictionaryKeywordDictionary['Production']
        return production
 
    def HeaderOptions(self):
        """
        Write the header of the options file.
        """
 
        self.OptionFileOptionFile.WriteHeader(self.EventTypeNumberEventTypeNumber(),
                                    self.DecayDescriptorDecayDescriptor())
 
 
def writeBkkTable(evttypeid, descriptor, nickname):
    """
    Write the file to create the entry in the ORACLE database.
    """
 
    global bkk_first, eventid_inbkk
    TableName = '../doc/table_event.txt'
    logging.warning(TableName)
    if bkk_first:
        bkk_first = False
        if not os.path.exists(TableName):
            with open(TableName, 'wb') as f:
                line = 'EventTypeID | NickName | Description\n'
                f.write(line)
        else:
            # read the file
            with open(TableName, 'rb') as f:
                for line in f:
                    eventid_inbkk.append(line.split()[0])
 
    if evttypeid not in eventid_inbkk:
        eventid_inbkk.append(evttypeid)
        nick = nickname[:255]
        desc = descriptor[:255]
        with open(TableName, 'a+') as f:
            line = '{0} | {1} | {2}\n'.format(evttypeid, nick, desc)
            f.write(line)
 
 
def writeSQLTable(evttypeid, descriptor, nickname):
    """
    Write the file to create the entry in the  database.
    """
 
    global sql_first, eventid_insql
    TableName = '../doc/table_event.sql'
 
    if sql_first:
        sql_first = False
        if not os.path.exists(TableName):
            os.system('touch ' + TableName)
        else:
            # read the file
            with open(TableName, 'rb') as f:
                for line in f:
                    eventid_insql.append(line.split()[2].strip(','))
 
    if evttypeid not in eventid_insql:
        eventid_insql.append(evttypeid)
        nick = nickname[:255]
        desc = descriptor[:255]
        with open(TableName, 'a+') as f:
            line = 'EVTTYPEID = {0}, DESCRIPTION = "{1}", PRIMARY = "{2}"\n'.format(
                evttypeid, nick, desc)
            f.write(line)
 
 
def readObsoleteTypeTable():
    """
    Read the table of obsolete events.
    """
 
    filename = '../doc/table_obsolete.sql'
    global list_of_obsoletes
    try:
        with open(filename, 'rb') as f:
            for line in f:
                list_of_obsoletes.append(line.split()[2].strip(','))
                logging.info(' This will be ignored %s', line)
    except IOError:
        logging.warning('No files containing obsolete event types found')
    except IndexError:
        pass
 
 
def run_create(dkfile, remove, python, force):
    """
    Create an options file corresponding to a single decay file.
    """
 
    technology = 'Text'
    if python:
        technology = 'Python'
 
    eventtype = EventType(dkfile, remove, technology)
    eventtype.DecodeDecayFile()
 
    logging.info('Creation of production script file for Decay file %s.dec',
                 eventtype.DecayName())
    try:
        eventtype.Validate(list_of_obsoletes)
    except SyntaxWarning:
        if force:
            pass
        else:
            raise UserWarning
 
    # check if the options file already exist and do not overwrite it
    eventtype.SetOptionFileName()
 
    # get the first digit of the eventtype
    eventtype.EventTypeNumber()[0:2]
    eventtype.EventTypeNumber()[0:2] + eventtype.E()
    eventtype.EventTypeNumber()[0:2] + eventtype.U()
 
    eventtype.HeaderOptions()
 
    # Optional lines for all event types ---------------------------------
    # Check if exists ExtraOptions keyword
    if eventtype.HasExtraOptions():
        eventtype.OptionFile.AddExtraOptions(eventtype)
 
    # Mandatory lines to write -------------------------------------------
    # Event type number
    eventtype.OptionFile.AddEventTypeNumber(eventtype)
 
    # Decay tool
    if not eventtype.HasDecayEngine():
        eventtype.OptionFile.AddEvtGenUserDecayFile(eventtype)
    else:
        eventtype.OptionFile.AddDecayEngine(eventtype)
 
    # Generation.SAMPLE.GENERATOR.InclusivePIDList
    # if Inclusive
    if 'Inclusive' in eventtype.Sample():
        if eventtype.G() == '1':
            pidlist = '521, -521, 511, -511, 531, -531, 541, -541, 5122, -5122, 5222, -5222, 5212, -5212, 5112, -5112, ' \
                '5312, -5312, 5322, -5322, 5332, -5332, 5132, -5132, 5232, -5232'
        elif int(eventtype.G()) in (2, 7):
            pidlist = '421, -421, 411, -411, 431, -431, 4122, -4122, 443, 4112, -4112, 4212, -4212, 4222, -4222, 4312, ' \
                '-4312, 4322, -4322, 4332, -4332, 4132, -4132, 4232, -4232, 100443, 441, 10441, 20443, 445, 4214, -4214, ' \
                '4224, -4224, 4314, -4314, 4324, -4324, 4334, -4334, 4412, -4412, 4414,-4414, 4422, -4422, 4424, -4424, 4432, ' \
                '-4432, 4434, -4434, 4444, -4444, 14122, -14122,  14124, -14124, 100441'
        eventtype.OptionFile.AddInclusivePIDList(eventtype, pidlist)
 
    # Check if exists ParticleTable keyword
    if eventtype.HasParticleTable():
        eventtype.OptionFile.AddParticleTable(eventtype)
 
    # Check if exists ParticleValue keyword
    if eventtype.HasParticleValue():
        eventtype.OptionFile.AddParticleValue(eventtype)
 
    # insert python lines directly
    if technology == 'Python':
        if eventtype.HasPythonCodeToInsert():
            eventtype.OptionFile.Write([eventtype.PythonCodeToInsert()])
 
    writeBkkTable(eventtype.EventTypeNumber(), eventtype.DecayDescriptor(),
                  eventtype.NickName())
    writeSQLTable(eventtype.EventTypeNumber(), eventtype.DecayDescriptor(),
                  eventtype.NickName())
 
 
def run_loop(remove, python, force):
    """
    Loop in the FILES directory to generate the options file.
    """
 
    files = glob.glob(os.environ['DECFILESROOT'] + '/dec/*.dec')
    for f in files:
        try:
            run_create(f, remove, python, force)
        except UserWarning:
            pass
 
 
def CheckFile(option, opt_str, value, parser):
    """
    Check if file exists.
    """
 
    if not os.path.exists('{0}/dec/{1}.dec'.format(os.environ['DECFILESROOT'],
                                                   value)):
        raise OptionValueError('Decay file %s.dec ' % value + 'does not ' +
                               'exist in the $DECFILESROOT/dec directory')
    setattr(parser.values, option.dest, value)
 
 
# ---------------------------------------------------------------------------
# Color formatting
# ---------------------------------------------------------------------------
 
(
    BLACK,
    RED,
    GREEN,
    YELLOW,
    BLUE,
    MAGENTA,
    CYAN,
    WHITE,
) = list(range(8))
 
# The background is set with 40 plus the number of the color, and the
# foreground with 30
 
# These are the sequences need to get colored ouput
RESET_SEQ = "\033[0m"
COLOR_SEQ = "\033[1;%d;40m"
BOLD_SEQ = "\033[1m"
 
COLORS = {
    'WARNING': YELLOW,
    'INFO': WHITE,
    'DEBUG': BLUE,
    'CRITICAL': YELLOW,
    'ERROR': RED,
}
 
 
class ColoredFormatter(logging.Formatter):
 
    """
    Define color convention for output messages.
    """
 
    def __init__(self, msg, use_color=True):
        """
        Constructor.
 
        Attributes:
             use_color use color output flag
        """
        logging.Formatter.__init__(self, msg)
 
        
        self.use_coloruse_color = use_color
 
    def format(self, record):
        """
        Set output format.
        """
        levelname = record.levelname
        color = COLOR_SEQ % (30 + COLORS[levelname])
        message = logging.Formatter.format(self, record)
        message = message.replace(
            '$RESET',
            RESET_SEQ).replace(
            '$BOLD',
            BOLD_SEQ).replace(
            '$COLOR',
            color)
        return message + RESET_SEQ
 
 
# ---------------------------------------------------------------------------
# Main routine
# ---------------------------------------------------------------------------
 
def main():
    global exit_status
    
    mylog = logging.StreamHandler()
    logging.getLogger().setLevel(logging.DEBUG)
    mylog.setFormatter(
        ColoredFormatter(
            '$COLOR$BOLD[%(levelname)-10s]$RESET$COLOR  %(message)s',
            True))
    logging.getLogger().addHandler(mylog)
    usage = 'usage: %prog [options]'
    parser = OptionParser(usage=usage, version=version)
    parser.add_option(
        '-q',
        '--quiet',
        dest='verbose',
        default=False,
        action='store_false',
        help='switch off info printout',
    )
    parser.add_option('--remove', dest='remove', default=False,
                      action='store_true',
                      help='force the delete of the option file before '
                      'creating a new one, by default existing option '
                      'files are not overwritten')
    parser.add_option(
        '-d',
        '--decay',
        type='string',
        dest='NickName',
        help='name of the nick name of the decay to create option '
        'for, if not specified, loop over all decay files in the '
        'dec directory',
        action='callback',
        callback=CheckFile,
    )
    parser.add_option('--text', dest='python', default=True,
                      action='store_false',
                      help='create text option files instead of python options'
                      )
    parser.add_option(
        '--force',
        dest='force',
        default=False,
        action='store_true',
        help='force create of option file even when the decay file '
        'syntax is not correct')
 
    # Check that the environment variable DECFILESROOT exist otherwise
    # set it to ../dec
    if 'DECFILESROOT' not in os.environ:
        logging.warning('')
        logging.warning('The variable DECFILESROOT is not defined.')
        logging.warning('Use ../ instead.')
        logging.warning(
            'Run the setup script of the package to set the correct value.')
        logging.warning('')
        os.environ['DECFILESROOT'] = '../'
    else:
        logging.info('')
        logging.info('The DECFILESROOT environment variable is set to: %s',
                     os.environ['DECFILESROOT'])
        logging.info('')
 
    (options, args) = parser.parse_args()
 
    if not options.verbose:
        logging.getLogger().setLevel(logging.INFO)
 
    readObsoleteTypeTable()
 
    if options.NickName:
        try:
            run_create(
                '{0}/dec/{1}.dec'.format(
                    os.environ['DECFILESROOT'],
                    options.NickName),
                options.remove,
                options.python,
                options.force)
        except UserWarning:
            exit_status = 1
    else:
        run_loop(options.remove, options.python, options.force)
 
 
if __name__ == '__main__':
    main()
    sys.exit(exit_status)