Skip to content

mixins

django_spire.file.mixins

FileModelMixin

Bases: Model

files = GenericRelation(File, editable=False) class-attribute instance-attribute

Meta

abstract = True class-attribute instance-attribute

copy_files_to

Source code in django_spire/file/mixins.py 
25
26
def copy_files_to(self, target: models.Model) -> list[File]:
    return copy_files_to_instance(self.files.active(), target)

FileProcessorServiceMixin

extract_single_file staticmethod

Source code in django_spire/file/mixins.py 
30
31
32
@staticmethod
def extract_single_file(files: MultiValueDict) -> InMemoryUploadedFile | None:
    return next(iter(files.values()), None)

extract_multiple_files staticmethod

Source code in django_spire/file/mixins.py 
34
35
36
37
38
39
40
41
@staticmethod
def extract_multiple_files(files: MultiValueDict) -> list[InMemoryUploadedFile]:
    result = []

    for field_name in files:
        result.extend(files.getlist(field_name))

    return result

add_file

Source code in django_spire/file/mixins.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
def add_file(
    self,
    file: InMemoryUploadedFile,
    related_field: str = '',
    validator: FileValidator | None = None,
) -> File:
    handler = SingleFileHandler.for_related_field(
        related_field,
        validator=validator,
        app_name=self._get_app_name(),
    )

    return handler.add(file, self.obj)

replace_file

Source code in django_spire/file/mixins.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
def replace_file(
    self,
    data: dict | InMemoryUploadedFile | None,
    related_field: str = '',
    validator: FileValidator | None = None,
) -> File | None:
    handler = SingleFileHandler.for_related_field(
        related_field,
        validator=validator,
        app_name=self._get_app_name(),
    )

    return handler.replace(data, self.obj)

add_files

Source code in django_spire/file/mixins.py 
82
83
84
85
86
87
88
89
90
91
92
93
94
def add_files(
    self,
    files: list[InMemoryUploadedFile],
    related_field: str = '',
    validator: FileValidator | None = None,
) -> list[File]:
    handler = MultiFileHandler.for_related_field(
        related_field,
        validator=validator,
        app_name=self._get_app_name(),
    )

    return handler.add_many(files, self.obj)

replace_files

Source code in django_spire/file/mixins.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def replace_files(
    self,
    data: list[dict] | list[InMemoryUploadedFile] | None,
    related_field: str = '',
    validator: FileValidator | None = None,
) -> list[File]:
    handler = MultiFileHandler.for_related_field(
        related_field,
        validator=validator,
        app_name=self._get_app_name(),
    )

    return handler.replace(data, self.obj)

delete_file

Source code in django_spire/file/mixins.py 
110
111
112
113
114
115
116
def delete_file(self, file_id: int, related_field: str = '') -> bool:
    handler = SingleFileHandler.for_related_field(
        related_field,
        app_name=self._get_app_name(),
    )

    return handler.remove(file_id, self.obj)

delete_files

Source code in django_spire/file/mixins.py 
118
119
120
121
122
123
124
def delete_files(self, related_field: str = '') -> int:
    handler = MultiFileHandler.for_related_field(
        related_field,
        app_name=self._get_app_name(),
    )

    return handler.remove_all(self.obj)