interject 0.1.0__py3-none-any.whl

interject/__init__.py

@@ -0,0 +1,116 @@
+"""interject — a durable ``ask()`` primitive.
+
+Stop a program, ask a human, resume days later on another machine:
+
+    >>> from interject import ask
+    >>> vehicle = ask("Is this a car?", options=["car", "moto"], id="vehicle_type")
+
+and the outbound half of the same idea, where silence is the event:
+
+    >>> from interject import heartbeat
+    >>> heartbeat("nightly.etl", expect_every="26h")
+"""
+from __future__ import annotations
+
+from typing import Any
+
+from ._client import DEFAULT_PRIORITY, DEFAULT_WAIT, KINDS, ON_TIMEOUT, Client
+from ._duration import Duration
+from ._keys import context_digest, question_key
+from .errors import (
+    Expired,
+    InterjectError,
+    ProtocolError,
+    Suspended,
+    Unauthorized,
+    Unreachable,
+)
+
+__all__ = [
+    "DEFAULT_PRIORITY",
+    "DEFAULT_WAIT",
+    "KINDS",
+    "ON_TIMEOUT",
+    "Client",
+    "Duration",
+    "Expired",
+    "InterjectError",
+    "ProtocolError",
+    "Suspended",
+    "Unauthorized",
+    "Unreachable",
+    "__version__",
+    "answer",
+    "ask",
+    "context_digest",
+    "heartbeat",
+    "inbox",
+    "key_for",
+    "peek",
+    "peek_answer",
+    "question_key",
+    "release",
+]
+
+__version__ = "0.1.0"
+
+_default_client: Client | None = None
+
+
+def _client() -> Client:
+    """The process-wide client, configured from the environment on first use."""
+    global _default_client
+    if _default_client is None:
+        _default_client = Client()
+    return _default_client
+
+
+def ask(prompt: str, **kwargs: Any) -> Any:
+    """Ask a human using the process-wide client. See :meth:`Client.ask`."""
+    kwargs.setdefault("_stacklevel", 3)
+    return _client().ask(prompt, **kwargs)
+
+
+def answer(key: str, value: Any, **kwargs: Any) -> Any:
+    """Answer a question using the process-wide client. See :meth:`Client.answer`."""
+    return _client().answer(key, value, **kwargs)
+
+
+def inbox(**kwargs: Any) -> Any:
+    """Open questions, grouped by batch. See :meth:`Client.inbox`."""
+    return _client().inbox(**kwargs)
+
+
+def claim(key: str, ttl_seconds: int | None = None) -> Any:
+    """Hold a question while you work on it. See :meth:`Client.claim`."""
+    return _client().claim(key, ttl_seconds)
+
+
+def release(key: str) -> Any:
+    """Give up a claim. See :meth:`Client.release`."""
+    return _client().release(key)
+
+
+def assign(key: str, to: str | None) -> Any:
+    """Route a question to one person. See :meth:`Client.assign`."""
+    return _client().assign(key, to)
+
+
+def key_for(id: str, context: Any = None) -> str:
+    """The key the process-wide client would use. See :meth:`Client.key_for`."""
+    return _client().key_for(id, context)
+
+
+def peek(key: str) -> Any:
+    """Look at a question without creating one. See :meth:`Client.peek`."""
+    return _client().peek(key)
+
+
+def peek_answer(key: str, default: Any = None) -> Any:
+    """The stored answer for ``key``, or ``default``. See :meth:`Client.peek_answer`."""
+    return _client().peek_answer(key, default)
+
+
+def heartbeat(name: str, **kwargs: Any) -> None:
+    """Report a live signal using the process-wide client. See :meth:`Client.heartbeat`."""
+    return _client().heartbeat(name, **kwargs)

interject/_client.py

