config

Configuration settings for the Pointblank library.

USAGE

config(
    report_incl_header=True,
    report_incl_footer=True,
    report_incl_footer_timings=True,
    report_incl_footer_notes=True,
    preview_incl_header=True,
)

Parameters

report_incl_header : bool = True

This controls whether the header should be present in the validation table report. The header contains the table name, label information, and might contain global failure threshold levels (if set).

report_incl_footer : bool = True

Should the footer of the validation table report be displayed? The footer contains the starting and ending times of the interrogation and any notes added to validation steps.

report_incl_footer_timings : bool = True

Controls whether the validation timing information (start time, duration, and end time) should be displayed in the footer. Only applies when report_incl_footer=True.

report_incl_footer_notes : bool = True

Controls whether the notes from validation steps should be displayed in the footer. Only applies when report_incl_footer=True.

preview_incl_header : bool = True

Whether the header should be present in any preview table (generated via the preview() function).

Returns

PointblankConfig

A PointblankConfig object with the specified configuration settings.