CoverageRow#

class scikitplot.cleanprompt.CoverageRow(kind, pattern, validated, default_on, pack_patterns, pack_fields, entity, entity_default, entity_tiers, runtime, surrogate, action, reversible)[source]#

What covers one detection kind, and what happens to its values.

Parameters:
kindstr

The detection kind.

patternbool

A core structural pattern finds it.

validatedbool

A pattern that finds it, core or pack, has a validator (a checksum or a structural rule).

default_onbool

That pattern runs unless kinds narrows the selection.

pack_patternstuple of str

Packs whose patterns find it.

pack_fieldstuple of str

Packs whose field rules name it (a column, key or header).

entitybool

An entity engine can report it.

entity_defaultbool

Entity engines report it unless their labels are narrowed.

entity_tierstuple of str

Optional tiers that provide the entity engines; empty when entity is False.

runtimebool

The runtime issues it itself (--hide terms, artefact paths and columns).

surrogatebool

A surrogate stand-in exists for it (the safety floor).

actionstr

What the policy does with it: tokenize, surrogate, report or block.

reversiblebool

Decoding restores its values: the action replaces them with a stand-in the vault holds.

Parameters:
action: str[source]#
as_dict()[source]#

Return the row as JSON-safe data.

Return type:

dict[str, Any]

default_on: bool[source]#
entity: bool[source]#
entity_default: bool[source]#
entity_tiers: tuple[str, ...][source]#
kind: str[source]#
pack_fields: tuple[str, ...][source]#
pack_patterns: tuple[str, ...][source]#
pattern: bool[source]#
reversible: bool[source]#
runtime: bool[source]#
surrogate: bool[source]#
validated: bool[source]#