@@ -0,0 +1,350 @@
+"""The ``ask()`` primitive and its outbound twin, ``heartbeat()``."""
+from __future__ import annotations
+
+import os
+import sys
+from collections.abc import Mapping, Sequence
+from typing import Any
+
+from ._config import Config
+from ._duration import Duration, seconds
+from ._http import Transport
+from ._keys import question_key
+from .errors import Expired, ProtocolError, Suspended
+
+_UNSET = object()
+
+#: Question kinds the protocol defines. See docs/PROTOCOL.md.
+KINDS = ("choice", "multi", "text", "number", "approve", "rank", "label")
+
+#: What to do when ``wait`` elapses with the question still open. See DESIGN.md D3.
+ON_TIMEOUT = ("suspend", "block", "default")
+
+DEFAULT_WAIT = 30
+DEFAULT_PRIORITY = 5
+
+
+class Client:
+    """A connection to one project on one daemon.
+
+    Usually you want the module-level :func:`ask` and :func:`heartbeat`, which
+    share a process-wide client configured from the environment. Construct this
+    directly to talk to more than one project or daemon from one process.
+    """
+
+    def __init__(
+        self,
+        url: str | None = None,
+        token: str | None = None,
+        project: str | None = None,
+        identity: str | None = None,
+    ) -> None:
+        self._config = Config(url=url, token=token, project=project, identity=identity)
+        self._transport = Transport(self._config)
+
+    @property
+    def project(self) -> str:
+        return self._config.project
+
+    def ask(
+        self,
+        prompt: str,
+        *,
+        options: Sequence[Any] | None = None,
+        kind: str | None = None,
+        context: Mapping[str, Any] | None = None,
+        context_ref: str | None = None,
+        id: str | None = None,
+        ttl: Duration = None,
+        default: Any = _UNSET,
+        on_timeout: str = "suspend",
+        suggest: Mapping[str, Any] | None = None,
+        wait: Duration = DEFAULT_WAIT,
+        priority: int = DEFAULT_PRIORITY,
+        batch_key: str | None = None,
+        origin: Mapping[str, Any] | None = None,
+        assign_to: str | None = None,
+        _stacklevel: int = 2,
+    ) -> Any:
+        """Ask a human, and return their answer.
+
+        The question is content-addressed (DESIGN.md D2), so calling this again
+        with the same ``id`` and ``context`` returns the stored answer instead of
+        asking twice — which is what makes a crashed or restarted program resume
+        where it left off.
+
+        Raises :class:`~interject.errors.Suspended` when ``wait`` elapses with
+        the question still open and ``on_timeout`` is ``"suspend"`` (the
+        default). Let it propagate and exit; the next run will pick up the
+        answer.
+        """
+        if on_timeout not in ON_TIMEOUT:
+            raise ValueError(f"on_timeout must be one of {ON_TIMEOUT}, got {on_timeout!r}")
+        if kind is None:
+            kind = _infer_kind(options, default)
+        if kind not in KINDS:
+            raise ValueError(f"kind must be one of {KINDS}, got {kind!r}")
+        if on_timeout == "default" and default is _UNSET:
+            raise ValueError('on_timeout="default" requires a default= value')
+        if kind in ("choice", "multi", "rank") and not options:
+            raise ValueError(f"kind={kind!r} requires options=")
+
+        question_id = id or _derive_id(_stacklevel)
+        key = question_key(self._config.project, question_id, context)
+        wait_seconds = seconds(wait) or 0
+
+        body: dict[str, Any] = {
+            "key": key,
+            "id": question_id,
+            "prompt": prompt,
+            "kind": kind,
+            "options": list(options) if options is not None else None,
+            "context": dict(context) if context is not None else None,
+            "context_ref": context_ref,
+            "suggest": dict(suggest) if suggest is not None else None,
+            "ttl_seconds": seconds(ttl),
+            "on_timeout": on_timeout,
+            "priority": priority,
+            "batch_key": batch_key or question_id,
+            "origin": dict(origin) if origin is not None else _derive_origin(_stacklevel),
+            "assign_to": assign_to,
+        }
+        if default is not _UNSET:
+            body["default"] = default
+
+        status, payload = self._transport.request(
+            "POST", "/v0/questions", body, timeout=_timeout_for(0)
+        )
+        if status >= 400:
+            raise ProtocolError(_error_message(payload, status, "registering question"))
+
+        resolved = self._resolve(payload, key, question_id, default)
+        if resolved is not _UNSET:
+            return resolved
+
+        # Not answered yet. Long-poll, then apply the timeout policy.
+        while True:
+            status, payload = self._transport.request(
+                "GET",
+                f"/v0/questions/{key}?wait={wait_seconds}",
+                timeout=_timeout_for(wait_seconds),
+            )
+            if status >= 400:
+                raise ProtocolError(_error_message(payload, status, "polling question"))
+
+            resolved = self._resolve(payload, key, question_id, default)
+            if resolved is not _UNSET:
+                return resolved
+
+            if on_timeout == "block":
+                continue
+            if on_timeout == "default":
+                # Record the default so a later replay returns the same value.
+                self._transport.request(
+                    "POST",
+                    "/v0/answers",
+                    {"key": key, "value": default, "source": "default"},
+                    timeout=_timeout_for(0),
+                )
+                return default
+            raise Suspended(key, question_id)
+
+    def key_for(self, id: str, context: Mapping[str, Any] | None = None) -> str:
+        """The question key this client would use for ``id`` and ``context``."""
+        return question_key(self._config.project, id, context)
+
+    def peek(self, key: str) -> dict[str, Any] | None:
+        """Look at a question without creating one.
+
+        Returns the snapshot, or ``None`` if no question with that key exists.
+        :meth:`ask` deliberately registers as it checks, which makes it the wrong
+        tool for "has this been answered yet?" over a large backlog — this is that
+        tool.
+        """
+        status, payload = self._transport.request(
+            "GET", f"/v0/questions/{key}?wait=0", timeout=_timeout_for(0)
+        )
+        if status == 404:
+            return None
+        if status >= 400:
+            raise ProtocolError(_error_message(payload, status, "peeking at a question"))
+        return dict(payload)
+
+    def peek_answer(self, key: str, default: Any = _UNSET) -> Any:
+        """The answer for ``key``, or ``default`` if it is unknown or unanswered."""
+        snapshot = self.peek(key)
+        if snapshot is None or snapshot.get("state") != "answered":
+            if default is _UNSET:
+                return None
+            return default
+        answer = snapshot.get("answer") or {}
+        return answer.get("value")
+
+    def answer(
+        self,
+        key: str,
+        value: Any,
+        answered_by: str | None = None,
+        source: str | None = None,
+    ) -> dict[str, Any]:
+        """Answer a question on a human's behalf.
+
+        The answering side of the protocol, for building a surface in Python.
+        Pipelines call :meth:`ask`; inboxes call this.
+        """
+        body: dict[str, Any] = {"key": key, "value": value}
+        if answered_by is not None:
+            body["answered_by"] = answered_by
+        if source is not None:
+            body["source"] = source
+        status, payload = self._transport.request(
+            "POST", "/v0/answers", body, timeout=_timeout_for(0)
+        )
+        if status >= 400:
+            raise ProtocolError(_error_message(payload, status, "answering a question"))
+        return dict(payload)
+
+    def inbox(
+        self,
+        limit: int = 50,
+        batch_key: str | None = None,
+        for_identity: str | None = None,
+        all_of_them: bool = False,
+    ) -> dict[str, Any]:
+        """Open questions, grouped by batch.
+
+        By default this is *your* inbox: questions assigned to someone else, and
+        questions another person currently holds a claim on, are left out.
+        ``all_of_them`` lifts both filters.
+        """
+        path = f"/v0/inbox?limit={limit}"
+        if batch_key is not None:
+            path += f"&batch_key={batch_key}"
+        if for_identity is not None:
+            path += f"&for={for_identity}"
+        if all_of_them:
+            path += "&all=true"
+        status, payload = self._transport.request("GET", path, timeout=_timeout_for(0))
+        if status >= 400:
+            raise ProtocolError(_error_message(payload, status, "reading the inbox"))
+        return dict(payload)
+
+    def claim(self, key: str, ttl_seconds: int | None = None) -> dict[str, Any]:
+        """Take an advisory hold on a question while you work on it.
+
+        Advisory: it stops two people duplicating effort, but answering is still
+        governed by answers being write-once. Claims expire, so wandering off
+        mid-question does not hide it from everyone else for long.
+        """
+        status, payload = self._transport.request(
+            "POST",
+            f"/v0/questions/{key}/claim",
+            {"ttl_seconds": ttl_seconds},
+            timeout=_timeout_for(0),
+        )
+        if status >= 400:
+            raise ProtocolError(_error_message(payload, status, "claiming a question"))
+        return dict(payload)
+
+    def release(self, key: str) -> bool:
+        """Give up a claim, so the question reappears for everyone at once."""
+        status, payload = self._transport.request(
+            "POST", f"/v0/questions/{key}/release", {}, timeout=_timeout_for(0)
+        )
+        if status >= 400:
+            raise ProtocolError(_error_message(payload, status, "releasing a claim"))
+        return bool(payload.get("released"))
+
+    def assign(self, key: str, to: str | None) -> None:
+        """Route a question to one person, or back to the pool with ``None``."""
+        status, payload = self._transport.request(
+            "POST", f"/v0/questions/{key}/assign", {"to": to}, timeout=_timeout_for(0)
+        )
+        if status >= 400:
+            raise ProtocolError(_error_message(payload, status, "assigning a question"))
+
+    def heartbeat(self, name: str, *, expect_every: Duration = None, expect_by: str | None = None) -> None:
+        """Declare that a named signal is alive, and when it is next due.
+
+        Silence past the deadline is itself an event — the outbound half of the
+        same idea as :meth:`ask`. Exactly one of ``expect_every`` or
+        ``expect_by`` should be given.
+        """
+        if (expect_every is None) == (expect_by is None):
+            raise ValueError("pass exactly one of expect_every= or expect_by=")
+        body: dict[str, Any] = {"name": name}
+        if expect_every is not None:
+            body["expect_every_seconds"] = seconds(expect_every)
+        else:
+            body["expect_by"] = expect_by
+        status, payload = self._transport.request(
+            "POST", "/v0/signals/heartbeat", body, timeout=_timeout_for(0)
+        )
+        if status >= 400:
+            raise ProtocolError(_error_message(payload, status, "sending heartbeat"))
+
+    def _resolve(
+        self, payload: Mapping[str, Any], key: str, question_id: str, default: Any
+    ) -> Any:
+        """Turn a protocol response into an answer, or ``_UNSET`` if still open."""
+        state = payload.get("state")
+        if state == "answered":
+            answer = payload.get("answer")
+            if not isinstance(answer, dict) or "value" not in answer:
+                raise ProtocolError("daemon reported 'answered' without an answer value")
+            return answer["value"]
+        if state == "expired":
+            if default is not _UNSET:
+                return default
+            raise Expired(key, question_id)
+        if state != "open":
+            raise ProtocolError(f"daemon reported unknown state {state!r}")
+        return _UNSET
+
+
+def _timeout_for(wait_seconds: int) -> float:
+    """Read timeout: always longer than the long-poll the daemon will hold."""
+    return float(wait_seconds) + 15.0
+
+
+def _infer_kind(options: Sequence[Any] | None, default: Any) -> str:
+    if options:
+        return "choice"
+    if isinstance(default, bool):
+        return "approve"
+    return "text"
+
+
+def _derive_id(stacklevel: int) -> str:
+    """Fall back to ``file:function:line`` when no explicit ``id=`` was given.
+
+    This is deliberately fragile in a documented way: editing the file moves the
+    line number, which changes the question key and re-asks the question. Pass
+    an explicit ``id=`` for anything long-lived (DESIGN.md D2).
+    """
+    try:
+        frame = sys._getframe(stacklevel)
+    except ValueError:  # pragma: no cover - shallower stack than expected
+        return "anonymous"
+    return f"{os.path.basename(frame.f_code.co_filename)}:{frame.f_code.co_name}:{frame.f_lineno}"
+
+
+def _derive_origin(stacklevel: int) -> dict[str, Any]:
+    try:
+        frame = sys._getframe(stacklevel)
+        site = f"{frame.f_code.co_filename}:{frame.f_lineno}"
+    except ValueError:  # pragma: no cover
+        site = None
+    origin: dict[str, Any] = {"site": site}
+    for field, variable in (("repo", "INTERJECT_REPO"), ("job", "INTERJECT_JOB"), ("run", "INTERJECT_RUN")):
+        value = os.environ.get(variable)
+        if value:
+            origin[field] = value
+    return origin
+
+
+def _error_message(payload: Mapping[str, Any], status: int, doing: str) -> str:
+    error = payload.get("error")
+    if isinstance(error, dict) and error.get("message"):
+        return "{} failed ({}): {}".format(doing, status, error["message"])
+    return f"{doing} failed with status {status}"

