Skip to content

tool_service

django_spire.knowledge.entry.services.tool_service

EntryToolService

Bases: BaseDjangoModelService['Entry']

Source code in django_spire/contrib/constructor/constructor.py
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

get_files_to_convert

Source code in django_spire/knowledge/entry/services/tool_service.py
def get_files_to_convert(self) -> QuerySet[File]:
    return (
        File.objects.related_field(field_name=ENTRY_IMPORT_RELATED_FIELD)
        .filter(content_type=ContentType.objects.get_for_model(self.obj_class))
        .active()
        .order_by('object_id')
    )

get_files_to_convert_json

Source code in django_spire/knowledge/entry/services/tool_service.py
def get_files_to_convert_json(self) -> str:
    return json.dumps(
        [
            {
                'id': file_object.id,
                'name': file_object.name,
                'type': file_object.type,
                'size': file_object.size,
            }
            for file_object in self.get_files_to_convert()
        ]
    )