API reference ¶

adoptComponents(*args, **kw)[source]¶

Adopt and return components.

For each component in components, set location to this location, as well as retrieving and setting appropriate resource identifier.

Raise ftrack.ComponentNotInLocationError if any of the components are not found in this location.

See also

delete()¶

get(key)¶

getAccessor()[source]¶: Return current accessor for this location.

getComponent(componentId)[source]¶

Retrieve component with componentId from this location.

Raise ftrack.ComponentNotInLocationError if component not found in this location.

Note

If an accessor is available for this location then the access path will also be set on the returned component.

See also

getComponentAvailabilities(componentIds)[source]¶: Return list of availabilities for components in this location.

getComponentAvailability(componentId)[source]¶: Return availability as percentage of component in this location.

getComponents(*args, **kw)[source]¶

Retrieve components with componentIds from this location.

Raise ftrack.ComponentNotInLocationError if any of the specified components are not found in this location.

If componentIds is not specified (or None) then retrieve ALL components currently in this location.

Note

If an accessor is available for this location then the access path will also be set on the returned component.

See also

getEntityRef()¶

getId()[source]¶: Return id.

getName()[source]¶: Return name.

getPriority()[source]¶: Return priority.

getResourceIdentifierTransformer()[source]¶: Return current resource identifier transformer for this location.

getStructure()[source]¶: Return current structure for this location.

keys()¶: Return keys accessible using get/set methods.

removeComponent(componentId, recursive=True, manageData=True)[source]¶

Remove component with componentId from this location.

If component is a container and recursive is True then also remove each member of the container from this location.

If manageData is True then manage removal of data from this location ( an accessor must be set for this location). If False assume data has been managed externally.

set(key, value=None)¶

setAccessor(accessor)[source]¶: Set current accessor for this location.

setPriority(priority)[source]¶: Set priority.

setResourceIdentifierTransformer(resourceIdentifierTransformer)[source]¶: Set current resourceIdentifierTransformer for this location.

setStructure(structure)[source]¶: Set current structure for this location.

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

exception ftrack.LocationError(message=None, details=None, **kw)[source]¶

Base for errors associated with locations.

__init__(message=None, details=None, **kw)¶

Initialise exception with message.

If message is None, the class ‘defaultMessage’ will be used.

args¶

defaultMessage = 'Unspecified location error'¶

message¶

class ftrack.Manager(id=None, dict=None, eagerload=None)[source]¶

Represent managers for projects and entities.

A manager is a User associated with a ManagerType. The manager is connected to an entity such as a project or sequence.

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getEntityRef()¶

getId()¶

getType()[source]¶: Return the type for this manager.

getUser()[source]¶: Return the user for this manager.

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.ManagerType(id=None, dict=None, eagerload=None)[source]¶

Represent the type of a Manager.

Manager types can be created in Settings ‣ Manager types. A manager type has a name that can be used to fetch that type by passing it to the constructor. Examples of manager types are “supervisor” or “producer”.

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getEntityRef()¶

getId()¶

getName()[source]¶: Return name of the manager type.

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.MemoryLocation(*args, **kw)[source]¶

Represent storage for components.

Unlike a standard location, only store metadata for components in this location in memory rather than persisting to the database.

__init__(*args, **kw)[source]¶: Initialise location.

addComponent(*args, **kw)¶

Add component to this location transferring relevant data.

If component is a container and recursive is True then also add each member of the container to this location.

If manageData is True then manage transfer of data to the location ( an accessor must be set for this location and the location of the component). If False assume data has been managed externally.

Note

Externally managed data must still match the path generated by this location’s structure interface. No existence check is currently performed.

Raise ftrack.ComponentInLocationError if the component already exists in this location.

Raise ftrack.LocationError if the generated target structure for the component already exists according to the accessor. This helps prevent potential data loss by avoiding overwriting existing data. Note that there is a race condition between the check and the write so if another process creates data at the same target during that period it will be overwritten.

Return component in this location.

adoptComponent(component)¶

Adopt and return component.

Set location on component to this location, as well as retrieving and setting appropriate resource identifier.

Raise ftrack.ComponentNotInLocationError if component not found in this location.

Note that this compliments getComponent() rather than addComponent().

See also

adoptComponents(*args, **kw)¶

Adopt and return components.

For each component in components, set location to this location, as well as retrieving and setting appropriate resource identifier.

Raise ftrack.ComponentNotInLocationError if any of the components are not found in this location.

See also

delete()¶

get(key)¶

getAccessor()¶: Return current accessor for this location.

getComponent(componentId)¶

Retrieve component with componentId from this location.

Raise ftrack.ComponentNotInLocationError if component not found in this location.

Note

If an accessor is available for this location then the access path will also be set on the returned component.

See also

getComponentAvailabilities(componentIds)[source]¶: Return list of availabilities for components in this location.

getComponentAvailability(componentId)[source]¶: Return availability as percentage of component in this location.

getComponents(*args, **kw)¶

Retrieve components with componentIds from this location.

Raise ftrack.ComponentNotInLocationError if any of the specified components are not found in this location.

If componentIds is not specified (or None) then retrieve ALL components currently in this location.

Note

If an accessor is available for this location then the access path will also be set on the returned component.

See also

getEntityRef()¶

getId()¶: Return id.

getName()¶: Return name.

getPriority()¶: Return priority.

getResourceIdentifierTransformer()¶: Return current resource identifier transformer for this location.

getStructure()¶: Return current structure for this location.

keys()¶: Return keys accessible using get/set methods.

removeComponent(componentId, recursive=True, manageData=True)¶

Remove component with componentId from this location.

If component is a container and recursive is True then also remove each member of the container from this location.

If manageData is True then manage removal of data from this location ( an accessor must be set for this location). If False assume data has been managed externally.

set(key, value=None)¶

setAccessor(accessor)¶: Set current accessor for this location.

setPriority(priority)¶: Set priority.

setResourceIdentifierTransformer(resourceIdentifierTransformer)¶: Set current resourceIdentifierTransformer for this location.

setStructure(structure)¶: Set current structure for this location.

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.Metable[source]¶

Abstract class inherited by objects to enable meta functionality.

__init__¶: x.__init__(...) initializes x; see help(type(x)) for signature

getMeta(key=None)[source]¶

Get metadata from an object. This method can be used to retrive meta data from an object. The data is stored in key/value pairs where key and value are strings.

This method can also be used without any arguments to retrive a dict with all metadata key/value pairs attached to this object.

Parameters:	key – A `string` representing the key or `None` to retrive all key/value pairs on this object.
Return type:	`string` or `dict`

metaKeys()[source]¶: Return keys accessible using getMeta/setMeta methods.

setMeta(key, value=None)[source]¶

Set metadata on an object. This method can be used to store arbitrary data on an object. The data is stored in key/value pairs where key and value are strings.

This method also accepts a dict with key/value pairs

Parameters:	key – A `string` representing the key or a `dict` with key/value pairs. value – A `string` representing the value or None if key is a `dict`.

exception ftrack.NotFoundError(message=None, details=None, **kw)[source]¶

Raise when something that should exist is not found.

__init__(message=None, details=None, **kw)¶

Initialise exception with message.

