django-spire 0.24.1__py3-none-any.whl → 0.24.2__py3-none-any.whl

django_spire/consts.py

@@ -1,4 +1,4 @@
-__VERSION__ = '0.24.1'
+__VERSION__ = '0.24.2'
 
 MAINTENANCE_MODE_SETTINGS_NAME = 'MAINTENANCE_MODE'
 

django_spire/contrib/service/django_model_service.py

@@ -3,15 +3,18 @@ from __future__ import annotations
 import logging
 
 from abc import ABC
+from itertools import chain
 from typing import Generic, TypeVar
 
+from django.contrib.contenttypes.fields import GenericForeignKey
 from django.db import transaction
-from django.db.models import Model
+from django.db.models import Model, Field, AutoField, ForeignObjectRel, FileField
 
 from django_spire.contrib.constructor.django_model_constructor import BaseDjangoModelConstructor
 from django_spire.contrib.service.exceptions import ServiceError
 
 
+
 log = logging.getLogger(__name__)
 
 TypeDjangoModel_co = TypeVar('TypeDjangoModel_co', bound=Model, covariant=True)
@@ -22,63 +25,78 @@ class BaseDjangoModelService(
     ABC,
     Generic[TypeDjangoModel_co]
 ):
-    def _get_concrete_fields(self) -> dict:
-        return {
-            field.name: field
-            for field in self.obj._meta.get_fields()
-            if field.concrete and not field.many_to_many and not field.one_to_many
-        }
-
-    def _get_touched_fields(self, concrete_fields: dict, **field_data: dict) -> list[str]:
-        foreign_key_id_aliases = {f"{name}_id" for name, field in concrete_fields.items() if field.many_to_one}
-        allowed = set(concrete_fields) | foreign_key_id_aliases
-
-        touched_fields: list[str] = []
-
-        for field, value in field_data.items():
-            if field not in allowed:
-                log.warning(f'Field {field!r} is not valid for {self.obj.__class__.__name__}')
-                continue
+    def _set_non_m2m_fields(self, **field_data: dict):
+        model_fields = self.obj._meta.fields
 
-            model_field = concrete_fields.get(field.removesuffix("_id"), None)
+        file_field_list = []
+        updated_fields = []
 
-            if model_field and (getattr(model_field, 'auto_created', False) or not model_field.editable):
+        for field in model_fields:
+            if isinstance(field, AutoField) or field.name not in field_data:
                 continue
 
-            setattr(self.obj, field, value)
-
-            touched_fields.append(field.removesuffix('_id'))
-
-        return touched_fields
-
-    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)
+            # Defer saving file-type fields until after the other fields, so a
+            # callable upload_to can use the values from other fields (from django's construct_instance).
+            if isinstance(field, FileField):
+                file_field_list.append(field)
+                updated_fields.append(field.name)
+            else:
+                field.save_form_data(self.obj, field_data[field.name])
+                updated_fields.append(field.name)
+
+        # Update foreign key id aliases in field_data for
+        # related fields that weren't already updated above
+        foreign_key_id_aliases = [
+            f"{field.name}_id" for field in model_fields
+            if f"{field.name}_id" in field_data and field.many_to_one and field.name not in updated_fields
+        ]
+
+        for field_name in foreign_key_id_aliases:
+            setattr(self.obj, field_name, field_data[field_name])
+
+        # Update file fields deferred from earlier
+        for field in file_field_list:
+            field.save_form_data(self.obj, field_data[field.name])
+
+    def _set_m2m_fields(self, **field_data):
+        model_meta = self.obj._meta
+
+        for field in chain(model_meta.many_to_many, model_meta.private_fields):
+            if not hasattr(field, "save_form_data"):
+                continue
+            if field.name in field_data:
+                field.save_form_data(self.obj, field_data[field.name])
 
