linesman.backends

class linesman.backends.base.Backend(*args, **kwargs)

Base class for all backends. Methods that raise a NotImplementedError exception are required to be overriden by children, while functions that pass are optional.

add(session)

Store a new session in history.

Raises a NotImplementedError exception.

delete(session_uuid)

Removes a specific stored session from the history.

This should return the number of rows removed (0 or 1).

Raises a NotImplementedError exception.

delete_all()

Removes all stored sessions from the history.

This should return the number of rows removed.

Raises a NotImplementedError exception.

delete_many(session_uuids)

Removes a list of stored sessions from the history.

This should return the number of rows removed.

Raises a NotImplementedError exception.

get(session_uuid)

Returns the data associated with session_uuid. Should return None if no session can be found with the specified uuid.

Raises a NotImplementedError exception.

get_all()

Return a dictionary-like object of ALL sessions, where the key is the session uuid.

Raises a NotImplementedError exception.

setup()

Responsible for initializing the backend. for usage. This is run once on middleware startup.

Raises a NotImplementedError exception.

class linesman.backends.pickle.PickleBackend(filename='sessions.dat')

Stores entire session as a pickled object. This can be extremely slow when using even smaller sets of sessions–on the order of 30mb, or around 200 requests.

add(session)

Adds a session to this dictionary and flushes it to disk.

delete(session_uuid)

Remove a session from the dictionary and flush it to disk.

delete_all()

Clear the entire session history and flush it to disk.

delete_many(session_uuids)

Remove the sessions from the dictionary and flush it to disk.

get(session_uuid)

get_all()

setup()

Reads in pickled data from filename.

class linesman.backends.sqlite.SqliteBackend(filename='sessions.db')

Stores sessions in a SQLite database.

add(session)

Insert a new session into the database.

conn

delete(session_uuid)

Remove the session.

delete_all()

Truncate the database.

delete_many(session_uuids)

Remove the sessions.

get(session_uuid)

Retrieves the session from the database.

get_all()

Generates a dictionary of the data based on the contents of the DB.

setup()

Creates table for Linesman, if it doesn’t already exist.