If message is None, the class ‘defaultMessage’ will be used.

args¶

defaultMessage = 'Not found.'¶

message¶

exception ftrack.NotUniqueError(message=None, details=None, **kw)[source]¶

Raise when something that should be unique is not.

__init__(message=None, details=None, **kw)¶

Initialise exception with message.

If message is None, the class ‘defaultMessage’ will be used.

args¶

defaultMessage = 'Not unique.'¶

message¶

class ftrack.Note(id=None, dict=None, eagerload=None)[source]¶

__init__(id=None, dict=None, eagerload=None)¶

createAttachment(file, fileName=None)[source]¶: Create an attachment from file.

createNote(note, category='auto', recipients=None)¶

Create note with text note.

Optional category can be specified to set the note category of the note. Can be either NoteCategory or category id. If set to auto the default note category setting will be used.

Recipients can be specified by setting recipients to be a list of User or user ids.

createReply(*args, **argv)[source]¶

Used to add a note on a note

Parameters:	note – the note text as a string category – `NoteCategory` (optional)

delete()¶

get(key)¶

getAttachments()[source]¶: Return attachments.

getCategory()[source]¶

getDate()[source]¶

getDefaultRecipients()¶

Get default recipients for an object

Return type:	`list` with User objects

getEntityRef()¶

getId()[source]¶

getMeta(key=None)¶

Get metadata from an object. This method can be used to retrive meta data from an object. The data is stored in key/value pairs where key and value are strings.

This method can also be used without any arguments to retrive a dict with all metadata key/value pairs attached to this object.

Parameters:	key – A `string` representing the key or `None` to retrive all key/value pairs on this object.
Return type:	`string` or `dict`

getNotes()¶: Fetch notes from an entity, this will include replies.

getRecipients()[source]¶: Get recipients for this note. Recipients are users that were notified when it was created.

getText()[source]¶

getUser()[source]¶

isReply()[source]¶

keys()¶: Return keys accessible using get/set methods.

metaKeys()¶: Return keys accessible using getMeta/setMeta methods.

set(key, value=None)¶

setMeta(key, value=None)¶

Set metadata on an object. This method can be used to store arbitrary data on an object. The data is stored in key/value pairs where key and value are strings.

This method also accepts a dict with key/value pairs

Parameters:	key – A `string` representing the key or a `dict` with key/value pairs. value – A `string` representing the value or None if key is a `dict`.

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.NoteCategory(id=None, dict=None, eagerload=None)[source]¶

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getColor()[source]¶

getEntityRef()¶

getId()[source]¶

getName()[source]¶

getSort()[source]¶

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.Noteable[source]¶

__init__¶: x.__init__(...) initializes x; see help(type(x)) for signature

createNote(note, category='auto', recipients=None)[source]¶

Create note with text note.

Optional category can be specified to set the note category of the note. Can be either NoteCategory or category id. If set to auto the default note category setting will be used.

Recipients can be specified by setting recipients to be a list of User or user ids.

getDefaultRecipients()[source]¶

Get default recipients for an object

Return type:	`list` with User objects

getNotes()[source]¶: Fetch notes from an entity, this will include replies.

class ftrack.OriginStructure(prefix='')[source]¶

Origin structure supporting Components only.

Will maintain original internal component path.

__init__(prefix='')¶: Initialise structure.

getResourceIdentifier(entity)[source]¶: Return a resourceIdentifier for supplied entity.

class ftrack.Parentable[source]¶

__init__¶: x.__init__(...) initializes x; see help(type(x)) for signature

getParent()[source]¶

Get parent object from this object

Return type:	`FTObject` of that type

getParents()[source]¶

Get parent object from this object

Return type:	`list` owith items of that type

exception ftrack.PermissionDeniedError(message=None, details=None, **kw)[source]¶

Raise when permission is denied.

__init__(message=None, details=None, **kw)¶

Initialise exception with message.

If message is None, the class ‘defaultMessage’ will be used.

args¶

defaultMessage = 'Permission denied.'¶

message¶

class ftrack.Phase(id=None, dict=None, eagerload=None)[source]¶

__init__(id=None, dict=None, eagerload=None)¶

addTaskType(taskType)[source]¶: Add taskType to the phase.

assignUser(user)[source]¶

Assign a user to this phase

Parameters:	user – A `User` to assign to this phase

delete()¶

get(key)¶

getEntityRef()¶

getId()¶

getMeta(key=None)¶

Get metadata from an object. This method can be used to retrive meta data from an object. The data is stored in key/value pairs where key and value are strings.

This method can also be used without any arguments to retrive a dict with all metadata key/value pairs attached to this object.

Parameters:	key – A `string` representing the key or `None` to retrive all key/value pairs on this object.
Return type:	`string` or `dict`

getParent()¶

Get parent object from this object

Return type:	`FTObject` of that type

getParents()¶

Get parent object from this object

Return type:	`list` owith items of that type

getTaskTypes()[source]¶: Return task types for phase.

getUsers()[source]¶: Return all users assigned to this phase

keys()¶: Return keys accessible using get/set methods.

metaKeys()¶: Return keys accessible using getMeta/setMeta methods.

removeTaskType(taskType)[source]¶: Remove taskType from the phase.

set(key, value=None)¶

setMeta(key, value=None)¶

Set metadata on an object. This method can be used to store arbitrary data on an object. The data is stored in key/value pairs where key and value are strings.

This method also accepts a dict with key/value pairs

Parameters:	key – A `string` representing the key or a `dict` with key/value pairs. value – A `string` representing the value or None if key is a `dict`.

unAssignUser(user)[source]¶

Un-assign a user to this phase

Parameters:	user – Un-assign a `User` from this phase

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.Priority(id=None, dict=None, eagerload=None)[source]¶

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getColor()[source]¶

getEntityRef()¶

getId()[source]¶

getName()[source]¶

getSort()[source]¶

getValue()[source]¶

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.Project(id=None, dict=None, eagerload=None)[source]¶

Used to get data from a project or its children @param id show id

__init__(id=None, dict=None, eagerload=None)¶

create(objectType, name, statusId=None, typeId=None, priorityId=None)¶: Create a context from objectType with name.

createAsset(name, assetType, task=None)¶

Create a new asset or return existing.

name is the name of the asset and assetType is the type of the asset defined by its short name. A task or task id can also be passed in which will be used as the default task when versions are created on this asset.

createAssetBuild(name, typeid=None)[source]¶: Create an asset build from name and typeid.

createAttachment(file, fileName=None, isThumb=False)¶: Legacy method to attach files to objects.

createEpisode(name)¶: Create an episode from name.

createList(name, category, objectType=None)[source]¶

Creates a list for this project

Parameters:	name – A `str` with the name of the list category – A `ListCategory` object that defines the category for this list objectType – A `ListCategory` object that defines what this list should contain. This should be `AssetVersion` or None
Return type:	`List`

createManager(user, managerType)¶

Create a manager from user and managerType for this entity.

user should be a User instance.

managerType should be a ManagerType instance.

createNote(note, category='auto', recipients=None)¶

Create note with text note.

Optional category can be specified to set the note category of the note. Can be either NoteCategory or category id. If set to auto the default note category setting will be used.

