fix: Fix imports and use relative imports

Author: EnriqueSoria

django_lifecycle/__init__.py

@@ -2,6 +2,7 @@
 __author__ = "Robert Singer"
 __author_email__ = "[email protected]"
 
+from .constants import NotSet
 from .decorators import hook
 from .hooks import AFTER_CREATE
 from .hooks import AFTER_DELETE
@@ -14,11 +15,6 @@
 from .mixins import LifecycleModelMixin
 from .models import LifecycleModel
 
-
-class NotSet(object):
-    pass
-
-
 __all__ = [
     "hook",
     "LifecycleModelMixin",

django_lifecycle/conditions/__init__.py

@@ -5,8 +5,8 @@
 from typing import Iterable
 from typing import Union
 
-from django_lifecycle import NotSet
-from django_lifecycle.conditions.base import ChainableCondition
+from ..constants import NotSet
+from ..conditions.base import ChainableCondition
 
 
 __all__ = [
@@ -25,9 +25,7 @@ class WhenFieldValueWas(ChainableCondition):
     field_name: str
     value: Any = "*"
 
-    def __call__(
-        self, instance: Any, update_fields: Union[Iterable[str], None] = None
-    ) -> bool:
+    def __call__(self, instance: Any, update_fields: Union[Iterable[str], None] = None) -> bool:
         return self.value in (instance.initial_value(self.field_name), "*")
 
 
@@ -36,9 +34,7 @@ class WhenFieldValueIs(ChainableCondition):
     field_name: str
     value: Any = "*"
 
-    def __call__(
-        self, instance: Any, update_fields: Union[Iterable[str], None] = None
-    ) -> bool:
+    def __call__(self, instance: Any, update_fields: Union[Iterable[str], None] = None) -> bool:
         return self.value in (instance._current_value(self.field_name), "*")
 
 
@@ -47,73 +43,47 @@ class WhenFieldHasChanged(ChainableCondition):
     field_name: str
     has_changed: bool | None = None
 
-    def __call__(
-        self, instance: Any, update_fields: Union[Iterable[str], None] = None
-    ) -> bool:
+    def __call__(self, instance: Any, update_fields: Union[Iterable[str], None] = None) -> bool:
         is_partial_fields_update = update_fields is not None
-        is_synced = (
-            is_partial_fields_update is False or self.field_name in update_fields
-        )
+        is_synced = is_partial_fields_update is False or self.field_name in update_fields
         if not is_synced:
             return False
 
-        return self.has_changed is None or self.has_changed == instance.has_changed(
-            self.field_name
-        )
+        return self.has_changed is None or self.has_changed == instance.has_changed(self.field_name)
 
 
 @dataclass
 class WhenFieldValueIsNot(ChainableCondition):
     field_name: str
     value: Any = NotSet
 
-    def __call__(
-        self, instance: Any, update_fields: Union[Iterable[str], None] = None
-    ) -> bool:
-        return (
-            self.value is NotSet
-            or instance._current_value(self.field_name) != self.value
-        )
+    def __call__(self, instance: Any, update_fields: Union[Iterable[str], None] = None) -> bool:
+        return self.value is NotSet or instance._current_value(self.field_name) != self.value
 
 
 @dataclass
 class WhenFieldValueWasNot(ChainableCondition):
     field_name: str
     value: Any = NotSet
 
-    def __call__(
-        self, instance: Any, update_fields: Union[Iterable[str], None] = None
-    ) -> bool:
-        return (
-            self.value is NotSet
-            or instance.initial_value(self.field_name) != self.value
-        )
+    def __call__(self, instance: Any, update_fields: Union[Iterable[str], None] = None) -> bool:
+        return self.value is NotSet or instance.initial_value(self.field_name) != self.value
 
 
 @dataclass
 class WhenFieldValueChangesTo(ChainableCondition):
     field_name: str
     value: Any = NotSet
 
-    def __call__(
-        self, instance: Any, update_fields: Union[Iterable[str], None] = None
-    ) -> bool:
+    def __call__(self, instance: Any, update_fields: Union[Iterable[str], None] = None) -> bool:
         is_partial_fields_update = update_fields is not None
-        is_synced = (
-            is_partial_fields_update is False or self.field_name in update_fields
-        )
+        is_synced = is_partial_fields_update is False or self.field_name in update_fields
         if not is_synced:
             return False
 
-        value_has_changed = bool(
-            instance.initial_value(self.field_name) != self.value
-        )
-        new_value_is_the_expected = bool(
-            instance._current_value(self.field_name) == self.value
-        )
-        return self.value is NotSet or (
-            value_has_changed and new_value_is_the_expected
-        )
+        value_has_changed = bool(instance.initial_value(self.field_name) != self.value)
+        new_value_is_the_expected = bool(instance._current_value(self.field_name) == self.value)
+        return self.value is NotSet or (value_has_changed and new_value_is_the_expected)
 
 
 class Always:

django_lifecycle/conditions/base.py

@@ -7,7 +7,7 @@
 from typing import Iterable
 from typing import Union
 
-from django_lifecycle import types
+from .. import types
 
 
 @dataclass
@@ -28,9 +28,7 @@ def __and__(self, other):
     def __or__(self, other):
         return ChainedCondition(self, other, operator=operator.or_)
 
-    def __call__(
-        self, instance: Any, update_fields: Union[Iterable[str], None] = None
-    ) -> bool:
+    def __call__(self, instance: Any, update_fields: Union[Iterable[str], None] = None) -> bool:
         left_result = self.left(instance, update_fields)
         right_result = self.right(instance, update_fields)
         return self.operator(left_result, right_result)
@@ -45,7 +43,5 @@ def __and__(self, other) -> ChainedCondition:
     def __or__(self, other) -> ChainedCondition:
         return ChainedCondition(self, other, operator=operator.or_)
 
-    def __call__(
-        self, instance: Any, update_fields: Union[Iterable[str], None] = None
-    ) -> bool:
+    def __call__(self, instance: Any, update_fields: Union[Iterable[str], None] = None) -> bool:
         ...

django_lifecycle/conditions/legacy.py

@@ -5,14 +5,14 @@
 from typing import List
 from typing import Optional
 
-from django_lifecycle import NotSet
-from django_lifecycle.conditions.base import ChainableCondition
-from django_lifecycle.conditions import WhenFieldValueChangesTo
-from django_lifecycle.conditions import WhenFieldHasChanged
-from django_lifecycle.conditions import WhenFieldValueIsNot
-from django_lifecycle.conditions import WhenFieldValueIs
-from django_lifecycle.conditions import WhenFieldValueWas
-from django_lifecycle.conditions import WhenFieldValueWasNot
+from ..constants import NotSet
+from ..conditions.base import ChainableCondition
+from ..conditions import WhenFieldValueChangesTo
+from ..conditions import WhenFieldHasChanged
+from ..conditions import WhenFieldValueIsNot
+from ..conditions import WhenFieldValueIs
+from ..conditions import WhenFieldValueWas
+from ..conditions import WhenFieldValueWasNot
 
 
 @dataclass
@@ -26,9 +26,7 @@ class When(ChainableCondition):
     changes_to: Any = NotSet
 
     def __call__(self, instance: Any, update_fields=None) -> bool:
-        has_changed_condition = WhenFieldHasChanged(
-            self.when, has_changed=self.has_changed
-        )
+        has_changed_condition = WhenFieldHasChanged(self.when, has_changed=self.has_changed)
         if not has_changed_condition(instance, update_fields=update_fields):
             return False
 
@@ -78,6 +76,4 @@ def __call__(self, instance: Any, update_fields=None) -> bool:
             )
             for field in self.when_any
         )