interject/_config.py

@@ -0,0 +1,32 @@
+"""Client configuration, read from the environment."""
+from __future__ import annotations
+
+import os
+
+DEFAULT_URL = "http://127.0.0.1:8787"
+DEFAULT_PROJECT = "default"
+
+
+class Config:
+    """Where the daemon is and who we are to it."""
+
+    __slots__ = ("identity", "project", "token", "url")
+
+    def __init__(
+        self,
+        url: str | None = None,
+        token: str | None = None,
+        project: str | None = None,
+        identity: str | None = None,
+    ) -> None:
+        self.url = (url or os.environ.get("INTERJECT_URL") or DEFAULT_URL).rstrip("/")
+        self.token = token if token is not None else os.environ.get("INTERJECT_TOKEN")
+        self.project = project or os.environ.get("INTERJECT_PROJECT") or DEFAULT_PROJECT
+        #: Who this client acts as, for routing. A token's own label wins
+        #: server-side, so this only matters on daemons without tokens.
+        self.identity = identity or os.environ.get("INTERJECT_IDENTITY")
+
+    def __repr__(self) -> str:  # pragma: no cover - debugging aid
+        return "Config(url={!r}, project={!r}, token={})".format(
+            self.url, self.project, "set" if self.token else "unset"
+        )