Recipients can be specified by setting recipients to be a list of User or user ids.

createPhase(description, startdate, enddate, color=None)[source]¶

Create a phase for this project

Parameters:	description – A `str` with the description of this phase startdate – A `datetime` with the start date of this phase enddate – A `datetime` with the end date of this phase color – A `str` with the color of this phase

createReviewSession(name, description)[source]¶: Create a new review session with name and description.

createSequence(name)¶: Create a sequence from name.

createShot(name)¶: Create a shot from name.

createTask(name, taskType=None, taskStatus=None)¶: Create a task from name, taskType and taskStatus.

createThumbnail(file, fileName='image.jpg')¶: Create thumbnail from file.

delete()¶

get(key)¶

getAllocatedGroups()[source]¶: Return groups allocated on the project.

getAllocatedUsers()[source]¶: Return users allocated on the project.

getAssetBuildTypes()[source]¶: Return the asset build types valid for this project.

getAssetBuilds()[source]¶

getAssets(assetTypes=None, includeChildren=False, componentNames=None, excludeWithTasks=False)[source]¶

Get attached Assets

Parameters:	names – A `list` with names of the assets assetTypes – A `list` with names of the asset types or short names of the asset types or asset type ids componentNames – A `list` with names of components that the versions must have at least one of excludeWithTasks – A `bool` which defaults to False, can be used to get assets with versions that are not connected to any tasks
Return type:	FTList of Asset

getBookings()[source]¶: Return all bookings for this project

getChildren(objectType=None, depth=1)¶

Get attached Children (not tasks)

Return type:	FTList of Children

getDefaultRecipients()¶

Get default recipients for an object

Return type:	`list` with User objects

getEntityRef()¶

getEpisodes()¶

getFPS()[source]¶

getFullName()[source]¶

getId()[source]¶

getList(name)[source]¶

Returns a list by name

Parameters:	name – Name of the list on this project.
Return type:	`List`

getLists(name=None, categories=None)[source]¶

Returns all lists for this project

Parameters:	name – Used to match the names. categories – list of ListCategory to use as filter.
Return type:	`list`

getManagers()¶: Return all managers assigned to this entity.

getMeta(key=None)¶

Get metadata from an object. This method can be used to retrive meta data from an object. The data is stored in key/value pairs where key and value are strings.

This method can also be used without any arguments to retrive a dict with all metadata key/value pairs attached to this object.

Parameters:	key – A `string` representing the key or `None` to retrive all key/value pairs on this object.
Return type:	`string` or `dict`

getName()[source]¶

getNotes()¶: Fetch notes from an entity, this will include replies.

getPath(full=False)[source]¶

Get OS specific path to project folder

Parameters:	full – `bool` Include asset prefix setting at end of path
Return type:	A string with the file path to the project

getPhases()[source]¶: Return all phases for this project

getReviewSessions()[source]¶: Return all review sessions on project.

getRoot()[source]¶

getSequences()¶

Get attached Sequences

Return type:	FTList of Sequence

getShots()¶

getStatuses(name)[source]¶: Return valid statuses for object of type name.

getTaskStatuses(typeid=None)[source]¶

Get TaskStatus that are defined by this projects workflow schema.

Parameters:	typeid – Defaults to `None`. The id or `TaskType` object. This should always be used since it makes sure the correct statuses are returned if there is an override in place for this type.
Return type:	FTList of TaskStatus

getTaskTypes()[source]¶

Get TaskStatus

Return type:	FTList of TaskTypes

getTasks(*args, **argv)¶

Get attached Tasks

Parameters:

users – list with usernames like [‘username1’,’username2’] to filter out tasks
taskTypes – list representing task types. Can be TaskType objects, their IDs or their names.
taskStatuses – list representing task statuses. Can be TaskStatus objects, their IDs or their names.
states – list with states. Possible states are NOT_STARTED, IN_PROGRESS, DONE, BLOCKED which are availible from the ftrack module
activeProjectsOnly – bool Default to True. specifying if only to query active projects.
includeChildren – bool Default to False. childrens tasks should be included.
includePath – bool Default to False. specifying if the path should be added to each task. Much faster than useing getParents on each task afterwards.

Return type:

FTList with Task

getThumbnail()¶: Get a url to the thumbnail.

getTimelogs(start=None, end=None, includeChildren=False)¶

Return timelogs between start and end dates.

If includeChildren is set, also return timelogs on descendants.

getURL()¶: Return url that can be used to view this entity in a browser.

getUsers()[source]¶

getVersionStatuses()[source]¶

Get version statuses from project workflow scheme used by this project

Return type:	FTList of `VersionStatus`

getWebWidgetUrl(name, theme='dark')¶

Return url that can be used is a qt webwidget.

name should be the name of the ftrack panel. theme is optional.

keys()¶: Return keys accessible using get/set methods.

metaKeys()¶: Return keys accessible using getMeta/setMeta methods.

set(key, value=None)¶

setMeta(key, value=None)¶

Set metadata on an object. This method can be used to store arbitrary data on an object. The data is stored in key/value pairs where key and value are strings.

This method also accepts a dict with key/value pairs

Parameters:	key – A `string` representing the key or a `dict` with key/value pairs. value – A `string` representing the value or None if key is a `dict`.

setThumbnail(component)¶: Set component as thumbnail.

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.ProjectScheme(id=None, dict=None, eagerload=None)[source]¶

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getEntityRef()¶

getId()[source]¶

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.Registry(paths=None)[source]¶

Registry for plugins.

__init__(paths=None)[source]¶: Initialise plugin registry.

add(plugin)[source]¶: Add plugin.

clear()¶: This is slow (creates N new iterators!) but effective.

discard(plugin)[source]¶: Remove plugin.

discover(**kw)[source]¶

Find and load plugins in search paths.

Each discovered module should implement a register function that accepts this registry and additional kw. The function should add appropriate instances to the registry:

def register(registry, **kw):
    plugin = MyPlugin(name='plugin.name')
    registry.add(plugin)

Note

Each instance must have a ‘getName’ method that will identify the plugin.

get(name)[source]¶

Retrieve a discovered plugin by name.

Return None if no matching plugin found.

isdisjoint(other)¶: Return True if two sets have a null intersection.

pop()¶: Return the popped value. Raise KeyError if empty.

remove(value)¶: Remove an element. If not a member, raise a KeyError.

class ftrack.ResourceIdentifierTransformer[source]¶

Transform resource identifiers.

Provide ability to modify resource identifier before it is stored centrally (encode()), or after it has been retrieved, but before it is used locally (decode()).

For example, you might want to decompose paths into a set of key, value pairs to store centrally and then compose a path from those values when reading back.

Note

This is separate from any transformations an ftrack.Accessor may perform and is targeted towards common transformations.

__init__¶: x.__init__(...) initializes x; see help(type(x)) for signature

decode(resourceIdentifier, context=None)[source]¶

Return decoded resourceIdentifier for use locally.

A mapping of context values may be supplied to guide the transformation.

encode(resourceIdentifier, context=None)[source]¶

Return encoded resourceIdentifier for storing centrally.

A mapping of context values may be supplied to guide the transformation.

class ftrack.Review[source]¶

A utility class that contains functions used by ftrackreview.

