Prep for Wagtail 7.0 (#257)

* Update min versions and add Wagtail 7.0 to the test matrix
* Use SPDX license expression
   https://peps.python.org/pep-0639/
   https://hugovk.dev/blog/2025/improving-licence-metadata/
* Tidy up tests setup
* Use the non-deprecated/removed pagination template
   `wagtailadmin/shared/ajax_pagination_nav.html` was soft deprecated since Wagtail 2.16 and was removed in 7.0

Author: zerolab

.github/workflows/nightly-tests.yml

@@ -40,7 +40,8 @@ jobs:
         id: test
         continue-on-error: true
         run: |
-          ./runtests.py
+          cd tests
+          python manage.py test
         env:
           DATABASE_ENGINE: django.db.backends.postgresql
           DATABASE_HOST: localhost

.github/workflows/test.yml

@@ -19,7 +19,7 @@ env:
   PIP_DISABLE_PIP_VERSION_CHECK: "1"
   PIP_NO_PYTHON_VERSION_WARNING: "1"
   # Keep in sync with .pre-commit-config.yaml/default_language_version/python.
-  PYTHON_LATEST: "3.12"  # because harden runner fails on the 3.13 download
+  PYTHON_LATEST: "3.13"  # because harden runner fails on the 3.13 download
 
 jobs:
   tests:

README.md

@@ -14,8 +14,8 @@ but for audio and video files.
 wagtailmedia requires the following:
 
 - Python (3.9, 3.10, 3.11, 3.12, 3.13)
-- Django (4.2, 5.0, 5.1)
-- Wagtail (5.2, 6.2, 6.3)
+- Django (4.2, 5.1, 5.2)
+- Wagtail (6.3, 6.4, 7.0)
 
 ## Install
 
@@ -361,7 +361,7 @@ Now you can run tests as shown below:
 tox
 ```
 
-or, you can run them for a specific environment `tox -e py310-dj41-wagtail41` or specific test
-`tox -e py310-dj41-wagtail41 -- tests.test_views.TestMediaChooserUploadView`
+or, you can run them for a specific environment `tox -e py313-dj51-wagtail70` or specific test
+`tox -e py313-dj51-wagtail70 -- tests.test_views.TestMediaChooserUploadView`
 
 To run the test app interactively, use `tox -e interactive`, visit `http://127.0.0.1:8020/admin/` and log in with `admin`/`changeme`.

manage.py

@@ -4,14 +4,14 @@ description = "A Wagtail module for audio and video files."
 authors = [{name = "Mikalai Radchuk ", email = "[email protected]"}]
 maintainers = [{name = "Dan Braghis", email="[email protected]"}]
 readme = "README.md"
-license = {file = "LICENSE"}
+license = "BSD-3-Clause"
+license-files = [ "LICENSE" ]
 keywords = ["Wagtail", "Django", "media"]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Environment :: Web Environment",
     "Intended Audience :: Developers",
     "Operating System :: OS Independent",
-    "License :: OSI Approved :: BSD License",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.9",
@@ -20,23 +20,23 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Framework :: Wagtail",
-    "Framework :: Wagtail :: 5",
     "Framework :: Wagtail :: 6",
+    "Framework :: Wagtail :: 7",
 ]
 
 dynamic = ["version"]
 requires-python = ">=3.9"
 dependencies = [
-    "Wagtail>=5.2",
+    "Wagtail>=6.3",
     "Django>=4.2",
 ]
 
 [project.optional-dependencies]
 testing = [
-    "coverage>=7.6.0",
+    "coverage>=7.8.0",
 ]
 linting = [
-    "pre-commit>=5.0.0",
+    "pre-commit>=4.2.0",
 ]
 
 [project.urls]
@@ -45,7 +45,7 @@ Changelog = "https://github.com/torchbox/wagtailmedia/blob/main/CHANGELOG.md"
 Issues = "https://github.com/torchbox/wagtailmedia/issues"
 
 [build-system]
-requires = ["flit_core >=3.2,<4"]
+requires = ["flit_core >=3.11,<4"]
 build-backend = "flit_core.buildapi"
 
 [tool.flit.module]
