SerialSubstitution.ProcessorClass Class Reference

Public Member Functions
def	__init__ (self, name)
def	SetOptions (self, options)
def	SetColors (self, colors)
def	Color (self, msg, category)
def	RecordPattern (self, pattern)
def	AddFilePattern (self, pattern)
def	AddFileNamePattern (self, name_pattern)
def	AddFileType (self, suffixes)
def	AddRegExPattern (self, pattern, repl, exceptions=[])
def	AddRegExRemoveLine (self, pattern, exceptions=[])
def	AddSimplePattern (self, pattern, repl, exceptions=[])
def	AddWord (self, word, repl, exceptions=[])
def	AddWarningPattern (self, pattern, msg, exceptions=[])
def	AddPattern (self, pattern, repl, exceptions=[])
def	MatchFile (self, FilePath)
def	SubstituteLine (self, line, context=None)
def	ProcessFile (self, FilePath)
def	ProcessFiles (self, files)
def	ProcessDir (self, DirPath)
def	__str__ (self)
def	Describe (self)

Static Public Member Functions
def	CreateTempFile (FilePath)

Public Attributes
	name
	options
	file_filters
	patterns

Static Public Attributes
	context = LineNoContextClass(FilePath, 0)
list	Content = []
int	nChanges = 0
	SourceFile = open(FilePath, 'r')
	new_line = self.SubstituteLine(line, context)
	OutputFile = ProcessorClass.CreateTempFile(FilePath)
	OutputPath = OutputFile.name

Detailed Description

Definition at line 193 of file SerialSubstitution.py.

Constructor & Destructor Documentation

def SerialSubstitution.ProcessorClass.__init__	(		self,
			name
	)

Supported keyword arguments: "options"

Definition at line 194 of file SerialSubstitution.py.

        def __init__(self, name):
                """Supported keyword arguments: "options"
                """
                self.name = name
                self.options = None
                self.file_filters = []
                self.patterns = []

Member Function Documentation

def SerialSubstitution.ProcessorClass.__str__

(

self

)

Definition at line 402 of file SerialSubstitution.py.

        def __str__(self): return self.name
        

def SerialSubstitution.ProcessorClass.AddFileNamePattern	(		self,
			name_pattern
	)

Definition at line 229 of file SerialSubstitution.py.

        def AddFileNamePattern(self, name_pattern):
                return self.AddFilePattern(R"(.*/)*" + name_pattern)
        

def SerialSubstitution.ProcessorClass.AddFilePattern	(		self,
			pattern
	)

Definition at line 222 of file SerialSubstitution.py.

        def AddFilePattern(self, pattern):
                if not pattern.endswith('$'): pattern += "$"
                match = re.compile(pattern)
                self.file_filters.append(match)
                return self

def SerialSubstitution.ProcessorClass.AddFileType	(		self,
			suffixes
	)

Definition at line 232 of file SerialSubstitution.py.

        def AddFileType(self, *suffixes):
                for suffix in suffixes: self.AddFileNamePattern(".*\." + suffix)
                return self

def SerialSubstitution.ProcessorClass.AddPattern	(		self,
			pattern,
			repl,
			exceptions = []
	)

Definition at line 261 of file SerialSubstitution.py.

        def AddPattern(self, pattern, repl, exceptions=[]):
                return self.AddRegExPattern(pattern, repl, exceptions)
        
        

def SerialSubstitution.ProcessorClass.AddRegExPattern	(		self,
			pattern,
			repl,
			exceptions = []
	)

Definition at line 238 of file SerialSubstitution.py.

        def AddRegExPattern(self, pattern, repl, exceptions = []):
                self.RecordPattern(RegExSubstitutionClass(pattern, repl, exceptions))
                return self

def SerialSubstitution.ProcessorClass.AddRegExRemoveLine	(		self,
			pattern,
			exceptions = []
	)

Definition at line 243 of file SerialSubstitution.py.

        def AddRegExRemoveLine(self, pattern, exceptions = []):
                self.RecordPattern(RegExDeleteLineClass(pattern, exceptions))
                return self

def SerialSubstitution.ProcessorClass.AddSimplePattern	(		self,
			pattern,
			repl,
			exceptions = []
	)

