Types

A primary objective of our framework is to simplify its usage for those who wish to employ it without delving into development. We aim to offer them a straightforward and effortless setup process, minimizing the complexities and initializations associated with numerous classes. This approach reduces potential bugs and allows users to focus on their primary task: developing an application using our framework. To ensure uniformity throughout the framework and to effectively manage new Response Generators while avoiding incorrect class initializations, we have introduced Types identifiers. These identifiers, at a high level, determine the specific type of response generator required. Consequently, CHA users are relieved from the intricate details of initializing Response Generator objects, integrating them into the CHA, and handling setups.

Response Generator Types

This enumeration class defines different types of response generator. This ensures consistency in case the response generator developer decides to change the name of their response generator, the end user need not to change their code cause they use the keys. It inherits from the str class and the Enum class in Python’s enum module. Each value in this enumeration represents a specific type of response generator. The key naming convention should be all uppercase with underscore, and the value naming convention should be underscore_case: NAME_OF_RESPONSE_GENERATOR = this_is_a_sample_response_generator_name

from enum import Enum


class ResponseGeneratorType(str, Enum):
    BASE_GENERATOR = "base-generator"

Types

This dictionary is used to map each ResponseGeneratorType value to its corresponding Response Generator class. It allows for easy retrieval of the appropriate class based on the response generator type.

from typing import Dict
from typing import Type

from openCHA.response_generators import (
    BaseResponseGenerator,
)
from openCHA.response_generators import (
    ResponseGeneratorType,
)


RESPONSE_GENERATOR_TO_CLASS: Dict[
    ResponseGeneratorType, Type[BaseResponseGenerator]
] = {ResponseGeneratorType.BASE_GENERATOR: BaseResponseGenerator}