Skip to content

serializers#

BaseRefdataSerializer#

Bases: CommonModelSerializer

Source code in src/apps/refdata/serializers.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class BaseRefdataSerializer(CommonModelSerializer):
    omit_related = False

    def get_fields(self):
        fields = super().get_fields()
        if self.omit_related:
            fields = {
                name: field
                for name, field in fields.items()
                if name not in {"broader", "narrower"}
            }
        return fields

    def to_representation(self, instance):
        rep = super().to_representation(instance)
        if len(rep["pref_label"].keys()) > 4:
            rep["pref_label"] = {
                key: rep["pref_label"][key]
                for key in ["fi", "en", "sv", "und"]
                if key in rep["pref_label"].keys()
            }
        return rep

get_refdata_serializer_class#

Create serializer class for reference data model.

Source code in src/apps/refdata/serializers.py 
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
59
60
61
def get_refdata_serializer_class(refdata_model):
    """Create serializer class for reference data model."""

    class Meta:
        model = refdata_model
        ref_name = getattr(
            refdata_model, "serializer_ref_name", f"Reference{refdata_model.__name__}"
        )

        # using reverse here would cause errors due to circular import, so use hardcoded url
        swagger_description = _("Reference data from `{url}`").format(
            url=f"/v3/reference-data/{refdata_model.get_model_url().replace('?', '')}"
        )

        fields = (
            "id",
            "url",
            "in_scheme",
            "pref_label",
            "broader",
            "narrower",
            "deprecated",
            # include fields defined in refdata_class.serializer_extra_fields
            *getattr(refdata_model, "serializer_extra_fields", ()),
        )

    serializer_class = type(
        f"{refdata_model.__name__}ModelSerializer",
        (BaseRefdataSerializer,),
        {"Meta": Meta},
    )
    return serializer_class