Skip to content

client

tit.jobs.client

Notebook client for tit.jobs (TODO.md §2.3): submit into the same queue the desktop app uses, over the local server's HTTP API — so a notebook and the GUI never race on the same resource without the scheduler knowing about both.

Talks to tit.server over plain HTTP (stdlib urllib, no new dependency); defaults come from the same environment variables the server itself uses (TIT_SERVER_URL, TIT_SERVER_TOKEN) so a notebook started alongside NOTEBOOK in-container needs no extra configuration.

JobClientError

Bases: RuntimeError

An HTTP call to tit.server failed (non-2xx, or the server is unreachable).

submit 

submit(kind: str, config: dict[str, Any], subject_ids: list[str], *, after: list[str] | None = None, tags: list[str] | None = None, overwrite: bool = False, base_url: str | None = None, token: str | None = None) -> dict[str, Any]

POST /api/jobs; returns the JobStatus dict.

Source code in tit/jobs/client.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def submit(
    kind: str,
    config: dict[str, Any],
    subject_ids: list[str],
    *,
    after: list[str] | None = None,
    tags: list[str] | None = None,
    overwrite: bool = False,
    base_url: str | None = None,
    token: str | None = None,
) -> dict[str, Any]:
    """``POST /api/jobs``; returns the ``JobStatus`` dict."""
    body: dict[str, Any] = {"kind": kind, "config": config, "subject_ids": subject_ids}
    if after:
        body["after"] = after
    if tags:
        body["tags"] = tags
    if overwrite:
        body["overwrite"] = overwrite
    return _request("POST", "/api/jobs", base_url=base_url, token=token, body=body)

get 

get(job_id: str, *, base_url: str | None = None, token: str | None = None) -> dict[str, Any]

GET /api/jobs/{id}; returns the JobDetail dict (spec/status/artifacts).

Source code in tit/jobs/client.py 
83
84
85
86
87
def get(
    job_id: str, *, base_url: str | None = None, token: str | None = None
) -> dict[str, Any]:
    """``GET /api/jobs/{id}``; returns the ``JobDetail`` dict (``spec``/``status``/``artifacts``)."""
    return _request("GET", f"/api/jobs/{job_id}", base_url=base_url, token=token)

watch 

watch(job_id: str, *, base_url: str | None = None, token: str | None = None, poll_interval: float = 1.0, print_events: bool = True) -> dict[str, Any]

Poll /api/jobs/{id}/events until job_id reaches a terminal state.

Prints log/stage events as they arrive when print_events is true (the notebook equivalent of watching the Jobs panel). Returns the final JobStatus dict.

Source code in tit/jobs/client.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
def watch(
    job_id: str,
    *,
    base_url: str | None = None,
    token: str | None = None,
    poll_interval: float = 1.0,
    print_events: bool = True,
) -> dict[str, Any]:
    """Poll ``/api/jobs/{id}/events`` until *job_id* reaches a terminal state.

    Prints ``log``/``stage`` events as they arrive when *print_events* is true (the notebook
    equivalent of watching the Jobs panel). Returns the final ``JobStatus`` dict.
    """
    since = 0
    while True:
        events = (
            _request(
                "GET",
                f"/api/jobs/{job_id}/events?since={since}",
                base_url=base_url,
                token=token,
            )
            or []
        )
        for event in events:
            since = max(since, event.get("seq", since) + 1)
            if not print_events:
                continue
            if event.get("type") == "log":
                print(f"[{event.get('level', 'info')}] {event.get('msg', '')}")
            elif event.get("type") == "stage":
                print(f"-- stage: {event.get('stage')}")
        detail = get(job_id, base_url=base_url, token=token)
        status = detail.get("status", detail)
        if status["state"] in TERMINAL_STATES:
            return status
        time.sleep(poll_interval)

run_from_json 

run_from_json(spec_path: str, *, base_url: str | None = None, token: str | None = None, poll_interval: float = 1.0, print_events: bool = True) -> dict[str, Any]

Read a spec.json ({kind, config, subject_ids, after?, tags?, overwrite?}), submit it, and block until it finishes. Returns the final JobStatus dict.

Source code in tit/jobs/client.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
def run_from_json(
    spec_path: str,
    *,
    base_url: str | None = None,
    token: str | None = None,
    poll_interval: float = 1.0,
    print_events: bool = True,
) -> dict[str, Any]:
    """Read a ``spec.json`` (``{kind, config, subject_ids, after?, tags?, overwrite?}``), submit
    it, and block until it finishes. Returns the final ``JobStatus`` dict.
    """
    with open(spec_path, encoding="utf-8") as fh:
        spec = json.load(fh)
    status = submit(
        spec["kind"],
        spec.get("config", {}),
        spec.get("subject_ids", []),
        after=spec.get("after"),
        tags=spec.get("tags"),
        overwrite=spec.get("overwrite", False),
        base_url=base_url,
        token=token,
    )
    return watch(
        status["id"],
        base_url=base_url,
        token=token,
        poll_interval=poll_interval,
        print_events=print_events,
    )