Fix: Error when setting table name with inherit (#1196)

* fix(simple_histor.models): Custom history table name

Error was thrown when table_name is set with inherit=True in base model.

- add not inherited check

#1195

* fix(docs): Custom history table name

- authors and changes docs updated

* merge(master): Merged latest changes from master

* merge(master): Resolved conflicts

* merge(master): Resolved conflicts

* merge(master): Resolved conflicts

* merge(master): Resolved conflicts

* fix(simple_histor.models): Custom history table name

- unit test added

* Small improvement of the test for #1196

Now also compares the table name of the inherited (base) model, so that
it's easier to see that the history table name is not inherited.

* Added note on table_name inheritance to docs

---------

Co-authored-by: Anders <[email protected]>

Author: muneeb706

CHANGES.rst

@@ -19,6 +19,7 @@ Unreleased
 - Fixed ``HistoryRequestMiddleware`` not cleaning up after itself (i.e. deleting
   ``HistoricalRecords.context.request``) under some circumstances (gh-1188)
 - Made ``HistoryRequestMiddleware`` async-capable (gh-1209)
+- Fixed error when setting ``table_name`` with ``inherit=True`` (gh-1195)
 
 3.3.0 (2023-03-08)
 ------------------

docs/historical_model.rst

@@ -361,7 +361,7 @@ Allow tracking to be inherited
 
 By default history tracking is only added for the model that is passed
 to ``register()`` or has the ``HistoricalRecords`` descriptor. By
-passing ``inherit=True`` to either way of registering you can change
+passing ``inherit=True`` to either way of registering, you can change
 that behavior so that any child model inheriting from it will have
 historical tracking as well. Be careful though, in cases where a model
 can be tracked more than once, ``MultipleRegistrationsError`` will be
@@ -384,6 +384,9 @@ raised.
 Both ``User`` and ``Poll`` in the example above will cause any model
 inheriting from them to have historical tracking as well.
 
+**Note:** For parent models having a ``HistoricalRecords`` field with ``inherit=True``
+*and* a ``table_name``, the latter option will not be inherited by child models.
+
 History Model In Different App
 ------------------------------
 

simple_history/models.py

@@ -298,7 +298,7 @@ def create_history_model(self, model, inherited):
         attrs.update(self.get_extra_fields(model, fields))
         # type in python2 wants str as a first argument
         attrs.update(Meta=type("Meta", (), self.get_meta_options(model)))
-        if self.table_name is not None:
+        if not inherited and self.table_name is not None:
             attrs["Meta"].db_table = self.table_name
 
         # Set as the default then check for overrides

simple_history/tests/models.py

@@ -670,7 +670,7 @@ class InheritTracking4(TrackedAbstractBaseA):
 
 class BasePlace(models.Model):
     name = models.CharField(max_length=50)
-    history = HistoricalRecords(inherit=True)
+    history = HistoricalRecords(inherit=True, table_name="base_places_history")
 
 
 class InheritedRestaurant(BasePlace):

simple_history/tests/tests/test_models.py

@@ -724,6 +724,24 @@ def test_history_diff_includes_changed_fields_of_base_model(self):
         self.assertEqual(delta.new_record, new_record)
         self.assertEqual(expected_change.field, delta.changes[0].field)
 
+    def test_history_table_name_is_not_inherited(self):
+        def assert_table_name(obj, expected_table_name):
+            history_model = obj.history.model
+            self.assertEqual(
+                history_model.__name__, f"Historical{obj._meta.model.__name__}"
+            )
+            self.assertEqual(history_model._meta.db_table, expected_table_name)
+
+        place = BasePlace.objects.create(name="Place Name")
+        # This is set in `BasePlace.history`
+        assert_table_name(place, "base_places_history")
+
+        r = InheritedRestaurant.objects.create(name="KFC", serves_hot_dogs=True)
+        self.assertTrue(isinstance(r, BasePlace))
+        # The default table name of the history model,
+        # instead of inheriting from `BasePlace`
+        assert_table_name(r, f"tests_Historical{r._meta.model.__name__}".lower())
+
     def test_history_diff_with_incorrect_type(self):
         p = Poll.objects.create(question="what's up?", pub_date=today)
         p.question = "what's up, man?"