Added support for Django 5.1

Also handled the deprecation of `get_cache_name()` - see https://docs.djangoproject.com/en/5.1/releases/5.1/#features-deprecated-in-5-1

Author: tim-schilling

.github/workflows/test.yml

@@ -12,12 +12,14 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
-        django-version: ['4.2', '5.0', 'main']
+        django-version: ['4.2', '5.0', '5.1', 'main']
 
         exclude:
-          # Exclude py3.9 for Django main and 5.0
+          # Exclude py3.9 for Django main and 5+
           - python-version: '3.9'
             django-version: '5.0'
+          - python-version: '3.9'
+            django-version: '5.1'
           - python-version: '3.9'
             django-version: 'main'
 
@@ -109,7 +111,7 @@ jobs:
           # Install this project in editable mode, so that its package metadata can be queried
           pip install -e .
           # Install the latest minor version of Django we support
-          pip install Django==5.0
+          pip install Django==5.1
 
       - name: Check translation files are updated
         run: python -m simple_history.tests.generated_file_checks.check_translations

CHANGES.rst

@@ -11,6 +11,7 @@ Unreleased
 - Added HistoricOneToOneField (gh-1394)
 - Updated all djangoproject.com links to reference the stable version (gh-1420)
 - Dropped support for Python 3.8, which reached end-of-life on 2024-10-07 (gh-1421)
+- Added support for Django 5.1 (gh-1388)
 
 3.7.0 (2024-05-29)
 ------------------

README.rst

@@ -47,6 +47,7 @@ This app supports the following combinations of Django and Python:
 ==========  ========================
 4.2         3.9, 3.10, 3.11, 3.12, 3.13
 5.0         3.10, 3.11, 3.12, 3.13
+5.1         3.10, 3.11, 3.12, 3.13
 main        3.10, 3.11, 3.12, 3.13
 ==========  ========================
 

docs/index.rst

@@ -43,6 +43,7 @@ This app supports the following combinations of Django and Python:
 ==========  =======================
 4.2         3.9, 3.10, 3.11, 3.12, 3.13
 5.0         3.10, 3.11, 3.12, 3.13
+5.1         3.10, 3.11, 3.12, 3.13
 main        3.10, 3.11, 3.12, 3.13
 ==========  =======================
 

simple_history/models.py

@@ -899,10 +899,14 @@ def related_manager_cls(self):
 
         class HistoricRelationModelManager(related_model._default_manager.__class__):
             def get_queryset(self):
+                cache_name = (
+                    # DEV: Remove this when support for Django 5.0 has been dropped
+                    self.field.remote_field.get_cache_name()
+                    if django.VERSION < (5, 1)
+                    else self.field.remote_field.cache_name
+                )
                 try:
-                    return self.instance._prefetched_objects_cache[
-                        self.field.remote_field.get_cache_name()
-                    ]
+                    return self.instance._prefetched_objects_cache[cache_name]
                 except (AttributeError, KeyError):
                     history = getattr(
                         self.instance, SIMPLE_HISTORY_REVERSE_ATTR_NAME, None

tox.ini

@@ -1,8 +1,7 @@
 [tox]
 envlist =
     py{39,310,311,312,313}-dj42-{sqlite3,postgres,mysql,mariadb},
-    py{310,311,312,313}-dj50-{sqlite3,postgres,mysql,mariadb},
-    py{310,311,312,313}-djmain-{sqlite3,postgres,mysql,mariadb},
+    py{310,311,312,313}-dj{50,51,main}-{sqlite3,postgres,mysql,mariadb},
     docs,
     lint
 
@@ -18,6 +17,7 @@ python =
 DJANGO =
     4.2: dj42
     5.0: dj50
+    5.1: dj51
     main: djmain
 
 [flake8]
@@ -31,6 +31,7 @@ deps =
     -rrequirements/test.txt
     dj42: Django>=4.2,<4.3
     dj50: Django>=5.0,<5.1
+    dj51: Django>=5.1,<5.2
     djmain: https://github.com/django/django/tarball/main
     postgres: -rrequirements/postgres.txt
     mysql: -rrequirements/mysql.txt