ftrack_connect_pipeline¶

ftrack_connect_pipeline.configure_logging¶

ftrack_connect_pipeline.configure_logging.get_log_directory()[source]¶

Get log directory.

Will create the directory (recursively) if it does not exist.

Raise if the directory can not be created.

ftrack_connect_pipeline.configure_logging.configure_logging(logger_name, level=None, format=None, extra_modules=None, extra_handlers=None, propagate=True)[source]¶

Configure loggerName loggers with console and file handler.

Optionally specify log level (default WARNING)

Optionally set format, default: %(asctime)s - %(name)s - %(levelname)s - %(message)s.

Optional extra_modules to extend the modules to be set to level.

ftrack_connect_pipeline.event¶

class ftrack_connect_pipeline.event.EventManager(session, mode=0)[source]¶

Bases: object

Manages the events handling.

property id¶

property session¶

property connected¶

property mode¶

__init__(session, mode=0)[source]¶

publish(event, callback=None, mode=None)[source]¶: Emit event and provide callback function.

subscribe(topic, callback)[source]¶

ftrack_connect_pipeline.exception¶

exception ftrack_connect_pipeline.exception.PipelineError[source]¶

Bases: Exception

Base pipeline error.

exception ftrack_connect_pipeline.exception.PluginError[source]¶

Bases: PipelineError

Exception raised in case of plugin error

exception ftrack_connect_pipeline.exception.ValidatorPluginError[source]¶

Bases: PluginError

Exception raised in case of validator plugin error

ftrack_connect_pipeline.utils¶

ftrack_connect_pipeline.utils.str_context(context, with_id=False, force_version_nr=None, delimiter='/')[source]¶: Utility function to produce a human readable string out or a context.

ftrack_connect_pipeline.utils.str_version(v, with_id=False, force_version_nr=None, delimiter='/')[source]¶: Utility function to produce a human readable string out or an asset version.

ftrack_connect_pipeline.utils.safe_string(string)[source]¶

ftrack_connect_pipeline.utils.get_save_path(context_id, session, extension=None, temp=True)[source]¶: Calculate the path to local save (work path), DCC independent