utils/earned_time/earned_time/_resolution.py
Krzysztof kuhy Rudnicki 0d9974c194
Some checks failed
dependency freshness / dependencies on newest stable (push) Waiting to run
file length / file-length (push) Waiting to run
md-naming / markdown naming convention (push) Waiting to run
palette drift / palette (push) Waiting to run
repo-contract / repo contract (push) Waiting to run
shared gate tests / gate unit tests (push) Waiting to run
earned_time pre-commit / pre-commit (push) Has been cancelled
earned_time tests / test (push) Has been cancelled
earned_time 0.22.0: gaming budget switch off
Dated switch GAMING_UNLIMITED_FROM (2026-11-16) and gaming_enforced(day);
Resolution.gaming_enforced; leisure_active False from it; sick shutdown
uses rung pay from it. No public name removed; shutdown unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WzxdWViGJJaqBKGr1Hbppr
2026-11-16 15:57:14 +01:00

89 lines
2.7 KiB
Python

# Copyright (c) 2026 Krzysztof Rudnicki
"""What :func:`earned_time.resolve` returns: the base, each term, the sum.
Split from :mod:`earned_time._resolve` (0.11.0) to keep both under the line
cap; ``earned_time._resolve`` still re-exports all three.
"""
from __future__ import annotations
from dataclasses import dataclass
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from datetime import date
from earned_time._policy import Earner
@dataclass(frozen=True)
class Base:
"""The floor for one day, after every penalty in force on it.
Attributes:
gaming_minutes: Gaming time a day that earned nothing gets.
shutdown_minutes: Shutdown time of such a day, minutes after midnight.
"""
gaming_minutes: int
shutdown_minutes: int
@dataclass(frozen=True)
class Term:
"""What one earner contributed.
Attributes:
earner: The earner.
answer: The consumer's answer: a unit count, or ``None`` for
"could not check" (and for no answer at all).
gaming_minutes: Gaming minutes earned.
shutdown_minutes: Shutdown minutes earned.
"""
earner: Earner
answer: int | None
gaming_minutes: int
shutdown_minutes: int
@dataclass(frozen=True)
class Resolution:
"""One day's budget and shutdown, and what earned them.
Attributes:
day: The day resolved.
base: Its floor.
terms: One entry per registered earner, in registry order.
gaming_minutes: Base plus terms, capped at the gaming ceiling.
shutdown_minutes: Base plus terms, capped at the shutdown ceiling;
on a sick day raised to the sick floor (:mod:`earned_time._sick`).
sick: Whether the day was resolved as a sick day (0.11.0).
sick_lift_minutes: How far the sick floor raised ``shutdown_minutes``
above base plus terms (``0`` unless sick): a consumer adding live
credits on top pays them out of this first, as with a grace lift.
gaming_enforced: Whether ``day`` has a gaming budget at all (0.22.0,
:func:`earned_time.gaming_enforced`). ``False``: ``gaming_minutes``
is history, a consumer must not enforce it.
"""
day: date
base: Base
terms: tuple[Term, ...]
gaming_minutes: int
shutdown_minutes: int
sick: bool = False
sick_lift_minutes: int = 0
gaming_enforced: bool = True
def term(self, name: str) -> Term:
"""The term of the earner called ``name``.
Raises:
KeyError: No such earner was resolved.
"""
for candidate in self.terms:
if candidate.earner.name == name:
return candidate
raise KeyError(name)