Sync fork master branch

.github/workflows/test.yml

@@ -22,6 +22,12 @@ jobs:
           - python-version: '3.7'
             django-version: 'main'
 
+          - python-version: '3.8'
+            django-version: 'main'
+
+          - python-version: '3.9'
+            django-version: 'main'
+
           - python-version: '3.11'
             django-version: '3.2'
           - python-version: '3.11'

.pre-commit-config.yaml

@@ -1,14 +1,14 @@
 ---
 repos:
   - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.4
+    rev: 1.7.5
     hooks:
       - id: bandit
         args:
           - "-x *test*.py"
 
   - repo: https://github.com/psf/black
-    rev: 22.10.0
+    rev: 23.1.0
     hooks:
       - id: black
         language_version: python3.8
@@ -21,7 +21,7 @@ repos:
           - "--config=tox.ini"
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+    rev: 5.12.0
     hooks:
       - id: isort
 
@@ -40,14 +40,14 @@ repos:
       - id: detect-private-key
 
   - repo: https://github.com/adrienverge/yamllint
-    rev: v1.28.0
+    rev: v1.29.0
     hooks:
       - id: yamllint
         args:
           - "--strict"
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.2.2
+    rev: v3.3.1
     hooks:
       - id: pyupgrade
         args: [--py37-plus]

CHANGES.rst

@@ -4,14 +4,27 @@ Changes
 Unreleased
 ----------
 
+
+3.3.0 (2023-03-08)
+------------------
+
+- Made it possible to use the new ``m2m_fields`` with model inheritance (gh-1042)
+- Added two signals: ``pre_create_historical_m2m_records`` and ``post_create_historical_m2m_records`` (gh-1042)
+- Added ``tracked_fields`` attribute to historical models (gh-1038)
+- Fixed ``KeyError`` when running ``clean_duplicate_history`` on models with ``excluded_fields`` (gh-1038)
+- Added support for Python 3.11 (gh-1053)
+- Added Arabic translations (gh-1056)
+- Fixed a code example under "Tracking many to many relationships" (gh-1069)
+- Added a ``--base-manager`` option to the ``clean_duplicate_history`` management command (gh-1115)
+
+3.2.0 (2022-09-28)
+------------------
+
 - Fixed typos in the docs
 - Removed n+1 query from ``bulk_create_with_history`` utility (gh-975)
 - Started using ``exists`` query instead of ``count`` in ``populate_history`` command (gh-982)
 - Add basic support for many-to-many fields (gh-399)
 - Added support for Django 4.1 (gh-1021)
-- Added ``tracked_fields`` attribute to historical models (gh-1038)
-- Fixed ``KeyError`` when running ``clean_duplicate_history`` on models with ``excluded_fields`` (gh-1038)
-- Added support for Python 3.11 (gh-1053)
 
 3.1.1 (2022-04-23)
 ------------------

README.rst

@@ -1,8 +1,8 @@
 django-simple-history
 =====================
 
-.. image:: https://github.com/jazzband/django-simple-history/workflows/build/badge.svg?branch=master
-   :target: https://github.com/jazzband/django-simple-history/actions?workflow=build
+.. image:: https://github.com/jazzband/django-simple-history/actions/workflows/test.yml/badge.svg
+   :target: https://github.com/jazzband/django-simple-history/actions/workflows/test.yml
    :alt: Build Status
 
 .. image:: https://readthedocs.org/projects/django-simple-history/badge/?version=latest

docs/utils.rst

@@ -31,6 +31,14 @@ from the duplicate check
 
     $ python manage.py clean_duplicate_history --auto --excluded_fields field1 field2
 
+You can use Django's base manager to perform the cleanup over all records,
+including those that would otherwise be filtered or modified by a
+custom manager, by using the ``--base-manager`` flag.
+
+.. code-block:: bash
+
+    $ python manage.py clean_duplicate_history --auto --base-manager
+
 clean_old_history
 -----------------------
 

requirements/coverage.txt

@@ -1,2 +1,2 @@
-coverage==6.5.0
+coverage==7.2.2
 toml==0.10.2

requirements/lint.txt

@@ -1,3 +1,3 @@
-black==22.10.0
+black==23.1.0
 flake8==6.0.0
-isort==5.10.1
+isort==5.12.0

