Skip to content

serializers#

HomePageSerializer#

Bases: CommonModelSerializer

Serialize parent organizations up to root.

Source code in src/apps/actors/serializers.py 
12
13
14
15
16
17
class HomePageSerializer(CommonModelSerializer):
    """Serialize parent organizations up to root."""

    class Meta:
        model = HomePage
        fields = ["title", "url"]

get_org_children#

Serialize reference data childen of organization.

Source code in src/apps/actors/serializers.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
def get_org_children(context: dict, org: Organization):
    """Serialize reference data childen of organization."""
    # Return only children that match the deprecation status of the parent
    if org.deprecated:
        children = [
            child for child in org.children.all() if child.is_reference_data and child.deprecated
        ]
    else:
        children = [
            child
            for child in org.children.all()
            if child.is_reference_data and not child.deprecated
        ]
    serializer = ChildOrganizationSerializer(instance=children, many=True, context=context)
    return serializer.data

ChildOrganizationSerializer#

Bases: CommonModelSerializer

Serialize child organization tree without repeating parent organization.

Source code in src/apps/actors/serializers.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
class ChildOrganizationSerializer(CommonModelSerializer):
    """Serialize child organization tree without repeating parent organization."""

    children = serializers.SerializerMethodField(read_only=True, method_name="get_children")

    def get_children(self, obj):
        return get_org_children(self.context, obj)

    class Meta:
        model = Organization
        fields = "__all__"

    def to_representation(self, instance):
        if not self.context.get("expand_child_organizations"):
            return instance.id

        reps = super().to_representation(instance)
        reps.pop("parent")
        return reps

ParentOrganizationSerializer#

Bases: CommonModelSerializer

Serialize parent organizations up to root.

Source code in src/apps/actors/serializers.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
class ParentOrganizationSerializer(CommonModelSerializer):
    """Serialize parent organizations up to root."""

    parent = serializers.SerializerMethodField(read_only=True, method_name="get_parent")

    def get_parent(self, obj):
        if obj.parent:
            serializer = ParentOrganizationSerializer(instance=obj.parent)
            return serializer.data
        return None

    class Meta:
        model = Organization
        fields = "__all__"

OrganizationSerializer#

Bases: CommonModelSerializer

Serialize organization

Will include * All child organizations * Parent organizations up to root, but no children of parents

Source code in src/apps/actors/serializers.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
class OrganizationSerializer(CommonModelSerializer):
    """Serialize organization

    Will include
    * All child organizations
    * Parent organizations up to root, but no children of parents
    """

    children = serializers.SerializerMethodField(read_only=True, method_name="get_children")
    parent = ParentOrganizationSerializer(read_only=True)
    homepage = HomePageSerializer(read_only=True)

    def get_children(self, obj):
        return get_org_children(self.context, obj)

    class Meta:
        model = Organization
        fields = "__all__"

PersonModelSerializer#

Bases: CommonModelSerializer

Source code in src/apps/actors/serializers.py 
94
95
96
97
class PersonModelSerializer(CommonModelSerializer):
    class Meta:
        model = Person
        fields = ("id", "name", "email", "external_identifier")

ActorModelSerializer#

Bases: CommonModelSerializer

Source code in src/apps/actors/serializers.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
class ActorModelSerializer(CommonModelSerializer):
    organization = OrganizationSerializer(many=False, required=False, allow_null=True)
    person = PersonModelSerializer(many=False, required=False, allow_null=True)

    def create(self, validated_data):
        org = None
        person = None

        if org_data := validated_data.pop("organization", None):
            org = self.fields["organization"].create(org_data)
        if person_data := validated_data.pop("person", None):
            person = self.fields["person"].create(person_data)

        return Actor.objects.create(organization=org, person=person, **validated_data)

    def update(self, instance, validated_data):
        if org_data := validated_data.pop("organization", None):
            self.fields["organization"].update(instance.organization, org_data)
        return super().update(instance, validated_data)

    class Meta:
        model = Actor
        fields = ("organization", "person", "id")
        read_only_fields = ("id",)
        list_serializer_class = CommonListSerializer