Inheritance diagram for TestSupport.MessageFilters.MessageFilter:

Public Member Functions
def	__init__ (self, MessageHandling handling, Optional[str] regEx)

bool	match (self, str messageText)

str	getTypePostfix (self)

bool	__eq__ (self, other)

MessageType	GetMessageType (cls)

bool	IsTypeMatch (cls, str typeString)

Public Attributes
	hadMatch

	hadNonMatch

Detailed Description

Base class to implement filters for specific log messages, allowing e.g. to expect or ignore errors.

Definition at line 34 of file MessageFilters.py.

Constructor & Destructor Documentation

◆ init()

def TestSupport.MessageFilters.MessageFilter.__init__	(		self,
		MessageHandling	handling,
		Optional[str]	regEx
	)

Reimplemented in TestSupport.MessageFilters.InfoMessageFilter, TestSupport.MessageFilters.WarningMessageFilter, and TestSupport.MessageFilters.ErrorMessageFilter.

Definition at line 42 of file MessageFilters.py.

References TestSupport.MessageFilters.MessageFilter.__handling, and TestSupport.MessageFilters.MessageFilter.__regEx.

Member Function Documentation

◆ eq()

bool TestSupport.MessageFilters.MessageFilter.__eq__	(	self,
		other
	)

Definition at line 79 of file MessageFilters.py.

References TestSupport.MessageFilters.MessageFilter.__handling, TestSupport.MessageFilters.MessageFilter.__regEx, TestSupport.MessageFilters.MessageFilter._messageType, TestSupport.MessageFilters.ErrorMessageFilter._messageType, TestSupport.MessageFilters.WarningMessageFilter._messageType, and TestSupport.MessageFilters.InfoMessageFilter._messageType.

◆ GetMessageType()

MessageType TestSupport.MessageFilters.MessageFilter.GetMessageType ( cls )

Definition at line 86 of file MessageFilters.py.

References TestSupport.MessageFilters.MessageFilter._messageType, TestSupport.MessageFilters.ErrorMessageFilter._messageType, TestSupport.MessageFilters.WarningMessageFilter._messageType, and TestSupport.MessageFilters.InfoMessageFilter._messageType.

◆ getTypePostfix()

str TestSupport.MessageFilters.MessageFilter.getTypePostfix ( self )

Returns the suitable postfix shown in the test report for the message type based on 
self.__handling

Definition at line 66 of file MessageFilters.py.

References TestSupport.MessageFilters.MessageFilter.__handling.

◆ IsTypeMatch()

bool TestSupport.MessageFilters.MessageFilter.IsTypeMatch	(		cls,
		str	typeString
	)

Returns True if any of the classes' type identifiers (e.g. 'cerr') occurs in the given typeString.
Note that the check is case insensitive.

Definition at line 91 of file MessageFilters.py.

References TestSupport.MessageFilters.ErrorMessageFilter._typeIdentifiers, TestSupport.MessageFilters.WarningMessageFilter._typeIdentifiers, and TestSupport.MessageFilters.InfoMessageFilter._typeIdentifiers.

◆ match()

bool TestSupport.MessageFilters.MessageFilter.match	(		self,
		str	messageText
	)

Returns True if the given messageText matches the regex, and also updates the fields
hadMatch and hadNonMatch

Definition at line 50 of file MessageFilters.py.

References TestSupport.MessageFilters.MessageFilter.__isMatch(), TestSupport.MessageFilters.MessageFilter.__regEx, TestSupport.MessageFilters.MessageFilter.hadMatch, and TestSupport.MessageFilters.MessageFilter.hadNonMatch.

Member Data Documentation

◆ hadMatch

TestSupport.MessageFilters.MessageFilter.hadMatch

Definition at line 47 of file MessageFilters.py.

Referenced by TestSupport.MessageFilters.MessageFilter.match().

◆ hadNonMatch

TestSupport.MessageFilters.MessageFilter.hadNonMatch

Definition at line 48 of file MessageFilters.py.