Functions

List of functions in the ude.reporting namespace.

Entity Name	Description
coverage_report_to_findings	Converts a `CoverageReport`’s undocumented entities into `Finding`s.
_rule_short_description	Human-readable description for a rule_id, for SARIF’s `shortDescription`.
to_sarif	Serializes findings into a SARIF 2.1.0 log.
to_codeclimate	Serializes findings into a GitLab Code Quality report (CodeClimate-flavored JSON).

Generated with Flude

Directory & Entity Index

Entity Name Summary / Description

_rule_short_description function

Human-readable description for a rule_id, for SARIF’s shortDescription.

Returns:

The description from _RULE_DESCRIPTIONS, or – for a rule_id not

Methods

_rule_short_description

_rule_short_description(rule_id: str) -> str

Human-readable description for a rule_id, for SARIF’s shortDescription.

Returns:

The description from _RULE_DESCRIPTIONS, or – for a rule_id not

Parameter	Type	Description
rule_id	`str`	The rule identifier (e.g. “undocumented-entity”).

Generated with Flude

coverage_report_to_findings function

Converts a CoverageReport’s undocumented entities into Findings.

Returns:

One Finding (rule_id “undocumented-entity”) per entity in report.entities

Methods

coverage_report_to_findings

coverage_report_to_findings(report: CoverageReport) -> List[Finding]

Converts a CoverageReport’s undocumented entities into Findings.

Returns:

One Finding (rule_id “undocumented-entity”) per entity in report.entities

Parameter	Type	Description
report	`CoverageReport`	The computed documentation coverage report.

Generated with Flude

to_codeclimate function

Serializes findings into a GitLab Code Quality report (CodeClimate-flavored JSON).

Returns:

A JSON array (not wrapped in an object, per GitLab’s own report format)

Methods

to_codeclimate

to_codeclimate(findings: List) -> list

Serializes findings into a GitLab Code Quality report (CodeClimate-flavored JSON).

Returns:

A JSON array (not wrapped in an object, per GitLab’s own report format)

Parameter	Type	Description
findings	`List`	The findings to include.

Generated with Flude

to_sarif function

Serializes findings into a SARIF 2.1.0 log.

Returns:

A SARIF 2.1.0 log dict with one tool.driver.rules entry per distinct

Methods

to_sarif

to_sarif(findings: List) -> dict

Serializes findings into a SARIF 2.1.0 log.

Returns:

A SARIF 2.1.0 log dict with one tool.driver.rules entry per distinct

Parameter	Type	Description
findings	`List`	The findings to include as SARIF `results`.

Generated with Flude