Session Module

The Session module provides a robust and thread-safe in-memory session store implementation with expiration and cleanup capabilities.

Classes

class true_storage.session.SessionStore(config=None)

Bases: object

A robust and thread-safe in-memory session store with expiration, LRU eviction, and persistence.

__init__(config=None)

_start_background_threads()

Initialize and start background threads.

_setup_logging()

Setup logging configuration.

Return type:

None

set(key, value, expiration=None)

Set a session key to a value with optional custom expiration.

Return type:

None

get(key, default=None)

Retrieve a session value by key with metadata update.

Return type:

Any

lock(key, duration=None)

Lock a session key for exclusive access.

Return type:

bool

unlock(key)

Unlock a session key.

Return type:

bool

_evict_lru_session()

Evict the least recently used session.

Return type:

None

get_metadata(key)

Get metadata for a session key.

Return type:

Optional[SessionMetadata]

get_status(key)

Get the status of a session key.

Return type:

Optional[SessionStatus]

_backup_sessions()

Periodically backup sessions to disk if persistence is enabled.

Return type:

None

_save_to_disk()

Save sessions to disk.

Return type:

None

_restore_sessions()

Restore sessions from disk on initialization.

Return type:

None

stop()

Stop all background threads and perform final backup.

Return type:

None

__del__()

Ensure all threads are stopped and final backup is performed.

delete(key)

Delete a session key. Returns True if the key was deleted, False if not found.

Return type:

bool

clear()

Clear all sessions.

Return type:

None

keys()

Return an iterator over the session keys.

Return type:

Iterator[Any]

values()

Return an iterator over the session values.

Return type:

Iterator[Any]

items()

Return an iterator over the session items (key, value).

Return type:

Iterator[tuple[Any, Any]]

_cleanup_expired_sessions()

Background thread method to clean up expired sessions periodically.

Return type:

None

__setitem__(key, value)

Enable dict-like setting of items.

Return type:

None

__getitem__(key)

Enable dict-like getting of items.

Return type:

Any

__delitem__(key)

Enable dict-like deletion of items.

Return type:

None

__contains__(key)

Enable use of ‘in’ keyword to check for key existence.

Return type:

bool

__len__()

Return the number of active (non-expired) sessions.

Return type:

int

class true_storage.session.SessionStoreConfig(max_size=1000, expiration_time=3600, cleanup_interval=60, persistence_path=None, backup_interval=300, max_lock_time=30, enable_logging=True, log_level=20)

Bases: object

Configuration for SessionStore.

max_size: int = 1000

expiration_time: int = 3600

cleanup_interval: int = 60

persistence_path: Optional[str] = None

backup_interval: int = 300

max_lock_time: int = 30

enable_logging: bool = True

log_level: int = 20

__init__(max_size=1000, expiration_time=3600, cleanup_interval=60, persistence_path=None, backup_interval=300, max_lock_time=30, enable_logging=True, log_level=20)