ftrack_connect_pipeline.plugin.base

ftrack_connect_pipeline.plugin.base.action

class ftrack_connect_pipeline.plugin.base.action.BaseActionPluginValidation(plugin_name, required_output, return_type, return_value)

Bases: BasePluginValidation

Action Plugin Validation class inherits from BasePluginValidation

__init__(plugin_name, required_output, return_type, return_value)

Initialise PluginValidation with plugin_name, required_output, return_type, return_value.

plugin_name : current plugin name.

required_output : required exporters of the current plugin.

return_type : required return type of the current plugin.

return_value : Expected return value of the current plugin.

validate_required_output(result)

Ensures that result contains all the expected required_output values defined for the current plugin.

result : exporters value of the plugin execution.

Return tuple (bool,str)

class ftrack_connect_pipeline.plugin.base.action.BaseActionPlugin(session)

Bases: BasePlugin

Base Action Plugin Class inherits from BasePlugin

return_type

Required return type

alias of list

plugin_type = 'action'

Type of the plugin

__init__(session)

Initialise BasePlugin with instance of ftrack_api.session.Session

run(context_data=None, data=None, options=None)

Runs the current plugin with , context_data , data and options.

context_data provides a mapping with the asset_name, context_id, asset_type_name, comment and status_id of the asset that we are working on.

data a list of data coming from previous collector or empty list

options a dictionary of options passed from outside.

Note

Use always self.exporters as a base to return the values, don’t override self.exporters as it contains the _required_output

ftrack_connect_pipeline.plugin.base.collector

class ftrack_connect_pipeline.plugin.base.collector.BaseCollectorPluginValidation(plugin_name, required_output, return_type, return_value)

Bases: BasePluginValidation

Collector Plugin Validation class inherits from BasePluginValidation

__init__(plugin_name, required_output, return_type, return_value)

Initialise PluginValidation with plugin_name, required_output, return_type, return_value.

plugin_name : current plugin name.

required_output : required exporters of the current plugin.

return_type : required return type of the current plugin.

return_value : Expected return value of the current plugin.

validate_required_output(result)

Ensures that result contains all the expected required_output values defined for the current plugin.

result : exporters value of the plugin execution.

Return tuple (bool,str)

class ftrack_connect_pipeline.plugin.base.collector.BaseCollectorPlugin(session)

Bases: BasePlugin

Base Collector Plugin Class inherits from BasePlugin

return_type

Required return type

alias of list

plugin_type = 'collector'

Type of the plugin

__init__(session)

Initialise BasePlugin with instance of ftrack_api.session.Session

run(context_data=None, data=None, options=None)

Runs the current plugin with , context_data , data and options.

context_data provides a mapping with the asset_name, context_id, asset_type_name, comment and status_id of the asset that we are working on.

data a list of data coming from previous collector or empty list

options a dictionary of options passed from outside.

Note

Use always self.exporters as a base to return the values, don’t override self.exporters as it contains the _required_output

ftrack_connect_pipeline.plugin.base.context

class ftrack_connect_pipeline.plugin.base.context.BaseContextPluginValidation(plugin_name, required_output, return_type, return_value)

Bases: BasePluginValidation

Context Plugin Validation class inherits from BasePluginValidation

__init__(plugin_name, required_output, return_type, return_value)

Initialise PluginValidation with plugin_name, required_output, return_type, return_value.

plugin_name : current plugin name.

required_output : required exporters of the current plugin.

return_type : required return type of the current plugin.

return_value : Expected return value of the current plugin.

class ftrack_connect_pipeline.plugin.base.context.BaseContextPlugin(session)

Bases: BasePlugin

Base Context Plugin Class inherits from BasePlugin

return_type

Required return type

alias of dict

plugin_type = 'context'

Type of the plugin

__init__(session)

Initialise BasePlugin with instance of ftrack_api.session.Session

run(context_data=None, data=None, options=None)

Runs the current plugin with , context_data , data and options.

context_data provides a mapping with the asset_name, context_id, asset_type_name, comment and status_id of the asset that we are working on.

data a list of data coming from previous collector or empty list

options a dictionary of options passed from outside.

Note

Use always self.exporters as a base to return the values, don’t override self.exporters as it contains the _required_output

