Skip to content

factory_service

django_spire.knowledge.entry.version.block.services.factory_service

EntryVersionBlockFactoryService

Bases: BaseDjangoModelService['EntryVersionBlock']

Source code in django_spire/contrib/constructor/constructor.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def __init__(self, obj: Any = None):
    self._obj_type_name: str = str(
        list(self.__class__.__annotations__.values())[0]
    ).split('.')[-1]

    if obj is None:
        return

    self._obj_mro_type_names = [cls.__name__ for cls in obj.__class__.__mro__]

    if not self._obj_type_name in self._obj_mro_type_names:
        raise ConstructorException(
            f'{self.__class__.__name__} was instantiated with obj type "{obj.__class__.__name__}" and failed as it was expecting "{self._obj_type_name}".'
        )

    self._obj_type: type[TypeAny] = obj.__class__

    if self._obj_type is None or self._obj_type is ...:
        raise ConstructorException(
            f'{self.__class__.__name__} top class attribute must have an annotated type.')

    self.obj: TypeAny = obj

    if ABC not in self.__class__.__bases__:
        if not self._obj_is_valid:
            raise ConstructorException(f'{self._obj_type_name} failed to validate on {self.__class__.__name__}')

    self.__post_init__()

obj instance-attribute

create_blank_block

Source code in django_spire/knowledge/entry/version/block/services/factory_service.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def create_blank_block(
        self,
        entry_version: EntryVersion,
        block_type: BlockTypeChoices,
        order: int,
        **kwargs
) -> EntryVersionBlock:
    self.obj = self.obj_class(
        version=entry_version,
        type=block_type,
        order=order,
    )
    self.obj.block = ENTRY_BLOCK_MAP[block_type](
        value='',
        type=block_type,
        **kwargs
    )
    self.obj.save()

    self.obj.ordering_services.processor.move_to_position(
        destination_objects=(
            self.obj_class.objects
            .active()
            .by_version_id(entry_version_id=entry_version.id)
        ),
        position=order,
    )

    return self.obj

create_blocks_from_file

Source code in django_spire/knowledge/entry/version/block/services/factory_service.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
def create_blocks_from_file(
        self,
        file: File,
        entry_version: EntryVersion
) -> list[EntryVersionBlock]:
    if file.type not in FILE_TYPE_CONVERTER_MAP:
        return []

    converter = FILE_TYPE_CONVERTER_MAP[file.type](entry_version=entry_version)

    return self.obj_class.objects.bulk_create(
        converter.convert_file_to_blocks(file=file)
    )

create_null_block

Source code in django_spire/knowledge/entry/version/block/services/factory_service.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def create_null_block(
        self,
        entry_version: EntryVersion,
        block_type: BlockTypeChoices,
        order: int,
        value: str,
        **kwargs,
):
    self.obj = self.obj_class(
        version=entry_version,
        type=block_type,
        order=order
    )
    block = ENTRY_BLOCK_MAP[block_type](
        type=block_type,
        value=value,
        **kwargs
    )
    self.obj.block = block
    return self.obj