Skip to content

updateable

Updateable

(Base) class that provides update() method for each class that inherits from this class, in particular demographic- related classes.

Source code in emod_api/demographics/updateable.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
class Updateable:
    """
    (Base) class that provides update() method for each class that inherits from this class, in particular demographic-
    related classes.
    """
    def __init__(self):
        self.parameter_dict = {}

    def to_dict(self) -> dict:
        raise NotImplementedError

    def update(self, overlay_object: Union["Updateable", dict], allow_nones: bool = False) -> None:
        """
        Updates an object with the values from overlay_object.

        Args:
            overlay_object: object with overriding attributes/values to apply to THIS object
            allow_nones: whether or not to apply/use attributes in overlay_object with value = None

        Returns:
            Nothing
        """
        try:
            # overlaying a provided Updateable object
            overlay_dict = vars(overlay_object)
        except TypeError:
            # overlaying a provided dict
            overlay_dict = overlay_object

        for attribute_name, new_attribute_value in overlay_dict.items():
            if not hasattr(self, attribute_name):
                raise AttributeError(f"Object of type: {type(self)} does not have an attribute named {attribute_name} "
                                     f"to override)")
            # only overlay non-None value UNLESS explicitly allowing it
            if new_attribute_value is not None or allow_nones is True:
                try:
                    # Calling update method in case we have an Updateable being overridden
                    getattr(self, attribute_name).update(new_attribute_value)
                except AttributeError:
                    # not an Updateable being overridden, do direct assignment
                    setattr(self, attribute_name, new_attribute_value)

    def add_parameter(self, key: str, value: Any) -> None:
        """
        Adds a user defined key-value pair to demographics.

        Args:
            key (str): parameter name to add to the object.
            value (any): Custom value to assign to the new key.

        Returns:
            Nothing

        """
        self.parameter_dict[key] = value

add_parameter(key, value)

Adds a user defined key-value pair to demographics.

Parameters:

Name Type Description Default
key str

parameter name to add to the object.

 required
value any

Custom value to assign to the new key.

 required

Returns:

Type Description
None

Nothing
Source code in emod_api/demographics/updateable.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
def add_parameter(self, key: str, value: Any) -> None:
    """
    Adds a user defined key-value pair to demographics.

    Args:
        key (str): parameter name to add to the object.
        value (any): Custom value to assign to the new key.

    Returns:
        Nothing

    """
    self.parameter_dict[key] = value

update(overlay_object, allow_nones=False)

Updates an object with the values from overlay_object.

Parameters:

Name Type Description Default
overlay_object Union[Updateable, dict]

object with overriding attributes/values to apply to THIS object

 required
allow_nones bool

whether or not to apply/use attributes in overlay_object with value = None

 False

Returns:

Type Description
None

Nothing
Source code in emod_api/demographics/updateable.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def update(self, overlay_object: Union["Updateable", dict], allow_nones: bool = False) -> None:
    """
    Updates an object with the values from overlay_object.

    Args:
        overlay_object: object with overriding attributes/values to apply to THIS object
        allow_nones: whether or not to apply/use attributes in overlay_object with value = None

    Returns:
        Nothing
    """
    try:
        # overlaying a provided Updateable object
        overlay_dict = vars(overlay_object)
    except TypeError:
        # overlaying a provided dict
        overlay_dict = overlay_object

    for attribute_name, new_attribute_value in overlay_dict.items():
        if not hasattr(self, attribute_name):
            raise AttributeError(f"Object of type: {type(self)} does not have an attribute named {attribute_name} "
                                 f"to override)")
        # only overlay non-None value UNLESS explicitly allowing it
        if new_attribute_value is not None or allow_nones is True:
            try:
                # Calling update method in case we have an Updateable being overridden
                getattr(self, attribute_name).update(new_attribute_value)
            except AttributeError:
                # not an Updateable being overridden, do direct assignment
                setattr(self, attribute_name, new_attribute_value)