interject/_duration.py

@@ -0,0 +1,29 @@
+"""Human-friendly durations: ``"48h"``, ``"15m"``, ``90``, ``2.5``."""
+from __future__ import annotations
+
+import re
+from typing import Union
+
+Duration = Union[str, int, float, None]
+
+_UNITS = {"s": 1, "m": 60, "h": 3600, "d": 86400, "w": 604800}
+_PATTERN = re.compile(r"^\s*(\d+(?:\.\d+)?)\s*([smhdw])?\s*$", re.IGNORECASE)
+
+
+def seconds(value: Duration) -> int | None:
+    """Return whole seconds, or ``None`` when ``value`` is ``None``."""
+    if value is None:
+        return None
+    if isinstance(value, bool):  # bool is an int subclass; reject it explicitly
+        raise TypeError("duration must be a number or a string like '15m', not a bool")
+    if isinstance(value, (int, float)):
+        if value < 0:
+            raise ValueError("duration must not be negative")
+        return int(value)
+    match = _PATTERN.match(value)
+    if not match:
+        raise ValueError(
+            f"could not parse duration {value!r}; use seconds or a suffix of s/m/h/d/w"
+        )
+    magnitude, unit = match.groups()
+    return int(float(magnitude) * _UNITS[(unit or "s").lower()])

