SZZReport

Module for SZZReport.

class varats.data.reports.szz_report.SZZTool(tool_name, shorthand)

Bases: Enum

Enum for available SZZ tools.

property tool_name: str

property shorthand: str

SZZ_UNLEASHED = ('SZZUnleashed', 'SZZU')

PYDRILLER_SZZ = ('PyDrillerSZZ', 'PySZZ')

class varats.data.reports.szz_report.SZZReport(path, szz_tool)

Bases: BaseReport

Base class for reports created by several SZZ tools.

Subclasses of this report only differ in the tool used and the shorthand.

classmethod shorthand()

Shorthand for this report.

Return type:

str

get_all_raw_bugs()

Get the set of all bugs in this report.

Return type:

FrozenSet[Bug[FullCommitHash]]

Returns:

A set of RawBug s.

get_raw_bug_by_fix(fixing_commit)

Get a bug by the id of the fixing commit.

Return type:

Optional[Bug[FullCommitHash]]

Returns:

A RawBug if avilable, else None.

FILE_TYPE: str = 'yaml'

SHORTHAND: str = 'SZZ'

class varats.data.reports.szz_report.SZZUnleashedReport(path)

Bases: SZZReport

SZZReport as generated by the SZZUnleashedExperiment.

FILE_TYPE: str = 'yaml'

SHORTHAND: str = 'SZZU'

class varats.data.reports.szz_report.PyDrillerSZZReport(path)

Bases: SZZReport

SZZReport as generated by the PyDrillerSZZExperiment.

FILE_TYPE: str = 'yaml'

SHORTHAND: str = 'PySZZ'