Skip to content

directory_serializer#

ContextFileStorageMixin#

Bases: Serializer

Serializer mixin that gets FileStorage fields from context.

Source code in src/apps/files/serializers/directory_serializer.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class ContextFileStorageMixin(serializers.Serializer):
    """Serializer mixin that gets FileStorage fields from context."""

    storage_service = serializers.SerializerMethodField()
    csc_project = serializers.SerializerMethodField()

    def get_storage(self, obj) -> FileStorage:
        return self.context.get("storage")

    def get_csc_project(self, obj):
        if "storage" in self.context:
            return self.context["storage"].csc_project

    def get_storage_service(self, obj):
        if "storage" in self.context:
            return self.context["storage"].storage_service

DirectoryFileSerializer#

Bases: ContextFileStorageMixin, FileSerializer

Source code in src/apps/files/serializers/directory_serializer.py 
37
38
39
40
class DirectoryFileSerializer(ContextFileStorageMixin, FileSerializer):
    def get_fields(self):
        fields = super().get_fields()
        return remove_hidden_fields(fields, self.context.get("file_fields"))

BaseDirectorySerializer#

Bases: ContextFileStorageMixin, Serializer

Source code in src/apps/files/serializers/directory_serializer.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
class BaseDirectorySerializer(ContextFileStorageMixin, serializers.Serializer):
    name = serializers.CharField()
    pathname = serializers.CharField()
    file_count = serializers.IntegerField()  # total file count including subdirectories
    published_file_count = serializers.IntegerField()  # number of files in some public dataset
    size = serializers.IntegerField()  # total byte size including subdirectories
    created = serializers.DateTimeField(default=None)  # oldest file modification
    modified = serializers.DateTimeField(default=None)  # most recent file modification

    dataset_metadata = serializers.SerializerMethodField(read_only=True)

    def get_dataset_metadata(self, obj):
        if "directory_metadata" in self.context:
            if metadata := self.context["directory_metadata"].get(obj["pathname"]):
                return get_directory_metadata_serializer()(metadata).data

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

        # FileStorage should be available in context for directories
        if storage := self.get_storage(instance):
            storage.remove_unsupported_extra_fields(rep)
        return rep

SubDirectorySerializer#

Bases: BaseDirectorySerializer

Serializer for subdirectory, shows file counts and sizes.

Source code in src/apps/files/serializers/directory_serializer.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class SubDirectorySerializer(BaseDirectorySerializer):
    """Serializer for subdirectory, shows file counts and sizes."""

    url = serializers.SerializerMethodField(read_only=True, method_name="get_url")

    def get_fields(self):
        fields = super().get_fields()
        return remove_hidden_fields(fields, self.context.get("directory_fields"))

    def get_url(self, obj):
        """Get url for browsing directory contents."""
        url = self.context["request"].build_absolute_uri()
        new_url = replace_query_path(url, obj["pathname"])
        return new_url

get_url(obj) #

Get url for browsing directory contents.

Source code in src/apps/files/serializers/directory_serializer.py 
81
82
83
84
85
def get_url(self, obj):
    """Get url for browsing directory contents."""
    url = self.context["request"].build_absolute_uri()
    new_url = replace_query_path(url, obj["pathname"])
    return new_url

ParentDirectorySerializer#

Bases: BaseDirectorySerializer

Source code in src/apps/files/serializers/directory_serializer.py 
88
89
90
91
92
93
94
95
96
97
98
class ParentDirectorySerializer(BaseDirectorySerializer):
    parent_url = serializers.SerializerMethodField(read_only=True, method_name="get_parent_url")

    def get_parent_url(self, obj):
        """Get url for navigating to parent of current directory."""
        if obj["pathname"] == "/":
            return None
        url = self.context["request"].build_absolute_uri()
        parent_path = "/".join(obj["pathname"].split("/")[:-2]) + "/"
        new_url = replace_query_path(url, parent_path)
        return new_url

get_parent_url(obj) #

Get url for navigating to parent of current directory.

Source code in src/apps/files/serializers/directory_serializer.py 
91
92
93
94
95
96
97
98
def get_parent_url(self, obj):
    """Get url for navigating to parent of current directory."""
    if obj["pathname"] == "/":
        return None
    url = self.context["request"].build_absolute_uri()
    parent_path = "/".join(obj["pathname"].split("/")[:-2]) + "/"
    new_url = replace_query_path(url, parent_path)
    return new_url

DirectorySerializer#

Bases: Serializer

Serializer for directory with subdirectories and files.

Source code in src/apps/files/serializers/directory_serializer.py 
101
102
103
104
105
106
107
108
109
110
111
112
class DirectorySerializer(serializers.Serializer):
    """Serializer for directory with subdirectories and files."""

    directory = ParentDirectorySerializer(default=None)  # directory being viewed
    directories = SubDirectorySerializer(many=True)  # direct child directories
    files = DirectoryFileSerializer(many=True)  # direct child files

    def to_representation(self, instance):
        data = super().to_representation(instance)
        if data["directory"] is None:
            del data["directory"]
        return data