Skip to content

common_auth.schemas.results

One lightweight, secret-safe operation report for every auth domain.

Classes

AuthError

Bases: RuntimeError

Safe operation failure; protected evidence stays on the attached result.

__init__

def __init__(result: AuthResult[Any]) -> None

Fields and properties declared here; inherited members belong to the bases above.

result

result = result

AuthResult

Inspect status/reference; explicitly unwrap the protected operation value.

Values are references to existing contracts or operation products, never a second set of result-family schemas. Payloads, upstream responses and original exceptions are deliberately absent from repr. No generic dump exposes them. observed_at is the observation time, not a new token issuance time.

__init__

def __init__(op: str, status: AuthStatus, value: T | None = None, reference: AuthReference | None = None, reason: str | None = None, error: BaseException | None = None, evidence: object | None = None, revision: int | None = None, observed_at: datetime = (lambda: datetime.now(UTC))(), expires_at: datetime | None = None) -> None

Fields and properties declared here; inherited members belong to the bases above.

error

error: BaseException | None = field(default=None, repr=False, compare=False)

evidence

evidence: object | None = field(default=None, repr=False, compare=False)

expires_at

expires_at: datetime | None = None

observed_at

observed_at: datetime = field(default_factory=(lambda: datetime.now(UTC)))

ok

Read-only property.

ok: bool

op

op: str

reason

reason: str | None = None

reference

reference: AuthReference | None = None

revision

revision: int | None = None

status

status: AuthStatus

value

value: T | None = field(default=None, repr=False)

failure

@classmethod
def failure(error: BaseException | None = None, *, op: str, reason: str, status: AuthStatus = 'error', value: T | None = None, reference: AuthReference | None = None, revision: int | None = None, evidence: object | None = None, observed_at: datetime | None = None, expires_at: datetime | None = None) -> Self

success

@classmethod
def success(value: T | None = None, *, op: str, reference: AuthReference | None = None, revision: int | None = None, evidence: object | None = None, observed_at: datetime | None = None, expires_at: datetime | None = None) -> Self

unwrap

def unwrap() -> T

Return the value, or explicitly raise the original/safe failure.