glyff-file-store 0.13.0

File-based SessionStore implementation for glyff.

glyff-file-store

File-backed ExecutionRepository implementation for glyff.

This package provides a human-readable debug backend:

• JsonFileBackend provides a file-backed execution repository and transaction provider. It stores executions in a single pretty-printed JSON map and rewrites that file atomically on each commit.

For the durable production backend, see glyff-sqlite.

Install

pip install glyff-file-store

This package depends on glyff>=0.1.0.

Public API

Name	Description
JsonFileBackend	Bundle exposing repository and transaction provider.
FileExecutionRepository	Debug repository writing pretty-printed JSON.
FileTransactionProvider	Transaction provider for the file backend.

Construct it with a base_dir and session_id:

from glyff_file_store import JsonFileBackend

backend = JsonFileBackend(base_dir=".sessions", session_id="my-session")

The underlying FileClient is internal and not part of the public API.

JSON debug format

JsonFileBackend stores each session under <base_dir>/<session_id>/ in a single pretty-printed JSON file (executions.json). The execution map is read from that file on access and rewritten atomically on every commit. Execution results and metadata are stored as embedded JSON values, so serializers used with this backend must produce JSON text.

This format is intended for debugging and manual inspection, not as the durable or high-throughput backend.

Commit atomicity

The store commits the staged ops for an entire session directory as a unit. Each commit builds the full new session state in a sibling .commit-* directory and then swaps it into place using directory renames. All staged ops are visible together or none are, regardless of how many files were touched, and a writer callback raising mid-commit leaves the on-disk session unchanged.

If a process dies mid-commit, the next time the session directory is opened it is restored from session.bak when the live directory is missing, or the stale backup is removed when the live directory is already in place. Any orphan .commit-* temp directories are also removed.

Status

Early development. APIs may change before v1.0.

License

MIT