Changed the order of some util functions

Author: ddabble

simple_history/tests/tests/test_utils.py

@@ -10,7 +10,17 @@
 from django.utils import timezone
 
 from simple_history.exceptions import AlternativeManagerError, NotHistoricalModelError
-from simple_history.tests.models import (
+from simple_history.utils import (
+    bulk_create_with_history,
+    bulk_update_with_history,
+    get_history_manager_for_model,
+    get_history_model_for_model,
+    get_m2m_field_name,
+    get_m2m_reverse_field_name,
+    update_change_reason,
+)
+
+from ..models import (
     BulkCreateManyToManyModel,
     Document,
     Place,
@@ -28,19 +38,21 @@
     PollWithUniqueQuestion,
     Street,
 )
-from simple_history.utils import (
-    bulk_create_with_history,
-    bulk_update_with_history,
-    get_history_manager_for_model,
-    get_history_model_for_model,
-    get_m2m_field_name,
-    get_m2m_reverse_field_name,
-    update_change_reason,
-)
 
 User = get_user_model()
 
 
+class UpdateChangeReasonTestCase(TestCase):
+    def test_update_change_reason_with_excluded_fields(self):
+        poll = PollWithExcludeFields(
+            question="what's up?", pub_date=timezone.now(), place="The Pub"
+        )
+        poll.save()
+        update_change_reason(poll, "Test change reason.")
+        most_recent = poll.history.order_by("-history_date").first()
+        self.assertEqual(most_recent.history_change_reason, "Test change reason.")
+
+
 class GetM2MFieldNamesTestCase(unittest.TestCase):
     def test__get_m2m_field_name__returns_expected_value(self):
         def field_names(model):
@@ -629,14 +641,3 @@ def test_bulk_manager_with_custom_model_attributes(self):
             PollWithHistoricalSessionAttr.history.filter(session="co-op").count(),
             5,
         )
-
-
-class UpdateChangeReasonTestCase(TestCase):
-    def test_update_change_reason_with_excluded_fields(self):
-        poll = PollWithExcludeFields(
-            question="what's up?", pub_date=timezone.now(), place="The Pub"
-        )
-        poll.save()
-        update_change_reason(poll, "Test change reason.")
-        most_recent = poll.history.order_by("-history_date").first()
-        self.assertEqual(most_recent.history_change_reason, "Test change reason.")

simple_history/utils.py

@@ -5,6 +5,13 @@
 from simple_history.exceptions import AlternativeManagerError, NotHistoricalModelError
 
 
+def get_change_reason_from_object(obj):
+    if hasattr(obj, "_change_reason"):
+        return getattr(obj, "_change_reason")
+
+    return None
+
+
 def update_change_reason(instance, reason):
     attrs = {}
     model = type(instance)
@@ -35,6 +42,11 @@ def get_history_manager_for_model(model):
     return getattr(model, manager_name)
 
 
+def get_history_model_for_model(model):
+    """Return the history model for a given app model."""
+    return get_history_manager_for_model(model).model
+
+
 def get_history_manager_from_history(history_instance):
     """
     Return the history manager, based on an existing history instance.
@@ -45,11 +57,6 @@ def get_history_manager_from_history(history_instance):
     )
 
 
-def get_history_model_for_model(model):
-    """Return the history model for a given app model."""
-    return get_history_manager_for_model(model).model
-
-
 def get_app_model_primary_key_name(model):
     """Return the primary key name for a given app model."""
     if isinstance(model._meta.pk, ForeignKey):
@@ -233,10 +240,3 @@ def bulk_update_with_history(
             custom_historical_attrs=custom_historical_attrs,
         )
     return rows_updated
-
-
-def get_change_reason_from_object(obj):
-    if hasattr(obj, "_change_reason"):
-        return getattr(obj, "_change_reason")
-
-    return None