ftrack_connect_pipeline.plugin.base.discover

class ftrack_connect_pipeline.plugin.base.discover.BaseDiscoverPluginValidation(plugin_name, required_output, return_type, return_value)

Bases: BasePluginValidation

Discover Plugin Validation class inherits from BasePluginValidation

__init__(plugin_name, required_output, return_type, return_value)

Initialise PluginValidation with plugin_name, required_output, return_type, return_value.

plugin_name : current plugin name.

required_output : required exporters of the current plugin.

return_type : required return type of the current plugin.

return_value : Expected return value of the current plugin.

validate_required_output(result)

Ensures that result contains all the expected required_output values defined for the current plugin.

result : exporters value of the plugin execution.

Return tuple (bool,str)

class ftrack_connect_pipeline.plugin.base.discover.BaseDiscoverPlugin(session)

Bases: BasePlugin

Base Discover Plugin Class inherits from BasePlugin

return_type

Required return type

alias of list

plugin_type = 'discover'

Type of the plugin

__init__(session)

Initialise BasePlugin with instance of ftrack_api.session.Session

run(context_data=None, data=None, options=None)

Runs the current plugin with , context_data , data and options.

context_data provides a mapping with the asset_name, context_id, asset_type_name, comment and status_id of the asset that we are working on.

data a list of data coming from previous collector or empty list

options a dictionary of options passed from outside.

Note

Use always self.exporters as a base to return the values, don’t override self.exporters as it contains the _required_output

ftrack_connect_pipeline.plugin.base.finalizer

class ftrack_connect_pipeline.plugin.base.finalizer.BaseFinalizerPluginValidation(plugin_name, required_output, return_type, return_value)

Bases: BasePluginValidation

Finalizer Plugin Validation class inherits from BasePluginValidation

__init__(plugin_name, required_output, return_type, return_value)

Initialise PluginValidation with plugin_name, required_output, return_type, return_value.

plugin_name : current plugin name.

required_output : required exporters of the current plugin.

return_type : required return type of the current plugin.

return_value : Expected return value of the current plugin.

class ftrack_connect_pipeline.plugin.base.finalizer.BaseFinalizerPlugin(session)

Bases: BasePlugin

Base Finalizer Plugin Class inherits from BasePlugin

return_type

Required return type

alias of dict

plugin_type = 'finalizer'

Type of the plugin

__init__(session)

Initialise BasePlugin with instance of ftrack_api.session.Session

run(context_data=None, data=None, options=None)

Runs the current plugin with , context_data , data and options.

context_data provides a mapping with the asset_name, context_id, asset_type_name, comment and status_id of the asset that we are working on.

data a list of data coming from previous collector or empty list

options a dictionary of options passed from outside.

Note

Use always self.exporters as a base to return the values, don’t override self.exporters as it contains the _required_output

ftrack_connect_pipeline.plugin.base.importer

class ftrack_connect_pipeline.plugin.base.importer.BaseImporterPluginValidation(plugin_name, required_output, return_type, return_value)

Bases: BasePluginValidation

Importer Plugin Validation class inherits from BasePluginValidation

__init__(plugin_name, required_output, return_type, return_value)

Initialise PluginValidation with plugin_name, required_output, return_type, return_value.

plugin_name : current plugin name.

required_output : required exporters of the current plugin.

return_type : required return type of the current plugin.

return_value : Expected return value of the current plugin.

class ftrack_connect_pipeline.plugin.base.importer.BaseImporterPlugin(session)

Bases: BasePlugin

Base Importer Plugin Class inherits from BasePlugin

return_type

Required return type

alias of dict

plugin_type = 'importer'

Type of the plugin

__init__(session)

Initialise BasePlugin with instance of ftrack_api.session.Session

run(context_data=None, data=None, options=None)

Runs the current plugin with , context_data , data and options.

context_data provides a mapping with the asset_name, context_id, asset_type_name, comment and status_id of the asset that we are working on.

data a list of data coming from previous collector or empty list

options a dictionary of options passed from outside.

Note

Use always self.exporters as a base to return the values, don’t override self.exporters as it contains the _required_output

ftrack_connect_pipeline.plugin.base.exporter

class ftrack_connect_pipeline.plugin.base.exporter.BaseExporterPluginValidation(plugin_name, required_output, return_type, return_value)

