Skip to content

fields#

CommaSeparatedListField#

Bases: ListField

ListField that serializes into a comma-separated string.

Source code in src/apps/files/serializers/fields.py 
15
16
17
18
19
20
21
22
23
24
25
26
class CommaSeparatedListField(serializers.ListField):
    """ListField that serializes into a comma-separated string."""

    def get_value(self, dictionary):
        return super(serializers.ListField, self).get_value(dictionary)

    def to_internal_value(self, data):
        data = data.split(",")
        return super().to_internal_value(data)

    def to_representation(self, data):
        return ",".join(data)

FileNameField#

Bases: RegexField

Source code in src/apps/files/serializers/fields.py 
37
38
39
40
41
42
class FileNameField(serializers.RegexField):
    default_error_messages = {"invalid": _("Expected file name to not contain slashes.")}

    def __init__(self, *args, **kwargs):
        kwargs["trim_whitespace"] = False
        super().__init__(filename_regex, *args, **kwargs)

FilePathField#

Bases: RegexField

Source code in src/apps/files/serializers/fields.py 
45
46
47
48
49
50
class FilePathField(serializers.RegexField):
    default_error_messages = {"invalid": _("Expected file path to be in format '/path/file'.")}

    def __init__(self, *args, **kwargs):
        kwargs["trim_whitespace"] = False
        super().__init__(file_pathname_regex, *args, **kwargs)

DirectoryPathField#

Bases: RegexField

Source code in src/apps/files/serializers/fields.py 
53
54
55
56
57
58
class DirectoryPathField(serializers.RegexField):
    default_error_messages = {"invalid": _("Expected directory path to be in format /path/.")}

    def __init__(self, *args, **kwargs):
        kwargs["trim_whitespace"] = False
        super().__init__(directory_pathname_regex, *args, **kwargs)

OptionalSlashDirectoryPathField#

Bases: RegexField

Directory path field that automatically appends slash to end if missing.

Source code in src/apps/files/serializers/fields.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
class OptionalSlashDirectoryPathField(serializers.RegexField):
    """Directory path field that automatically appends slash to end if missing."""

    default_error_messages = {
        "invalid": _("Expected directory path to be in format /path/ or /path.")
    }

    def __init__(self, *args, **kwargs):
        kwargs["trim_whitespace"] = False
        super().__init__(optional_slash_pathname_regex, *args, **kwargs)

    def to_internal_value(self, data):
        if data and not data.endswith("/"):
            data += "/"
        return super().to_internal_value(data)

StorageServiceField#

Bases: ListValidChoicesField

ChoiceField with validation for storage services.

Source code in src/apps/files/serializers/fields.py 
78
79
80
81
82
83
class StorageServiceField(ListValidChoicesField):
    """ChoiceField with validation for storage services."""

    def __init__(self, *args, **kwargs):
        kwargs["choices"] = list(settings.STORAGE_SERVICE_FILE_STORAGES)
        super().__init__(*args, **kwargs)