interject/_http.py

@@ -0,0 +1,103 @@
+"""Minimal JSON-over-HTTP transport. Standard library only, on purpose.
+
+The client has no third-party dependencies so that adding ``interject`` to an
+existing pipeline can never create a version conflict. See DESIGN.md D1.
+"""
+from __future__ import annotations
+
+import json
+import time
+import urllib.error
+import urllib.request
+from typing import Any
+
+from ._config import Config
+from .errors import ProtocolError, Unauthorized, Unreachable
+
+_RETRY_BACKOFF = (0.2, 0.6, 1.8)
+_USER_AGENT = "interject-python/0.0.1"
+
+
+class Transport:
+    """Speaks ``docs/PROTOCOL.md`` over HTTP/1.1."""
+
+    def __init__(self, config: Config) -> None:
+        self._config = config
+
+    @property
+    def config(self) -> Config:
+        return self._config
+
+    def _headers(self) -> dict[str, str]:
+        headers = {
+            "Content-Type": "application/json",
+            "Accept": "application/json",
+            "User-Agent": _USER_AGENT,
+            "X-Interject-Project": self._config.project,
+        }
+        if self._config.token:
+            headers["Authorization"] = f"Bearer {self._config.token}"
+        if self._config.identity:
+            headers["X-Interject-Identity"] = self._config.identity
+        return headers
+
+    def request(
+        self,
+        method: str,
+        path: str,
+        body: dict[str, Any] | None = None,
+        timeout: float = 35.0,
+    ) -> tuple[int, dict[str, Any]]:
+        """Perform one request, retrying transport errors and 5xx responses.
+
+        4xx responses are returned to the caller rather than raised, because
+        several of them (``404`` on an unknown key, ``409`` on an already
+        answered question) are ordinary control flow for this protocol.
+        """
+        url = f"{self._config.url}{path}"
+        payload = None if body is None else json.dumps(body).encode("utf-8")
+        last_error: BaseException | None = None
+
+        for attempt in range(len(_RETRY_BACKOFF) + 1):
+            request = urllib.request.Request(url, data=payload, method=method)
+            for name, value in self._headers().items():
+                request.add_header(name, value)
+            try:
+                with urllib.request.urlopen(request, timeout=timeout) as response:
+                    return response.status, _decode(response.read())
+            except urllib.error.HTTPError as error:
+                raw = error.read()
+                if error.code == 401 or error.code == 403:
+                    raise Unauthorized(_message(raw, "daemon rejected the project token"))
+                if error.code < 500:
+                    return error.code, _decode(raw, allow_empty=True)
+                last_error = error
+            except (urllib.error.URLError, OSError) as error:
+                last_error = error
+
+            if attempt < len(_RETRY_BACKOFF):
+                time.sleep(_RETRY_BACKOFF[attempt])
+
+        raise Unreachable(
+            f"could not reach interjectd at {self._config.url} ({last_error})"
+        )
+
+
+def _decode(raw: bytes, allow_empty: bool = False) -> dict[str, Any]:
+    if not raw and allow_empty:
+        return {}
+    try:
+        decoded = json.loads(raw.decode("utf-8"))
+    except (ValueError, UnicodeDecodeError) as error:
+        raise ProtocolError(f"daemon returned a body that is not JSON: {error}")
+    if not isinstance(decoded, dict):
+        raise ProtocolError(f"daemon returned {type(decoded).__name__}, expected a JSON object")
+    return decoded
+
+
+def _message(raw: bytes, fallback: str) -> str:
+    try:
+        payload = json.loads(raw.decode("utf-8"))
+        return str(payload["error"]["message"])
+    except Exception:  # noqa: BLE001 - never let error-body parsing mask the real error
+        return fallback