Bases: BasePluginValidation

Output Plugin Validation class inherits from BasePluginValidation

__init__(plugin_name, required_output, return_type, return_value)

Initialise PluginValidation with plugin_name, required_output, return_type, return_value.

plugin_name : current plugin name.

required_output : required exporters of the current plugin.

return_type : required return type of the current plugin.

return_value : Expected return value of the current plugin.

validate_required_output(result)

Ensures that result contains all the expected required_output keys defined for the current plugin.

result : exporters value of the plugin execution.

Return tuple (bool,str)

class ftrack_connect_pipeline.plugin.base.exporter.BaseExporterPlugin(session)

Bases: BasePlugin

Base Output Plugin Class inherits from BasePlugin

return_type

Required return type

alias of list

plugin_type = 'exporter'

Type of the plugin

__init__(session)

Initialise BasePlugin with instance of ftrack_api.session.Session

run(context_data=None, data=None, options=None)

Runs the current plugin with , context_data , data and options.

context_data provides a mapping with the asset_name, context_id, asset_type_name, comment and status_id of the asset that we are working on.

data a list of data coming from previous collector or empty list

options a dictionary of options passed from outside.

Note

Use always self.exporters as a base to return the values, don’t override self.exporters as it contains the _required_output

ftrack_connect_pipeline.plugin.base.post_import

class ftrack_connect_pipeline.plugin.base.post_importer.BasePostImporterPluginValidation(plugin_name, required_output, return_type, return_value)

Bases: BasePluginValidation

Post Import Plugin Validation class inherits from BasePluginValidation

__init__(plugin_name, required_output, return_type, return_value)

Initialise PluginValidation with plugin_name, required_output, return_type, return_value.

plugin_name : current plugin name.

required_output : required exporters of the current plugin.

return_type : required return type of the current plugin.

return_value : Expected return value of the current plugin.

class ftrack_connect_pipeline.plugin.base.post_importer.BasePostImporterPlugin(session)

Bases: BasePlugin

Base Post Import Plugin Class inherits from BasePlugin

return_type

Required return type

alias of dict

plugin_type = 'post_importer'

Type of the plugin

__init__(session)

Initialise BasePlugin with instance of ftrack_api.session.Session

run(context_data=None, data=None, options=None)

Runs the current plugin with , context_data , data and options.

context_data provides a mapping with the asset_name, context_id, asset_type_name, comment and status_id of the asset that we are working on.

data a list of data coming from previous collector or empty list

options a dictionary of options passed from outside.

Note

Use always self.exporters as a base to return the values, don’t override self.exporters as it contains the _required_output

ftrack_connect_pipeline.plugin.base.validator

class ftrack_connect_pipeline.plugin.base.validator.BaseValidatorPluginValidation(plugin_name, required_output, return_type, return_value)

Bases: BasePluginValidation

Validator Plugin Validation class inherits from BasePluginValidation

__init__(plugin_name, required_output, return_type, return_value)

Initialise PluginValidation with plugin_name, required_output, return_type, return_value.

plugin_name : current plugin name.

required_output : required exporters of the current plugin.

return_type : required return type of the current plugin.

return_value : Expected return value of the current plugin.

validate_required_output(result)

Ensures that result contains all the expected required_output values defined for the current plugin.

result : exporters value of the plugin execution.

Return tuple (bool,str)

validate_result_value(result)

Ensures that result is True.

result : exporters value of the plugin execution.

Return tuple (bool,str)

class ftrack_connect_pipeline.plugin.base.validator.BaseValidatorPlugin(session)

Bases: BasePlugin

Base Validator Plugin Class inherits from BasePlugin

return_type

Required return type

alias of bool

plugin_type = 'validator'

Type of the plugin

return_value = True

Required return Value

__init__(session)

Initialise BasePlugin with instance of ftrack_api.session.Session

run(context_data=None, data=None, options=None)

Runs the current plugin with , context_data , data and options.

context_data provides a mapping with the asset_name, context_id, asset_type_name, comment and status_id of the asset that we are working on.

data a list of data coming from previous collector or empty list

options a dictionary of options passed from outside.

Note

Use always self.exporters as a base to return the values, don’t override self.exporters as it contains the _required_output