requirements/tox.txt

@@ -1,3 +1,3 @@
 -r ./coverage.txt
-tox==3.27.1
-tox-gh-actions==2.11.0
+tox==4.4.7
+tox-gh-actions==3.1.0

runtests.py

@@ -135,6 +135,7 @@ def __getitem__(self, item):
         }
     ],
     DEFAULT_AUTO_FIELD="django.db.models.AutoField",
+    USE_TZ=False,
 )
 MIDDLEWARE = [
     "django.contrib.sessions.middleware.SessionMiddleware",

simple_history/management/commands/clean_duplicate_history.py

@@ -1,8 +1,7 @@
 from django.db import transaction
 from django.utils import timezone
 
-from ... import models, utils
-from ...exceptions import NotHistoricalModelError
+from ... import utils
 from . import populate_history
 
 
@@ -36,10 +35,19 @@ def add_arguments(self, parser):
             nargs="+",
             help="List of fields to be excluded from the diff_against check",
         )
+        parser.add_argument(
+            "--base-manager",
+            action="store_true",
+            default=False,
+            help="Use Django's base manager to handle all records stored in the"
+            " database, including those that would otherwise be filtered or modified"
+            " by a custom manager.",
+        )
 
     def handle(self, *args, **options):
         self.verbosity = options["verbosity"]
         self.excluded_fields = options.get("excluded_fields")
+        self.base_manager = options.get("base_manager")
 
         to_process = set()
         model_strings = options.get("models", []) or args
@@ -72,7 +80,10 @@ def _process(self, to_process, date_back=None, dry_run=True):
                 continue
 
             # Break apart the query so we can add additional filtering
-            model_query = model.objects.all()
+            if self.base_manager:
+                model_query = model._base_manager.all()
+            else:
+                model_query = model._default_manager.all()
 
             # If we're provided a stop date take the initial hit of getting the
             # filtered records to iterate over

simple_history/management/commands/clean_old_history.py

@@ -53,7 +53,6 @@ def handle(self, *args, **options):
         self._process(to_process, days_back=options["days"], dry_run=options["dry"])
 
     def _process(self, to_process, days_back=None, dry_run=True):
-
         start_date = timezone.now() - timezone.timedelta(days=days_back)
         for model, history_model in to_process:
             history_model_manager = history_model.objects

simple_history/management/commands/populate_history.py

@@ -135,7 +135,6 @@ def _bulk_history_create(self, model, batch_size):
             # creating them. So we only keep batch_size worth of models in
             # historical_instances and clear them after we hit batch_size
             if index % batch_size == 0:
-
                 history.bulk_history_create(instances, batch_size=batch_size)
 
                 instances = []

simple_history/registry_tests/migration_test_app/migrations/0001_initial.py

@@ -5,7 +5,6 @@
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [migrations.swappable_dependency(settings.AUTH_USER_MODEL)]

simple_history/registry_tests/migration_test_app/migrations/0002_historicalmodelwithcustomattrforeignkey_modelwithcustomattrforeignkey.py

@@ -10,7 +10,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
         ("migration_test_app", "0001_initial"),

simple_history/registry_tests/migration_test_app/migrations/0003_alter_historicalmodelwithcustomattrforeignkey_options_and_more.py