interject/_keys.py

@@ -0,0 +1,39 @@
+"""Question identity.
+
+Every client MUST compute keys exactly as specified in ``docs/PROTOCOL.md``,
+because the key is the mechanism behind crash-replay, deduplication and
+coalescing alike. See DESIGN.md D2.
+"""
+from __future__ import annotations
+
+import hashlib
+import json
+from collections.abc import Mapping
+from typing import Any
+
+_NUL = "\x00"
+
+
+def canon(context: Mapping[str, Any] | None) -> bytes:
+    """Canonical JSON encoding of a question's context.
+
+    Sorted keys, no insignificant whitespace, non-ASCII preserved, UTF-8. A
+    missing context is treated as ``{}`` so that omitting it and passing an
+    empty mapping produce the same key.
+    """
+    return json.dumps(
+        {} if context is None else dict(context),
+        sort_keys=True,
+        separators=(",", ":"),
+        ensure_ascii=False,
+    ).encode("utf-8")
+
+
+def context_digest(context: Mapping[str, Any] | None) -> str:
+    return hashlib.sha256(canon(context)).hexdigest()
+
+
+def question_key(project: str, question_id: str, context: Mapping[str, Any] | None) -> str:
+    """``sha256(project \\x00 question_id \\x00 context_digest)``, lowercase hex."""
+    material = _NUL.join((project, question_id, context_digest(context)))
+    return hashlib.sha256(material.encode("utf-8")).hexdigest()

