eh.FunctionMap Class Reference

#include <eh.py.h>

Inheritance diagram for eh.FunctionMap:

List of all members.

---

Detailed Description

Implementation of EDocItemMapContainer specifically for EDoc.Function type objects.

Public Member Functions
	__init__ (functions)
	Constructor.
	Suppress ()
	Suppresses generation of output for all functions that are in this list.
	UnSuppress ()
	UnSuppresses generation of output for all functions that are in this list.
	MatchesDeclared (match_str, mtype=Regexp, inverse=False)
	Performs the same as ItemContainer.Matches() except on the functions declared name as returned by EDoc.Function.GetDeclaredName().
	Flat ()
	Returns a managed list of all EDoc.CodeBlock's that exist for all functions in this current container.
	MatchesPropogatingExceptionsRegexp (type, function='.*', line='.*', file='.*')
	Returns a managed list of all EDoc.PropogatingException's that match the provided criteria from all functions in this current container.
	GenPossCallSuppressions ()
	Returns a list of strings each containing a generated suppression for all possible function calls made from all functions in this container.
	RenameDeclared (old, new, mtype=Regexp, inverse=False)
	Renames the declared name of all functions whose declared names match old, to the new name defined in new.

---

Member Function Documentation

eh.FunctionMap.__init__

(

functions

)

Constructor.

eh.FunctionMap.Suppress

(

)

Suppresses generation of output for all functions that are in this list.

eh.FunctionMap.UnSuppress

(

)

UnSuppresses generation of output for all functions that are in this list.

eh.FunctionMap.MatchesDeclared	(	match_str	,
		mtype	= Regexp,
		inverse	= False
	)

Performs the same as ItemContainer.Matches() except on the functions declared name as returned by EDoc.Function.GetDeclaredName().

This is just a convenience function.

eh.FunctionMap.Flat

(

)

Returns a managed list of all EDoc.CodeBlock's that exist for all functions in this current container.

eh.FunctionMap.MatchesPropogatingExceptionsRegexp	(	type	,
		function	= '.*',
		line	= '.*',
		file	= '.*'
	)

Returns a managed list of all EDoc.PropogatingException's that match the provided criteria from all functions in this current container.

Parameters:

	type	A regexp that can identify the type of the propogating exceptions to match.
	function	A regexp that can be used to identify particular functions from which to get the propogating exceptions.

Note: It is preferred to use the ItemContainer.Matches() functions over this function parameter before calling this method.

Parameters:

	line	The line number identifying the location that the propagating exception entered the function.
	file	The file name identifying the location that the propagating exception entered the function.

eh.FunctionMap.GenPossCallSuppressions

(

)

Returns a list of strings each containing a generated suppression for all possible function calls made from all functions in this container.

The resulting strings can be included into a suppressions file to suppress individual propagating exceptions.

eh.FunctionMap.RenameDeclared	(	old	,
		new	,
		mtype	= Regexp,
		inverse	= False
	)

Renames the declared name of all functions whose declared names match old, to the new name defined in new.

This uses ItemContainer.Matches() to search using old as the match_str.

---

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

• eh.py.h

---