@@ -4,7 +4,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         (
             "migration_test_app",

simple_history/registry_tests/migration_test_app/migrations/0004_history_date_indexing.py

@@ -4,7 +4,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         (
             "migration_test_app",

simple_history/registry_tests/migration_test_app/migrations/0005_historicalmodelwithcustomattronetoonefield_modelwithcustomattronetoonefield.py

@@ -9,7 +9,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
         (

simple_history/registry_tests/migration_test_app/migrations/0006_alter_historicalmodelwithcustomattronetoonefield_options_and_more.py

@@ -4,7 +4,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         (
             "migration_test_app",

simple_history/registry_tests/migration_test_app/migrations/0007_alter_historicalmodelwithcustomattrforeignkey_options_and_more.py

@@ -4,7 +4,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         (
             "migration_test_app",

simple_history/tests/models.py

@@ -92,6 +92,22 @@ class PollWithAlternativeManager(models.Model):
     history = HistoricalRecords()
 
 
+class CustomPollManager(models.Manager):
+    def get_queryset(self):
+        return super().get_queryset().exclude(hidden=True)
+
+
+class PollWithCustomManager(models.Model):
+    some_objects = CustomPollManager()
+    all_objects = models.Manager()
+
+    question = models.CharField(max_length=200)
+    pub_date = models.DateTimeField("date published")
+    hidden = models.BooleanField(default=False)
+
+    history = HistoricalRecords()
+
+
 class IPAddressHistoricalModel(models.Model):
     ip_address = models.GenericIPAddressField()
 

simple_history/tests/tests/test_admin.py

@@ -455,6 +455,7 @@ def test_history_form_view_without_getting_history(self):
             admin.history_form_view(request, poll.id, history.pk)
 
         context = {
+            **admin_site.each_context(request),
             # Verify this is set for original object
             "original": poll,
             "change_history": False,
@@ -484,7 +485,10 @@ def test_history_form_view_without_getting_history(self):
             "save_on_top": admin.save_on_top,
             "root_path": getattr(admin_site, "root_path", None),
         }
-        context.update(admin_site.each_context(request))
+        # This key didn't exist prior to Django 4.2
+        if "log_entries" in context:
+            context["log_entries"] = ANY
+
         mock_render.assert_called_once_with(
             request, admin.object_history_form_template, context
         )
@@ -509,6 +513,7 @@ def test_history_form_view_getting_history(self):
                 admin.history_form_view(request, poll.id, history.pk)
 
         context = {
+            **admin_site.each_context(request),
             # Verify this is set for history object not poll object
             "original": history.instance,
             "change_history": True,
@@ -538,7 +543,10 @@ def test_history_form_view_getting_history(self):
             "save_on_top": admin.save_on_top,
             "root_path": getattr(admin_site, "root_path", None),
         }
-        context.update(admin_site.each_context(request))
+        # This key didn't exist prior to Django 4.2
+        if "log_entries" in context:
+            context["log_entries"] = ANY
+
         mock_render.assert_called_once_with(
             request, admin.object_history_form_template, context
         )
@@ -563,6 +571,7 @@ def test_history_form_view_getting_history_with_setting_off(self):
                 admin.history_form_view(request, poll.id, history.pk)
 
         context = {
+            **admin_site.each_context(request),
             # Verify this is set for history object not poll object
             "original": poll,
             "change_history": False,
@@ -592,7 +601,10 @@ def test_history_form_view_getting_history_with_setting_off(self):
             "save_on_top": admin.save_on_top,
             "root_path": getattr(admin_site, "root_path", None),
         }
-        context.update(admin_site.each_context(request))
+        # This key didn't exist prior to Django 4.2
+        if "log_entries" in context:
+            context["log_entries"] = ANY
+
         mock_render.assert_called_once_with(
             request, admin.object_history_form_template, context
         )
@@ -617,6 +629,7 @@ def test_history_form_view_getting_history_abstract_external(self):
                 admin.history_form_view(request, obj.id, history.pk)
 
         context = {
+            **admin_site.each_context(request),
             # Verify this is set for history object
             "original": history.instance,
             "change_history": True,
@@ -648,7 +661,10 @@ def test_history_form_view_getting_history_abstract_external(self):
             "save_on_top": admin.save_on_top,
             "root_path": getattr(admin_site, "root_path", None),
         }
-        context.update(admin_site.each_context(request))
+        # This key didn't exist prior to Django 4.2
+        if "log_entries" in context:
+            context["log_entries"] = ANY
+
         mock_render.assert_called_once_with(
             request, admin.object_history_form_template, context
         )
@@ -676,6 +692,7 @@ def test_history_form_view_accepts_additional_context(self):
             )
 
         context = {
+            **admin_site.each_context(request),
             # Verify this is set for original object
             "anything_else": "will be merged into context",
             "original": poll,
@@ -706,7 +723,10 @@ def test_history_form_view_accepts_additional_context(self):
             "save_on_top": admin.save_on_top,
             "root_path": getattr(admin_site, "root_path", None),
         }
-        context.update(admin_site.each_context(request))
+        # This key didn't exist prior to Django 4.2
+        if "log_entries" in context:
+            context["log_entries"] = ANY
+
         mock_render.assert_called_once_with(
             request, admin.object_history_form_template, context
         )