Skip to content

queue_management

Module for managing task queues associated with entities.

This module provides a mixin class, QueueManagementMixin, designed to simplify the management of task queues associated with an entity. The mixin can be used by any class that has the necessary attributes to support queue retrieval, specifically an entity_info object containing a queues list.

QueueManagementMixin

Mixin for managing queues associated with an entity.

This mixin provides a method for retrieving the task queues assigned to an entity. It assumes that the class using this mixin has an entity_info object containing a queues list.

Methods:

Name Description
get_queues

Retrieve the task queues assigned to the entity.
Source code in merlin/db_scripts/entities/mixins/queue_management.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class QueueManagementMixin:
    """
    Mixin for managing queues associated with an entity.

    This mixin provides a method for retrieving the task queues assigned to an entity.
    It assumes that the class using this mixin has an `entity_info` object containing
    a `queues` list.

    Methods:
        get_queues:
            Retrieve the task queues assigned to the entity.
    """

    def get_queues(self) -> List[str]:
        """
        Get the queues that this entity is assigned to.

        Assumptions:
            - The class using this must have an `entity_info` object containing a `queues` list

        Returns:
            A list of queue names.
        """
        return self.entity_info.queues

get_queues()

Get the queues that this entity is assigned to.

Assumptions
  • The class using this must have an entity_info object containing a queues list

Returns:

Type Description
List[str]

A list of queue names.
Source code in merlin/db_scripts/entities/mixins/queue_management.py 
35
36
37
38
39
40
41
42
43
44
45
def get_queues(self) -> List[str]:
    """
    Get the queues that this entity is assigned to.

    Assumptions:
        - The class using this must have an `entity_info` object containing a `queues` list

    Returns:
        A list of queue names.
    """
    return self.entity_info.queues