Skip to content

utils

get_trigger_conditions(campaign, trigger_list)

Get the trigger conditions from the campaign module and return the trigger list.

Source code in emodpy/campaign/utils.py 
16
17
18
19
20
21
22
23
24
25
26
27
def get_trigger_conditions(campaign: api_campaign, trigger_list: list[str]) -> list[str]:
    """
    Get the trigger conditions from the campaign module and return the trigger list.
    """
    if not trigger_list or not isinstance(trigger_list, list):
        raise ValueError(f"{trigger_list} must be a non-empty list of strings.")

    def validate_trigger(trigger: str) -> str:
        if not trigger:
            raise ValueError(f"{trigger} must be a string and cannot be None or empty.")
        return trigger
    return [campaign.get_recv_trigger(validate_trigger(trigger), old=True) for trigger in trigger_list]

set_event(broadcast_event, event_argument_name, campaign, optional=True)

Set the event to the campaign module as a broadcast event and return the event name.

Source code in emodpy/campaign/utils.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
def set_event(broadcast_event: str, event_argument_name: str, campaign: api_campaign, optional: bool = True) -> str:
    """
    Set the event to the campaign module as a broadcast event and return the event name.
    """
    if broadcast_event is None or broadcast_event == '':
        if optional:
            return ''
        else:
            raise ValueError(f"{event_argument_name} must be a string and cannot be None or empty.")
    return campaign.get_send_trigger(broadcast_event, old=True)