Example of adding reviewable components to a version:

import ftrack

# Get a shot and a task on the shot
shot = ftrack.getShot(['project', 'seq', 'shot'])
task = shot.getTasks().pop()

# Create an asset to publish a new reviewable version
asset = shot.createAsset(
    name='compositing', assetType='comp', task=task
)

# Create a new version
version = asset.createVersion(comment='Made som changes to the helmet')

# Set the path to the file that should be attached to the version
filePath = '/Users/carlclaesson/Documents/data/helmet.mov'

# Make the version reviewable by using the util function
# ftrack.Review.makeReviewable(). This will create an original
# component and move it to the ``ftrack.server`` location and trigger
# encoding.
ftrack.Review.makeReviewable(version, filePath)

version.publish()

__init__¶: x.__init__(...) initializes x; see help(type(x)) for signature

static encodeComponent(component)[source]¶

Create reviewable components from a given component. The component file needs to be a valid s3 key.

Parameters:	component – `Component` to convert

static makeReviewable(version=None, filePath=None)[source]¶: Add web reviewable compoment to version based on filePath.

class ftrack.ReviewSession(id=None, dict=None, eagerload=None)[source]¶

Represent review session.

__init__(id=None, dict=None, eagerload=None)¶

createInvitee(email, name)[source]¶: Create a new invitee with email and name on review session.

createObject(assetVersion, name='', description='', version='', syncAssetVersionData=False)[source]¶

Create a new review session object on review session.

assetVersion should be an instance of ftrack.AssetVersion.

Optionally specify a name, description, version number which will be visible when viewing the review session in the web interface.

If syncAssetVersionData is set to True the name, description and version will be set based on the assetVersion.

delete()¶

get(key)¶

getEntityRef()¶

getId()¶

getInvitees()[source]¶: Return all invitees on review session.

getObjects()[source]¶: Return a ftrack.FTList of ftrack.ReviewSessionObject.

keys()¶: Return keys accessible using get/set methods.

reviewSessionObjects()[source]¶: Return a ftrack.FTList of ftrack.ReviewSessionObject.

Warning

Deprecated method, use ftrack.ReviewSession.getObjects().

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.ReviewSessionInvitee(id=None, dict=None, eagerload=None)[source]¶

Represent review session invitee.

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getEntityRef()¶

getId()¶

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.ReviewSessionObject(id=None, dict=None, eagerload=None)[source]¶

Represent review session object.

__init__(id=None, dict=None, eagerload=None)¶

createNote(note, category='auto', recipients=None)¶

Create note with text note.

Optional category can be specified to set the note category of the note. Can be either NoteCategory or category id. If set to auto the default note category setting will be used.

Recipients can be specified by setting recipients to be a list of User or user ids.

delete()¶

get(key)¶

getDefaultRecipients()¶

Get default recipients for an object

Return type:	`list` with User objects

getEntityRef()¶

getId()¶

getNotes()¶: Fetch notes from an entity, this will include replies.

getStatuses()[source]¶

Return list of ftrack.ReviewSessionObjectStatus.

If the list is empty no invitees has voted.

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

setStatus(status, invitee)[source]¶

Set status on object for invitee.

invitee should be of type ftrack.ReviewSessionInvitee.

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.ReviewSessionObjectStatus(id=None, dict=None, eagerload=None)[source]¶

Represent review session invitee.

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getEntityRef()¶

getId()¶

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.Role(id=None, dict=None, eagerload=None)[source]¶

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getEntityRef()¶

getId()[source]¶

getName()[source]¶

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.S3Accessor(bucketName, accessKey, secretKey, **kw)[source]¶

Provide Amazon S3 location access.

To use, please first install the Boto package.

Important

There is a known issue on some operating systems when using Boto >= 2.29 against Python >= 2.7. The issue typically manifests itself with the following error:

TypeError: cannot deepcopy this pattern object

To work around the issue please install an earlier version of the Boto package, such as 2.28.

__init__(bucketName, accessKey, secretKey, **kw)[source]¶

Initialise location accessor.

bucketName is the name of the bucket to provide access to using accessKey and secretKey credentials.

bucket¶: Return bucket.

connection¶: Return S3 connection.

exists(resourceIdentifier)[source]¶: Return if resourceIdentifier is valid and exists in location.

getContainer(resourceIdentifier)[source]¶

Return resourceIdentifier of container for resourceIdentifier.

Raise AccessorParentResourceNotFoundError if container of resourceIdentifier could not be determined.

getFilesystemPath(resourceIdentifier)¶

Return filesystem path for resourceIdentifier.

Raise AccessorFilesystemPathError if filesystem path could not be determined from resourceIdentifier or AccessorUnsupportedOperationError if retrieving filesystem paths is not supported by this accessor.

getUrl(resourceIdentifier)¶

Return URL for resourceIdentifier.

Raise ftrack.AccessorUrlError if URL could not be determined from resourceIdentifier* or ftrack.AccessorUnsupportedOperationError if retrieving URL’s is not supported by this accessor.

isContainer(resourceIdentifier)[source]¶: Return whether resourceIdentifier refers to a container.

isFile(resourceIdentifier)[source]¶: Return whether resourceIdentifier refers to a file.

isSequence(resourceIdentifier)[source]¶: Return whether resourceIdentifier refers to a file sequence.

list(resourceIdentifier)[source]¶

Return list of entries in resourceIdentifier container.

Each entry in the returned list should be a valid resource identifier.

Raise AccessorResourceNotFoundError if resourceIdentifier does not exist or AccessorResourceInvalidError if resourceIdentifier is not a container.

makeContainer(resourceIdentifier, recursive=True)[source]¶

Make a container at resourceIdentifier.

If recursive is True, also make any intermediate containers.

open(resourceIdentifier, mode='rb')[source]¶: Return Data for resourceIdentifier.

remove(resourceIdentifier)[source]¶

Remove resourceIdentifier.

Raise AccessorResourceNotFoundError if resourceIdentifier does not exist.

removeContainer(resourceIdentifier)¶: Remove container at resourceIdentifier.

class ftrack.Sequence(id=None, dict=None, eagerload=None)[source]¶

DEPRECATED CLASS

__init__(id=None, dict=None, eagerload=None)¶

addPredecessor(task)¶

Add a dependency from another task to this task

Parameters:	task – The predecessor task

addSuccessor(task)¶

Add a dependency from this task to another task

Parameters:	task – The successor task

assignUser(user)¶

Assigns a user to a task

Parameters:	user – A `User` object representing the user that should be assigned to the task.

create(objectType, name, statusId=None, typeId=None, priorityId=None)¶: Create a context from objectType with name.

createAsset(name, assetType, task=None)¶

Create a new asset or return existing.

name is the name of the asset and assetType is the type of the asset defined by its short name. A task or task id can also be passed in which will be used as the default task when versions are created on this asset.

createAttachment(file, fileName=None, isThumb=False)¶: Legacy method to attach files to objects.

createEpisode(name)¶: Create an episode from name.

createManager(user, managerType)¶

Create a manager from user and managerType for this entity.

user should be a User instance.

managerType should be a ManagerType instance.

createNote(note, category='auto', recipients=None)¶

Create note with text note.

