screen-locker/screen_locker/status_view.py
Krzysztof kuhy Rudnicki 600d0fd084 Migrate screen_locker to gatelock v0.2.0 per-output locking
The lock now paints one container per live output instead of one window on
the primary, and claims the screen through an Arbiter at RANK_SCREEN_LOCKER
so the wake alarm can outrank it.

The fan-out happens at the widget factory, not the render loop. Painting a
screen here is not a pure function -- the ~20 clear_container() flows record
workouts, credit weeks and branch on state while they paint -- so re-running
a flow per surface would double those side effects. Instead `_label`,
`_button_row` and friends build N copies and return a group that mirrors
later configure calls to all of them, and a flow body still runs once. Frame
groups nest, so `_button(button_row, ...)` reads exactly as it did.

The degenerate case carries as much weight as the general one: the status
window, the post-sick-day verify window and the relaxed-day prompt have no
lock and no surfaces, and share this same factory. They get a group of
exactly one frame and behave as they always did.

Text boxes are the one thing that cannot be shared. Entries fan out over a
single StringVar, but tk.Text has no such variable, so the sick-day
description genuinely diverges per monitor; TextGroup.get() returns whichever
copy was actually typed into, preserving "answer on any monitor".

Tests: the suite hung rather than failed on first run, which is the trap
gatelock's own conftest documents -- screen_locker patches its own `tk`, but
LockWindow builds Toplevels through gatelock's, and real tkinter over a
MagicMock root recurses without bound. `_gatelock_fixtures` closes that and
redirects the runtime dir so no test can stand a production locker down.
Every other test runs single-output, where fan-out is unobservable, so
test_surface_fanout runs on two outputs; each assertion was checked by
cropping the group loops to the primary and confirming it goes red.

874 tests, 100% branch coverage, pre-commit clean, no lint suppressions.
2026-07-25 16:26:39 +02:00

368 lines
14 KiB
Python

