feat: add django 4.2 compatibility support (#1)

* feat: add django 4.2 compatibility support

* fix: fix grammer & styles

* update setupcfg file

* fix: pyupgrade errors

* fix: isort errors

* update

* fix: remove `cms_multisite_url` setup, use `re_path`

* feat: add github workflow

* fix: update workflow files

* fix: update setup.cfg

* fix: add `constrain_package_deps` to fix package deps override deps error

* update install_requires to limit django version range

* change install requires package url

* move the multisite requirements from install requires to dependency links

* change the multisite requirements

---------

Co-authored-by: Josh Yu <[email protected]>
Co-authored-by: Freeman,Yu <[email protected]>

.github/workflows/codeql.yml

@@ -0,0 +1,76 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '37 3 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: 'ubuntu-latest'
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/test.yml

@@ -0,0 +1,43 @@
+name: Tox tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }}
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.continue-on-error }}
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+        django: [32, 42]
+        continue-on-error: [true]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Cache pip
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ format('test-py{0}-django{1}', matrix.python-version, matrix.django) }}
+        restore-keys: |
+          ${{ runner.os }}-pip-${{ format('test-py{0}-django{1}', matrix.python-version, matrix.django) }}
+    - name: Cache tox
+      uses: actions/cache@v3
+      with:
+        path: .tox
+        key: ${{ runner.os }}-tox-${{ format('test-{{py{0}-django{1}}}', matrix.python-version, matrix.django) }}-${{ hashFiles('setup.cfg') }}
+        restore-keys: |
+          ${{ runner.os }}-tox-${{ format('test-{{py{0}-django{1}}}', matrix.python-version, matrix.django) }}-
+    - name: Install dependencies
+      run: |
+        sudo apt-get install gettext
+        python -m pip install --upgrade pip setuptools tox>4 tox-docker
+    - name: Test with tox
+      env:
+        TOX_ENV: ${{ format('test-py{0}-django{1}', matrix.python-version, matrix.django) }}
+      run: |
+        tox -e$TOX_ENV

CHANGELOG.rst

@@ -2,6 +2,12 @@
 Changelog
 =========
 
+Unreleased
+==================
+* Add compatibility with Django 4.2
+* Dropped support for Django < 3.1
+* Dropped support for python < 3.8
+
 
 0.7.2 (unreleased)
 ==================

aldryn_config.py

@@ -126,8 +126,7 @@ def single_process_settings(self, env, settings):
         MIDDLEWARE_CLASSES.insert(
             MIDDLEWARE_CLASSES.index(
                 "cms.middleware.utils.ApphookReloadMiddleware"
-            )
-            + 1,
+            ) + 1,
             "django_multisite_plus.middlewares.CMSMultiSiteMiddleware",
         )
 

setup.cfg

@@ -18,8 +18,6 @@ classifiers =
     Operating System :: OS Independent
     Programming Language :: Python
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.6
-    Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
@@ -34,12 +32,12 @@ include_package_data = True
 package_dir =
     = src
 packages = find:
-python_requires = >=3.6
+python_requires = >=3.8
 setup_requires = setuptools_scm[toml]
 install_requires =
-    django>=2
-    django-multisite>=1.4.0
-    djangocms-multisite>=0.2.2  # Note: this is divio/djangocms-multisite, not nephila/djangocms-multisite
+    django>=3.2,<5
+    django-multisite @ https://github.com/FidelityInternational/django-multisite/tarball/feat/django-42-compat#egg=django-multisite
+    djangocms-multisite @ https://github.com/FidelityInternational/djangocms-multisite/tarball/feat/django-42-compat#egg=djangocms-multisite
     aldryn-django
     aldryn_addons
     click
@@ -52,3 +50,26 @@ console_scripts =
 
 [options.packages.find]
 where = src
+
+[flake8]
+max-line-length = 120
+exclude =
+    .git,
+    __pycache__,
+    **/migrations/,
+    build/,
+    .tox/,
+
+[isort]
+line_length = 79
+multi_line_output = 3
+lines_after_imports = 2
+combine_as_imports = true
+include_trailing_comma = true
+balanced_wrapping = true
+skip = manage.py, migrations, .tox
+extra_standard_library = mock
+known_django = django
+known_cms = cms, menus
+known_first_party = djangocms_version_locking
+sections = FUTURE, STDLIB, DJANGO, CMS, THIRDPARTY, FIRSTPARTY, LOCALFOLDER

setup.py

@@ -2,6 +2,7 @@
 
 from setuptools import find_packages, setup
 
