ftrack_connect_pipeline.constants¶
- ftrack_connect_pipeline.constants.UI_TYPE = None¶
Default ui type for ftrack_connect_pipeline
- ftrack_connect_pipeline.constants.HOST_TYPE = 'python'¶
Default host type for ftrack_connect_pipeline
- ftrack_connect_pipeline.constants.STEP = 'step'¶
Step Category.
- ftrack_connect_pipeline.constants.STAGE = 'stage'¶
Stage Category.
- ftrack_connect_pipeline.constants.PLUGIN = 'plugin'¶
Plugin Category.
- ftrack_connect_pipeline.constants.CONTEXTS = 'contexts'¶
Contexts step group.
- ftrack_connect_pipeline.constants.FINALIZERS = 'finalizers'¶
Finalizers step group.
- ftrack_connect_pipeline.constants.COMPONENTS = 'components'¶
Components step group.
- ftrack_connect_pipeline.constants.CONTEXT = 'context'¶
Contexts step type.
- ftrack_connect_pipeline.constants.FINALIZER = 'finalizer'¶
Finalizers step type.
- ftrack_connect_pipeline.constants.COMPONENT = 'component'¶
Components step type.
- ftrack_connect_pipeline.constants.COLLECTOR = 'collector'¶
Collector component stage name.
- ftrack_connect_pipeline.constants.VALIDATOR = 'validator'¶
Validator component stage name.
- ftrack_connect_pipeline.constants.EXPORTER = 'exporter'¶
Output component stage name.
- ftrack_connect_pipeline.constants.IMPORTER = 'importer'¶
Importer component stage name.
- ftrack_connect_pipeline.constants.POST_IMPORTER = 'post_importer'¶
Post_import component stage name.
- ftrack_connect_pipeline.constants.OPENER = 'opener'¶
Opener client and its definition.
- ftrack_connect_pipeline.constants.LOADER = 'loader'¶
Loader client and its definition used with assembler
- ftrack_connect_pipeline.constants.PUBLISHER = 'publisher'¶
Publisher client and its definition.
- ftrack_connect_pipeline.constants.PIPELINE_REGISTER_TOPIC = 'ftrack.pipeline.register'¶
Pipeline register topic event. Published by the
Host
and used to register the definitions module. Definitions Docs
- ftrack_connect_pipeline.constants.PIPELINE_RUN_PLUGIN_TOPIC = 'ftrack.pipeline.run'¶
Pipeline run plugin topic event. Used to run the plugins. Published in
change_version()
and_run_plugin()
. Subscribed to run the plugins inregister()
- ftrack_connect_pipeline.constants.PIPELINE_DISCOVER_PLUGIN_TOPIC = 'ftrack.pipeline.discover'¶
Pipeline discover plugin topic event. Used to discover the plugins. Published in
_discover_plugin()
, Subscribed to discover the plugins inregister()
- ftrack_connect_pipeline.constants.PIPELINE_HOST_RUN = 'ftrack.pipeline.host.run'¶
Pipeline host run plugin topic event. Used to communicate between client and host, by the host connection to make the host run the plugin. the plugins. Published in
run()
, and Subscribed inon_register_definition()
- ftrack_connect_pipeline.constants.PIPELINE_CLIENT_NOTIFICATION = 'ftrack.pipeline.client.notification'¶
Pipeline client notification topic event. Used to communicate the result of the plugin execution from host to the client. Published in
_notify_client()
, and Subscribed inon_client_notification()
- ftrack_connect_pipeline.constants.PIPELINE_CLIENT_PROGRESS_NOTIFICATION = 'ftrack.pipeline.client.progress.notification'¶
Pipeline client progress notification topic event. Used to communicate the result of the steps execution from host to the client. Published in
_notify_progress_client()
, and Subscribed inon_client_progress_notification()
- ftrack_connect_pipeline.constants.PIPELINE_DISCOVER_HOST = 'ftrack.pipeline.host.discover'¶
Pipeline Discover host topic event. Used to discover available hosts. Published in
_discover_hosts()
, and Subscribed inon_register_definition()
ftrack_connect_pipeline.constants.event¶
- ftrack_connect_pipeline.constants.event.REMOTE_EVENT_MODE = 1¶
Run the events of the session in remote mode
- ftrack_connect_pipeline.constants.event.LOCAL_EVENT_MODE = 0¶
Run the events of the session in local mode
ftrack_connect_pipeline.constants.status¶
- ftrack_connect_pipeline.constants.status.UNKNOWN_STATUS = 'UNKNOWN_STATUS'¶
Unknown status of plugin execution.
- ftrack_connect_pipeline.constants.status.SUCCESS_STATUS = 'SUCCESS_STATUS'¶
Succed status of plugin execution.
- ftrack_connect_pipeline.constants.status.WARNING_STATUS = 'WARNING_STATUS'¶
Warning status of plugin execution.
- ftrack_connect_pipeline.constants.status.ERROR_STATUS = 'ERROR_STATUS'¶
Error status of plugin execution.
- ftrack_connect_pipeline.constants.status.EXCEPTION_STATUS = 'EXCEPTION_STATUS'¶
Exception status of plugin execution.
- ftrack_connect_pipeline.constants.status.RUNNING_STATUS = 'RUNNING_STATUS'¶
Running status of plugin execution.
- ftrack_connect_pipeline.constants.status.DEFAULT_STATUS = 'PAUSE_STATUS'¶
Default status of plugin execution.
- ftrack_connect_pipeline.constants.status.status_bool_mapping = {'ERROR_STATUS': False, 'EXCEPTION_STATUS': False, 'PAUSE_STATUS': False, 'RUNNING_STATUS': False, 'SUCCESS_STATUS': True, 'UNKNOWN_STATUS': False, 'WARNING_STATUS': False}¶
Mapping of the run plugins status. Valid or non-valid result.