"""Read-only Tkinter status window plus a lightweight i3blocks summary CLI.
Opening or refreshing this window only ever reads files already on disk
(via ``_status_data.gather_status``). The live Warsaw temperature (see
``_section_temperature``) is fetched via
``_temperature.fetch_current_temp_with_status`` on open and on every refresh,
in its own background thread, bounded to ``_temperature.HARD_TIMEOUT_SECONDS``
— the same call the real locker's heat-skip check makes, so the window shows
what the lock actually sees. That fetch is display-only and never writes.
Two user-initiated buttons *do* write to ``workout_log.json`` (never a silent
log):
* "Check Phone" runs ``PhoneVerificationMixin._verify_phone_workout`` and, when
that finds nothing, ``RunnerUpVerificationMixin._verify_runnerup_workout`` as
a fallback — the same StrongLifts→RunnerUp chain the locked screen uses. On a
verified workout it writes the entry and applies the shutdown reward via
``_apply_workout_credit`` (guarded against double-crediting on the same day),
mirroring the submit/poll/``Future`` idiom of ``_ui_flows.py``.
* "Log Manual Workout" is a user-initiated, explicit evidence-form submission
(see ``_manual_workout_dialog.ManualWorkoutDialogMixin``).
"""
from __future__ import annotations
from pathlib import Path
import sys
import tkinter as tk
from typing import TYPE_CHECKING
from gatelock import LockConfig
from screen_locker import _manual_workout
from screen_locker._manual_workout_dialog import ManualWorkoutDialogMixin
from screen_locker._status_data import (
DayStatus,
ManualWorkoutBudgetStatus,
ShutdownProjection,
SickBudgetStatus,
StatusSnapshot,
WeeklySummary,
format_summary_line,
gather_status,
)
from screen_locker._status_view_verify import PhoneCheckMixin, _make_bare_verifier
from screen_locker._surface_group import FrameGroup
from screen_locker._temperature import (
fetch_current_temp_with_status,
)
from screen_locker._temperature_status_mixin import TemperatureStatusMixin
from screen_locker._ui_widgets import UIWidgetsMixin
if TYPE_CHECKING:
from collections.abc import Callable
from concurrent.futures import Future
from screen_locker._compliance_state import LockExplanation
from screen_locker._temperature import TemperatureCheck
from screen_locker.screen_lock import ScreenLocker
_DEFAULT_LOG_FILE = Path(__file__).resolve().parent / "workout_log.json"
_STATUS_COLORS = LockConfig()
class StatusWindow(
UIWidgetsMixin,
ManualWorkoutDialogMixin,
TemperatureStatusMixin,
PhoneCheckMixin,
):
"""Thin Tk view over a :class:`StatusSnapshot`.
Formatting logic lives in ``_status_data``, not here.
"""
def __init__(
self,
root: tk.Tk,
snapshot: StatusSnapshot,
*,
on_refresh: Callable[[], None],
log_file: Path = _DEFAULT_LOG_FILE,
verifier_factory: Callable[[Path], ScreenLocker] = _make_bare_verifier,
temperature_fetcher: Callable[
[str], TemperatureCheck
] = fetch_current_temp_with_status,
) -> None:
"""Build the window's container and render *snapshot* immediately."""
self.root = root
self.on_refresh = on_refresh
self.log_file = log_file
self.verifier_factory = verifier_factory
self.temperature_fetcher = temperature_fetcher
self.demo_mode = True # only affects UIWidgetsMixin._button's cursor
self._phone_future: Future[tuple[str | None, str, str, str | None]] | None = (
None
)
self._phone_check_result: tuple[str, str] | None = None
self._credit_message: str | None = None
self._temp_future: Future[TemperatureCheck] | None = None
self._temp_result: TemperatureCheck | None = None
self._last_snapshot = snapshot
self._colors = _STATUS_COLORS
# A group of one: this window has no lock and no per-output surfaces,
# but it shares UIWidgetsMixin's factory with the locker, which now
# builds through a group. Filling the window rather than centring, so
# this is built here instead of via FrameGroup.single().
frame = tk.Frame(root, bg=self._colors.bg)
frame.pack(fill="both", expand=True)
self.container = FrameGroup([frame])
self._start_temperature_check()
self.render(snapshot)
def render(self, snapshot: StatusSnapshot) -> None:
"""Redraw the whole window from *snapshot*."""
self._last_snapshot = snapshot
self.clear_container()
self._label("Workout Status", font_size=28, pady=15)
self._section_today(self.container, snapshot.today)
self._section_week(self.container, snapshot.week)
self._section_lock_explanation(self.container, snapshot.lock_explanation)
self._section_temperature(self.container)
self._section_sick_budget(self.container, snapshot.sick_budget)
self._section_manual_workout_budget(
self.container, snapshot.manual_workout_budget
)
self._section_shutdown(self.container, snapshot.shutdown)
if self._phone_check_result is not None:
status, message = self._phone_check_result
color = (
self._colors.success if status == "verified" else self._colors.warning
)
self._text(f"Phone check ({status}): {message}", font_size=16, color=color)
if self._credit_message is not None:
self._text(self._credit_message, font_size=16, color=self._colors.success)
# "Check Phone"/"Log Manual Workout" are the primary write actions
# (accent, high contrast per rule 3); "Refresh"/"Close" are secondary
# utility actions (muted) -- two tiers instead of four arbitrary hues.
frame = self._button_row()
self._button(
frame,
"Check Phone",
bg=self._colors.accent,
command=self._on_check_phone_clicked,
width=14,
).pack(side="left", padx=8)
if not _manual_workout.is_budget_exhausted(self.log_file):
self._button(
frame,
"Log Manual Workout",
bg=self._colors.accent,
command=self._show_manual_workout_form,
width=16,
).pack(side="left", padx=8)
self._button(
frame,
"Refresh",
bg=self._colors.field_bg,
command=self._on_refresh_clicked,
width=10,
).pack(side="left", padx=8)
self._button(
frame,
"Close",
bg=self._colors.field_bg,
command=self.root.destroy,
width=8,
).pack(side="left", padx=8)
def _section_today(self, parent: tk.Widget, day: DayStatus) -> None:
"""Render today's outcome."""
del parent
mark = "✓" if day.counted else ("😷" if day.is_sick_day else "—")
entry_str = ", ".join(day.entry_types) or (
"sick day" if day.is_sick_day else "no entry yet"
)
self._text(
f"{mark} Today ({day.label}): {entry_str}",
font_size=18,
color=self._colors.success if day.counted else self._colors.warning,
)
if day.source:
# Secondary provenance note on an already-shown entry -- a
# deliberately caption-sized exception to the 16px floor.
self._text(day.source, font_size=12, color=self._colors.muted, pady=4)
def _section_week(self, parent: tk.Widget, week: WeeklySummary) -> None:
"""Render this ISO week's per-day breakdown and totals."""
del parent
self._label(
f"This Week: {week.counted_count}/{week.minimum}", font_size=18, pady=8
)
for day in week.days:
mark = "✓" if day.counted else ("😷" if day.is_sick_day else "·")
entry_str = ", ".join(day.entry_types) or (
"sick day" if day.is_sick_day else "no entry"
)
self._text(
f"{mark} {day.label}: {entry_str}",
font_size=16,
color=self._colors.muted,
pady=4,
)
if week.remaining > 0:
self._text(
f"Need {week.remaining} more this week.",
font_size=16,
color=self._colors.warning,
)
elif week.extra > 0:
self._text(
f"{week.extra} above the weekly minimum!",
font_size=16,
color=self._colors.success,
)
def _section_lock_explanation(
self, parent: tk.Widget, expl: LockExplanation
) -> None:
"""Render why the lock did/didn't fire today, plus its evaluation trace."""
del parent
self._label("Why the lock did/didn't fire", font_size=16, pady=8)
self._text(
expl.reason,
font_size=16,
color=self._colors.danger if expl.fired else self._colors.success,
)
if expl.auto_upgrade.would_attempt:
self._text(
f"Pending auto-upgrade: {expl.auto_upgrade.reason}",
font_size=14,
color=self._colors.warning,
)
def _section_sick_budget(self, parent: tk.Widget, sick: SickBudgetStatus) -> None:
"""Render rolling sick-day budget usage."""
del parent
self._label("Sick Budget", font_size=16, pady=8)
self._text(
f"{sick.used_7d}/{sick.budget_7d} week · {sick.used_30d}/{sick.budget_30d} "
f"month · {sick.used_90d}/{sick.budget_90d} quarter · debt {sick.debt}",
font_size=16,
color=self._colors.danger if sick.exhausted else self._colors.muted,
)
def _section_manual_workout_budget(
self, parent: tk.Widget, manual: ManualWorkoutBudgetStatus
) -> None:
"""Render rolling manual-workout budget usage."""
del parent
self._label("Manual Workout Budget", font_size=16, pady=8)
self._text(
f"{manual.used_7d}/{manual.budget_7d} week · "
f"{manual.used_30d}/{manual.budget_30d} month",
font_size=16,
color=self._colors.danger if manual.exhausted else self._colors.muted,
)
def _section_shutdown(
self, parent: tk.Widget, shutdown: ShutdownProjection
) -> None:
"""Render tonight's live config, rest-of-week, and next-week preview."""
del parent
self._label("Shutdown Time", font_size=16, pady=8)
if shutdown.tonight is not None:
mon_wed_hour, thu_sun_hour, _morning = shutdown.tonight
self._text(
f"Live config — Mon-Wed {mon_wed_hour:02d}:00, "
f"Thu-Sun {thu_sun_hour:02d}:00",
font_size=16,
)
else:
self._text(
"Live shutdown config unavailable.",
font_size=16,
color=self._colors.warning,
)
# Rest-of-week/next-week/explanation are speculative annotations, not
# the section's primary content -- a deliberate caption-sized
# exception to the 16px floor, all sharing one muted tone instead of
# three unrelated ad hoc grays.
rest_line = ", ".join(
f"{d.label} {d.hour:02d}:00" for d in shutdown.rest_of_week
)
self._text(f"Rest of week: {rest_line}", font_size=12, color=self._colors.muted)
next_line = ", ".join(
f"{d.label} {d.hour:02d}:00" for d in shutdown.next_week_preview
)
self._text(
f"Next week (speculative): {next_line}",
font_size=12,
color=self._colors.muted,
)
self._text(shutdown.explanation, font_size=12, color=self._colors.muted)
def _on_refresh_clicked(self) -> None:
"""Clear any stale phone-check/credit/temperature results, re-check both."""
self._phone_check_result = None
self._credit_message = None
self._temp_result = None
self._start_temperature_check()
self.on_refresh()
def _on_manual_workout_saved(self, entry: dict) -> None:
"""Persist the manual-workout entry via a bare verifier, then refresh.
Unlike the phone check, this one deliberate path does write to
``workout_log.json`` — the user just explicitly filled out and
submitted the evidence form, so this is not a silent log. Uses the
same ``_apply_workout_credit`` the locked screen's ``unlock_screen``
uses, so this voluntary path earns the identical shutdown-later
bonus / debt-clear / extra-bonus credit (guarded against being
applied twice on the same day).
"""
verifier = self.verifier_factory(self.log_file)
verifier.workout_data = entry
credit = verifier._apply_workout_credit()
self._credit_message = "\n".join(
self._credit_result_lines(
f"Manual workout logged: {entry.get('source', '')}", credit
)
)
self.render(gather_status())
def _on_manual_workout_cancelled(self) -> None:
"""Return to the main status view without saving anything."""
self.render(gather_status())
def _compliance_state_word(snapshot: StatusSnapshot) -> str:
"""One-word compliance state for the tray icon: ``ok`` / ``warn`` / ``lock``.
``lock`` — the lock would fire right now (no skip condition applies).
``warn`` — not locked, but this week's minimum isn't met yet.
``ok`` — not locked and the weekly minimum is already met.
"""
if snapshot.lock_explanation.fired:
return "lock"
if snapshot.week.remaining > 0:
return "warn"
return "ok"
def main(argv: list[str] | None = None) -> None:
"""Entry point: ``--summary``/``--state`` print one line; else opens the window."""
args = sys.argv[1:] if argv is None else argv
if "--summary" in args:
print(format_summary_line(gather_status()))
return
if "--state" in args:
print(_compliance_state_word(gather_status()))
return
root = tk.Tk()
root.title("Workout Status")
root.configure(bg=_STATUS_COLORS.bg)
root.minsize(560, 200)
def refresh() -> None:
window.render(gather_status())
window = StatusWindow(root, gather_status(), on_refresh=refresh)
root.mainloop()
if __name__ == "__main__":
main()