-        return any(
-            condition(instance, update_fields=update_fields) for condition in conditions
-        )
+        return any(condition(instance, update_fields=update_fields) for condition in conditions)

django_lifecycle/constants.py

@@ -0,0 +1,2 @@
+class NotSet(object):
+    pass

django_lifecycle/decorators.py

@@ -1,17 +1,18 @@
 from __future__ import annotations
 
 import operator
-from django_lifecycle import types
 from dataclasses import dataclass
 from functools import reduce
 from functools import wraps
 from typing import Any
 from typing import Callable
-from typing import List, Optional
+from typing import List
+from typing import Optional
 
-from django_lifecycle import NotSet
+from . import types
 from .conditions import Always
 from .conditions.legacy import When
+from .constants import NotSet
 from .dataclass_validation import Validations
 from .hooks import VALID_HOOKS
 from .priority import DEFAULT_PRIORITY
@@ -110,8 +111,7 @@ def validate_when_any(self, value, **kwargs):
             return
 
         when_any_error_msg = (
-            "'when_any' hook param must be a list of strings "
-            "matching the names of model fields"
+            "'when_any' hook param must be a list of strings " "matching the names of model fields"
         )
 
         if not isinstance(value, list):
@@ -145,9 +145,7 @@ def validate_on_commit(self, value, **kwargs):
 
     def validate_priority(self, value, **kwargs):
         if self.priority < 0:
-            raise DjangoLifeCycleException(
-                "'priority' hook param must be a positive integer"
-            )
+            raise DjangoLifeCycleException("'priority' hook param must be a positive integer")
 
         return value
 