@@ -62,7 +62,5 @@ exclude = [
     "*.yml",
     "CHANGELOG.md",
     "SPECIFICATION.md",
-    "manage.py",
-    "runtests.py",
     "ruff.toml",
 ]

pyproject.toml

@@ -0,0 +1,16 @@
+# Generated by Django 5.2 on 2025-05-06 16:58
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("wagtailmedia", "0004_duration_optional_floatfield"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="media",
+            options={"verbose_name": "media", "verbose_name_plural": "media items"},
+        ),
+    ]

runtests.py

@@ -153,6 +153,7 @@ def clean(self, *args, **kwargs):
     class Meta:
         abstract = True
         verbose_name = _("media")
+        verbose_name_plural = _("media items")
 
 
 class Media(AbstractMedia):

src/wagtailmedia/migrations/0005_alter_media_options.py

@@ -21,9 +21,17 @@ MEDIA_CHOOSER_MODAL_ONLOAD_HANDLERS = {
 
             $('.pagination a', context).on('click', function(e) {
                 let params = {
-                    p: this.getAttribute("data-page"),
                     collection_id: collectionChooser.val()
                 };
+
+                if (this.hasAttribute("data-page")) {
+                    params['p'] = this.getAttribute("data-page");
+                }
+                else if (this.parentElement.classList.contains("prev") || this.parentElement.classList.contains("next")) {
+                    const href = new URL(this.href);
+                    params = Object.fromEntries(href.searchParams.entries());
+                }
+
                 const query = searchInput.val();
                 if (query.length) {
                     params['q'] = query;

src/wagtailmedia/models.py

@@ -14,7 +14,7 @@ <h2>{% trans "Latest media" %}</h2>
 
     {% include "wagtailmedia/media/list.html" with choosing=1 %}
 
-    {% include pagination_template with items=media_files is_ajax=1 %}
+    {% include pagination_template with items=media_files link_url=link_url %}
 {% else %}
     {% if is_searching %}
         <p>{% blocktrans %}Sorry, no media files match "<em>{{ query_string }}</em>"{% endblocktrans %}</p>

src/wagtailmedia/static/wagtailmedia/js/media-chooser-modal.js

@@ -2,19 +2,29 @@
 
 from typing import TYPE_CHECKING
 
-from django.core.paginator import Paginator
 from django.forms.utils import flatatt
 from django.utils.html import format_html, format_html_join
 from django.utils.translation import gettext_lazy as _
 
 
+try:
+    from wagtail.admin.paginator import WagtailPaginator as Paginator
+except ImportError:
+    from django.core.paginator import Paginator
+
+
 if TYPE_CHECKING:
+    from django.core.paginator import Page as PaginatorPage
+    from django.http import HttpRequest
+
     from .models import AbstractMedia
 
-DEFAULT_PAGE_KEY = "p"
+DEFAULT_PAGE_KEY: str = "p"
 
 
-def paginate(request, items, page_key=DEFAULT_PAGE_KEY, per_page=20):
+def paginate(
+    request: HttpRequest, items, page_key: str = DEFAULT_PAGE_KEY, per_page: int = 20
+) -> tuple[Paginator, PaginatorPage]:
     paginator = Paginator(items, per_page)
     page = paginator.get_page(request.GET.get(page_key))
     return paginator, page

src/wagtailmedia/templates/wagtailmedia/chooser/results.html

@@ -15,7 +15,7 @@
 from wagtailmedia.utils import paginate
 
 
-pagination_template = "wagtailadmin/shared/ajax_pagination_nav.html"
+pagination_template = "wagtailadmin/shared/pagination_nav.html"
 permission_checker = PermissionPolicyChecker(permission_policy)
 
 
@@ -100,7 +100,7 @@ def chooser(request, media_type=None):
                 media_files = media_files.filter(tags__name=tag_name)
 
         # Pagination
-        paginator, media_files = paginate(request, media_files, per_page=10)
+        paginator, media_files = paginate(request, media_files)
 
         return render(
             request,
@@ -112,6 +112,10 @@ def chooser(request, media_type=None):
                 "pagination_template": pagination_template,
                 "media_type": media_type,
                 "ordering": ordering,
+                "linkurl": reverse("wagtailmedia:chooser"),
+                "elided_page_range": paginator.get_elided_page_range(
+                    request.GET.get("p", 1)
+                ),
             },
         )
     else:
@@ -122,7 +126,7 @@ def chooser(request, media_type=None):
             collections = None
 
         media_files = media_files.order_by(ordering)
-        paginator, media_files = paginate(request, media_files, per_page=10)
+        paginator, media_files = paginate(request, media_files)
 
     if media_type == "audio":
         title = _("Choose audio")
@@ -147,6 +151,10 @@ def chooser(request, media_type=None):
             "ordering": ordering,
             "title": title,
             "icon": f"wagtailmedia-{media_type}" if media_type is not None else "media",
+            "linkurl": reverse("wagtailmedia:chooser"),
+            "elided_page_range": paginator.get_elided_page_range(
+                request.GET.get("p", 1)
+            ),
         },
         json_data={
             "step": "chooser",

src/wagtailmedia/utils.py

@@ -0,0 +1,67 @@
+#!/usr/bin/env python
+
+import argparse
+import os
+import shutil
+import sys
+import warnings
+
+from django.core.management import execute_from_command_line
+
+
+os.environ["DJANGO_SETTINGS_MODULE"] = "testapp.settings"
+sys.path.append("tests")
+
+
+def make_parser():
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--deprecation",
+        choices=["all", "pending", "imminent", "none"],
+        default="imminent",
+    )
+    return parser
+
+
+def parse_args(args=None):
+    return make_parser().parse_known_args(args)
+
+
+def runtests():
+    args, rest = parse_args()
+
+    only_wagtail = r"^wagtail(\.|$)"
+    if args.deprecation == "all":
+        # Show all deprecation warnings from all packages
+        warnings.simplefilter("default", DeprecationWarning)
+        warnings.simplefilter("default", PendingDeprecationWarning)
+    elif args.deprecation == "pending":
+        # Show all deprecation warnings from wagtail
+        warnings.filterwarnings(
+            "default", category=DeprecationWarning, module=only_wagtail
+        )
+        warnings.filterwarnings(
+            "default", category=PendingDeprecationWarning, module=only_wagtail
+        )
+    elif args.deprecation == "imminent":
+        # Show only imminent deprecation warnings from wagtail
+        warnings.filterwarnings(
+            "default", category=DeprecationWarning, module=only_wagtail
+        )
+    elif args.deprecation == "none":
+        # Deprecation warnings are ignored by default
+        pass
+
+    argv = [sys.argv[0]] + rest
+
+    try:
+        execute_from_command_line(argv)
+    finally:
+        from wagtail.test.settings import MEDIA_ROOT, STATIC_ROOT
+
+        shutil.rmtree(STATIC_ROOT, ignore_errors=True)
+        shutil.rmtree(MEDIA_ROOT, ignore_errors=True)
+
+
+if __name__ == "__main__":
+    runtests()

src/wagtailmedia/views/chooser.py

@@ -1,7 +1,7 @@
 from django.test import TestCase
 from django.utils.safestring import SafeString
+from testapp.models import BlogStreamPage
 
-from tests.testapp.models import BlogStreamPage
 from wagtailmedia.blocks import (
     AudioChooserBlock,
     MediaChooserBlockComparison,

tests/manage.py

@@ -1,11 +1,11 @@
 from django.contrib.auth.models import AnonymousUser
 from django.test import RequestFactory, TestCase
 from django.urls import reverse
+from testapp.models import BlogStreamPage
 from wagtail import VERSION as WAGTAIL_VERSION
 from wagtail.admin.panels import FieldPanel, ObjectList
 from wagtail.models import Page
 
-from tests.testapp.models import BlogStreamPage
 from wagtailmedia.edit_handlers import MediaChooserPanel, MediaFieldComparison
 from wagtailmedia.widgets import AdminAudioChooser, AdminMediaChooser, AdminVideoChooser