Skip to content

module encoding_detector

EncodingDetector class for managing chardet encoding detection.

Global Variables

  • ENCODING
  • OFF_WHITE
  • CONFIDENCE_SCORE_RANGE

class EncodingDetector

Manager class to ease dealing with the encoding detection library chardet.

Each instance of this class manages a chardet.detect_all() scan on a single set of bytes.

Attributes:

  • bytes (bytes): The bytes to analyze.
  • assessments (list[EncodingAssessment]): List of EncodingAssessment objects from chardet results.
  • force_decode_assessments (list[EncodingAssessment]): Assessments above force decode threshold.
  • force_display_assessments (list[EncodingAssessment]): Assessments above force display threshold.
  • has_any_idea (bool | None): True if chardet had any idea what the encoding might be, False if not, None if chardet wasn't run yet.
  • raw_chardet_assessments (list[dict]): Raw list of dicts returned by chardet.detect_all().
  • table (Table): A rich Table object summarizing the chardet results.
  • unique_assessments (list[EncodingAssessment]): Unique assessments by encoding, highest confidence only.

method __init__

__init__(
    _bytes: bytes,
    assessments: list[EncodingAssessment] = <factory>,
    force_decode_assessments: list[EncodingAssessment] = <factory>,
    force_display_assessments: list[EncodingAssessment] = <factory>,
    has_any_idea: bool | None = None,
    raw_chardet_assessments: list[dict] = <factory>,
    table: Table = <factory>,
    unique_assessments: list[EncodingAssessment] = <factory>
) → None

property bytes

property bytes_len

method get_encoding_assessment

get_encoding_assessment(encoding: str) → EncodingAssessment

Get the chardet assessment for a specific encoding.

Args:

  • encoding (str): The encoding to look for.

Returns:

  • EncodingAssessment: Assessment for the encoding if it exists, otherwise a dummy with 0 confidence.

This file was automatically generated via lazydocs.