@@ -159,9 +157,7 @@ def validate_on_commit_only_for_after_hooks(self):
 
     def validate_when_and_when_any(self):
         if self.when is not None and self.when_any is not None:
-            raise DjangoLifeCycleException(
-                "Can pass either 'when' or 'when_any' but not both"
-            )
+            raise DjangoLifeCycleException("Can pass either 'when' or 'when_any' but not both")
 
     def validate_condition_and_legacy_parameters_are_not_combined(self):
         if self.condition is not None and self._legacy_parameters_have_been_passed():

tests/testapp/tests/test_conditions.py

@@ -1,6 +1,6 @@
 from django.test import TestCase
 
-from django_lifecycle import NotSet
+from django_lifecycle.constants import NotSet
 from django_lifecycle.conditions import WhenFieldValueChangesTo
 from django_lifecycle.conditions import WhenFieldHasChanged
 from django_lifecycle.conditions import WhenFieldValueIsNot

tests/testapp/tests/test_mixin.py

@@ -3,7 +3,7 @@
 import django
 from django.test import TestCase
 
-from django_lifecycle import NotSet
+from django_lifecycle.constants import NotSet
 from django_lifecycle.decorators import HookConfig
 from django_lifecycle.priority import DEFAULT_PRIORITY
 from tests.testapp.models import CannotRename
@@ -66,9 +66,7 @@ def test_initial_value_for_fk_model_field(self):
         )
 
         user_account = UserAccount.objects.get()
-        self.assertEqual(
-            user_account.initial_value("organization.name"), "Dunder Mifflin"
-        )
+        self.assertEqual(user_account.initial_value("organization.name"), "Dunder Mifflin")
 
     def test_initial_value_if_field_has_changed(self):
         data = self.stub_data
@@ -100,17 +98,13 @@ def test_current_value_for_watched_fk_model_field(self):
         UserAccount.objects.create(**self.stub_data, organization=org)
         user_account = UserAccount.objects.get()
 
-        self.assertEqual(
-            user_account._current_value("organization.name"), "Dunder Mifflin"
-        )
+        self.assertEqual(user_account._current_value("organization.name"), "Dunder Mifflin")
 
         org.name = "Dwight's Paper Empire"
         org.save()
         user_account._clear_watched_fk_model_cache()
 
-        self.assertEqual(
-            user_account._current_value("organization.name"), "Dwight's Paper Empire"
-        )
+        self.assertEqual(user_account._current_value("organization.name"), "Dwight's Paper Empire")
 
     def test_run_hooked_methods_for_when(self):
         instance = UserAccount(first_name="Bob")
@@ -338,19 +332,15 @@ def test_changes_to_condition_should_pass(self):
         data = self.stub_data
         UserAccount.objects.create(**data)
         user_account = UserAccount.objects.get()
-        with self.assertRaises(
-            CannotRename, msg="Oh, not Flanders. Anybody but Flanders."
-        ):
+        with self.assertRaises(CannotRename, msg="Oh, not Flanders. Anybody but Flanders."):
             user_account.last_name = "Flanders"
             user_account.save()
 
     def test_changes_to_condition_included_in_update_fields_should_fire_hook(self):
         user_account = UserAccount.objects.create(**self.stub_data)
         user_account.first_name = "Flanders"
         user_account.last_name = "Flanders"
-        with self.assertRaises(
-            CannotRename, msg="Oh, not Flanders. Anybody but Flanders."
-        ):
+        with self.assertRaises(CannotRename, msg="Oh, not Flanders. Anybody but Flanders."):
             user_account.last_name = "Flanders"
             user_account.save(update_fields=["last_name"])
 
@@ -360,9 +350,7 @@ def test_changes_to_condition_not_included_in_update_fields_should_not_fire_hook
         user_account = UserAccount.objects.create(**self.stub_data)
         user_account.first_name = "Flanders"
         user_account.last_name = "Flanders"
-        user_account.save(
-            update_fields=["first_name"]
-        )  # `CannotRename` exception is not raised
+        user_account.save(update_fields=["first_name"])  # `CannotRename` exception is not raised
 
         user_account.refresh_from_db()
         self.assertEqual(user_account.first_name, "Flanders")
@@ -486,9 +474,7 @@ def test_run_hooked_methods_for_on_commit(self):
                 ),
                 MagicMock(
                     __name__="after_save_method_that_fires_if_changed_on_commit",
-                    _hooked=[
-                        HookConfig(hook="after_save", has_changed=True, on_commit=True)
-                    ],
+                    _hooked=[HookConfig(hook="after_save", has_changed=True, on_commit=True)],
                 ),
             ]
         )