SerialSubstitution Namespace Reference

Classes
class	ContextClass
class	LineNoContextClass
class	ProcessorClass
class	ProcessorsList
class	RegExDeleteLineClass
class	RegExSubstitutionClass
class	ReplacementClass
class	SubstitutionClass
class	WarningClass

Functions
def	ANSIcode (content)
def	Colorize (msg, category, options)
	Library code. More...
def	AddProcessor (processor)
def	LoggingSetup (LoggingLevel=logging.INFO)
def	RunSubstitutor ()

Variables
string	__doc__ = "Performs hard-coded substitutions on all files in a directory."
string	__version__ = '2.0'
	ANSIReset = ANSIcode("0")
	ANSIRed = ANSIcode("31")
	ANSIGreen = ANSIcode("32")
	ANSIBlue = ANSIcode("34")
	ANSIBrightBlue = ANSIcode("1;34")
	ANSIMagenta = ANSIcode("35")
	ANSIYellow = ANSIcode("1;33")
	ANSIWhite = ANSIcode("1;37")
	subst = AddProcessor(ProcessorClass("subst"))
	Test. More...

Function Documentation

def SerialSubstitution.AddProcessor

(

processor

)

Definition at line 489 of file SerialSubstitution.py.

def AddProcessor(processor):
        return ProcessorsList.Global.AddProcessor(processor)

def SerialSubstitution.ANSIcode

(

content

)

Definition at line 19 of file SerialSubstitution.py.

def ANSIcode(content): return "\x1B[" + content + "m"

def SerialSubstitution.Colorize	(		msg,
			category,
			options
	)

Library code.

Definition at line 33 of file SerialSubstitution.py.

def Colorize(msg, category, options):
        if not options or not options.UseColor: return str(msg)
        return options.Colors.get(category, "") + str(msg) + ANSIReset
# Colorize()

def SerialSubstitution.LoggingSetup

(

LoggingLevel = logging.INFO

)

Definition at line 493 of file SerialSubstitution.py.

def LoggingSetup(LoggingLevel = logging.INFO):
        
        logging.basicConfig(
          level=LoggingLevel,
          format="%(levelname)s: %(message)s"
          )
        
# def LoggingSetup()

def SerialSubstitution.RunSubstitutor

(

)

Definition at line 503 of file SerialSubstitution.py.

def RunSubstitutor():
        import argparse
        
        parser = argparse.ArgumentParser(description=__doc__)
        
        parser.add_argument("InputDirs", nargs="*", action="store",
          help="input directories [current]")
        
        parser.add_argument('--doit', dest="DoIt", action='store_true',
          help="perform the substitutions [%(default)s]")
        
        parser.add_argument('--verbose', '-v', dest="DoVerbose", action='store_true',
          help="shows all the changes on screen [%(default)s]")
        parser.add_argument('--debug', dest="DoDebug", action='store_true',
          help="enables debug messages on screen")
        parser.add_argument('--color', '-U', dest="UseColor", action='store_true',
          help="enables coloured output [%(default)s]")
        
        parser.add_argument('--list', dest="DoList", action='store_true',
          help="just prints the hard-coded substitutions for each processor")
        parser.add_argument('--only', dest="SelectedProcessors", action='append',
          help="executes only the processors with the specified name (see --list)")
        parser.add_argument('--version', action='version',
          version='%(prog)s ' + __version__)
        
        arguments = parser.parse_args()
        
        # set up the logging system
        LoggingSetup(logging.DEBUG if arguments.DoDebug else logging.INFO)
        
        if arguments.DoVerbose: arguments.LogMsg = logging.info
        else:                   arguments.LogMsg = logging.debug
        
        Processors = ProcessorsList.Global # use the global list
        
        Processors.SetOptions(arguments)
        Processors.SetColors(
          old=ANSIRed, new=ANSIGreen, source=ANSIWhite, line_no=ANSIMagenta,
          warning=ANSIYellow
          )
        if arguments.SelectedProcessors:
                Processors.SelectProcessors(arguments.SelectedProcessors)
        
        if arguments.DoList:
                logging.info("\n".join(Processors.Describe()))
                sys.exit(0)
        # if
        
        
        if not arguments.InputDirs: arguments.InputDirs = [ '.' ]
        
        for InputPath in arguments.InputDirs:
                Processors.ProcessDir(InputPath)
        
        return 0
# RunSubstitutor()

Variable Documentation

string SerialSubstitution.__doc__ = "Performs hard-coded substitutions on all files in a directory."

private

Definition at line 10 of file SerialSubstitution.py.

string SerialSubstitution.__version__ = '2.0'

private

Definition at line 11 of file SerialSubstitution.py.

SerialSubstitution.ANSIBlue = ANSIcode("34")

Definition at line 24 of file SerialSubstitution.py.

SerialSubstitution.ANSIBrightBlue = ANSIcode("1;34")

Definition at line 25 of file SerialSubstitution.py.

SerialSubstitution.ANSIGreen = ANSIcode("32")

Definition at line 23 of file SerialSubstitution.py.

SerialSubstitution.ANSIMagenta = ANSIcode("35")

Definition at line 26 of file SerialSubstitution.py.

SerialSubstitution.ANSIRed = ANSIcode("31")

Definition at line 22 of file SerialSubstitution.py.

SerialSubstitution.ANSIReset = ANSIcode("0")

Definition at line 21 of file SerialSubstitution.py.

SerialSubstitution.ANSIWhite = ANSIcode("1;37")

Definition at line 28 of file SerialSubstitution.py.

SerialSubstitution.ANSIYellow = ANSIcode("1;33")

Definition at line 27 of file SerialSubstitution.py.

SerialSubstitution.subst = AddProcessor(ProcessorClass("subst"))

Test.

Definition at line 567 of file SerialSubstitution.py.