Class CancelReason

src/trio/_core/_run.py:324–334

Attached to a :class:`CancelScope` upon cancellation with details of the source of the cancellation, which is then used to construct the string in a :exc:`Cancelled`. Users can pass a ``reason`` str to :meth:`CancelScope.cancel` to set it. Not publicly exported or documented.

@attrs.define
class CancelReason:
    """Attached to a :class:`CancelScope` upon cancellation with details of the source of the
    cancellation, which is then used to construct the string in a :exc:`Cancelled`.
    Users can pass a ``reason`` str to :meth:`CancelScope.cancel` to set it.

    Not publicly exported or documented.
    """

    source: CancelReasonLiteral
    source_task: str | None = None
    reason: str | None = None


@attrs.define(eq=False)