Skip to content

file_serializer#

get_or_create_storage#

Source code in src/apps/files/serializers/file_serializer.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def get_or_create_storage(csc_project: str, storage_service: str) -> FileStorage:
    if storage_service not in settings.STORAGE_SERVICE_FILE_STORAGES:
        raise serializers.ValidationError(
            {
                "storage_service": _("Unknown storage service: '{storage_service}'").format(
                    storage_service=storage_service
                )
            }
        )
    storage, created = FileStorage.available_objects.get_or_create(
        csc_project=csc_project,
        storage_service=storage_service,
    )
    return storage

CreateOnlyFieldsMixin#

Source code in src/apps/files/serializers/file_serializer.py 
46
47
48
49
50
51
52
53
54
55
class CreateOnlyFieldsMixin:
    create_only_fields = []

    def update(self, instance, validated_data):
        for field in self.create_only_fields:
            if field in validated_data and getattr(instance, field) != validated_data[field]:
                raise serializers.ValidationError(
                    {field: "Changing field value after creation is not allowed"}
                )
        return super().update(instance, validated_data)

FileCharacteristicsSerializer#

Bases: CommonModelSerializer, StrictSerializer

Source code in src/apps/files/serializers/file_serializer.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
class FileCharacteristicsSerializer(CommonModelSerializer, StrictSerializer):
    file_format_version = FileFormatVersion.get_serializer_field(required=False, allow_null=True)
    encoding = ListValidChoicesField(
        choices=FileCharacteristics.EncodingChoices.choices, required=False, allow_null=True
    )
    csv_delimiter = ListValidChoicesField(
        choices=FileCharacteristics.CSVDelimiterChoices.choices, required=False, allow_null=True
    )
    csv_record_separator = ListValidChoicesField(
        choices=FileCharacteristics.CSVRecordSeparatorChoices.choices,
        required=False,
        allow_null=True,
    )

    class Meta:
        model = FileCharacteristics
        fields = [
            "file_format_version",
            "encoding",
            "csv_has_header",
            "csv_quoting_char",
            "csv_delimiter",
            "csv_record_separator",
        ]

FileSerializer#

Bases: CreateOnlyFieldsMixin, CommonNestedModelSerializer

Source code in src/apps/files/serializers/file_serializer.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
class FileSerializer(CreateOnlyFieldsMixin, CommonNestedModelSerializer):
    create_only_fields = [
        "pathname",
        "csc_project",
        "storage_service",
        "storage_identifier",
    ]

    # FileStorage specific fields
    storage_service = ListValidChoicesField(choices=list(settings.STORAGE_SERVICE_FILE_STORAGES))
    csc_project = serializers.CharField(max_length=200, default=None)

    checksum = ChecksumField(max_length=200)

    # when saving files, filename and pathname are generated from pathname
    pathname = FilePathField()
    filename = FileNameField(read_only=True)

    dataset_metadata = serializers.SerializerMethodField()

    characteristics = FileCharacteristicsSerializer(required=False, allow_null=True)

    def get_dataset_metadata(self, obj):
        if "file_metadata" in self.context:
            if metadata := self.context["file_metadata"].get(obj.id):
                return get_file_metadata_serializer()(metadata).data

    def to_representation(self, instance):
        rep = super().to_representation(instance)
        if "file_metadata" not in self.context:
            rep.pop("dataset_metadata", None)

        storage = FileStorage.get_proxy_model(get_attr_or_item(instance, "storage_service"))
        storage.remove_unsupported_extra_fields(rep)
        return rep

    def to_internal_value(self, data):
        val = super().to_internal_value(data)

        # Fill identifying data for existing files.
        if self.instance:
            val.setdefault("id", self.instance.id)
            val.setdefault("storage_service", self.instance.storage.storage_service)
            val.setdefault("csc_project", self.instance.storage.csc_project)

        if not (self.parent and self.parent.many):
            # When in a list, this should be done in a parent serializer
            FileStorage.objects.assign_to_file_data(
                [val], allow_create=True, raise_exception=True, remove_filestorage_fields=True
            )
        return val

    def validate(self, data):
        if not (self.parent and self.parent.many):
            # When in a list, this should be done in a parent serializer
            FileStorage.check_required_file_fields([data], raise_exception=True)
            FileStorage.check_file_data_conflicts([data], raise_exception=True)

        return super().validate(data)

    class Meta:
        model = File
        fields = [
            "id",
            "storage_identifier",
            "pathname",
            "filename",
            "size",
            "storage_service",
            "csc_project",
            "checksum",
            "frozen",
            "modified",
            "removed",
            "published",
            "user",
            "dataset_metadata",
            "characteristics",
            "characteristics_extension",
        ]
        extra_kwargs = {"published": {"read_only": True}}