LogReplacementFilter Class Reference

Public Member Functions
	__init__ (self, out, replacements)
	write (self, data)
	__getattr__ (self, name)

Protected Attributes
	_out = out
	where to forward output
	_replacements = replacements
	what to replace
	_regex = re.compile("|".join(re.escape(e) for e in replacements))
	build a regular expression from dictionary keys

Detailed Description

Simple class to intercept anything written to python stdout and replace
a given set of strings with placehholders to improve reproducibility.

Definition at line 14 of file logfilter.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			out,
			replacements )

Setup the forwarding and replacements

Parameters:
    out (file object): Where to forward the output too
    replacements (dict(str, str)): Dictionary of strings and their replacements

Definition at line 20 of file logfilter.py.

    def __init__(self, out, replacements):
        """Setup the forwarding and replacements
 
        Parameters:
            out (file object): Where to forward the output too
            replacements (dict(str, str)): Dictionary of strings and their replacements
        """
        
        self._out = out
        
        self._replacements = replacements
        
        self._regex = re.compile("|".join(re.escape(e) for e in replacements))
 

Member Function Documentation

__getattr__()

__getattr__	(		self,
			name )

Forward all other methods from the out stream

Definition at line 39 of file logfilter.py.

    def __getattr__(self, name):
        """Forward all other methods from the out stream"""
        return getattr(self._out, name)

write()

write	(		self,
			data )

Check all messages for strings to replace

Definition at line 34 of file logfilter.py.

    def write(self, data):
        """Check all messages for strings to replace"""
        replaced = self._regex.sub(lambda m: self._replacements[m[0]], data)
        self._out.write(replaced)
 

Member Data Documentation

_out

_out = out

protected

where to forward output

Definition at line 28 of file logfilter.py.

_regex

_regex = re.compile("|".join(re.escape(e) for e in replacements))

protected

build a regular expression from dictionary keys

Definition at line 32 of file logfilter.py.

_replacements

_replacements = replacements

protected

what to replace

Definition at line 30 of file logfilter.py.

---

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

• framework/scripts/b2test_utils/logfilter.py