feat: Support for Django 4.1 (#7404)

* support: Django 4.1 * Fix: apphook test * Run tests on all databases Co-authored-by: Vinit Kumar <mail@vinitkumar.me> Co-authored-by: Mark Walker <theshow@gmail.com>
django-cms · fsbraun · Nov 8, 2022 · Jun 29, 2022 · Jul 3, 2022 · Jul 3, 2022
commit 777864af374a75398af3e0ffddf28282703bb123
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -18,6 +18,7 @@ jobs:
           django-3.1.txt,
           django-3.2.txt,
           django-4.0.txt,
+          django-4.1.txt,
         ]
         os: [
           ubuntu-20.04,
@@ -71,6 +72,7 @@ jobs:
           django-3.1.txt,
           django-3.2.txt,
           django-4.0.txt,
+          django-4.1.txt,
         ]
         os: [
           ubuntu-20.04,
@@ -123,6 +125,7 @@ jobs:
           django-3.1.txt,
           django-3.2.txt,
           django-4.0.txt,
+          django-4.1.txt,
         ]
         os: [
           ubuntu-20.04,

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,7 @@ Changelog
 unreleased
 ==========
 
+* Support for django 4.1
 * Allow to partially override ``CMS_CACHE_DURATIONS``
 * Add support for tel: and mailto: URIs in Advanced Page Settings redirect field.
 * Make javascript dark mode functions available to popups as CMS.API.getColorScheme

diff --git a/cms/models/pagemodel.py b/cms/models/pagemodel.py
@@ -839,11 +839,14 @@ def save_base(self, *args, **kwargs):
         PUBLISHER_STATE_DEFAULT (in publish method).
         """
         keep_state = getattr(self, '_publisher_keep_state', None)
-        if self.publisher_is_draft and not keep_state and self.is_new_dirty():
-            self.title_set.all().update(publisher_state=PUBLISHER_STATE_DIRTY)
+        is_new_dirty = self.is_new_dirty()
         if keep_state:
             delattr(self, '_publisher_keep_state')
-        return super().save_base(*args, **kwargs)
+        result = super().save_base(*args, **kwargs)
+        if self.publisher_is_draft and not keep_state and is_new_dirty:
+            # As of Django 4.1 only possible after self has been saved.
+            self.title_set.all().update(publisher_state=PUBLISHER_STATE_DIRTY)
+        return result
 
     def update(self, refresh=False, draft_only=True, **data):
         assert self.publisher_is_draft

diff --git a/cms/templatetags/cms_admin.py b/cms/templatetags/cms_admin.py
@@ -72,7 +72,7 @@ def render_tag(self, context, page, language):
         )
 
 
-register.tag(TreePublishRow)
+register.tag("tree_publish_row", TreePublishRow)
 
 @register.filter
@@ -191,7 +191,7 @@ def get_context(self, context):
         return context
 
 
-register.tag(PageSubmitRow)
+register.tag("page_submit_row", PageSubmitRow)
 
 
 def in_filtered(seq1, seq2):
@@ -217,7 +217,7 @@ def render_tag(self, context):
         return CMS_ADMIN_ICON_BASE
 
 
-register.tag(CMSAdminIconBase)
+register.tag("cms_admin_icon_base", CMSAdminIconBase)
 
 
 @register.inclusion_tag('admin/cms/page/plugin/submit_line.html', takes_context=True)

diff --git a/cms/templatetags/cms_js_tags.py b/cms/templatetags/cms_js_tags.py
@@ -85,4 +85,4 @@ def render_tag(self, context, **kwargs):
         return "'%s'" % escapejs(rendered.strip())
 
 
-register.tag(JavascriptString)
+register.tag("javascript_string", JavascriptString)
diff --git a/cms/tests/test_apphooks.py b/cms/tests/test_apphooks.py
@@ -26,6 +26,7 @@
 from cms.test_utils.testcases import CMSTestCase
 from cms.tests.test_menu_utils import DumbPageLanguageUrl
 from cms.toolbar.toolbar import CMSToolbar
+from cms.utils.compat import DJANGO_2_2, DJANGO_3
 from cms.utils.conf import get_cms_setting
 from cms.utils.urlutils import admin_reverse
 from menus.menu_pool import menu_pool
@@ -306,7 +307,7 @@ def test_apphook_permissions_preserves_view_name(self):
         view_names = (
             ('sample-settings', 'sample_view'),
             ('sample-class-view', 'ClassView'),
-            ('sample-class-based-view', 'ClassBasedView'),
+            ('sample-class-based-view', 'view' if not (DJANGO_3 or DJANGO_2_2) else 'ClassBasedView' ),
         )
 
         with force_language("en"):

diff --git a/cms/tests/test_i18n.py b/cms/tests/test_i18n.py
@@ -2,12 +2,11 @@
 
 from django.conf import settings
 from django.test.utils import override_settings
-from django.utils.translation import LANGUAGE_SESSION_KEY
 
 from cms import api
 from cms.test_utils.testcases import CMSTestCase
 from cms.utils import get_language_from_request, i18n
-from cms.utils.compat import DJANGO_3_0, DJANGO_3_1, DJANGO_3_2
+from cms.utils.compat import DJANGO_2_2
 
 
 @override_settings(
@@ -363,19 +362,21 @@ def test_session_language(self):
 
         #   ugly and long set of session
         session = self.client.session
-        if DJANGO_3_0 or DJANGO_3_1 or DJANGO_3_2:
-            self.client.cookies[settings.LANGUAGE_COOKIE_NAME] = 'fr'
-        else:
+        if DJANGO_2_2:
+            from django.utils.translation import LANGUAGE_SESSION_KEY
+
             session[LANGUAGE_SESSION_KEY] = 'fr'
             session.save()
+        else:
+            self.client.cookies[settings.LANGUAGE_COOKIE_NAME] = 'fr'
         response = self.client.get('/')
         self.assertEqual(response.status_code, 302)
         self.assertRedirects(response, '/fr/')
         self.client.get('/en/')
-        if DJANGO_3_0 or DJANGO_3_1 or DJANGO_3_2:
-            self.assertEqual(self.client.cookies[settings.LANGUAGE_COOKIE_NAME].value, 'en')
-        else:
+        if DJANGO_2_2:
             self.assertEqual(self.client.session[LANGUAGE_SESSION_KEY], 'en')
+        else:
+            self.assertEqual(self.client.cookies[settings.LANGUAGE_COOKIE_NAME].value, 'en')
         response = self.client.get('/')
         self.assertEqual(response.status_code, 302)
         self.assertRedirects(response, '/en/')

diff --git a/cms/tests/test_migrations.py b/cms/tests/test_migrations.py
@@ -17,7 +17,9 @@ def test_for_missing_migrations(self):
         }
 
         try:
-            call_command('makemigrations', **options)
+            # Django 4.1 introduces a new migration to djangocms_text_ckeditor
+            # therefore only check for own migrations
+            call_command('makemigrations', 'cms', **options)
         except SystemExit as e:
             status_code = str(e)
         else:

diff --git a/cms/utils/compat/__init__.py b/cms/utils/compat/__init__.py
@@ -1,13 +1,15 @@
-from distutils.version import LooseVersion
 from platform import python_version
 
 from django import get_version
+from packaging.version import Version
 
 DJANGO_VERSION = get_version()
 PYTHON_VERSION = python_version()
 
 # These means "less than or equal to DJANGO_FOO_BAR"
-DJANGO_2_2 = LooseVersion(DJANGO_VERSION) < LooseVersion('3.0')
-DJANGO_3_0 = LooseVersion(DJANGO_VERSION) < LooseVersion('3.1')
-DJANGO_3_1 = LooseVersion(DJANGO_VERSION) < LooseVersion('3.2')
-DJANGO_3_2 = LooseVersion('3.2') <= LooseVersion(DJANGO_VERSION) and  LooseVersion(DJANGO_VERSION) < LooseVersion('3.3')
+DJANGO_2_2 = Version(DJANGO_VERSION) < Version('3.0')
+DJANGO_3_0 = Version(DJANGO_VERSION) < Version('3.1')
+DJANGO_3_1 = Version(DJANGO_VERSION) < Version('3.2')
+DJANGO_3_2 = Version(DJANGO_VERSION) < Version('4.0')
+DJANGO_3 = DJANGO_3_2
+DJANGO_4_1 = Version(DJANGO_VERSION) < Version('4.2')
diff --git a/menus/templatetags/menu_tags.py b/menus/templatetags/menu_tags.py
@@ -168,7 +168,7 @@ def get_context(self, context, from_level, to_level, extra_inactive,
         return context
 
 
-register.tag(ShowMenu)
+register.tag("show_menu", ShowMenu)
 
 
 class ShowMenuBelowId(ShowMenu):
@@ -185,7 +185,7 @@ class ShowMenuBelowId(ShowMenu):
     )
 
 
-register.tag(ShowMenuBelowId)
+register.tag("show_menu_below_id", ShowMenuBelowId)
 
 
 class ShowSubMenu(InclusionTag):
@@ -260,7 +260,7 @@ def get_context(self, context, levels, root_level, nephews, template):
         return context
 
 
-register.tag(ShowSubMenu)
+register.tag("show_sub_menu", ShowSubMenu)
 
 
 class ShowBreadcrumb(InclusionTag):
@@ -328,7 +328,7 @@ def get_context(self, context, start_level, template, only_visible):
         return context
 
 
-register.tag(ShowBreadcrumb)
+register.tag("show_breadcrumb", ShowBreadcrumb)
 
 
 def _raw_language_marker(language, lang_code):
@@ -406,7 +406,7 @@ def get_context(self, context, template, i18n_mode):
         return context
 
 
-register.tag(LanguageChooser)
+register.tag("language_chooser", LanguageChooser)
 
 
 class PageLanguageUrl(InclusionTag):
@@ -439,4 +439,4 @@ def get_context(self, context, lang):
         return {'content': url}
 
 
-register.tag(PageLanguageUrl)
+register.tag("page_language_url", PageLanguageUrl)
diff --git a/test_requirements/django-4.0.txt b/test_requirements/django-4.0.txt
@@ -1,4 +1,4 @@
 -r requirements_base.txt
-Django==4.0.1
+Django==4.0
 django-formtools==2.2
 pyenchant==3.0.1
diff --git a/test_requirements/django-4.1.txt b/test_requirements/django-4.1.txt
@@ -0,0 +1,4 @@
+-r requirements_base.txt
+Django==4.1
+django-formtools==2.2
+pyenchant==3.0.1
Original file line number	Diff line number	Diff line change
Expand Up		@@ -85,4 +85,4 @@ def render_tag(self, context, **kwargs):
		return "'%s'" % escapejs(rendered.strip())


		register.tag(JavascriptString)
		register.tag("javascript_string", JavascriptString)