70 lines
2.7 KiB
Python
70 lines
2.7 KiB
Python
"""The ask's file in the folder loop-inbox reads, and which asks it lists."""
|
|
import contextlib
|
|
import pathlib
|
|
import typing
|
|
|
|
from loop_state.waiting.answers import answer_file
|
|
from loop_state.waiting.ask import Ask, ask_fields, read_ask
|
|
from loop_effects.effects import Effects, say
|
|
from loop_state.session_lock import ended, running
|
|
from failure import Failure
|
|
from text_files.file_writes import make_private, replace_json
|
|
|
|
|
|
def ask_file(folder: pathlib.Path, session: str) -> pathlib.Path:
|
|
return folder / f"{session}.json"
|
|
|
|
|
|
def publish(folder: pathlib.Path, ask: Ask) -> Failure | None:
|
|
try:
|
|
make_private(folder)
|
|
except OSError as failure:
|
|
return Failure(f"cannot make {folder}: {failure.strerror}")
|
|
return replace_json(ask_file(folder, ask.session), ask_fields(ask))
|
|
|
|
|
|
def withdraw(folder: pathlib.Path, session: str) -> Failure | None:
|
|
"""Removes the session's ask and any answer to it."""
|
|
for path in (ask_file(folder, session), answer_file(folder, session)):
|
|
try:
|
|
path.unlink(missing_ok=True)
|
|
except OSError as failure:
|
|
return Failure(f"cannot remove {path}: {failure.strerror}")
|
|
return None
|
|
|
|
|
|
def shown(folder: pathlib.Path, ask: Ask, effects: Effects) -> None:
|
|
"""Lists ask in loop-inbox, in its state. A failure only warns: the question is still answered on the loop's terminal."""
|
|
if unshown := publish(folder, ask):
|
|
say(f"loop-inbox cannot show this question: {unshown.reason}", effects)
|
|
|
|
|
|
@contextlib.contextmanager
|
|
def listed(folder: pathlib.Path, ask: Ask, effects: Effects) -> typing.Iterator[None]:
|
|
"""Lists ask in loop-inbox while the with block runs, then takes it out, with any answer. A failure to list it only warns: the question is still answered on the loop's terminal.
|
|
|
|
listed doesn't take the session's lock, which loop-inbox needs held to list the ask. Pass the folder running_loops.shown_running yields: shown_running holds the lock for the loop's whole run.
|
|
"""
|
|
shown(folder, ask, effects)
|
|
try:
|
|
yield
|
|
finally:
|
|
# An ask this fails to remove is left to loop-inbox, which stops listing it once the lock is let go, and removes it.
|
|
withdraw(folder, ask.session)
|
|
|
|
|
|
def waiting(folder: pathlib.Path) -> list[Ask]:
|
|
"""The asks of loops still running, oldest first. A file that cannot be read or parsed is left out."""
|
|
try:
|
|
paths = sorted(folder.glob("*.json"))
|
|
except OSError:
|
|
return []
|
|
asks = [ask for path in paths if (ask := read_ask(path)) and running(folder, ask.session)]
|
|
return sorted(asks, key=lambda ask: ask.asked)
|
|
|
|
|
|
def drop_ended(folder: pathlib.Path) -> None:
|
|
"""Removes each ask, with any answer, whose session's lock no loop holds: a loop that was killed leaves its ask behind. An ask it cannot remove stays on disk, and waiting leaves it out all the same."""
|
|
for session in ended(folder, "*.json"):
|
|
withdraw(folder, session)
|