Index
state
¶
State management backends.
Classes¶
StateBackend
¶
Bases: ABC
Abstract base class for state storage backends.
Implementations handle persistence of job state for resumable execution.
Attributes¶
supports_execution_history
property
¶
Whether this backend persists execution history.
Backends that override record_execution should also override this
to return True. Callers can check this to avoid silent data loss
when a backend unexpectedly lacks execution recording.
Functions¶
load
abstractmethod
async
¶
Load state for a job.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
str
|
Unique job identifier |
required |
Returns:
| Type | Description |
|---|---|
CheckpointState | None
|
CheckpointState if found, None otherwise |
save
abstractmethod
async
¶
Save job state.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
state
|
CheckpointState
|
Checkpoint state to persist |
required |
delete
abstractmethod
async
¶
Delete state for a job.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
str
|
Unique job identifier |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if deleted, False if not found |
list_jobs
abstractmethod
async
¶
List all jobs with state.
Returns:
| Type | Description |
|---|---|
list[CheckpointState]
|
List of all checkpoint states |
get_next_sheet
abstractmethod
async
¶
Get the next sheet to process for a job.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
str
|
Unique job identifier |
required |
Returns:
| Type | Description |
|---|---|
int | None
|
Next sheet number, or None if complete |
mark_sheet_status
abstractmethod
async
¶
Update status of a specific sheet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
str
|
Unique job identifier |
required |
sheet_num
|
int
|
Sheet number to update |
required |
status
|
SheetStatus
|
New status |
required |
error_message
|
str | None
|
Optional error message for failures |
None
|
Source code in src/marianne/state/base.py
close
async
¶
Release any resources held by the backend (Q018/#37).
Optional method — backends that hold persistent connections or file handles should override this. The default no-op is safe for backends that use per-operation connections (e.g. aiosqlite context managers).
Source code in src/marianne/state/base.py
record_execution
async
¶
record_execution(job_id, sheet_num, attempt_num, prompt=None, output=None, exit_code=None, duration_seconds=None)
Record an execution attempt in history.
Optional method -- backends that support execution recording (e.g. SQLite) override this. The default logs at WARNING level so silent data loss is traceable, then returns None.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
str
|
Job identifier. |
required |
sheet_num
|
int
|
Sheet number. |
required |
attempt_num
|
int
|
Attempt number within the sheet. |
required |
prompt
|
str | None
|
The prompt sent to the backend. |
None
|
output
|
str | None
|
The output received. |
None
|
exit_code
|
int | None
|
Exit code from the execution. |
None
|
duration_seconds
|
float | None
|
Execution duration. |
None
|
Returns:
| Type | Description |
|---|---|
int | None
|
The ID of the inserted record, or None if not supported. |
Source code in src/marianne/state/base.py
infer_state_from_artifacts
async
¶
Infer last completed sheet from artifact files.
Fallback when state file is missing - checks for output files. Based on the fallback logic in run-sheet-review.sh.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
str
|
Unique job identifier |
required |
workspace
|
str
|
Workspace directory path |
required |
artifact_pattern
|
str
|
Glob pattern for sheet artifacts (e.g., "sheet*-security-report.md") |
required |
Returns:
| Type | Description |
|---|---|
int | None
|
Inferred last completed sheet number, or None |
Source code in src/marianne/state/base.py
JsonStateBackend
¶
Bases: StateBackend
JSON file-based state storage.
Stores each job's state in a separate JSON file within the state directory. File naming: {state_dir}/{job_id}.json
Initialize JSON backend.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
state_dir
|
Path
|
Directory to store state files |
required |
Source code in src/marianne/state/json_backend.py
Functions¶
load
async
¶
Load state from JSON file.
Automatically detects and recovers zombie jobs (RUNNING status but process dead). When a zombie is detected, the state is updated to PAUSED and saved before returning.
Source code in src/marianne/state/json_backend.py
save
async
¶
Save state to JSON file.
Source code in src/marianne/state/json_backend.py
delete
async
¶
list_jobs
async
¶
List all jobs with state files.
Optimized: reads raw JSON and sorts by updated_at before doing full Pydantic validation, avoiding expensive model_validate on every file just to determine sort order.
Source code in src/marianne/state/json_backend.py
get_next_sheet
async
¶
Get next sheet from state.
mark_sheet_status
async
¶
Update sheet status in state.
Source code in src/marianne/state/json_backend.py
InMemoryStateBackend
¶
Bases: StateBackend
In-memory state backend for testing.
Tracks state changes in a dict without filesystem I/O.
Source code in src/marianne/state/memory.py
SQLiteStateBackend
¶
Bases: StateBackend
SQLite-based state storage with execution history.
Stores job state in a SQLite database with queryable tables for: - jobs: Job-level metadata and status - sheets: Per-sheet state including attempts and errors - execution_history: Detailed record of each execution attempt
Supports schema migrations for future upgrades.
Initialize SQLite backend.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
db_path
|
str | Path
|
Path to SQLite database file |
required |
Source code in src/marianne/state/sqlite_backend.py
Functions¶
load
async
¶
Load state for a job from SQLite.
Automatically detects and recovers zombie jobs (RUNNING status but process dead). When a zombie is detected, the state is updated to PAUSED and saved before returning.
Source code in src/marianne/state/sqlite_backend.py
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 | |
save
async
¶
Save job state to SQLite.
Source code in src/marianne/state/sqlite_backend.py
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 | |
delete
async
¶
Delete state for a job.
Source code in src/marianne/state/sqlite_backend.py
list_jobs
async
¶
List all jobs with state.
Source code in src/marianne/state/sqlite_backend.py
get_next_sheet
async
¶
Get the next sheet to process for a job.
Source code in src/marianne/state/sqlite_backend.py
mark_sheet_status
async
¶
Update status of a specific sheet.
Source code in src/marianne/state/sqlite_backend.py
record_execution
async
¶
record_execution(job_id, sheet_num, attempt_num, prompt=None, output=None, exit_code=None, duration_seconds=None)
Record an execution attempt in history.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
str
|
Job identifier |
required |
sheet_num
|
int
|
Sheet number |
required |
attempt_num
|
int
|
Attempt number within the sheet |
required |
prompt
|
str | None
|
The prompt sent to Claude |
None
|
output
|
str | None
|
The output received |
None
|
exit_code
|
int | None
|
Exit code from the execution |
None
|
duration_seconds
|
float | None
|
Execution duration |
None
|
Returns:
| Type | Description |
|---|---|
int | None
|
The ID of the inserted record, or None if insertion failed. |
Source code in src/marianne/state/sqlite_backend.py
get_execution_history
async
¶
Get execution history for a job.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
str
|
Job identifier |
required |
sheet_num
|
int | None
|
Optional sheet number filter |
None
|
limit
|
int
|
Maximum records to return |
100
|
Returns:
| Type | Description |
|---|---|
list[dict[str, Any]]
|
List of execution history records |
Source code in src/marianne/state/sqlite_backend.py
get_execution_history_count
async
¶
Get total count of execution history records for a job.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
str
|
Job identifier |
required |
Returns:
| Type | Description |
|---|---|
int
|
Total number of execution history records |
Source code in src/marianne/state/sqlite_backend.py
get_job_statistics
async
¶
Get aggregate statistics for a job.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
str
|
Job identifier |
required |
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
Dictionary with statistics including: |
dict[str, Any]
|
|
dict[str, Any]
|
|
dict[str, Any]
|
|
dict[str, Any]
|
|
Source code in src/marianne/state/sqlite_backend.py
query_jobs
async
¶
Query jobs with filters for dashboard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
status
|
JobStatus | None
|
Optional status filter |
None
|
since
|
datetime | None
|
Only return jobs updated since this time |
None
|
limit
|
int
|
Maximum results |
50
|
Returns:
| Type | Description |
|---|---|
list[dict[str, Any]]
|
List of job summary dictionaries |