interject/errors.py

@@ -0,0 +1,45 @@
+"""Exceptions raised by the interject client."""
+
+
+class InterjectError(Exception):
+    """Base class for every error this library raises."""
+
+
+class Suspended(InterjectError):
+    """A question is still open and ``on_timeout="suspend"`` was in effect.
+
+    The caller is expected to let this propagate and exit cleanly. When the
+    program runs again it recomputes the same question key and, if the question
+    has been answered by then, :func:`interject.ask` returns immediately
+    instead of raising.
+    """
+
+    def __init__(self, key: str, question_id: str) -> None:
+        super().__init__(
+            f"question {question_id!r} is still open (key {key[:12]}); exit and retry later"
+        )
+        self.key = key
+        self.question_id = question_id
+
+
+class Expired(InterjectError):
+    """The question's TTL elapsed and no default was declared."""
+
+    def __init__(self, key: str, question_id: str) -> None:
+        super().__init__(
+            f"question {question_id!r} expired with no default (key {key[:12]})"
+        )
+        self.key = key
+        self.question_id = question_id
+
+
+class Unauthorized(InterjectError):
+    """The daemon rejected the project token."""
+
+
+class ProtocolError(InterjectError):
+    """The daemon returned a response this client could not understand."""
+
+
+class Unreachable(InterjectError):
+    """The daemon could not be reached."""

interject-0.1.0.dist-info/METADATA

