mirror of
https://github.com/kuhyx/steam-backlog-enforcer.git
synced 2026-11-22 23:02:19 +01:00
The installer ships as the steam_installer package beside steam_backlog_enforcer, with its tests, docs and Proton lock. The enforcer's fast install now starts the installer from this checkout. Both appinfo.vdf readers share one key-value decoder (steam_installer.appinfo_kv), and the duplicated test fixtures and helpers are folded into conftest and _cli_helpers so the whole-tree duplicate-code check is clean. check_requirements_sync treats sibling packages as first-party. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WzxdWZCxnNWLtpVwFLVk9w
85 lines
2.7 KiB
Python
85 lines
2.7 KiB
Python
"""Stop and start the Steam client around operations it would otherwise fight.
|
|
|
|
Steam owns `appmanifest_*.acf` while it runs: it rewrites them from its own
|
|
in-memory state, so anything this tool writes underneath a live client is
|
|
discarded. It also actively writes into `steamapps/downloading/<appid>/`, so
|
|
adopting a staged tree while it runs races a live download.
|
|
|
|
The client is only ever asked to leave politely (`steam -shutdown`). Nothing
|
|
here sends a signal: SIGKILLing a client mid-write is how a manifest ends up
|
|
truncated, and a hung Steam is a reason to stop and tell the user, not to
|
|
escalate.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import subprocess
|
|
import time
|
|
from typing import TYPE_CHECKING
|
|
|
|
from steam_installer import errors, recognize
|
|
|
|
if TYPE_CHECKING:
|
|
from collections.abc import Callable
|
|
import logging
|
|
|
|
# Looked up on PATH by the OS, as `steam` always was; a name, not a literal in
|
|
# the argv list, because ruff S607 objects to partial executable paths there.
|
|
STEAM = "steam"
|
|
SHUTDOWN_TIMEOUT = 60.0
|
|
POLL_INTERVAL = 0.5
|
|
|
|
|
|
class SteamStillRunningError(errors.InstallerError):
|
|
"""Steam was asked to exit and did not."""
|
|
|
|
|
|
def stop(
|
|
logger: logging.Logger,
|
|
*,
|
|
timeout: float = SHUTDOWN_TIMEOUT,
|
|
sleep: Callable[[float], None] = time.sleep,
|
|
) -> bool:
|
|
"""Shut Steam down. Returns True if it had been running, False if it wasn't.
|
|
|
|
Raises SteamStillRunningError if it refuses to exit, so callers can abort
|
|
without having touched anything.
|
|
"""
|
|
if not recognize.steam_client_pids():
|
|
return False
|
|
|
|
logger.info("Shutting down the Steam client...")
|
|
subprocess.run([STEAM, "-shutdown"], check=False, capture_output=True)
|
|
|
|
waited = 0.0
|
|
while waited < timeout:
|
|
if not recognize.steam_client_pids():
|
|
logger.info("Steam exited after %.0fs.", waited)
|
|
return True
|
|
sleep(POLL_INTERVAL)
|
|
waited += POLL_INTERVAL
|
|
|
|
pids = recognize.steam_client_pids()
|
|
msg = (
|
|
f"Steam is still running after {timeout:.0f}s (pid "
|
|
f"{', '.join(str(p) for p in pids)}). Close it by hand and re-run."
|
|
)
|
|
raise SteamStillRunningError(msg)
|
|
|
|
|
|
def _spawn_detached(cmd: list[str]) -> subprocess.Popen[bytes]:
|
|
"""Start `cmd` in its own session with no output; the caller never waits."""
|
|
return subprocess.Popen(
|
|
cmd,
|
|
start_new_session=True,
|
|
stdout=subprocess.DEVNULL,
|
|
stderr=subprocess.DEVNULL,
|
|
)
|
|
|
|
|
|
def start(logger: logging.Logger) -> None:
|
|
"""Relaunch Steam, detached, so it outlives this process."""
|
|
logger.info("Restarting the Steam client...")
|
|
# Detached on purpose: Steam outlives this process and is never waited on.
|
|
_spawn_detached([STEAM])
|