Skip to content

interfaces

django_spire.file.interfaces

FileFormatter dataclass

file instance-attribute

related_field = None class-attribute instance-attribute

name = ... class-attribute instance-attribute

type = ... class-attribute instance-attribute

app_name = 'Uncategorized' class-attribute instance-attribute

location property

__post_init__

Source code in django_spire/file/interfaces.py 
26
27
28
def __post_init__(self):
    self.name = self._format_name()
    self.type = self._parse_type()

null_file_obj

Source code in django_spire/file/interfaces.py 
40
41
42
43
44
45
46
47
def null_file_obj(self) -> File:
    return File(
        file=self.file,
        name=self.name,
        size=self.size_verbose(),
        type=self.type,
        related_field=self.related_field
    )

size_verbose

Source code in django_spire/file/interfaces.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def size_verbose(self) -> str:
    if self.file.size < 512000:
        value = round(self.file.size / 1000, 2)
        ext = ' kb'
    elif self.file.size < 512000 * 1000:
        value = round(self.file.size / 1000000, 2)
        ext = ' Mb'
    elif self.file.size < 512000 * 1000 * 1000:
        value = round(self.file.size / 1000000000, 2)
        ext = ' Gb'
    else:
        value = ''
        ext = '>1.00 Tb'

    return str(value) + ext

FileContentObjectFormatter dataclass

Bases: FileFormatter

content_object = ... class-attribute instance-attribute

location property

null_file_obj

Source code in django_spire/file/interfaces.py 
74
75
76
77
78
79
80
81
82
83
def null_file_obj(self) -> File:
    return File(
        content_type=ContentType.objects.get_for_model(self.content_object),
        object_id=self.content_object.id,
        file=self.file,
        name=self.name,
        size=self.size_verbose(),
        type=self.type,
        related_field=self.related_field
    )

FileUploader dataclass

Bases: ABC

related_field instance-attribute

null_file_obj

Source code in django_spire/file/interfaces.py 
90
91
92
def null_file_obj(self, file):
    formatted_file = FileFormatter(file, self.related_field)
    return formatted_file.null_file_obj()

upload abstractmethod

Source code in django_spire/file/interfaces.py 
94
95
96
@abstractmethod
def upload(self, *args, **kwargs) -> None:
    raise NotImplementedError

upload_from_form_field abstractmethod

Source code in django_spire/file/interfaces.py 
 98
 99
100
@abstractmethod
def upload_from_form_field(self, *args, **kwargs) -> None:
    raise NotImplementedError

SingleFileUploader dataclass

Bases: FileUploader

upload

Source code in django_spire/file/interfaces.py 
105
106
107
108
def upload(self, file: InMemoryUploadedFile) -> File:
    file = self.null_file_obj(file)
    file.save()
    return file

delete_old_files

Source code in django_spire/file/interfaces.py 
110
111
112
113
114
115
116
117
def delete_old_files(self, content_object: FileModelMixin):
    old_files = content_object.files.active().related_field(self.related_field)

    for file in old_files:
        file.is_deleted = True
        file.is_active = False

    File.objects.bulk_update(old_files, ['is_active', 'is_deleted'])

upload_from_form_field

Source code in django_spire/file/interfaces.py 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
def upload_from_form_field(
    self,
    form_data,
    content_object: FileModelMixin
) -> File:
    try:
        return content_object.files.get(id=form_data['id'])
    except ObjectDoesNotExist:
        self.delete_old_files(content_object)
        file = File.objects.get(id=form_data['id'])
        file.content_type = ContentType.objects.get_for_model(content_object.__class__)
        file.object_id = content_object.id
        file.related_field = self.related_field
        return file.save()

MultiFileUploader dataclass

Bases: FileUploader

upload

Source code in django_spire/file/interfaces.py 
137
138
139
def upload(self, files: list[InMemoryUploadedFile]) -> list[File]:
    files_to_upload = [self.null_file_obj(file) for file in files]
    return File.objects.bulk_create(files_to_upload)

upload_from_form_field

Source code in django_spire/file/interfaces.py 
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
def upload_from_form_field(
    self,
    form_data: list[dict],
    content_object: FileModelMixin
) -> list[File]:
    file_ids = [file['id'] for file in form_data]

    # Delete files that are no longer in the form data
    old_files = (
        content_object
        .files
        .active()
        .related_field(self.related_field)
        .exclude(id__in=file_ids)
    )

    for old_file in old_files:
        old_file.is_deleted = True
        old_file.is_active = False

    File.objects.bulk_update(old_files, ['is_active', 'is_deleted'])

    link_files = File.objects.filter(id__in=file_ids, object_id__isnull=True)
    content_type = ContentType.objects.get_for_model(content_object.__class__)

    for link_file in link_files:
        link_file.content_type = content_type
        link_file.object_id = content_object.id
        link_file.related_field = self.related_field

    File.objects.bulk_update(
        link_files,
        fields=['content_type', 'object_id', 'related_field']
    )

    return content_object.files.active().related_field(self.related_field)