Optional category can be specified to set the note category of the note. Can be either NoteCategory or category id. If set to auto the default note category setting will be used.

Recipients can be specified by setting recipients to be a list of User or user ids.

createSequence(name)¶: Create a sequence from name.

createShot(name)¶: Create a shot from name.

createTask(name, taskType=None, taskStatus=None)¶: Create a task from name, taskType and taskStatus.

createThumbnail(file, fileName='image.jpg')¶: Create thumbnail from file.

delete()¶

get(key)¶

getAsset(name, assetType)¶

Get an Asset

Parameters:	name – `str` with the name of the asset assetType – a string with the asset type like ‘geo’
Return type:	`Asset`

getAssetVersions()¶

Get AssetVersions

Return type:	`list` of AssetVersions

getAssets(assetTypes=None, names=None, includeChildren=False, componentNames=None, excludeWithTasks=False)¶

Get Assets

Parameters:	names – A `list` with names of the assets assetTypes – A `list` with names of the asset types or short names of the asset types or asset type ids componentNames – A `list` with names of components that the versions must have at least one of excludeWithTasks – A `bool` which defaults to False, can be used to get assets with versions that are not connected to any tasks
Return type:	FTList of Assets

getBid()¶

getChildren(objectType=None, depth=1)¶

Get attached Children (not tasks)

Return type:	FTList of Children

getDefaultRecipients()¶

Get default recipients for an object

Return type:	`list` with User objects

getDescription()¶

getEndDate()¶

getEntityRef()¶

getEpisodes()¶

getFPS()¶

getFrameEnd()¶

getFrameStart()¶

getId()¶

getLists()¶

Returns the lists that have been linked/associated with this task. NOTE: There is a difference between a task being added to a list and lists linked to a task

Return type:	`list`

getManagers()¶: Return all managers assigned to this entity.

getMeta(key=None)¶

Get metadata from an object. This method can be used to retrive meta data from an object. The data is stored in key/value pairs where key and value are strings.

This method can also be used without any arguments to retrive a dict with all metadata key/value pairs attached to this object.

Parameters:	key – A `string` representing the key or `None` to retrive all key/value pairs on this object.
Return type:	`string` or `dict`

getName()¶

getNotes()¶: Fetch notes from an entity, this will include replies.

getObjectType()¶

getParent()¶

Get parent object from this object

Return type:	`FTObject` of that type

getParents()¶

Get parent object from this object

Return type:	`list` owith items of that type

getPredecessors()¶

Returns a list of items that this item depends on

Return type:	`list`

getPriority()¶: Return the priority of the object or None if it has no priority.

getProject()¶

Get project this object belongs to

Return type:	Project

getSequence()¶: @deprecated Use getParent instead

getSequences()¶

Get attached Sequences

Return type:	FTList of Sequence

getShots()¶

Get attached Shots

Return type:	FTList of Shot

getShow()¶: @deprecated Use getParent instead

getStartDate()¶

getStatus()¶: Return the status of the object or None if it has no status.

getSuccessors()¶

Returns a list of items that depend on this object

Return type:	`list`

getTasks(*args, **argv)¶

Get attached Tasks

Parameters:

users – list with usernames like [‘username1’,’username2’] to filter out tasks
taskTypes – list representing task types. Can be TaskType objects, their IDs or their names.
taskStatuses – list representing task statuses. Can be TaskStatus objects, their IDs or their names.
states – list with states. Possible states are NOT_STARTED, IN_PROGRESS, DONE, BLOCKED which are availible from the ftrack module
activeProjectsOnly – bool Default to True. specifying if only to query active projects.
includeChildren – bool Default to False. childrens tasks should be included.
includePath – bool Default to False. specifying if the path should be added to each task. Much faster than useing getParents on each task afterwards.

Return type:

FTList with Task

getThumbnail()¶: Get a url to the thumbnail.

getTimelogs(start=None, end=None, includeChildren=False)¶

Return timelogs between start and end dates.

If includeChildren is set, also return timelogs on descendants.

getType()¶: Return the type of the object or None if it has no type.

getURL()¶: Return url that can be used to view this entity in a browser.

getUsers()¶

Get Users assigned to this Task

Return type:	FTList of User

getWebWidgetUrl(name, theme='dark')¶

Return url that can be used is a qt webwidget.

name should be the name of the ftrack panel. theme is optional.

keys()¶: Return keys accessible using get/set methods.

metaKeys()¶: Return keys accessible using getMeta/setMeta methods.

removePredecessor(task)¶

remove a dependency another task to this task

Parameters:	task – The predecessor task

removeSuccessor(task)¶

remove a dependency from this task to another task

Parameters:	task – The successor task

set(key, value=None)¶

setEndDate(theDate)¶

setMeta(key, value=None)¶

Set metadata on an object. This method can be used to store arbitrary data on an object. The data is stored in key/value pairs where key and value are strings.

This method also accepts a dict with key/value pairs

Parameters:	key – A `string` representing the key or a `dict` with key/value pairs. value – A `string` representing the value or None if key is a `dict`.

setPriority(priority)¶

setStartDate(theDate)¶

setStatus(status)¶

Set status of the object

Parameters:	status – `Status` the status object that should be set

setThumbnail(component)¶: Set component as thumbnail.

unAssignUser(user)¶

Unassigns a user from a task

Parameters:	user – A `User` object representing the user that should be unassigned from the task.

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.SequenceLegacy[source]¶

__init__¶: x.__init__(...) initializes x; see help(type(x)) for signature

getShots()[source]¶

Get attached Shots

Return type:	FTList of Shot

getShow()[source]¶: @deprecated Use getParent instead

class ftrack.ServerAccessor(**kw)[source]¶

Provide server location access.

__init__(**kw)[source]¶: Initialise location accessor.

exists(resourceIdentifier)[source]¶: Return if resourceIdentifier is valid and exists in location.

getContainer(resourceIdentifier)[source]¶: Return resourceIdentifier of container for resourceIdentifier.

getFilesystemPath(resourceIdentifier)¶

Return filesystem path for resourceIdentifier.

Raise AccessorFilesystemPathError if filesystem path could not be determined from resourceIdentifier or AccessorUnsupportedOperationError if retrieving filesystem paths is not supported by this accessor.

getUrl(resourceIdentifier)[source]¶: Return url for resourceIdentifier.

isContainer(resourceIdentifier)[source]¶: Return whether resourceIdentifier refers to a container.

isFile(resourceIdentifier)[source]¶: Return whether resourceIdentifier refers to a file.

isSequence(resourceIdentifier)[source]¶: Return whether resourceIdentifier refers to a file sequence.

list(resourceIdentifier)[source]¶: Return list of entries in resourceIdentifier container.

makeContainer(resourceIdentifier, recursive=True)[source]¶: Make a container at resourceIdentifier.

open(resourceIdentifier, mode='rb')[source]¶: Return Data for resourceIdentifier.

remove(resourceIdentifier)[source]¶: Remove resourceIdentifier.

removeContainer(resourceIdentifier)¶: Remove container at resourceIdentifier.

class ftrack.Shot(id=None, dict=None, eagerload=None)[source]¶

DEPRECATED CLASS

__init__(id=None, dict=None, eagerload=None)¶

