superscore.client.Client

class superscore.client.Client(backend=None, control_layer=None, enable_editing_past=False)[source]
Parameters:

Methods

apply(entry[, sequential])

Apply settings found in entry.

compare(entry_l, entry_r)

Compare two entries and return a diff (EntryDiff).

convert_to_template(collection)

Create a new Template from an existing Collection.

delete(entry)

Remove item from backend, depending on backend

fill(entry[, fill_depth])

Walk through entry and replace UUIDs with corresponding Entry's.

fill_template(template, substitutions)

Produce a filled Collection from a Template and substitutions.

find_config()

Search for a superscore configuation file.

find_origin_collection(entry)

Return the Collection instance associated with an entry.

from_config([cfg])

Create a client from the configuration file specification.

from_parsed_config(cfg_parser[, cfg_path])

Initializes Client using a ConfigParser that has already read in a config.

get_entry(uuid[, fill, force_reload])

Get entry corresponding to uuid, optionally filling children UUIDs.

is_editable(entry)

Can the provided entry be modified, given the current authenticated user and backend.

save(entry)

Save information in entry to database.

search(*post)

Search backend for entries matching all SearchTerms in post.

snap(entry[, dest])

Asyncronously read data for all PVs under entry, and store in a Snapshot.

validate(entry)

Validate entry is properly formed and able to be inserted into the backend.

get_user

is_user_authorized

register_callback

run_callbacks