session: Application session support

A session provides access to most of the application’s state. At a minimum, it does not include the operating system state, like the current directory, nor the environment, nor any Python interpreter state – e.g., the exception hook, module globals, etc.

Code should be designed to support multiple sessions per process since it is easier to start with that assumption rather than add it later. Possible uses of multiple sessions include: one session per tabbed graphics window, or for comparing two sessions.

Session data, ie., data that is archived, uses the State and StateManager API.

SESSION_SUFFIX = '.cxs'

session file suffix

class Session(app_name, *, debug=False, silent=False, minimal=False)

Bases: object

Session management

The metadata attribute should be a dictionary with information about the session, e.g., a thumbnail, a description, the author, etc. See standard_metadata().

Attributes that support the StateManager API are automatically added as state managers (e.g. the session’s add_state_manager method is called with the ‘tag’ argument the same as the attribute name). Conversely, deleting the attribute will call remove_state_manager. If a session attribute is not desired, the add/remove_state_manager methods can be called directly.

Attributes:
logger : An instance of Logger

Use to log information, warning, errors.

metadata : dict

Information kept at beginning of session file, eg., a thumbnail

models : Instance of Models.
triggers : An instance of TriggerSet

Starts with session triggers.

metadata = None

Experimental API . session metadata

reset()

Experimental API . Reset session to data-less state

restore(stream, path=None, resize_window=None, restore_camera=True, metadata_only=False)

Experimental API . Deserialize session from binary stream.

save(stream, version, include_maps=False)

Experimental API . Serialize session to binary stream.

snapshot_methods(object, instance=True, type=<class 'chimerax.core.state.State'>)

Experimental API . Return an object having take_snapshot(), restore_snapshot(), and reset_state() methods for the given object. Can return None if no save/restore methods are available, for instance for primitive types.

common_startup(sess)

Experimental API . Initialize session with common data containers

save(session, path, version=3, uncompressed=False, include_maps=False)

Experimental API . command line version of saving a session

sdump(session, session_file, output=None)

Experimental API . dump contents of session for debugging

standard_metadata(previous_metadata={})

Experimental API . Fill in standard metadata for created files

Parameters:
previous_metadata : dict

Optional dictionary of previous metadata.

The standard metadata consists of:
generator :

HTML user agent (app name version (os))

created :

date first created

modified :

date last modified after being created

creator :

user name(s)

dateCopyrighted :

copyright(s)

creator and dateCopyrighted can be lists if there
is previous metadata with different values.
dates are in ISO 8601 UTC time. Also see
<http://www.w3.org/TR/NOTE-datetime>.
Metadata names are inspired by the HTML5 metadata,
https://www.w3.org/TR/html5/document-metadata.html.