addPredecessor(task)¶

Add a dependency from another task to this task

Parameters:	task – The predecessor task

addSuccessor(task)¶

Add a dependency from this task to another task

Parameters:	task – The successor task

assignUser(user)¶

Assigns a user to a task

Parameters:	user – A `User` object representing the user that should be assigned to the task.

create(objectType, name, statusId=None, typeId=None, priorityId=None)¶: Create a context from objectType with name.

createAsset(name, assetType, task=None)¶

Create a new asset or return existing.

name is the name of the asset and assetType is the type of the asset defined by its short name. A task or task id can also be passed in which will be used as the default task when versions are created on this asset.

createAttachment(file, fileName=None, isThumb=False)¶: Legacy method to attach files to objects.

createEpisode(name)¶: Create an episode from name.

createManager(user, managerType)¶

Create a manager from user and managerType for this entity.

user should be a User instance.

managerType should be a ManagerType instance.

createNote(note, category='auto', recipients=None)¶

Create note with text note.

Optional category can be specified to set the note category of the note. Can be either NoteCategory or category id. If set to auto the default note category setting will be used.

Recipients can be specified by setting recipients to be a list of User or user ids.

createSequence(name)¶: Create a sequence from name.

createShot(name)¶: Create a shot from name.

createTask(name, taskType=None, taskStatus=None)¶: Create a task from name, taskType and taskStatus.

createThumbnail(file, fileName='image.jpg')¶: Create thumbnail from file.

delete()¶

get(key)¶

getAsset(name, assetType)¶

Get an Asset

Parameters:	name – `str` with the name of the asset assetType – a string with the asset type like ‘geo’
Return type:	`Asset`

getAssetVersions()¶

Get AssetVersions

Return type:	`list` of AssetVersions

getAssets(assetTypes=None, names=None, includeChildren=False, componentNames=None, excludeWithTasks=False)¶

Get Assets

Parameters:	names – A `list` with names of the assets assetTypes – A `list` with names of the asset types or short names of the asset types or asset type ids componentNames – A `list` with names of components that the versions must have at least one of excludeWithTasks – A `bool` which defaults to False, can be used to get assets with versions that are not connected to any tasks
Return type:	FTList of Assets

getBid()¶

getChildren(objectType=None, depth=1)¶

Get attached Children (not tasks)

Return type:	FTList of Children

getDefaultRecipients()¶

Get default recipients for an object

Return type:	`list` with User objects

getDescription()¶

getEndDate()¶

getEntityRef()¶

getEpisodes()¶

getFPS()¶

getFrameEnd()¶

getFrameStart()¶

getId()¶

getLists()¶

Returns the lists that have been linked/associated with this task. NOTE: There is a difference between a task being added to a list and lists linked to a task

Return type:	`list`

getManagers()¶: Return all managers assigned to this entity.

getMeta(key=None)¶

Get metadata from an object. This method can be used to retrive meta data from an object. The data is stored in key/value pairs where key and value are strings.

This method can also be used without any arguments to retrive a dict with all metadata key/value pairs attached to this object.

Parameters:	key – A `string` representing the key or `None` to retrive all key/value pairs on this object.
Return type:	`string` or `dict`

getName()¶

getNotes()¶: Fetch notes from an entity, this will include replies.

getObjectType()¶

getParent()¶

Get parent object from this object

Return type:	`FTObject` of that type

getParents()¶

Get parent object from this object

Return type:	`list` owith items of that type

getPredecessors()¶

Returns a list of items that this item depends on

Return type:	`list`

getPriority()¶: Return the priority of the object or None if it has no priority.

getProject()¶

Get project this object belongs to

Return type:	Project

getSequence()¶: @deprecated Use getParent instead

getSequences()¶

Get attached Sequences

Return type:	FTList of Sequence

getShots()¶

Get attached Shots

Return type:	FTList of Shot

getShow()¶: @deprecated Use getParent instead

getStartDate()¶

getStatus()¶: Return the status of the object or None if it has no status.

getSuccessors()¶

Returns a list of items that depend on this object

Return type:	`list`

getTasks(*args, **argv)¶

Get attached Tasks

Parameters:

users – list with usernames like [‘username1’,’username2’] to filter out tasks
taskTypes – list representing task types. Can be TaskType objects, their IDs or their names.
taskStatuses – list representing task statuses. Can be TaskStatus objects, their IDs or their names.
states – list with states. Possible states are NOT_STARTED, IN_PROGRESS, DONE, BLOCKED which are availible from the ftrack module
activeProjectsOnly – bool Default to True. specifying if only to query active projects.
includeChildren – bool Default to False. childrens tasks should be included.
includePath – bool Default to False. specifying if the path should be added to each task. Much faster than useing getParents on each task afterwards.

Return type:

FTList with Task

getThumbnail()¶: Get a url to the thumbnail.

getTimelogs(start=None, end=None, includeChildren=False)¶

Return timelogs between start and end dates.

If includeChildren is set, also return timelogs on descendants.

getType()¶: Return the type of the object or None if it has no type.

getURL()¶: Return url that can be used to view this entity in a browser.

getUsers()¶

Get Users assigned to this Task

Return type:	FTList of User

getWebWidgetUrl(name, theme='dark')¶

Return url that can be used is a qt webwidget.

name should be the name of the ftrack panel. theme is optional.

keys()¶: Return keys accessible using get/set methods.

metaKeys()¶: Return keys accessible using getMeta/setMeta methods.

removePredecessor(task)¶

remove a dependency another task to this task

Parameters:	task – The predecessor task

removeSuccessor(task)¶

remove a dependency from this task to another task

Parameters:	task – The successor task

set(key, value=None)¶

setEndDate(theDate)¶

setMeta(key, value=None)¶

Set metadata on an object. This method can be used to store arbitrary data on an object. The data is stored in key/value pairs where key and value are strings.

This method also accepts a dict with key/value pairs

Parameters:	key – A `string` representing the key or a `dict` with key/value pairs. value – A `string` representing the value or None if key is a `dict`.

setPriority(priority)¶

setStartDate(theDate)¶

setStatus(status)¶

Set status of the object

Parameters:	status – `Status` the status object that should be set

setThumbnail(component)¶: Set component as thumbnail.

unAssignUser(user)¶

Unassigns a user from a task

Parameters:	user – A `User` object representing the user that should be unassigned from the task.

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.ShotLegacy[source]¶

__init__¶: x.__init__(...) initializes x; see help(type(x)) for signature

getFPS()[source]¶

getFrameEnd()[source]¶

getFrameStart()[source]¶

getSequence()[source]¶: @deprecated Use getParent instead

class ftrack.ShotStatus(id=None, dict=None, eagerload=None)[source]¶

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getEntityRef()¶

getId()[source]¶

getName()[source]¶

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

ftrack.Show¶: alias of Project

class ftrack.Status(id=None, dict=None, eagerload=None)[source]¶

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getEntityRef()¶

getId()[source]¶

getName()[source]¶

getState()[source]¶

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.Statusable[source]¶

__init__¶: x.__init__(...) initializes x; see help(type(x)) for signature

getStatus()[source]¶: Return the status of the object or None if it has no status.

setStatus(status)[source]¶

