Align show and doctor output columns

This commit is contained in:
mdaleo404 committed 2026-10-02 16:25:01 +01:00
1 parent a73c09cc9b
commit 9a44c3e158
5 files changed
+63 -26

No files matched your search

+21 -20
View File
@@ -35,31 +35,32 @@ def run_doctor(
) )
return return
schedls_details = [("version", __version__), ("Python", platform.python_version())]
systemd_details = [
("available", _yes_no(systemd["available"])),
("system manager", _reachable(systemd["system_manager"])),
("user manager", _reachable(systemd["user_manager"])),
("systemd-analyze", _yes_no(systemd["analyze"])),
("calendar validation", _yes_no(systemd["calendar_validation"])),
("user lingering", _lingering(systemd["user_lingering"])),
]
cron_details = [
("crontab", _yes_no(cron["crontab_available"])),
("system cron files", _yes_no(cron["file_sources"])),
("implementation", cron["implementation"] or "unknown"),
("current user allowed", _yes_no(cron["user_allowed"])),
("syntax validation", _yes_no(cron["validation"])),
]
width = max(len(key) for key, _ in [*schedls_details, *systemd_details, *cron_details])
output.heading("schedls") output.heading("schedls")
output.key_values([("version", __version__), ("Python", platform.python_version())]) output.key_values(schedls_details, width=width)
output.line() output.line()
output.heading("systemd") output.heading("systemd")
output.key_values( output.key_values(systemd_details, width=width)
[
("available", _yes_no(systemd["available"])),
("system manager", _reachable(systemd["system_manager"])),
("user manager", _reachable(systemd["user_manager"])),
("systemd-analyze", _yes_no(systemd["analyze"])),
("calendar validation", _yes_no(systemd["calendar_validation"])),
("user lingering", _lingering(systemd["user_lingering"])),
]
)
output.line() output.line()
output.heading("cron") output.heading("cron")
output.key_values( output.key_values(cron_details, width=width)
[
("crontab", _yes_no(cron["crontab_available"])),
("system cron files", _yes_no(cron["file_sources"])),
("implementation", cron["implementation"] or "unknown"),
("current user allowed", _yes_no(cron["user_allowed"])),
("syntax validation", _yes_no(cron["validation"])),
]
)
output.line() output.line()
output.heading("Result") output.heading("Result")
output.line(f" {'usable' if usable else 'unusable'}") output.line(f" {'usable' if usable else 'unusable'}")
+3 -2
View File
@@ -116,7 +116,6 @@ def render_show(output: Output, job: ScheduledJob) -> None:
core.extend([("Previous", previous), ("Command", job.command.display() or "unknown")]) core.extend([("Previous", previous), ("Command", job.command.display() or "unknown")])
if job.last_result: if job.last_result:
core.append(("Result", job.last_result)) core.append(("Result", job.last_result))
output.key_values(core)
details: list[tuple[str, str]] = [] details: list[tuple[str, str]] = []
if job.systemd is not None: if job.systemd is not None:
@@ -143,9 +142,11 @@ def render_show(output: Output, job: ScheduledJob) -> None:
details.append(("SHELL", job.cron.shell)) details.append(("SHELL", job.cron.shell))
if job.cron.mailto: if job.cron.mailto:
details.append(("MAILTO", job.cron.mailto)) details.append(("MAILTO", job.cron.mailto))
width = max(len(key) for key, _ in [*core, *details])
output.key_values(core, width=width)
if details: if details:
output.line() output.line()
output.key_values(details) output.key_values(details, width=width)
for warning in job.warnings: for warning in job.warnings:
output.line() output.line()
output.diagnostic(f"Warning: {warning}") output.diagnostic(f"Warning: {warning}")
+2 -2
View File
@@ -99,10 +99,10 @@ class Output:
for row in materialized: for row in materialized:
self.line(" ".join(cell.ljust(widths[i]) for i, cell in enumerate(row)).rstrip()) self.line(" ".join(cell.ljust(widths[i]) for i, cell in enumerate(row)).rstrip())
def key_values(self, pairs: Sequence[tuple[str, str]]) -> None: def key_values(self, pairs: Sequence[tuple[str, str]], *, width: int | None = None) -> None:
if not pairs: if not pairs:
return return
width = max(len(key) for key, _ in pairs) width = max(width if width is not None else 0, *(len(key) for key, _ in pairs))
for key, value in pairs: for key, value in pairs:
label = self.style(key.ljust(width), "bold", "cyan") label = self.style(key.ljust(width), "bold", "cyan")
self.line(f"{label} {value}".rstrip()) self.line(f"{label} {value}".rstrip())
+26
View File
@@ -7,6 +7,7 @@ from dataclasses import replace
import pytest import pytest
from schedls import __version__
from schedls.backends.base import CommandPlan, FileChange, MutationResult, Plan from schedls.backends.base import CommandPlan, FileChange, MutationResult, Plan
from schedls.backends.cron import CronBackend from schedls.backends.cron import CronBackend
from schedls.backends.systemd import SystemdBackend from schedls.backends.systemd import SystemdBackend
@@ -73,6 +74,24 @@ def test_render_show() -> None:
assert "systemd user timer" in text assert "systemd user timer" in text
def test_render_show_aligns_systemd_details() -> None:
job = replace(
_job(),
systemd=SystemdDetails(
timer_path="/var/lib/schedls/backup.timer",
service_path="/var/lib/schedls/backup.service",
persistent=True,
),
)
output, stream = _output()
inspect_ops.render_show(output, job)
backend = next(line for line in stream.getvalue().splitlines() if line.startswith("Backend"))
timer = next(line for line in stream.getvalue().splitlines() if line.startswith("Timer"))
assert backend.index("systemd") == timer.index("/var/lib/schedls/backup.timer")
def test_render_show_explains_unavailable_cron_history() -> None: def test_render_show_explains_unavailable_cron_history() -> None:
job = ScheduledJob( job = ScheduledJob(
name="cron-1", name="cron-1",
@@ -94,6 +113,9 @@ def test_render_show_explains_unavailable_cron_history() -> None:
assert "unavailable (cron does not provide per-job history)" in previous assert "unavailable (cron does not provide per-job history)" in previous
assert "\n\nBackend" not in text assert "\n\nBackend" not in text
assert "\n\nSource" in text assert "\n\nSource" in text
status = next(line for line in text.splitlines() if line.startswith("Status"))
source = next(line for line in text.splitlines() if line.startswith("Source"))
assert status.index("active") == source.index("current user's crontab")
def test_render_show_keeps_cron_next_run_null_in_json() -> None: def test_render_show_keeps_cron_next_run_null_in_json() -> None:
@@ -203,6 +225,10 @@ def test_doctor_human() -> None:
text = stream.getvalue() text = stream.getvalue()
assert "Cronie" in text assert "Cronie" in text
assert "usable" in text assert "usable" in text
version = next(line for line in text.splitlines() if line.startswith("version"))
available = next(line for line in text.splitlines() if line.startswith("available"))
crontab = next(line for line in text.splitlines() if line.startswith("crontab"))
assert version.index(__version__) == available.index("yes") == crontab.index("yes")
def test_doctor_json() -> None: def test_doctor_json() -> None:
+11 -2
View File
@@ -96,9 +96,18 @@ def test_key_values_colour_labels_but_not_values() -> None:
stream = io.StringIO() stream = io.StringIO()
output = Output(color="always", stdout=stream) output = Output(color="always", stdout=stream)
output.key_values([("S", "active"), ("Status", "waiting")]) output.key_values([("S", "active"), ("Status", "waiting")], width=8)
assert stream.getvalue() == ("\033[1m\033[36mS \033[0m active\n\033[1m\033[36mStatus\033[0m waiting\n") assert stream.getvalue() == ("\033[1m\033[36mS \033[0m active\n\033[1m\033[36mStatus \033[0m waiting\n")
def test_key_values_honours_requested_width() -> None:
stream = io.StringIO()
output = Output(color="never", stdout=stream)
output.key_values([("Key", "value")], width=6)
assert stream.getvalue() == "Key value\n"
def test_key_values_honours_no_color(monkeypatch) -> None: def test_key_values_honours_no_color(monkeypatch) -> None: