OpenSlides/openslides/assignments/apps.py

from typing import List

from django.apps import AppConfig
from mypy_extensions import TypedDict

from ..utils.projector import register_projector_elements


class AssignmentsAppConfig(AppConfig):
    name = 'openslides.assignments'
    verbose_name = 'OpenSlides Assignments'
    angular_site_module = True
    angular_projector_module = True

    def ready(self):
        # Import all required stuff.
        from ..core.config import config
        from ..core.signals import permission_change, user_data_required
        from ..utils.rest_api import router
        from .config_variables import get_config_variables
        from .projector import get_projector_elements
        from .signals import get_permission_change_data, required_users
        from .views import AssignmentViewSet, AssignmentPollViewSet

        # Define config variables and projector elements.
        config.update_config_variables(get_config_variables())
        register_projector_elements(get_projector_elements())

        # Connect signals.
        permission_change.connect(
            get_permission_change_data,
            dispatch_uid='assignments_get_permission_change_data')
        user_data_required.connect(
            required_users,
            dispatch_uid='assignments_required_users')

        # Register viewsets.
        router.register(self.get_model('Assignment').get_collection_string(), AssignmentViewSet)
        router.register('assignments/poll', AssignmentPollViewSet)

    def get_startup_elements(self):
        """
        Yields all Cachables required on startup i. e. opening the websocket
        connection.
        """
        yield self.get_model('Assignment')

    def get_angular_constants(self):
        assignment = self.get_model('Assignment')
        InnerItem = TypedDict('InnerItem', {'value': int, 'display_name': str})
        Item = TypedDict('Item', {'name': str, 'value': List[InnerItem]})
        data: Item = {
            'name': 'AssignmentPhases',
            'value': []}
        for phase in assignment.PHASES:
            data['value'].append({
                'value': phase[0],
                'display_name': phase[1],
            })
        return [data]