block_events.py

"""Custom event types for block-related operations."""

from __future__ import annotations

from typing import List, NamedTuple

from PyQt6.QtCore import QEvent

from rhyme import RhymeMark


class RhymeSyllableResult(NamedTuple):
    """Holds the result of a rhyme and syllable analysis."""

    syllable_counts: List[int]
    rhyme_marks: List[RhymeMark | None]


class AnalysisResultEvent(QEvent):
    """Event carrying the results of a block analysis."""

    EVENT_TYPE = QEvent.Type(QEvent.Type.User + 1)

    def __init__(self, block_id: str, result: RhymeSyllableResult) -> None:
        """Initialize the event.

        Args:
            block_id: The ID of the block that was analyzed.
            result: The analysis result.
        """
        super().__init__(self.EVENT_TYPE)
        self.block_id = block_id
        self.result = result