Skip to content

mixin_classes

DictMixin dataclass

Mixin class to add "as_dict()" method to classes. Equivalent to .dict.

Adds a .as_dict() method to classes that inherit from this mixin. For example, to add .as_dict() method to a parent class, where all children inherit the .as_dict() function, declare parent as:

1
2
3
@dataclass
class Parent(DictMixin):
    ...

and call like:

1
2
p = Parent()
p_dict = p.as_dict()
Source code in src/red_utils/core/dataclass_utils/mixins/mixin_classes.py 
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
@dataclass
class DictMixin:
    """Mixin class to add "as_dict()" method to classes. Equivalent to .__dict__.

    Adds a `.as_dict()` method to classes that inherit from this mixin. For example,
    to add `.as_dict()` method to a parent class, where all children inherit the .as_dict()
    function, declare parent as:

    ``` py linenums="1"
    @dataclass
    class Parent(DictMixin):
        ...
    ```

    and call like:

    ``` py linenums="1"
    p = Parent()
    p_dict = p.as_dict()
    ```
    """

    def as_dict(self: Generic[T]):
        """Return dict representation of a dataclass instance.

        Description:
        Any class that inherits from `DictMixin` will automatically have a method `.as_dict()`.
        There are no extra params.

        Returns
        -------
        A Python `dict` representation of a Python `dataclass` class.
        """
        try:
            return self.__dict__.copy()

        except Exception as exc:
            raise Exception(
                f"Unhandled exception converting class instance to dict. Details: {exc}"
            )

as_dict()

Return dict representation of a dataclass instance.

Description: Any class that inherits from DictMixin will automatically have a method .as_dict(). There are no extra params.

Returns

A Python dict representation of a Python dataclass class.

Source code in src/red_utils/core/dataclass_utils/mixins/mixin_classes.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def as_dict(self: Generic[T]):
    """Return dict representation of a dataclass instance.

    Description:
    Any class that inherits from `DictMixin` will automatically have a method `.as_dict()`.
    There are no extra params.

    Returns
    -------
    A Python `dict` representation of a Python `dataclass` class.
    """
    try:
        return self.__dict__.copy()

    except Exception as exc:
        raise Exception(
            f"Unhandled exception converting class instance to dict. Details: {exc}"
        )