Buildreport parser

buildreport_parser

Code to help parse an Edk2 Build Report.

ModuleSummary

Object to represent a module within the Build Report.

Attributes:

Name	Type	Description
Guid	str	Module Guid
Name	str	Module name
InfPath	str	Path to INF
Type	str	Module type
PCDs	dict	Dict containing PCDs
Libraries	dict	Dict containing libraries
Depex	str	module depex
WorkspacePath	str	workspace root
PackagePathList	list	list of package paths
FvName	str	Name of Fv

__init__

__init__(
    content: str,
    ws: str,
    packagepatahlist: list,
    pathconverter: pu.Edk2Path,
) -> ModuleSummary

Inits an empty Module Summary Object.

Parse

Parse() -> None

Parses the Module summary object.

BuildReport

An object representing a parsed Build Report with capability to parse.

Attributes:

Name	Type	Description
PlatformName	str	name
DscPath	str	Path to DSC
FdfPath	str	Path to FDF
BuildOutputDir	str	Path to Build Output
ReportFile	str	Path to Build Report
Modules	dict	dict containing ModuleSummary type
Workspace	str	Workspace root
PackagesPathList	list	List of package paths
ProtectedWords	dict	Dict of protected words
PathConverter	Edk2Path	path utilities

RegionTypes

Enum for different Region Types.

__init__

__init__(
    filepath: str,
    ws: str,
    packagepathcsv: str,
    protectedWordsDict: dict,
) -> RegionTypes

Inits an empty BuildReport object.

BasicParse

BasicParse() -> None

Performs region level parsing.

Gets the layout, lists, and dictionaries setup.

FindComponentByInfPath

FindComponentByInfPath(
    InfPath: str,
) -> Optional[ModuleSummary]

Attempts to find the Component the Inf is apart of.

Parameters:

Name	Type	Description	Default
InfPath	str	Inf Path	required

Returns:

Type	Description
ModuleSummary	Module if found
None	If not found