Set status of the object

Parameters:	status – `Status` the status object that should be set

class ftrack.String(content=None)[source]¶

Data wrapper using StringIO instance.

__init__(content=None)[source]¶: Initialise data with content.

close()¶: Flush buffers and prevent further access.

flush()¶: Flush buffers ensuring data written.

read(limit=None)¶: Return content from current position up to limit.

seek(offset, whence=0)¶: Move internal pointer by offset.

tell()¶: Return current position of internal pointer.

write(content)¶: Write content at current position.

ftrack.StringIO()¶: StringIO([s]) – Return a StringIO-like stream for reading or writing

class ftrack.Structure(prefix='')[source]¶

Structure plugin interface.

A structure plugin should compute appropriate paths for data.

__init__(prefix='')[source]¶: Initialise structure.

getResourceIdentifier(entity)[source]¶: Return a resourceIdentifier for supplied entity.

class ftrack.Task(id=None, dict=None, eagerload=None)[source]¶

__init__(id=None, dict=None, eagerload=None)¶

addPredecessor(task)¶

Add a dependency from another task to this task

Parameters:	task – The predecessor task

addSuccessor(task)¶

Add a dependency from this task to another task

Parameters:	task – The successor task

assignUser(user)[source]¶

Assigns a user to a task

Parameters:	user – A `User` object representing the user that should be assigned to the task.

create(objectType, name, statusId=None, typeId=None, priorityId=None)¶: Create a context from objectType with name.

createAsset(name, assetType, task=None)¶

Create a new asset or return existing.

name is the name of the asset and assetType is the type of the asset defined by its short name. A task or task id can also be passed in which will be used as the default task when versions are created on this asset.

createAttachment(file, fileName=None, isThumb=False)¶: Legacy method to attach files to objects.

createEpisode(name)¶: Create an episode from name.

createManager(user, managerType)¶

Create a manager from user and managerType for this entity.

user should be a User instance.

managerType should be a ManagerType instance.

createNote(note, category='auto', recipients=None)¶

Create note with text note.

Optional category can be specified to set the note category of the note. Can be either NoteCategory or category id. If set to auto the default note category setting will be used.

Recipients can be specified by setting recipients to be a list of User or user ids.

createSequence(name)¶: Create a sequence from name.

createShot(name)¶: Create a shot from name.

createTask(name, taskType=None, taskStatus=None)¶: Create a task from name, taskType and taskStatus.

createThumbnail(file, fileName='image.jpg')¶: Create thumbnail from file.

delete()¶

get(key)¶

getAsset(name, assetType)[source]¶

Get an Asset

Parameters:	name – `str` with the name of the asset assetType – a string with the asset type like ‘geo’
Return type:	`Asset`

getAssetVersions()[source]¶

Get AssetVersions

Return type:	`list` of AssetVersions

getAssets(assetTypes=None, names=None, includeChildren=False, componentNames=None, excludeWithTasks=False)[source]¶

Get Assets

Parameters:	names – A `list` with names of the assets assetTypes – A `list` with names of the asset types or short names of the asset types or asset type ids componentNames – A `list` with names of components that the versions must have at least one of excludeWithTasks – A `bool` which defaults to False, can be used to get assets with versions that are not connected to any tasks
Return type:	FTList of Assets

getBid()[source]¶

getChildren(objectType=None, depth=1)¶

Get attached Children (not tasks)

Return type:	FTList of Children

getDefaultRecipients()¶

Get default recipients for an object

Return type:	`list` with User objects

getDescription()[source]¶

getEndDate()[source]¶

getEntityRef()¶

getEpisodes()¶

getFPS()¶

getFrameEnd()¶

getFrameStart()¶

getId()[source]¶

getLists()[source]¶

Returns the lists that have been linked/associated with this task. NOTE: There is a difference between a task being added to a list and lists linked to a task

Return type:	`list`

getManagers()¶: Return all managers assigned to this entity.

getMeta(key=None)¶

Get metadata from an object. This method can be used to retrive meta data from an object. The data is stored in key/value pairs where key and value are strings.

This method can also be used without any arguments to retrive a dict with all metadata key/value pairs attached to this object.

Parameters:	key – A `string` representing the key or `None` to retrive all key/value pairs on this object.
Return type:	`string` or `dict`

getName()[source]¶

getNotes()¶: Fetch notes from an entity, this will include replies.

getObjectType()[source]¶

getParent()¶

Get parent object from this object

Return type:	`FTObject` of that type

getParents()¶

Get parent object from this object

Return type:	`list` owith items of that type

getPredecessors()¶

Returns a list of items that this item depends on

Return type:	`list`

getPriority()[source]¶: Return the priority of the object or None if it has no priority.

getProject()[source]¶

Get project this object belongs to

Return type:	Project

getSequence()¶: @deprecated Use getParent instead

getSequences()¶

Get attached Sequences

Return type:	FTList of Sequence

getShots()¶

Get attached Shots

Return type:	FTList of Shot

getShow()¶: @deprecated Use getParent instead

getStartDate()[source]¶

getStatus()¶: Return the status of the object or None if it has no status.

getSuccessors()¶

Returns a list of items that depend on this object

Return type:	`list`

getTasks(*args, **argv)¶

Get attached Tasks

Parameters:

users – list with usernames like [‘username1’,’username2’] to filter out tasks
taskTypes – list representing task types. Can be TaskType objects, their IDs or their names.
taskStatuses – list representing task statuses. Can be TaskStatus objects, their IDs or their names.
states – list with states. Possible states are NOT_STARTED, IN_PROGRESS, DONE, BLOCKED which are availible from the ftrack module
activeProjectsOnly – bool Default to True. specifying if only to query active projects.
includeChildren – bool Default to False. childrens tasks should be included.
includePath – bool Default to False. specifying if the path should be added to each task. Much faster than useing getParents on each task afterwards.

Return type:

FTList with Task

getThumbnail()¶: Get a url to the thumbnail.

getTimelogs(start=None, end=None, includeChildren=False)¶

Return timelogs between start and end dates.

If includeChildren is set, also return timelogs on descendants.

getType()[source]¶: Return the type of the object or None if it has no type.

getURL()¶: Return url that can be used to view this entity in a browser.

getUsers()[source]¶

Get Users assigned to this Task

Return type:	FTList of User

getWebWidgetUrl(name, theme='dark')¶

Return url that can be used is a qt webwidget.

name should be the name of the ftrack panel. theme is optional.

keys()¶: Return keys accessible using get/set methods.

metaKeys()¶: Return keys accessible using getMeta/setMeta methods.

removePredecessor(task)¶

remove a dependency another task to this task

Parameters:	task – The predecessor task

removeSuccessor(task)¶

remove a dependency from this task to another task

Parameters:	task – The successor task

set(key, value=None)¶

setEndDate(theDate)[source]¶

setMeta(key, value=None)¶

Set metadata on an object. This method can be used to store arbitrary data on an object. The data is stored in key/value pairs where key and value are strings.

This method also accepts a dict with key/value pairs

Parameters:	key – A `string` representing the key or a `dict` with key/value pairs. value – A `string` representing the value or None if key is a `dict`.

setPriority(priority)[source]¶

setStartDate(theDate)[source]¶