@@ -0,0 +1,119 @@
+Metadata-Version: 2.5
+Name: interject
+Version: 0.1.0
+Summary: A durable ask() primitive: stop, ask a human, resume.
+Project-URL: Homepage, https://github.com/TheJohnMatti/interject
+Project-URL: Repository, https://github.com/TheJohnMatti/interject
+Project-URL: Issues, https://github.com/TheJohnMatti/interject/issues
+Project-URL: Changelog, https://github.com/TheJohnMatti/interject/releases
+Author: John Matti
+License: Apache-2.0
+License-File: LICENSE
+Keywords: approval,durable,human-in-the-loop,pipeline,workflow
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-xdist; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# interject
+
+**A durable `ask()` primitive.** A program can stop, ask a human, and resume —
+days later, on another machine, in one tap.
+
+```python
+from interject import ask
+
+vehicle = ask(
+    "Is this a car?",
+    options=["car", "motorcycle", "boat", "trailer"],
+    id="vehicle_type",
+    context={"title": listing.title, "price": listing.price},
+    suggest={"value": "motorcycle", "confidence": 0.94},
+)
+```
+
+That call registers a question, lets everything not downstream of it keep
+running, reaches you wherever you are, and returns the answer **to this line of
+this program** — even if the process exited and was restarted two days later on
+different hardware. It may also never reach you at all, if the triage layer is
+confident enough. That is the point.
+
+## Why
+
+Modern pipelines are mostly autonomous with a handful of points where human
+judgment is irreducible. Today each of those is a bespoke JSON file nobody is
+watching, a blocking `input()` at a terminal nobody is sitting at, or a hard
+stop.
+
+## How it behaves
+
+**It does not block.** By default `ask` long-polls briefly and then raises
+`Suspended`, so the caller exits cleanly. The next run recomputes the same
+content-addressed key and gets the stored answer immediately:
+
+```python
+import interject
+
+try:
+    kind = interject.ask("Is this a car?", options=["car", "moto"],
+                         id="vehicle_type", context=listing, wait=0)
+except interject.Suspended:
+    return  # somebody will answer; the next run picks it up
+```
+
+Pass `on_timeout="block"` for an interactive script, or `on_timeout="default"`
+with a `default=` for best-effort enrichment.
+
+**Scanning a backlog does not create a backlog of questions.** `ask` registers as
+it checks, so use `peek` to look without creating:
+
+```python
+key = interject.key_for("vehicle_type", listing)
+if interject.peek_answer(key) is None:
+    ...  # not answered yet
+```
+
+**Silence is the other half.** A job can declare what it owes you, and going
+quiet becomes an event:
+
+```python
+interject.heartbeat("nightly.etl", expect_every="26h")
+```
+
+## Installation
+
+```bash
+pip install interject
+```
+
+No dependencies, Python 3.9+. It talks to an `interjectd` daemon over HTTP —
+see the [repository](https://github.com/TheJohnMatti/interject) for running one,
+for the one-tap phone inbox, and for the triage layer that makes it ask less
+over time.
+
+## Configuration
+
+| variable | default | meaning |
+|---|---|---|
+| `INTERJECT_URL` | `http://127.0.0.1:8787` | daemon base URL |
+| `INTERJECT_TOKEN` | *(none)* | project or device token |
+| `INTERJECT_PROJECT` | `default` | project name, for daemons without tokens |
+| `INTERJECT_IDENTITY` | *(none)* | who you answer as, for routing |
+
+Licensed under Apache-2.0.

interject-0.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+interject/__init__.py,sha256=Rk30rqi-G8OHQoPRyC6HIwiHtikov0PZRNSS0ua5vAE,3140
+interject/_client.py,sha256=L0QxBsCZvF9GL9Li9rgcXSHsUu1xJO-LBEIW-whiOyQ,13815
+interject/_config.py,sha256=Wrkg10iXDjNg4C4Tg0F_D6CFJnOB1u79JKsUuK25PJ8,1175
+interject/_duration.py,sha256=W0v3ApYqUCf0CFZ-igbMLL_ArIRAkNEKIdMZwzij9eg,1082
+interject/_http.py,sha256=03ob-bpNqrA98adZ4dNTlf6tD68-Nv6sLkvCg8OO8nM,3731
+interject/_keys.py,sha256=fCEOcv_BSue6pPge9jbi8LeI0LYw3gTLxn7FWcIYPhE,1276
+interject/errors.py,sha256=cRoYlmlnuG97p_laf5Xt_0LHQyBmqEldueDYxqUbFV4,1387
+interject/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+interject-0.1.0.dist-info/METADATA,sha256=7sqdBF5x5CDUUetR81iwLRaEVWHq2UF9AqOXge6n70U,4136
+interject-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+interject-0.1.0.dist-info/licenses/LICENSE,sha256=yVuuHRzgI17MzTVgt3LsHvuX80innw--CmNPDCzO_iw,11358
+interject-0.1.0.dist-info/RECORD,,

interject-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

interject-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+