Skip to content

linker

django_spire.file.linker

FileLinker dataclass

related_field = '' class-attribute instance-attribute

__post_init__

Source code in django_spire/file/linker.py 
20
21
22
23
def __post_init__(self) -> None:
    if len(self.related_field) > RELATED_FIELD_LENGTH_MAX:
        message = f'related_field must not exceed {RELATED_FIELD_LENGTH_MAX} characters.'
        raise ValueError(message)
Source code in django_spire/file/linker.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def link(self, file_obj: File, instance: models.Model) -> File:
    if instance.pk is None:
        message = 'Cannot link a file to an unsaved model instance.'
        raise FileLinkError(message)

    content_type = ContentType.objects.get_for_model(instance)

    file_obj.content_type = content_type
    file_obj.object_id = instance.pk
    file_obj.related_field = self.related_field
    file_obj.is_active = True
    file_obj.is_deleted = False
    file_obj.save()

    return file_obj
Source code in django_spire/file/linker.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def link_many(self, file_objects: list[File], instance: models.Model) -> None:
    if not file_objects:
        return

    if instance.pk is None:
        message = 'Cannot link files to an unsaved model instance.'
        raise FileLinkError(message)

    content_type = ContentType.objects.get_for_model(instance)

    for file_obj in file_objects:
        file_obj.content_type = content_type
        file_obj.object_id = instance.pk
        file_obj.related_field = self.related_field
        file_obj.is_active = True
        file_obj.is_deleted = False

    File.objects.bulk_update(
        file_objects,
        ['content_type', 'object_id', 'related_field', 'is_active', 'is_deleted'],
    )
Source code in django_spire/file/linker.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def unlink_existing(self, instance: models.Model) -> int:
    if instance.pk is None:
        message = 'Cannot unlink files from an unsaved model instance.'
        raise FileLinkError(message)

    content_type = ContentType.objects.get_for_model(instance)

    return (
        File.objects
        .active()
        .filter(content_type=content_type, object_id=instance.pk)
        .related_field(self.related_field)
        .update(is_active=False, is_deleted=True)
    )
Source code in django_spire/file/linker.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def unlink_except(self, instance: models.Model, keep_ids: list[int]) -> int:
    if instance.pk is None:
        message = 'Cannot unlink files from an unsaved model instance.'
        raise FileLinkError(message)

    content_type = ContentType.objects.get_for_model(instance)

    return (
        File.objects
        .active()
        .filter(content_type=content_type, object_id=instance.pk)
        .related_field(self.related_field)
        .exclude(id__in=keep_ids)
        .update(is_active=False, is_deleted=True)
    )