Definition at line 248 of file SerialSubstitution.py.

        def AddSimplePattern(self, pattern, repl, exceptions = []):
                self.RecordPattern(ReplacementClass(pattern, repl, exceptions))
                return self

def SerialSubstitution.ProcessorClass.AddWarningPattern	(		self,
			pattern,
			msg,
			exceptions = []
	)

Definition at line 256 of file SerialSubstitution.py.

        def AddWarningPattern(self, pattern, msg, exceptions = []):
                self.RecordPattern(WarningClass(pattern, msg, exceptions))
                return self

def SerialSubstitution.ProcessorClass.AddWord	(		self,
			word,
			repl,
			exceptions = []
	)

Definition at line 253 of file SerialSubstitution.py.

        def AddWord(self, word, repl, exceptions = []):
                return self.AddRegExPattern(r'\b' + word + r'\b', repl, exceptions)
        

def SerialSubstitution.ProcessorClass.Color	(		self,
			msg,
			category
	)

Definition at line 214 of file SerialSubstitution.py.

        def Color(self, msg, category): return Colorize(msg, category, self.options)
        

def SerialSubstitution.ProcessorClass.CreateTempFile (   FilePath )

static

Definition at line 419 of file SerialSubstitution.py.

        def CreateTempFile(FilePath):
                TempPath = os.path.join(
                  tempfile.gettempdir(),
                  tempfile.gettempprefix() + "-" + os.path.basename(FilePath) + ".tmp"
                  )
                TempFile = open(TempPath, 'w')
                return TempFile

def SerialSubstitution.ProcessorClass.Describe

(

self

)

Definition at line 404 of file SerialSubstitution.py.

        def Describe(self):
                output = [
                        "Processor '%s' applies %d substitutions" % (self, len(self.patterns))
                ]
                for subst in self.patterns:
                        try: output.append("  " + subst.Describe())
                        except AttributeError:
                                output.append("  " + str(subst))
                        except: 
                                output.append("  " + repr(subst))
                # for
                return output

def SerialSubstitution.ProcessorClass.MatchFile	(		self,
			FilePath
	)

Definition at line 265 of file SerialSubstitution.py.

        def MatchFile(self, FilePath):
                if not self.file_filters: return True
                for pattern in self.file_filters:
                        if pattern.match(FilePath) is None: continue
                #       logging.debug("Matched pattern: '%s'", pattern.pattern)
                        return True
                # for
                return False

def SerialSubstitution.ProcessorClass.ProcessDir	(		self,
			DirPath
	)

Returns the number of files processor actually acted on

Definition at line 369 of file SerialSubstitution.py.

        def ProcessDir(self, DirPath):
                """Returns the number of files processor actually acted on"""
                nActions = 0
                if os.path.isdir(DirPath):
                        for dirpath, dirnames, filenames in os.walk(DirPath):
                                filepaths \
                                  = [ os.path.join(dirpath, filename) for filename in filenames ]
                                nChanged = self.ProcessFiles(*filepaths)
                                if nChanged > 0:
                                        logging.debug("  processor '%s' changed %d files in '%s'",
                                          self.name, nChanged, dirpath
                                          )
                                # if
                                nActions += nChanged
                        # for
                        if nActions > 0:
                                ApplyChangesMsg = "changed" if self.options.DoIt else "would change"
                                logging.info("Processor '%s' %s %d files in '%s'",
                                  self.name, ApplyChangesMsg, nActions, DirPath
                                  )
                        # if nActions
                else:
                        if self.ProcessFile(DirPath):
                                ApplyChangesMsg = "changed" if self.options.DoIt else "would change"
                                logging.info("Processor '%s' %s file '%s'",
                                  self.name, ApplyChangesMsg, DirPath
                                  )
                                nActions += 1
                        # if
                # if ... else
                return nActions

def SerialSubstitution.ProcessorClass.ProcessFile	(		self,
			FilePath
	)

Returns whether substitutions were performed

Definition at line 309 of file SerialSubstitution.py.

        def ProcessFile(self, FilePath):
                """Returns whether substitutions were performed"""
                if not self.patterns: return False
                

