Skip to main content

File-based SessionStore implementation for glyff.

Project description

glyff-file-store

A file-based SessionStore implementation for glyff.

Sessions are persisted to disk as a JSON event log. The whole log is loaded into memory at startup and the file is rewritten atomically on each commit; suitable for sessions where the log fits comfortably in memory. For very large or high-throughput sessions, prefer a database-backed store.

Install

pip install glyff-file-store

This package depends on glyff>=0.1.0.

Public API

Name Description
FileClient Low-level file I/O for a session directory.
JsonFileSessionStore SessionStore writing a pretty-printed JSON event log file.

Format

Each session lives under <base_dir>/<session_id>/ and stores its event log in a single pretty-printed JSON file (executions.json). The whole log is read into memory on startup and rewritten atomically on every commit.

Commit atomicity

FileClient 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 via two renames (sessionsession.bak, tmpsession, drop session.bak). 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 FileClient(...) instantiation restores the session from session.bak (when the live directory is missing) or drops the stale backup (when the live directory is already in place), and removes any orphan .commit-* temp directories.

Status

Early development. APIs may change before v1.0.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

glyff_file_store-0.8.0.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

glyff_file_store-0.8.0-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file glyff_file_store-0.8.0.tar.gz.

File metadata

  • Download URL: glyff_file_store-0.8.0.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for glyff_file_store-0.8.0.tar.gz
Algorithm Hash digest
SHA256 f00f64afa831b5eda9ff9e38b265184d5a26b5d8efbd38d077320bbcaa96bbf9
MD5 58e74e685ca49e845864c8038baf6784
BLAKE2b-256 797d558ba5734672d639c4c773e11a84f43015f742e54f696341d96f903b6cb8

See more details on using hashes here.

Provenance

The following attestation bundles were made for glyff_file_store-0.8.0.tar.gz:

Publisher: publish-glyff-file-store.yml on nueruyu/glyff

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file glyff_file_store-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for glyff_file_store-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 87307d000b9943752b6655b77cf786db737b17da2a0c59e319065e438f48d65f
MD5 29e4e6baa95392fd6b5a03ee9631418a
BLAKE2b-256 0b037a6c683a8a370708a7f6ab1019b1d7609df55312d404289408eb96b80a6a

See more details on using hashes here.

Provenance

The following attestation bundles were made for glyff_file_store-0.8.0-py3-none-any.whl:

Publisher: publish-glyff-file-store.yml on nueruyu/glyff

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page