setStatus(status)¶

Set status of the object

Parameters:	status – `Status` the status object that should be set

setThumbnail(component)¶: Set component as thumbnail.

unAssignUser(user)[source]¶

Unassigns a user from a task

Parameters:	user – A `User` object representing the user that should be unassigned from the task.

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

ftrack.TaskStatus¶: alias of Status

class ftrack.TaskType(id=None, dict=None, eagerload=None)[source]¶

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getEntityRef()¶

getId()[source]¶

getName()[source]¶

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.TempData(id=None, dict=None, eagerload=None)[source]¶

Represent a temp object.

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getEntityRef()¶

getId()¶

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.Thumbnailable[source]¶

Mixin to add support for thumbnails.

__init__¶: x.__init__(...) initializes x; see help(type(x)) for signature

createThumbnail(file, fileName='image.jpg')[source]¶: Create thumbnail from file.

getThumbnail()[source]¶: Get a url to the thumbnail.

setThumbnail(component)[source]¶: Set component as thumbnail.

class ftrack.Timelog(id=None, dict=None, eagerload=None)[source]¶

Represent a timelog.

__init__(id=None, dict=None, eagerload=None)¶

delete()¶

get(key)¶

getEntityRef()¶

getId()¶

getUser()[source]¶: Return timelog user.

keys()¶: Return keys accessible using get/set methods.

set(key, value=None)¶

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.Timereportable[source]¶

Mixin for timelogging.

__init__¶: x.__init__(...) initializes x; see help(type(x)) for signature

getTimelogs(start=None, end=None, includeChildren=False)[source]¶

Return timelogs between start and end dates.

If includeChildren is set, also return timelogs on descendants.

class ftrack.UnmanagedLocation(id=None, dict=None, eagerload=None, accessor=None, structure=None, resourceIdentifierTransformer=None, priority=50)[source]¶

Represent location for un-managed components.

An un-managed component is one that is only tracked by the system without taking any ownership of the data or its structure. This is similar to the previous behaviour when handling data.

May also prove useful for those who want to manage data themselves and ensure that users of the API cannot accidentally manage the data through the system.

__init__(id=None, dict=None, eagerload=None, accessor=None, structure=None, resourceIdentifierTransformer=None, priority=50)¶

Initialise location with either id or dict.

accessor can be an instance of ftrack.Accessor and will manage access to data in this location for this instance.

structure can be an instance of ftrack.Structure and will be used to provide structure hints when adding components.

resourceIdentifierTransformer can be an instance of ftrack.ResourceIdentifierTransformer and, if set, will be called to encode resource identifiers before storing them centrally or to decode centrally retrieved identifiers before setting on a component.

priority is a basic hint for the priority of the location versus others in this session. The lower the number the higher the priority with zero considered highest priority.

addComponent(component, recursive=True, manageData=False)[source]¶

Add component to this location.

If component is a container and recursive is True then also add each member of the container to this location.

Note

manageData must be False as this type of location guarantees to never attempt management of data. Will raise ftrack.LocationError if a non false value is passed in.

Note

Externally managed data must still match the path generated by this location’s structure interface. No existence check is currently performed.

Return component in this location.

adoptComponent(component)¶

Adopt and return component.

Set location on component to this location, as well as retrieving and setting appropriate resource identifier.

Raise ftrack.ComponentNotInLocationError if component not found in this location.

Note that this compliments getComponent() rather than addComponent().

See also

adoptComponents(*args, **kw)¶

Adopt and return components.

For each component in components, set location to this location, as well as retrieving and setting appropriate resource identifier.

Raise ftrack.ComponentNotInLocationError if any of the components are not found in this location.

See also

delete()¶

get(key)¶

getAccessor()¶: Return current accessor for this location.

getComponent(componentId)¶

Retrieve component with componentId from this location.

Raise ftrack.ComponentNotInLocationError if component not found in this location.

Note

If an accessor is available for this location then the access path will also be set on the returned component.

See also

getComponentAvailabilities(componentIds)¶: Return list of availabilities for components in this location.

getComponentAvailability(componentId)¶: Return availability as percentage of component in this location.

getComponents(*args, **kw)¶

Retrieve components with componentIds from this location.

Raise ftrack.ComponentNotInLocationError if any of the specified components are not found in this location.

If componentIds is not specified (or None) then retrieve ALL components currently in this location.

Note

If an accessor is available for this location then the access path will also be set on the returned component.

See also

getEntityRef()¶

getId()¶: Return id.

getName()¶: Return name.

getPriority()¶: Return priority.

getResourceIdentifierTransformer()¶: Return current resource identifier transformer for this location.

getStructure()¶: Return current structure for this location.

keys()¶: Return keys accessible using get/set methods.

removeComponent(componentId, recursive=True, manageData=False)[source]¶

Remove component with componentId from this location.

If component is a container and recursive is True then also remove each member of the container from this location.

Note

manageData must be False as this type of location guarantees to never attempt management of data. Will raise ftrack.LocationError if a non false value is passed in.

set(key, value=None)¶

setAccessor(accessor)¶: Set current accessor for this location.

setPriority(priority)¶: Set priority.

setResourceIdentifierTransformer(resourceIdentifierTransformer)¶: Set current resourceIdentifierTransformer for this location.

setStructure(structure)¶: Set current structure for this location.

xmlServer = <FTrackCore.api.xmlserver.XMLServer instance at 0x3af3ab8>¶

class ftrack.UnmanagedMemoryLocation(*args, **kw)[source]¶

Represent memory based location for un-managed components.

__init__(*args, **kw)¶: Initialise location.

addComponent(component, recursive=True, manageData=False)¶

Add component to this location.

If component is a container and recursive is True then also add each member of the container to this location.

Note

manageData must be False as this type of location guarantees to never attempt management of data. Will raise ftrack.LocationError if a non false value is passed in.

Note

Externally managed data must still match the path generated by this location’s structure interface. No existence check is currently performed.

Return component in this location.

adoptComponent(component)¶

Adopt and return component.

Set location on component to this location, as well as retrieving and setting appropriate resource identifier.

Raise ftrack.ComponentNotInLocationError if component not found in this location.

Note that this compliments getComponent() rather than addComponent().

See also

adoptComponents(*args, **kw)¶

Adopt and return components.

For each component in components, set location to this location, as well as retrieving and setting appropriate resource identifier.

Raise ftrack.ComponentNotInLocationError if any of the components are not found in this location.

See also

delete()¶

get(key)¶

getAccessor()¶: Return current accessor for this location.

getComponent(componentId)¶

Retrieve component with componentId from this location.

Raise ftrack.ComponentNotInLocationError if component not found in this location.

Note

If an accessor is available for this location then the access path will also be set on the returned component.

See also

getComponentAvailabilities(componentIds)¶: Return list of availabilities for components in this location.

getComponentAvailability(componentId)¶: Return availability as percentage of component in this location.

getComponents(*args, **kw)¶

Retrieve components with componentIds from this location.

Raise ftrack.ComponentNotInLocationError if any of the specified components are not found in this location.

If componentIds is not specified (or None) then retrieve ALL components currently in this location.

Note

If an accessor is available for this location then the access path will also be set on the returned component.

See also