def SerialSubstitution.ProcessorClass.ProcessFiles	(		self,
			files
	)

Definition at line 361 of file SerialSubstitution.py.

        def ProcessFiles(self, *files):
                nChanged = 0
                for FilePath in files:
                        if self.ProcessFile(FilePath): nChanged += 1
                # for files
                return nChanged

def SerialSubstitution.ProcessorClass.RecordPattern	(		self,
			pattern
	)

Definition at line 216 of file SerialSubstitution.py.

        def RecordPattern(self, pattern):
                pattern.SetOptions(self.options)
                self.patterns.append(pattern)

def SerialSubstitution.ProcessorClass.SetColors	(		self,
			colors
	)

Definition at line 209 of file SerialSubstitution.py.

        def SetColors(self, **colors):
                try: self.options.Colors.update(colors)
                except AttributeError: self.options.Colors = colors

def SerialSubstitution.ProcessorClass.SetOptions	(		self,
			options
	)

Definition at line 203 of file SerialSubstitution.py.

        def SetOptions(self, options):
                self.options = options
                for pattern in self.patterns: pattern.SetOptions(options)
                return self

def SerialSubstitution.ProcessorClass.SubstituteLine	(		self,
			line,
			context = None
	)

Returns the very same string if the new line is the same as the old one
or a list of lines to replace line with

Definition at line 275 of file SerialSubstitution.py.

        def SubstituteLine(self, line, context = None):
                """Returns the very same string if the new line is the same as the old one
                or a list of lines to replace line with
                """
                if line is None: return line
                
                for subst in self.patterns:
                        new_line = subst(line, context)
                        if new_line is line: continue
                        
                        msg = "    pattern '%s' matched" % subst
                        if context is not None: msg += " at %s" % context
                        msg += ":"
                        if isinstance(new_line, str):
                                msg += "\n    OLD| " + self.Color(line.rstrip('\n'), 'old')
                                msg += "\n    NEW| %s" % self.Color(new_line.rstrip('\n'), 'new')
                        elif not new_line:
                                msg += "\n    DEL| %s" % self.Color(line.rstrip('\n'), 'old')
                        else:
                                msg += "\n    OLD| " + self.Color(line.rstrip('\n'), 'old')
                                for l in new_line:
                                        msg += "\n    NEW| %s" % self.Color(l.rstrip('\n'), 'new')
                        # if ... else
                        self.options.LogMsg(msg)
                        
                        # if the result if not a single line, we interrupt here;
                        # no particular reason, but we don't need a more complex behaviour
                        if not isinstance(new_line, str): return new_line
                        
                        line = new_line
                # for
                return line

Member Data Documentation

list SerialSubstitution.ProcessorClass.Content = []

static

Definition at line 321 of file SerialSubstitution.py.

SerialSubstitution.ProcessorClass.context = LineNoContextClass(FilePath, 0)

static

Definition at line 319 of file SerialSubstitution.py.

SerialSubstitution.ProcessorClass.file_filters

Definition at line 199 of file SerialSubstitution.py.

SerialSubstitution.ProcessorClass.name

Definition at line 197 of file SerialSubstitution.py.

int SerialSubstitution.ProcessorClass.nChanges = 0

static

Definition at line 322 of file SerialSubstitution.py.

SerialSubstitution.ProcessorClass.new_line = self.SubstituteLine(line, context)

static

Definition at line 326 of file SerialSubstitution.py.

SerialSubstitution.ProcessorClass.options

Definition at line 198 of file SerialSubstitution.py.

SerialSubstitution.ProcessorClass.OutputFile = ProcessorClass.CreateTempFile(FilePath)

static

Definition at line 347 of file SerialSubstitution.py.

SerialSubstitution.ProcessorClass.OutputPath = OutputFile.name

static

Definition at line 348 of file SerialSubstitution.py.

SerialSubstitution.ProcessorClass.patterns

Definition at line 200 of file SerialSubstitution.py.

SerialSubstitution.ProcessorClass.SourceFile = open(FilePath, 'r')

static

Definition at line 323 of file SerialSubstitution.py.

---

The documentation for this class was generated from the following file:

• larsoft/bin/python/SerialSubstitution.py