# :coding: utf-8
# :copyright: Copyright (c) 2014-2020 ftrack
from ftrack_connect_pipeline.plugin import BasePlugin, BasePluginValidation
from ftrack_connect_pipeline.constants import plugin
[docs]class BaseImporterPluginValidation(BasePluginValidation):
'''
Importer Plugin Validation class inherits from
:class:`~ftrack_connect_pipeline.plugin.BasePluginValidation`
'''
[docs] def __init__(
self, plugin_name, required_output, return_type, return_value
):
super(BaseImporterPluginValidation, self).__init__(
plugin_name, required_output, return_type, return_value
)
[docs]class BaseImporterPlugin(BasePlugin):
'''
Base Importer Plugin Class inherits from
:class:`~ftrack_connect_pipeline.plugin.BasePlugin`
'''
return_type = dict
'''Required return type'''
plugin_type = plugin._PLUGIN_IMPORTER_TYPE
'''Type of the plugin'''
_required_output = {}
'''Required return exporters'''
[docs] def __init__(self, session):
super(BaseImporterPlugin, self).__init__(session)
self.validator = BaseImporterPluginValidation(
self.plugin_name,
self._required_output,
self.return_type,
self.return_value,
)
[docs] def run(self, context_data=None, data=None, options=None):
raise NotImplementedError('Missing run method.')