Source code for shifthappens.task_data.task_registration

"""Class for storing a task's registration for the benchmark."""

from dataclasses import dataclass
from typing import Type

from shifthappens.task_data.task_metadata import TaskMetadata
from shifthappens.tasks.base import Task


@dataclass
class TaskRegistration:
    """Class for storing a task's registration for the benchmark. Arguments initialized
    automatically during task registration process.

    Args:
        cls: Task class.
        metadata: Task metadata passed with :py:meth:`shifthappens.benchmark.register_task`.
    """

    cls: Type[Task]
    metadata: TaskMetadata

    def __hash__(self):
        return hash(self.cls)