-        exclude = [field for field in concrete_fields if field not in touched_fields]
-        self.obj.full_clean(exclude=exclude)
+    @transaction.atomic
+    def save_model_obj(self, **field_data: dict | None) -> tuple[Model, bool]:
+        """
+        This is the core service method for saving a Django model object with field data provided via kwargs.
+        It will update the object with the given kwargs and handle any upstream attribute changes that were applied
+        directly to the model instance (i.e. it can also be called without any kwargs, similar to `Model.save()`).
 
-        return touched_fields
+        Its purpose is to run extra operations related to the model instance that need to run each time
+        the model is saved - it is meant to replace the need for overriding `BaseModelForm.save()` or `Model.save()`.
 
-    @transaction.atomic
-    def save_model_obj(self, **field_data: dict) -> tuple[Model, bool]:
-        new_model_obj_was_created = False
+        It is designed to emulate django's `BaseModelForm.save()` method as close as possible:
+        first, in `_set_non_m2m_fields`, it updates the fields on `self.obj` using logic similar to `django.forms.models.construct_instance`,
+        then it calls self.obj.save(), then updates the m2m fields on the object instance
+        using logic similar to django's `BaseModelForm._save_m2m()` method. In all cases,
+        it treats the incoming `field_data` exactly the same as `cleaned_data` is treated
+        in the django code that it is emulating, and therefore does not perform any validation 
+        on the data or the model instance as it is assumed that field_data has already been validated upstream.
 
-        if not field_data:
-            message = f'Field data is required to save on {self.obj.__class__.__name__}'
-            raise ServiceError(message)
+        Args:
+            **field_data:
 
-        touched_fields = self.validate_model_obj(**field_data)
+        Returns:
+            tuple[Model, bool]
 
-        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)
+        new_model_obj_was_created = True if self.model_obj_is_new else False
 
-        else:
-            message = f'{self.obj.__class__.__name__} is not a new object or there was no touched fields to update.'
-            log.warning(message)
+        self._set_non_m2m_fields(**field_data)
+        self.obj.save()
+        self._set_m2m_fields(**field_data)
 
         return self.obj, new_model_obj_was_created

django_spire/contrib/service/tests/test_service.py

@@ -37,66 +37,26 @@ class TestBaseDjangoModelService(TestCase):
             password='testpass'  # noqa: S106
         )
 
-    def test_get_concrete_fields_returns_dict(self) -> None:
+    def test_set_non_m2m_fields_sets_attribute(self) -> None:
         service = UserService(self.user)
-
-        result = service._get_concrete_fields()
-
-        assert isinstance(result, dict)
-        assert 'username' in result
-        assert 'email' in result
-
-    def test_get_touched_fields_returns_list(self) -> None:
-        service = UserService(self.user)
-        concrete_fields = service._get_concrete_fields()
-
-        result = service._get_touched_fields(concrete_fields, username='newuser')
-
-        assert isinstance(result, list)
-
-    def test_get_touched_fields_sets_attribute(self) -> None:
-        service = UserService(self.user)
-        concrete_fields = service._get_concrete_fields()
-
-        service._get_touched_fields(concrete_fields, first_name='NewName')
+        service._set_non_m2m_fields(first_name='NewName')
 
         assert service.obj.first_name == 'NewName'
 
-    def test_get_touched_fields_logs_warning_for_invalid_field(self) -> None:
-        service = UserService(self.user)
-        concrete_fields = service._get_concrete_fields()
-
-        with patch('django_spire.contrib.service.django_model_service.log') as mock_log:
-            service._get_touched_fields(concrete_fields, invalid_field='value')
-
-            mock_log.warning.assert_called_once()
+    def test_set_non_m2m_fields_skips_auto_created_fields(self) -> None:
+        UserService(self.user)._set_non_m2m_fields(id=999)
 
-    def test_get_touched_fields_skips_auto_created_fields(self) -> None:
-        service = UserService(self.user)
-        concrete_fields = service._get_concrete_fields()
+        assert self.user.id != 999
 
-        result = service._get_touched_fields(concrete_fields, id=999)
+    def test_has_set_non_m2m_fields_method(self) -> None:
+        assert hasattr(BaseDjangoModelService, '_set_non_m2m_fields')
 
-        assert 'id' not in result
-
-    def test_has_get_concrete_fields_method(self) -> None:
-        assert hasattr(BaseDjangoModelService, '_get_concrete_fields')
-
-    def test_has_get_touched_fields_method(self) -> None:
-        assert hasattr(BaseDjangoModelService, '_get_touched_fields')
+    def test_has_set_m2m_fields_method(self) -> None:
+        assert hasattr(BaseDjangoModelService, '_set_m2m_fields')
 
     def test_has_save_model_obj_method(self) -> None:
         assert hasattr(BaseDjangoModelService, 'save_model_obj')
 
-    def test_has_validate_model_obj_method(self) -> None:
-        assert hasattr(BaseDjangoModelService, 'validate_model_obj')
-
-    def test_save_model_obj_raises_error_without_field_data(self) -> None:
-        service = UserService(self.user)
-
-        with pytest.raises(ServiceError, match='Field data is required'):
-            service.save_model_obj()
-
     def test_save_model_obj_returns_tuple(self) -> None:
         service = UserService(self.user)
 
@@ -130,24 +90,11 @@ class TestBaseDjangoModelService(TestCase):
         assert created is True
         assert obj.pk is not None
 
-    def test_save_model_obj_logs_warning_when_no_changes(self) -> None:
+    def test_save_model_updates_obj_with_previous_changes(self) -> None:
         service = UserService(self.user)
 
-        with patch('django_spire.contrib.service.django_model_service.log') as mock_log:
-            service.save_model_obj(id=self.user.id)
+        service.obj.first_name = 'new_test'
 
-            mock_log.warning.assert_called_once()
-
-    def test_validate_model_obj_returns_touched_fields(self) -> None:
-        service = UserService(self.user)
-
-        result = service.validate_model_obj(first_name='Valid')
-
-        assert isinstance(result, list)
-        assert 'first_name' in result
-
-    def test_validate_model_obj_raises_validation_error(self) -> None:
-        service = UserService(self.user)
+        service.save_model_obj(id=self.user.id)
 
-        with pytest.raises(ValidationError):
-            service.validate_model_obj(email='invalid-email')
+        assert service.obj.first_name == 'new_test'

{django_spire-0.24.1.dist-info → django_spire-0.24.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-spire
-Version: 0.24.1
+Version: 0.24.2
 Summary: A project for Django Spire
 Author-email: Brayden Carlson <braydenc@stratusadv.com>, Nathan Johnson <nathanj@stratusadv.com>
 License: Copyright (c) 2025 Stratus Advanced Technologies and Contributors.

{django_spire-0.24.1.dist-info → django_spire-0.24.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
 django_spire/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 django_spire/conf.py,sha256=3oUB1mtgHRjvbJsxfQWG5uL1KUP9uGig3zdP2dZphe8,942
-django_spire/consts.py,sha256=A90ILXVJYixu3zNw9XSF3jhA9gKjIBnK88lrRZkpHRw,171
+django_spire/consts.py,sha256=biDSV-Uptfgm170WiJVdnjKxxa_xLSNHvUOESbiBmAY,171
 django_spire/exceptions.py,sha256=M7buFvm-K4lK09pH5fVcZ-MxsDIzdpEJBF33Xss5bSw,289
 django_spire/settings.py,sha256=Pr98O2Na5Cv9YXs5y8c2CvGYv1szmXED8RJVT5q2-W4,1164
 django_spire/urls.py,sha256=wQx6R-nXx69MeOF-WmDxcEUM5WmUHGplbY5uZ_HnDp8,703
@@ -463,10 +463,10 @@ django_spire/contrib/seeding/tests/test_enums.py,sha256=tpysk3dKDtOXfD-0ebqSTBba
 django_spire/contrib/seeding/tests/test_intel.py,sha256=Hi6Jr91nBIPoLGt4KtRZO4-uGq5gTCMltJ8tHMgDCUs,980
 django_spire/contrib/seeding/tests/test_override.py,sha256=8eliLQBsQ7n1-ARqXLQdZOcrWDD8XhWfYoc_iaDaktM,1843
 django_spire/contrib/service/__init__.py,sha256=EB44rklqr317T2tDXDW5qocfQDE7b4f2UFjf7DAWj-0,215
-django_spire/contrib/service/django_model_service.py,sha256=gky7mEqKw1s7YNa2y2IhlKefBABIZAb_R1QmDVPHqfI,2824
+django_spire/contrib/service/django_model_service.py,sha256=yQyNQZMfidRQKwDcPyXydF0yBSNIG1iSzEuJi-KKRXE,4188
 django_spire/contrib/service/exceptions.py,sha256=nIfh1kjeCN94eZE12zR4cGtvn3xKC2WAr_1KVakU28E,138
 django_spire/contrib/service/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-django_spire/contrib/service/tests/test_service.py,sha256=p1d_L4P5TcPlD_imFHWmBMoToU-vJY4RGUrLxqbXhRE,5094
+django_spire/contrib/service/tests/test_service.py,sha256=BlRY-UgQtZwylTj6nderZ-NjKB4Kj9o1iL4zWbGzKhw,3077
 django_spire/contrib/session/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 django_spire/contrib/session/apps.py,sha256=zrDjGlxth4TvLZel-CSGt-CQa-S8Xs92sM-uq5m7d58,257
 django_spire/contrib/session/controller.py,sha256=4kOTDw4URLy3pCBWqWfwuOKEHzpjNT6iKVDU8-uH7Zk,3022
@@ -1401,8 +1401,8 @@ django_spire/theme/urls/page_urls.py,sha256=Oak3x_xwQEb01NKdrsB1nk6yPaOEnheuSG1m
 django_spire/theme/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 django_spire/theme/views/json_views.py,sha256=PWwVTaty0BVGbj65L5cxex6JNhc-xVAI_rEYjbJWqEM,1893
 django_spire/theme/views/page_views.py,sha256=WenjOa6Welpu3IMolY56ZwBjy4aK9hpbiMNuygjAl1A,3922
-django_spire-0.24.1.dist-info/licenses/LICENSE.md,sha256=ZAeCT76WvaoEZE9xPhihyWjTwH0wQZXQmyRsnV2VPFs,1091
-django_spire-0.24.1.dist-info/METADATA,sha256=5NmKsUBFFIY13Mj1ET72NddFFiKxCMfZ32oPCjE4Nt0,5127
-django_spire-0.24.1.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
-django_spire-0.24.1.dist-info/top_level.txt,sha256=xf3QV1e--ONkVpgMDQE9iqjQ1Vg4--_6C8wmO-KxPHQ,13
-django_spire-0.24.1.dist-info/RECORD,,
+django_spire-0.24.2.dist-info/licenses/LICENSE.md,sha256=ZAeCT76WvaoEZE9xPhihyWjTwH0wQZXQmyRsnV2VPFs,1091
+django_spire-0.24.2.dist-info/METADATA,sha256=pVb0KnuCc5tuu28_0UqjZvt-NySVfnujEs7V4TFYbRQ,5127
+django_spire-0.24.2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+django_spire-0.24.2.dist-info/top_level.txt,sha256=xf3QV1e--ONkVpgMDQE9iqjQ1Vg4--_6C8wmO-KxPHQ,13
+django_spire-0.24.2.dist-info/RECORD,,

{django_spire-0.24.1.dist-info → django_spire-0.24.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.10.1)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any