ayon-core/pype/ftrack/lib/ftrack_event_handler.py

from .ftrack_base_handler import BaseHandler


class BaseEvent(BaseHandler):
    '''Custom Event base class

    BaseEvent is based on ftrack.update event
    - get entities from event

    If want to use different event base
    - override register and *optional _translate_event method

    '''

    type = 'Event'

    def __init__(self, session):
        '''Expects a ftrack_api.Session instance'''
        super().__init__(session)

    def register(self):
        '''Registers the event, subscribing the discover and launch topics.'''
        self.session.event_hub.subscribe(
            'topic=ftrack.update',
            self._launch,
            priority=self.priority
        )

    def _launch(self, event):
        args = self._translate_event(
            self.session, event
        )

        self.launch(
            self.session, *args
        )

        return

    def _translate_event(self, session, event):
        '''Return *event* translated structure to be used with the API.'''
        _selection = event['data'].get('entities', [])

        _entities = list()
        for entity in _selection:
            if entity['entityType'] in ['socialfeed']:
                continue
            _entities.append(
                (
                    session.get(
                        self._get_entity_type(entity),
                        entity.get('entityId')
                    )
                )
            )

        return [
            _entities,
            event
        ]