Skip to content

django_model_service

django_spire.contrib.service.django_model_service

log = logging.getLogger(__name__) module-attribute

TypeDjangoModel_co = TypeVar('TypeDjangoModel_co', bound=Model, covariant=True) module-attribute

BaseDjangoModelService

Bases: BaseDjangoModelConstructor[TypeDjangoModel_co], ABC, Generic[TypeDjangoModel_co]

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(
        next(iter(self.__class__.__annotations__.values()))
    ).split('.')[-1]

    if obj is None:
        return

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

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

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

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

    self.obj: TypeAny = obj

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

    self.__post_init__()

validate_model_obj

Source code in django_spire/contrib/service/django_model_service.py 
54
55
56
57
58
59
60
61
def validate_model_obj(self, **field_data: dict) -> list[str]:
    concrete_fields = self._get_concrete_fields()
    touched_fields = self._get_touched_fields(concrete_fields, **field_data)

    exclude = [field for field in concrete_fields if field not in touched_fields]
    self.obj.full_clean(exclude=exclude)

    return touched_fields

save_model_obj

Source code in django_spire/contrib/service/django_model_service.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
@transaction.atomic
def save_model_obj(self, **field_data: dict) -> tuple[Model, bool]:
    new_model_obj_was_created = False

    if not field_data:
        message = f'Field data is required to save on {self.obj.__class__.__name__}'
        raise ServiceError(message)

    touched_fields = self.validate_model_obj(**field_data)

    if self.model_obj_is_new:
        new_model_obj_was_created = True
        self.obj.save()

    elif touched_fields:
        self.obj.save(update_fields=touched_fields)

    else:
        message = f'{self.obj.__class__.__name__} is not a new object or there was no touched fields to update.'
        log.warning(message)

    return self.obj, new_model_obj_was_created