Class ExtractionResult

explainshell/extraction/types.py:70–89

Per-file extraction result. For SUCCESS, ``mp`` and ``raw`` are populated. For SKIPPED/FAILED, ``error`` describes why; ``stats`` may still carry prep-phase metrics (``plain_text_len``, ``chunks``). Extractors set ``gz_path`` on returned results. Error/skip entries are constru

@dataclass
class ExtractionResult:
    """Per-file extraction result.

    For SUCCESS, ``mp`` and ``raw`` are populated.
    For SKIPPED/FAILED, ``error`` describes why; ``stats`` may still carry
    prep-phase metrics (``plain_text_len``, ``chunks``).

    Extractors set ``gz_path`` on returned results.  Error/skip entries
    are constructed with it by the runner.
    """

    mp: ParsedManpage | None = None
    raw: RawManpage | None = None
    stats: ExtractionStats = field(default_factory=ExtractionStats)
    gz_path: str = ""
    outcome: ExtractionOutcome = ExtractionOutcome.SUCCESS
    error: str | None = None
    #: Classification of the skip/failure, set at the throw site.  ``None``
    #: for SUCCESS, or for legacy callers that didn't tag the exception.
    reason_class: FailureReason | None = None


@dataclass