fvm.tables module

Warning

Callables that are not documented in the Public API are not intented to be directly used and thus may change between minor versions.

Functions to display tables in the console and save them as HTML and text files.

fvm.tables.show_coverage_summary(data, title='xxx', outdir=None, step=None)[source]

Displays a table with the coverage summary.

Parameters:

  • data (list of dicts) –

    list of dicts with the data summary

    Example structure:

    [
    {
        "Status": "pass" or "fail" or "omit",
        "Coverage Type": "toggle" or "fsm state" or ...,
        "Intermediate Column 1": value,
        ...
        "Percentage": "85.00%",
        "Goal": "80.00%"
    },
    ...
]

  • title (str) – Title of the table

  • outdir (str or None) – directory where the HTML file will be saved

  • step (str or None) – name of the step

fvm.tables.show_friendliness_score(score, outdir=None, step=None)[source]

Displays the friendliness score in a table format.

Parameters:

  • score (float) – friendliness score as a float (0 to 100)

  • outdir (str or None) – directory where the HTML file will be saved

  • step (str or None) – name of the step

fvm.tables.show_prove_summary(data, title='Property Summary', outdir=None, step=None)[source]

Displays a table with the prove summary.

Parameters:

  • data (dict) –

    dict with the data summary

    Example structure:

    {
    "Proven": {"count": 5, "items": [...]},
    "Vacuous": {"count": 2, "items": [...]},
    "Fired": {"count": 1, "items": [...]},
    ...
}

  • title (str) – Title of the table

  • outdir (str or None) – directory where the HTML file will be saved

  • step (str or None) – name of the step

fvm.tables.show_step_summary(step_summary, error, warning, inconclusive=None, proven=None, outdir=None, step=None)[source]

Displays a table with the step summary.

Parameters:

  • step_summary (dict) –

    dict with the data summary

    Example structure:

    {
    "Violation": {"count": 2, "checks": {...}},
    "Caution": {"count": 1, "checks": {...}},
    ...
}

  • error (str) – category name used as ‘Error’ row (e.g., ‘Violation’)

  • warning (str) – category name used as ‘Warning’ row (e.g., ‘Caution’)

  • inconclusive (str or None) – category name used as ‘Inconclusive’ row (optional)

  • proven (str or None) – category name used as ‘Proven’ row (optional)

  • outdir (str or None) – directory where the HTML file will be saved

  • step (str or None) – name of the step