ftrack_api.operation

class ftrack_api.operation.Operations

Stack of operations.

__init__()

Initialise stack.

clear()

Clear all operations.

push(operation)

Push operation onto stack.

pop()

Pop and return most recent operation from stack.

class ftrack_api.operation.Operation

Represent an operation.

__init__()

class ftrack_api.operation.CreateEntityOperation(entity_type, entity_key, entity_data)

Represent create entity operation.

__init__(entity_type, entity_key, entity_data)

Initialise operation.

entity_type should be the type of entity in string form (as returned from ftrack_api.entity.base.Entity.entity_type).

entity_key should be the unique key for the entity and should follow the form returned from ftrack_api.inspection.primary_key().

entity_data should be a mapping of the initial data to populate the entity with when creating.

Note

Shallow copies will be made of each value in entity_data.

class ftrack_api.operation.UpdateEntityOperation(entity_type, entity_key, attribute_name, old_value, new_value)

Represent update entity operation.

__init__(entity_type, entity_key, attribute_name, old_value, new_value)

Initialise operation.

entity_type should be the type of entity in string form (as returned from ftrack_api.entity.base.Entity.entity_type).

entity_key should be the unique key for the entity and should follow the form returned from ftrack_api.inspection.primary_key().

attribute_name should be the string name of the attribute being modified and old_value and new_value should reflect the change in value.

Note

Shallow copies will be made of both old_value and new_value.

class ftrack_api.operation.DeleteEntityOperation(entity_type, entity_key)

Represent delete entity operation.

__init__(entity_type, entity_key)

Initialise operation.

entity_type should be the type of entity in string form (as returned from ftrack_api.entity.base.Entity.entity_type).

entity_key should be the unique key for the entity and should follow the form returned from ftrack_api.inspection.primary_key().