+
 setup(
     name="django-multisite-plus",
     version="0.7.2",

src/django_multisite_plus/admin.py

@@ -39,24 +39,24 @@ def has_add_permission(self, *args, **kwargs):
 
     def get_readonly_fields(self, request, obj=None):
         if not settings.DJANGO_MULTISITE_PLUS_REWRITE_DOMAINS:
-            return super(SiteInline, self).get_readonly_fields(request, obj)
+            return super().get_readonly_fields(request, obj)
         return ["slug", "real_domain", "is_enabled", "extra_uwsgi_ini"]
 
 
 class AliasInline(MultisiteAliasInline):
     def has_delete_permission(self, *args, **kwargs):
         if settings.DJANGO_MULTISITE_PLUS_REWRITE_DOMAINS:
             return False
-        return super(AliasInline, self).has_delete_permission(*args, **kwargs)
+        return super().has_delete_permission(*args, **kwargs)
 
     def has_add_permission(self, *args, **kwargs):
         if settings.DJANGO_MULTISITE_PLUS_REWRITE_DOMAINS:
             return False
-        return super(AliasInline, self).has_add_permission(*args, **kwargs)
+        return super().has_add_permission(*args, **kwargs)
 
     def get_readonly_fields(self, request, obj=None):
         if not settings.DJANGO_MULTISITE_PLUS_REWRITE_DOMAINS:
-            return super(AliasInline, self).get_readonly_fields(request, obj)
+            return super().get_readonly_fields(request, obj)
         return ["domain", "site", "is_canonical", "redirect_to_canonical"]
 
 
@@ -81,58 +81,59 @@ class SiteAdmin(DjangoSiteAdmin):
     def has_delete_permission(self, *args, **kwargs):
         if settings.DJANGO_MULTISITE_PLUS_REWRITE_DOMAINS:
             return False
-        return super(SiteAdmin, self).has_delete_permission(*args, **kwargs)
+        return super().has_delete_permission(*args, **kwargs)
 
     def has_add_permission(self, *args, **kwargs):
         if settings.DJANGO_MULTISITE_PLUS_REWRITE_DOMAINS:
             return False
-        return super(SiteAdmin, self).has_add_permission(*args, **kwargs)
+        return super().has_add_permission(*args, **kwargs)
 
     def get_readonly_fields(self, request, obj=None):
         if not settings.DJANGO_MULTISITE_PLUS_REWRITE_DOMAINS:
-            return super(SiteAdmin, self).get_readonly_fields(request, obj)
+            return super().get_readonly_fields(request, obj)
         return ["domain", "linked_url", "name"]
 
     def get_queryset(self, request):
-        qs = super(SiteAdmin, self).get_queryset(request)
+        qs = super().get_queryset(request)
         return qs.prefetch_related("multisiteplus_site")
 
+    @admin.display(
+        description=_("real domain"),
+        ordering="multisiteplus_site__real_domain",
+    )
     def real_domain(self, obj):
         return obj.multisiteplus_site.real_domain
 
-    real_domain.short_description = _("real domain")
-    real_domain.admin_order_field = "multisiteplus_site__real_domain"
-
+    @admin.display(
+        description=_("slug"),
+        ordering="multisiteplus_site__slug",
+    )
     def slug(self, obj):
         return obj.multisiteplus_site.slug
 
-    slug.short_description = _("slug")
-    slug.admin_order_field = "multisiteplus_site__slug"
-
+    @admin.display(
+        description=_("domain"),
+        ordering="domain",
+    )
     def domain_html(self, obj):
         return "{}".format(obj.domain)
 
-    domain_html.short_description = _("domain")
-    domain_html.admin_order_field = "domain"
-    domain_html.allow_tags = True
-
+    @admin.action(description=_("url"))
     def linked_url(self, obj, text=_("open")):
         return format_html(
             '<a href="{}" target="_blank">{}</a>',
             obj.multisiteplus_site.get_url(),
             text,
         )
 
-    linked_url.short_description = _("url")
-    linked_url.allow_tags = True
-
+    @admin.display(
+        description=_("is enabled"),
+        boolean=True,
+        ordering="multisiteplus_site__is_enabled",
+    )
     def is_enabled(self, obj):
         return obj.multisiteplus_site.is_enabled
 
-    is_enabled.short_description = _("is enabled")
-    is_enabled.admin_order_field = "multisiteplus_site__is_enabled"
-    is_enabled.boolean = True
-
     def update_site_action(self, request, queryset):
         for obj in queryset:
             try:

src/django_multisite_plus/cms_urls.py

@@ -1,8 +1,6 @@
-from django.conf.urls import include
-
-from djangocms_multisite.urlresolvers import cms_multisite_url
+from django.urls import include, re_path
 
 
 urlpatterns = [
-    cms_multisite_url(r"^", include("cms.urls")),
+    re_path(r"^", include("cms.urls")),
 ]

src/django_multisite_plus/management/commands/multisite_plus_populate_sites.py

@@ -1,4 +1,4 @@
-from django.core.management.base import BaseCommand, CommandError
+from django.core.management.base import BaseCommand
 
 from django_multisite_plus.models import Site
 

src/django_multisite_plus/management/commands/multisite_plus_rewrite_domains.py

@@ -1,4 +1,4 @@
-from django.core.management.base import BaseCommand, CommandError
+from django.core.management.base import BaseCommand
 
 from multisite.models import Alias
 

src/django_multisite_plus/middlewares.py

@@ -10,7 +10,7 @@
 
 class CMSMultiSiteMiddleware(middleware.CMSMultiSiteMiddleware):
     def process_request(self, request):
-        super(CMSMultiSiteMiddleware, self).process_request(request)
+        super().process_request(request)
 
         if "django_multisite_plus.cms_urls" in sys.modules:
             reload(sys.modules["django_multisite_plus.cms_urls"])

src/django_multisite_plus/migrations/0001_initial.py

@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
 import django.contrib.sites.models
 from django.db import migrations, models
 

src/django_multisite_plus/migrations/0002_auto_20180125_1157.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
 # Generated by Django 1.10.8 on 2018-01-25 11:57
-from __future__ import unicode_literals
 
 from django.db import migrations, models
 

src/django_multisite_plus/models.py

@@ -209,7 +209,7 @@ def update_site(self, use_real_domain=None):
             site.save()
 
     def save(self, **kwargs):
-        super(Site, self).save(**kwargs)
+        super().save(**kwargs)
         self.update_site()
 
 

tests/testproject/settings.py

@@ -19,7 +19,7 @@
 
 DATABASES = {
     "default": {
-        "ENGINE": "django.db.backends.postgresql_psycopg2",
+        "ENGINE": "django.db.backends.postgresql",
         "NAME": "postgres",
         "USER": "postgres",
         "HOST": os.environ["POSTGRES_HOST"],