python_coverage_gate.PathAwareIgnore Class Reference

Public Member Functions
	__init__ (self, list[str] ignoredirs)
	Store normalized ignored directory roots.
bool	names (self, filename, str modulename)
	Decide by full path whether a module is ignored.

Protected Attributes
	_ignoredirs

Detailed Description

Avoid stdlib trace's basename-only ignore cache for same-named modules.

Definition at line 20 of file python_coverage_gate.py.

Constructor & Destructor Documentation

__init__()

python_coverage_gate.PathAwareIgnore.__init__	(		self,
		list[str]	ignoredirs
	)

Store normalized ignored directory roots.

Parameters

[in]

ignoredirs

Directory roots to ignore.

Definition at line 23 of file python_coverage_gate.py.

    def __init__(self, ignoredirs: list[str]):
        """! @brief Store normalized ignored directory roots. @param[in] ignoredirs Directory roots to ignore. """
        self._ignoredirs = [os.path.normpath(path) for path in ignoredirs]
 

Member Function Documentation

names()

bool python_coverage_gate.PathAwareIgnore.names	(		self,
			filename,
		str	modulename
	)

Decide by full path whether a module is ignored.

Parameters

[in]	filename	Source filename reported by the tracer.
[in]	modulename	Source module name reported by the tracer.

Returns

True when ignored.

Definition at line 27 of file python_coverage_gate.py.

    def names(self, filename, modulename: str) -> bool:
        """!
        @brief Decide by full path whether a module is ignored.
        @param[in] filename Source filename reported by the tracer.
        @param[in] modulename Source module name reported by the tracer.
        @return True when ignored.
        """
        del modulename
        if filename is None:
            return True
        normalized = os.path.normpath(filename)
        return any(normalized.startswith(root + os.sep) for root in self._ignoredirs)
 
 

Field Documentation

_ignoredirs

python_coverage_gate.PathAwareIgnore._ignoredirs

protected

Definition at line 25 of file python_coverage_gate.py.

---

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

• python_coverage_gate.py