django-filthyfields 2.1.0__tar.gz → 2.2.0__tar.gz

{django_filthyfields-2.1.0/src/django_filthyfields.egg-info → django_filthyfields-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-filthyfields
-Version: 2.1.0
+Version: 2.2.0
 Summary: Tracking dirty fields on a Django model instance.
 License-Expression: BSD-3-Clause
 Project-URL: Homepage, https://github.com/oliverhaas/django-filthyfields
@@ -33,6 +33,6 @@ Dynamic: license-file
 Tracking dirty fields on a Django model instance.
 Dirty means that field in-memory and database values are different.
 
-Started as a fork of [django-dirtyfields](https://github.com/romgar/django-dirtyfields) with a rewritten lazy, descriptor-based implementation; since diverged with its own feature set and release cadence. The mixin and method names (`DirtyFieldsMixin`, `get_dirty_fields`, …) are kept from upstream — hence the play-on-words package name.
+Started as a fork of [django-dirtyfields](https://github.com/romgar/django-dirtyfields) with a rewritten lazy, descriptor-based implementation; since diverged with its own feature set and release cadence. The mixin and method names (`DirtyFieldsMixin`, `get_dirty_fields`, …) are mostly kept from upstream.
 
 See the [documentation](https://oliverhaas.github.io/django-filthyfields/) for more information.

{django_filthyfields-2.1.0 → django_filthyfields-2.2.0}/README.md

@@ -6,6 +6,6 @@
 Tracking dirty fields on a Django model instance.
 Dirty means that field in-memory and database values are different.
 
-Started as a fork of [django-dirtyfields](https://github.com/romgar/django-dirtyfields) with a rewritten lazy, descriptor-based implementation; since diverged with its own feature set and release cadence. The mixin and method names (`DirtyFieldsMixin`, `get_dirty_fields`, …) are kept from upstream — hence the play-on-words package name.
+Started as a fork of [django-dirtyfields](https://github.com/romgar/django-dirtyfields) with a rewritten lazy, descriptor-based implementation; since diverged with its own feature set and release cadence. The mixin and method names (`DirtyFieldsMixin`, `get_dirty_fields`, …) are mostly kept from upstream.
 
 See the [documentation](https://oliverhaas.github.io/django-filthyfields/) for more information.

{django_filthyfields-2.1.0 → django_filthyfields-2.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-filthyfields"
-version = "2.1.0"
+version = "2.2.0"
 description = "Tracking dirty fields on a Django model instance."
 readme = "README.md"
 license = "BSD-3-Clause"

{django_filthyfields-2.1.0 → django_filthyfields-2.2.0/src/django_filthyfields.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-filthyfields
-Version: 2.1.0
+Version: 2.2.0
 Summary: Tracking dirty fields on a Django model instance.
 License-Expression: BSD-3-Clause
 Project-URL: Homepage, https://github.com/oliverhaas/django-filthyfields
@@ -33,6 +33,6 @@ Dynamic: license-file
 Tracking dirty fields on a Django model instance.
 Dirty means that field in-memory and database values are different.
 
-Started as a fork of [django-dirtyfields](https://github.com/romgar/django-dirtyfields) with a rewritten lazy, descriptor-based implementation; since diverged with its own feature set and release cadence. The mixin and method names (`DirtyFieldsMixin`, `get_dirty_fields`, …) are kept from upstream — hence the play-on-words package name.
+Started as a fork of [django-dirtyfields](https://github.com/romgar/django-dirtyfields) with a rewritten lazy, descriptor-based implementation; since diverged with its own feature set and release cadence. The mixin and method names (`DirtyFieldsMixin`, `get_dirty_fields`, …) are mostly kept from upstream.
 
 See the [documentation](https://oliverhaas.github.io/django-filthyfields/) for more information.

{django_filthyfields-2.1.0 → django_filthyfields-2.2.0}/src/filthyfields/__init__.py

@@ -3,10 +3,16 @@
 from importlib.metadata import version
 
 from filthyfields.compare import normalise_value, raw_compare, timezone_support_compare
-from filthyfields.filthyfields import DirtyFieldsMixin, capture_dirty_state, reset_dirty_state
+from filthyfields.filthyfields import (
+    DirtyFieldsMixin,
+    DirtyStateNotCapturedError,
+    capture_dirty_state,
+    reset_dirty_state,
+)
 
 __all__ = [
     "DirtyFieldsMixin",
+    "DirtyStateNotCapturedError",
     "capture_dirty_state",
     "normalise_value",
     "raw_compare",

{django_filthyfields-2.1.0 → django_filthyfields-2.2.0}/src/filthyfields/_descriptor.c

@@ -1,4 +1,4 @@
-/* Generated by Cython 3.2.4 */
+/* Generated by Cython 3.2.5 */
 
 /* BEGIN: Cython Metadata
 {
@@ -34,8 +34,8 @@ END: Cython Metadata */
 #elif PY_VERSION_HEX < 0x03080000
     #error Cython requires Python 3.8+.
 #else
-#define __PYX_ABI_VERSION "3_2_4"
-#define CYTHON_HEX_VERSION 0x030204F0
+#define __PYX_ABI_VERSION "3_2_5"
+#define CYTHON_HEX_VERSION 0x030205F0
 #define CYTHON_FUTURE_DIVISION 1
 /* CModulePreamble */
 #include <stddef.h>
@@ -2760,7 +2760,7 @@ PyObject *__pyx_args, PyObject *__pyx_kwds
   {
     PyObject ** const __pyx_pyargnames[] = {&__pyx_mstate_global->__pyx_n_u_klass,0};
     const Py_ssize_t __pyx_kwds_len = (__pyx_kwds) ? __Pyx_NumKwargs_FASTCALL(__pyx_kwds) : 0;
-    if (unlikely(__pyx_kwds_len) < 0) __PYX_ERR(0, 29, __pyx_L3_error)
+    if (unlikely(__pyx_kwds_len < 0)) __PYX_ERR(0, 29, __pyx_L3_error)
     if (__pyx_kwds_len > 0) {
       switch (__pyx_nargs) {
         case  1:
@@ -2885,7 +2885,7 @@ PyObject *__pyx_args, PyObject *__pyx_kwds
   {
     PyObject ** const __pyx_pyargnames[] = {&__pyx_mstate_global->__pyx_n_u_fn,0};
     const Py_ssize_t __pyx_kwds_len = (__pyx_kwds) ? __Pyx_NumKwargs_FASTCALL(__pyx_kwds) : 0;
-    if (unlikely(__pyx_kwds_len) < 0) __PYX_ERR(0, 33, __pyx_L3_error)
+    if (unlikely(__pyx_kwds_len < 0)) __PYX_ERR(0, 33, __pyx_L3_error)
     if (__pyx_kwds_len > 0) {
       switch (__pyx_nargs) {
         case  1:
@@ -3010,7 +3010,7 @@ PyObject *__pyx_args, PyObject *__pyx_kwds
   {
     PyObject ** const __pyx_pyargnames[] = {&__pyx_mstate_global->__pyx_n_u_fn,0};
     const Py_ssize_t __pyx_kwds_len = (__pyx_kwds) ? __Pyx_NumKwargs_FASTCALL(__pyx_kwds) : 0;
-    if (unlikely(__pyx_kwds_len) < 0) __PYX_ERR(0, 37, __pyx_L3_error)
+    if (unlikely(__pyx_kwds_len < 0)) __PYX_ERR(0, 37, __pyx_L3_error)
     if (__pyx_kwds_len > 0) {
       switch (__pyx_nargs) {
         case  1:
@@ -3135,7 +3135,7 @@ PyObject *__pyx_args, PyObject *__pyx_kwds
   {
     PyObject ** const __pyx_pyargnames[] = {&__pyx_mstate_global->__pyx_n_u_fn,0};
     const Py_ssize_t __pyx_kwds_len = (__pyx_kwds) ? __Pyx_NumKwargs_FASTCALL(__pyx_kwds) : 0;
-    if (unlikely(__pyx_kwds_len) < 0) __PYX_ERR(0, 41, __pyx_L3_error)
+    if (unlikely(__pyx_kwds_len < 0)) __PYX_ERR(0, 41, __pyx_L3_error)
     if (__pyx_kwds_len > 0) {
       switch (__pyx_nargs) {
         case  1:
@@ -3813,7 +3813,7 @@ PyObject *__pyx_args, PyObject *__pyx_kwds
   {
     PyObject ** const __pyx_pyargnames[] = {&__pyx_mstate_global->__pyx_n_u_value,0};
     const Py_ssize_t __pyx_kwds_len = (__pyx_kwds) ? __Pyx_NumKwargs_FASTCALL(__pyx_kwds) : 0;
-    if (unlikely(__pyx_kwds_len) < 0) __PYX_ERR(0, 81, __pyx_L3_error)
+    if (unlikely(__pyx_kwds_len < 0)) __PYX_ERR(0, 81, __pyx_L3_error)
     if (__pyx_kwds_len > 0) {
       switch (__pyx_nargs) {
         case  1:
@@ -3917,7 +3917,7 @@ static int __pyx_pw_12filthyfields_11_descriptor_14DiffDescriptor_1__init__(PyOb
   {
     PyObject ** const __pyx_pyargnames[] = {&__pyx_mstate_global->__pyx_n_u_field,&__pyx_mstate_global->__pyx_n_u_deferred_attr,&__pyx_mstate_global->__pyx_n_u_track_mutations,0};
     const Py_ssize_t __pyx_kwds_len = (__pyx_kwds) ? __Pyx_NumKwargs_VARARGS(__pyx_kwds) : 0;
-    if (unlikely(__pyx_kwds_len) < 0) __PYX_ERR(0, 114, __pyx_L3_error)
+    if (unlikely(__pyx_kwds_len < 0)) __PYX_ERR(0, 114, __pyx_L3_error)
     if (__pyx_kwds_len > 0) {
       switch (__pyx_nargs) {
         case  3:
@@ -5960,7 +5960,7 @@ PyObject *__pyx_args, PyObject *__pyx_kwds
   {
     PyObject ** const __pyx_pyargnames[] = {&__pyx_mstate_global->__pyx_n_u_pyx_state,0};
     const Py_ssize_t __pyx_kwds_len = (__pyx_kwds) ? __Pyx_NumKwargs_FASTCALL(__pyx_kwds) : 0;
-    if (unlikely(__pyx_kwds_len) < 0) __PYX_ERR(1, 16, __pyx_L3_error)
+    if (unlikely(__pyx_kwds_len < 0)) __PYX_ERR(1, 16, __pyx_L3_error)
     if (__pyx_kwds_len > 0) {
       switch (__pyx_nargs) {
         case  1:
@@ -6103,7 +6103,7 @@ PyObject *__pyx_args, PyObject *__pyx_kwds
   {
     PyObject ** const __pyx_pyargnames[] = {&__pyx_mstate_global->__pyx_n_u_pyx_type,&__pyx_mstate_global->__pyx_n_u_pyx_checksum,&__pyx_mstate_global->__pyx_n_u_pyx_state,0};
     const Py_ssize_t __pyx_kwds_len = (__pyx_kwds) ? __Pyx_NumKwargs_FASTCALL(__pyx_kwds) : 0;
-    if (unlikely(__pyx_kwds_len) < 0) __PYX_ERR(1, 4, __pyx_L3_error)
+    if (unlikely(__pyx_kwds_len < 0)) __PYX_ERR(1, 4, __pyx_L3_error)
     if (__pyx_kwds_len > 0) {
       switch (__pyx_nargs) {
         case  3:
@@ -7890,11 +7890,11 @@ __Pyx_PyTuple_FromArray(PyObject *const *src, Py_ssize_t n)
     res = PyTuple_New(n);
     if (unlikely(res == NULL)) return NULL;
     for (i = 0; i < n; i++) {
+        Py_INCREF(src[i]);
         if (unlikely(__Pyx_PyTuple_SET_ITEM(res, i, src[i]) < (0))) {
             Py_DECREF(res);
             return NULL;
         }
-        Py_INCREF(src[i]);
     }
     return res;
 }
@@ -9221,7 +9221,7 @@ bad:
 }
 
 /* dict_iter */
-#if CYTHON_COMPILING_IN_PYPY
+#if CYTHON_AVOID_BORROWED_REFS
 #include <string.h>
 #endif
 static CYTHON_INLINE PyObject* __Pyx_dict_iterator(PyObject* iterable, int is_dict, PyObject* method_name,
@@ -9229,7 +9229,7 @@ static CYTHON_INLINE PyObject* __Pyx_dict_iterator(PyObject* iterable, int is_di
     is_dict = is_dict || likely(PyDict_CheckExact(iterable));
     *p_source_is_dict = is_dict;
     if (is_dict) {
-#if !CYTHON_COMPILING_IN_PYPY
+#if !CYTHON_AVOID_BORROWED_REFS
         *p_orig_length = PyDict_Size(iterable);
         Py_INCREF(iterable);
         return iterable;
@@ -9258,7 +9258,7 @@ static CYTHON_INLINE PyObject* __Pyx_dict_iterator(PyObject* iterable, int is_di
         iterable = __Pyx_PyObject_CallMethod0(iterable, method_name);
         if (!iterable)
             return NULL;
-#if !CYTHON_COMPILING_IN_PYPY
+#if !CYTHON_AVOID_BORROWED_REFS
         if (PyTuple_CheckExact(iterable) || PyList_CheckExact(iterable))
             return iterable;
 #endif
@@ -11427,7 +11427,6 @@ __Pyx_CyFunction_get_is_coroutine_value(__pyx_CyFunctionObject *op) {
         PyList_SET_ITEM(fromlist, 0, marker);
 #else
         if (unlikely(PyList_SetItem(fromlist, 0, marker) < 0)) {
-            Py_DECREF(marker);
             Py_DECREF(fromlist);
             return NULL;
         }
@@ -11668,8 +11667,7 @@ __Pyx_CyFunction_clear(__pyx_CyFunctionObject *m)
     Py_CLEAR(m->func_doc);
     Py_CLEAR(m->func_globals);
     Py_CLEAR(m->func_code);
-#if !CYTHON_COMPILING_IN_LIMITED_API
-#if PY_VERSION_HEX < 0x030900B1
+#if PY_VERSION_HEX < 0x030900B1 || CYTHON_COMPILING_IN_LIMITED_API
     Py_CLEAR(__Pyx_CyFunction_GetClassObj(m));
 #else
     {
@@ -11677,7 +11675,6 @@ __Pyx_CyFunction_clear(__pyx_CyFunctionObject *m)
         ((PyCMethodObject *) (m))->mm_class = NULL;
         Py_XDECREF(cls);
     }
-#endif
 #endif
     Py_CLEAR(m->defaults_tuple);
     Py_CLEAR(m->defaults_kwdict);
@@ -11729,11 +11726,10 @@ static int __Pyx_CyFunction_traverse(__pyx_CyFunctionObject *m, visitproc visit,
     Py_VISIT(m->func_doc);
     Py_VISIT(m->func_globals);
     __Pyx_VISIT_CONST(m->func_code);
-#if !CYTHON_COMPILING_IN_LIMITED_API
     Py_VISIT(__Pyx_CyFunction_GetClassObj(m));
-#endif
     Py_VISIT(m->defaults_tuple);
     Py_VISIT(m->defaults_kwdict);
+    Py_VISIT(m->func_annotations);
     Py_VISIT(m->func_is_coroutine);
     Py_VISIT(m->defaults);
     return 0;
@@ -12708,8 +12704,8 @@ raise_neg_overflow:
 #if CYTHON_VECTORCALL
 static int __Pyx_VectorcallBuilder_AddArg(PyObject *key, PyObject *value, PyObject *builder, PyObject **args, int n) {
     (void)__Pyx_PyObject_FastCallDict;
-    if (__Pyx_PyTuple_SET_ITEM(builder, n, key) != (0)) return -1;
     Py_INCREF(key);
+    if (__Pyx_PyTuple_SET_ITEM(builder, n, key) != (0)) return -1;
     args[n] = value;
     return 0;
 }

{django_filthyfields-2.1.0 → django_filthyfields-2.2.0}/src/filthyfields/filthyfields.py

@@ -23,6 +23,10 @@ if TYPE_CHECKING:
     NormaliseFunction = tuple[Callable[..., Any], dict[str, Any]]
 
 
+class DirtyStateNotCapturedError(RuntimeError):
+    """Raised when pre-save state is read before any save/asave/capture_dirty_state."""
+
+
 def _should_track_field(instance: models.Model, field_name: str, field_attname: str | None = None) -> bool:
     """Apply FIELDS_TO_CHECK / FIELDS_TO_CHECK_EXCLUDE. Accepts both name and attname (e.g. 'fkey'/'fkey_id')."""
     fields_to_check = getattr(instance, "FIELDS_TO_CHECK", None)
@@ -212,8 +216,15 @@ class DirtyFieldsMixin(models.Model, metaclass=_DirtyMeta):
 
     @property
     def was_adding(self) -> bool:
-        """Whether the instance was unsaved before the last ``save()`` / ``capture_dirty_state()``."""
-        return getattr(self, "_was_adding", False)
+        """Whether the instance was unsaved before the last ``save()`` / ``capture_dirty_state()``.
+
+        Raises ``DirtyStateNotCapturedError`` if no save or capture has happened yet.
+        """
+        if "_was_adding" not in self.__dict__:
+            raise DirtyStateNotCapturedError(
+                "was_adding read before any save()/asave()/capture_dirty_state() — nothing has been captured yet.",
+            )
+        return self._was_adding
 
     def _dirty_reset_state(self, fields: Iterable[str] | None = None) -> None:
         """Reset dirty state. ``fields=None`` resets everything; otherwise accepts name or attname."""
@@ -253,15 +264,12 @@ class DirtyFieldsMixin(models.Model, metaclass=_DirtyMeta):
                 if name in current_m2m:
                     self._original_m2m_state[name] = current_m2m[name]
 
-    def save(self, *args: Any, **kwargs: Any) -> None:
-        self._dirty_capture_was_dirty()
+    def save(self, *args: Any, dirty_capture: bool = True, dirty_reset: bool = True, **kwargs: Any) -> None:
+        if dirty_capture:
+            self._dirty_capture_was_dirty()
         super().save(*args, **kwargs)
-        self._dirty_reset_state(fields=kwargs.get("update_fields"))
-
-    async def asave(self, *args: Any, **kwargs: Any) -> None:
-        self._dirty_capture_was_dirty()
-        await super().asave(*args, **kwargs)
-        self._dirty_reset_state(fields=kwargs.get("update_fields"))
+        if dirty_reset:
+            self._dirty_reset_state(fields=kwargs.get("update_fields"))
 
     def refresh_from_db(  # ty: ignore[invalid-method-override]
         self,
@@ -450,20 +458,38 @@ class DirtyFieldsMixin(models.Model, metaclass=_DirtyMeta):
         return result
 
     def was_dirty(self, check_relationship: bool = False, check_m2m: bool = False) -> bool:
+        """Whether any tracked field was dirty before the last save.
+
+        Delegates to :meth:`get_was_dirty_fields`; raises ``DirtyStateNotCapturedError``
+        if no save or capture has happened yet.
+        """
         return bool(self.get_was_dirty_fields(check_relationship=check_relationship, check_m2m=check_m2m))
 
     def get_was_dirty_fields(self, check_relationship: bool = False, check_m2m: bool = False) -> dict[str, Any]:
-        """Fields dirty before the last save (captured by save()/asave())."""
+        """Fields dirty before the last save (captured by save()/asave()).
+
+        Raises ``DirtyStateNotCapturedError`` if no save or capture has happened yet, or
+        if ``check_m2m=True`` is requested but ``ENABLE_M2M_CHECK`` was disabled at the
+        time of the last capture.
+        """
         if check_m2m and not self.ENABLE_M2M_CHECK:
             raise ValueError("You can't check m2m fields if ENABLE_M2M_CHECK is set to False")
 
-        if check_relationship:
-            result = dict(getattr(self, "_was_dirty_fields_rel", {}))
-        else:
-            result = dict(getattr(self, "_was_dirty_fields", {}))
+        if "_was_dirty_fields" not in self.__dict__:
+            raise DirtyStateNotCapturedError(
+                "get_was_dirty_fields() called before any save()/asave()/capture_dirty_state() — "
+                "nothing has been captured yet.",
+            )
+
+        result = dict(self._was_dirty_fields_rel) if check_relationship else dict(self._was_dirty_fields)
 
         if check_m2m:
-            result.update(getattr(self, "_was_dirty_fields_m2m", {}))
+            if "_was_dirty_fields_m2m" not in self.__dict__:
+                raise DirtyStateNotCapturedError(
+                    "check_m2m=True but no M2M state was captured — "
+                    "ENABLE_M2M_CHECK was disabled at the time of the last save/capture.",
+                )
+            result.update(self._was_dirty_fields_m2m)
 
         return result