Encoded#

class scikitplot.cleanprompt.Encoded(text, source, format, output_name, round_trip, report=<factory>)[source]#

One encoded input: safe text and a report. Holds no removed value.

Parameters:
textstr

Safe to send.

sourcestr

The name the input was given as.

formatstr

The format that read it.

output_namestr

The name to write it under: the source name for formats that round trip, name.ext.txt for formats whose text was extracted.

round_tripbool

Whether decoding restores the original bytes rather than extracted text.

reportdict

Counts only — packs, kinds, fields matched — never a value.

Parameters:
property count: int#

Distinct values replaced in this input.

Type:

int

format: str[source]#
output_name: str[source]#
report: dict[str, Any][source]#
round_trip: bool[source]#
source: str[source]#
text: str[source]#