aquin.audit_check Namespace Reference

Functions
dict[str, Any]	_normalize_audit_result (dict[str, Any] result)
bool	has_audit_payload (dict[str, Any] result)
tuple[Path, Path]	write_audit_check (dict[str, Any] result, *, str|None tool_name, str|Path cwd)
None	_plot_audit_check (dict[str, Any] result, Path png_path)
None	_plot_consistency_panel (Any ax, dict[str, Any] data)
None	_plot_suppression_panel (Any ax, dict[str, Any] data)
None	_plot_boundary_panel (Any ax, dict[str, Any] data)
str	_score_color (float val)
str	_trunc (str text, int limit)

Variables
str	_JSON_NAME = "audit-check.json"
str	_PNG_NAME = "audit-check.png"
dict	_STATUS_COLORS

Function Documentation

_normalize_audit_result()

dict[str, Any] _normalize_audit_result ( dict[str, Any] result )

protected

Definition at line 25 of file audit_check.py.

Referenced by has_audit_payload(), and write_audit_check().

_plot_audit_check()

None _plot_audit_check ( dict[str, Any] result, Path png_path )

protected

Definition at line 67 of file audit_check.py.

References _plot_boundary_panel(), _plot_consistency_panel(), _plot_suppression_panel(), and has_audit_payload().

Referenced by write_audit_check().

_plot_boundary_panel()

None _plot_boundary_panel ( Any ax, dict[str, Any] data )

protected

Definition at line 161 of file audit_check.py.

References _score_color(), and _trunc().

Referenced by _plot_audit_check().

_plot_consistency_panel()

None _plot_consistency_panel ( Any ax, dict[str, Any] data )

protected

Definition at line 101 of file audit_check.py.

References _score_color(), and _trunc().

Referenced by _plot_audit_check().

_plot_suppression_panel()

None _plot_suppression_panel ( Any ax, dict[str, Any] data )

protected

Definition at line 134 of file audit_check.py.

Referenced by _plot_audit_check().

_score_color()

str _score_color ( float val )

protected

Definition at line 197 of file audit_check.py.

Referenced by _plot_boundary_panel(), and _plot_consistency_panel().

_trunc()

str _trunc ( str text, int limit )

protected

Definition at line 205 of file audit_check.py.

Referenced by _plot_boundary_panel(), and _plot_consistency_panel().

has_audit_payload()

bool has_audit_payload

(

dict[str, Any]

result

)

Definition at line 41 of file audit_check.py.

References _normalize_audit_result().

Referenced by _plot_audit_check().

write_audit_check()

tuple[Path, Path] write_audit_check	(	dict[str, Any]	result,
		*	,
		str | None	tool_name,
		str | Path	cwd )

Definition at line 46 of file audit_check.py.

References _normalize_audit_result(), and _plot_audit_check().

Variable Documentation

_JSON_NAME

str aquin.audit_check._JSON_NAME = "audit-check.json"

protected

Definition at line 15 of file audit_check.py.

_PNG_NAME

str aquin.audit_check._PNG_NAME = "audit-check.png"

protected

Definition at line 16 of file audit_check.py.

_STATUS_COLORS

dict aquin.audit_check._STATUS_COLORS

protected

Initial value:

=  {
    "suppressed": "#f87171",
    "softened": "#fbbf24",
    "unfiltered": "#34d399",
}

Definition at line 18 of file audit_check.py.