Extended Release model with an is_active flag to handle publication.

Author: nessita

releases/admin.py

@@ -6,12 +6,13 @@
 @admin.register(Release)
 class ReleaseAdmin(admin.ModelAdmin):
     fieldsets = [
-        (None, {"fields": ["version", "is_lts"]}),
+        (None, {"fields": ["version", "is_active", "is_lts"]}),
         ("Dates", {"fields": ["date", "eol_date"]}),
         ("Artifacts", {"fields": ["tarball", "wheel", "checksum"]}),
     ]
     list_display = (
         "version",
+        "show_is_published",
         "is_lts",
         "date",
         "eol_date",
@@ -30,3 +31,11 @@ class ReleaseAdmin(admin.ModelAdmin):
     )
     def show_status(self, obj):
         return obj.get_status_display()
+
+    @admin.display(
+        boolean=True,
+        description="Published?",
+        ordering="is_active",
+    )
+    def show_is_published(self, obj):
+        return obj.is_published

releases/migrations/0005_release_artifacts.py

@@ -1,4 +1,4 @@
-# Generated by Django 5.1.5 on 2025-03-05 15:00
+# Generated by Django 5.1.5 on 2025-03-11 10:29
 from functools import partial
 
 from django.db import migrations, models
@@ -22,12 +22,16 @@ def default_artifact(suffix):
 
 
 def populate_artifacts(apps, schema_editor):
-    """
-    Populate tarball, wheel and checksum fields based on historical data.
+    """Populate tarball, wheel and checksum fields based on historical data.
+
+    The flag "is_active" should always be True for existing releases (defaults to False
+    for future releases).
+
     """
     Release = apps.get_model("releases", "Release")
 
     Release.objects.update(
+        is_active=True,
         # releases/{major}.{minor}/Django-{version}.tar.gz
         tarball=Case(
             *(When(version=k, then=Value(v)) for k, v in VERSION_TO_TARBALL.items()),
@@ -63,6 +67,14 @@ class Migration(migrations.Migration):
                 verbose_name="Signed checksum as a .asc file",
             ),
         ),
+        migrations.AddField(
+            model_name="release",
+            name="is_active",
+            field=models.BooleanField(
+                default=False,
+                help_text="Set this release as active. A release is considered active only when its date is today or in the past, and this flag is enabled.",
+            ),
+        ),
         migrations.AddField(
             model_name="release",
             name="tarball",

releases/models.py

@@ -9,6 +9,7 @@
 from django.core.validators import RegexValidator
 from django.db import models
 from django.utils.functional import cached_property
+from django.utils.timezone import now
 from django.utils.version import get_complete_version, get_main_version
 
 from .utils import get_loose_version_tuple
@@ -174,6 +175,13 @@ class Release(models.Model):
     }
 
     version = models.CharField(max_length=16, primary_key=True)
+    is_active = models.BooleanField(
+        help_text=(
+            "Set this release as active. A release is considered active only "
+            "when its date is today or in the past, and this flag is enabled."
+        ),
+        default=False,
+    )
     date = models.DateField(
         "Release date",
         null=True,
@@ -197,6 +205,12 @@ class Release(models.Model):
     micro = models.PositiveSmallIntegerField(editable=False)
     status = models.CharField(max_length=1, choices=STATUS_CHOICES, editable=False)
     iteration = models.PositiveSmallIntegerField(editable=False)
+    is_lts = models.BooleanField(
+        "Long Term Support",
+        help_text='Is this an <abbr title="Long Term Support">LTS</abbr> release?',
+        default=False,
+    )
+    # Artifacts.
     tarball = models.FileField(
         "Tarball artifact as a .tar.gz file",
         storage=get_storage,
@@ -215,46 +229,9 @@ class Release(models.Model):
         upload_to=upload_to_checksum,
         blank=True,
     )
-    is_lts = models.BooleanField(
-        "Long Term Support",
-        help_text='Is this an <abbr title="Long Term Support">LTS</abbr> release?',
-        default=False,
-    )
 
     objects = ReleaseManager()
 
-    def clean(self):
-        if self.date is not None and not self.tarball:
-            raise ValidationError(
-                {
-                    "tarball": (
-                        "This field is required when the release is active "
-                        "by having a date"
-                    )
-                }
-            )
-
-        if (self.tarball or self.wheel) and not self.checksum:
-            raise ValidationError(
-                {
-                    "checksum": (
-                        "This field is required when an artifact has been uploaded"
-                    )
-                }
-            )
-
-        if self.tarball:
-            try:
-                self.validate_artifact_name(self.tarball.name, suffix=".tar.gz")
-            except ValidationError as e:
-                raise ValidationError({"tarball": e})
-
-        if self.wheel:
-            try:
-                self.validate_artifact_name(self.wheel.name, suffix="-py3-none-any.whl")
-            except ValidationError as e:
-                raise ValidationError({"wheel": e})
-
     def save(self, *args, **kwargs):
         self.major, self.minor, self.micro, status, self.iteration = self.version_tuple
         self.status = self.STATUS_REVERSE[status]
@@ -273,6 +250,10 @@ def save(self, *args, **kwargs):
     def __str__(self):
         return self.version
 
+    @property
+    def is_published(self):
+        return self.is_active and self.date is not None and self.date <= now().date()
+
     @cached_property
     def version_tuple(self):
         """Return a tuple in the format of django.VERSION."""
@@ -290,6 +271,33 @@ def version_tuple(self):
             version.append(0)
         return tuple(version)
 
+    def clean(self):
+        if self.is_published and not self.tarball:
+            raise ValidationError(
+                {"tarball": "This field is required when the release is active."}
+            )
+
+        if (self.tarball or self.wheel) and not self.checksum:
+            raise ValidationError(
+                {
+                    "checksum": (
+                        "This field is required when an artifact has been uploaded."
+                    )
+                }
+            )
+
+        if self.tarball:
+            try:
+                self.validate_artifact_name(self.tarball.name, suffix=".tar.gz")
+            except ValidationError as e:
+                raise ValidationError({"tarball": e})
+
+        if self.wheel:
+            try:
+                self.validate_artifact_name(self.wheel.name, suffix="-py3-none-any.whl")
+            except ValidationError as e:
+                raise ValidationError({"wheel": e})
+
     def validate_artifact_name(self, name, suffix):
         name = Path(name).name  # strip any folder name if present
         version = get_version(self.version_tuple)

releases/tests.py

@@ -8,6 +8,7 @@
 from django.test import SimpleTestCase, TestCase, override_settings
 from django.urls import reverse
 from django.utils.safestring import SafeString
+from django.utils.timezone import now
 
 from members.models import MEMBERSHIP_LEVELS, PLATINUM_MEMBERSHIP, CorporateMember
 
@@ -143,6 +144,27 @@ def test_preview(self):
         self.assertEqual(Release.objects.preview().version, "1.9b2")
 
 
+class ReleaseTestCase(TestCase):
+    def test_is_published(self):
+        today = now().date()
+        future = today + datetime.timedelta(days=1)
+        past = today - datetime.timedelta(days=1)
+        cases = [
+            ({"date": None, "is_active": True}, False),
+            ({"date": None, "is_active": False}, False),
+            ({"date": today, "is_active": True}, True),
+            ({"date": today, "is_active": False}, False),
+            ({"date": past, "is_active": True}, True),
+            ({"date": past, "is_active": False}, False),
+            ({"date": future, "is_active": True}, False),
+            ({"date": future, "is_active": False}, False),
+        ]
+        for i, (params, expected) in enumerate(cases):
+            release = Release.objects.create(version=f"{i}.0", **params)
+            with self.subTest(**params):
+                self.assertIs(release.is_published, expected)
+
+
 class ReleaseUploadToTestCase(SimpleTestCase):
     def test_upload_to_artifact(self):
         for version, filename, expected in [
@@ -201,15 +223,33 @@ def setUpClass(cls):
         cls.form_class = admin.site.get_model_admin(Release).get_form(request=None)
 
     def test_non_published_releases_tarball_not_required(self):
-        form = self.form_class({"version": "1.0", "date": None})
-        self.assertTrue(form.is_valid(), form.errors)
+        today = now().date()
+        future = today + datetime.timedelta(days=1)
+        past = today - datetime.timedelta(days=1)
+        cases = [
+            ({"date": None, "is_active": True}, False),
+            ({"date": None, "is_active": False}, False),
+            ({"date": today, "is_active": True}, True),
+            ({"date": today, "is_active": False}, False),
+            ({"date": past, "is_active": True}, True),
+            ({"date": past, "is_active": False}, False),
+            ({"date": future, "is_active": True}, False),
+            ({"date": future, "is_active": False}, False),
+        ]
+        for i, (params, tarball_required) in enumerate(cases):
+            form = self.form_class({"version": f"{i}.0", **params})
+            with self.subTest(**params):
+                self.assertIs(form.is_valid(), not tarball_required, form.errors)
 
-    def test_published_releases_tarball_required(self):
-        form = self.form_class({"version": "1.0", "date": "2008-09-03"})
+    def test_published_release_tarball_required(self):
+        form = self.form_class(
+            {"version": "1.0", "date": "2008-09-03", "is_active": True}
+        )
+        self.assertFalse(form.is_valid())
         self.assertFormError(
             form,
             "tarball",
-            "This field is required when the release is active by having a date",
+            "This field is required when the release is active.",
         )
 
     def test_checksum_required_if_tarball_provided(self):
@@ -220,7 +260,7 @@ def test_checksum_required_if_tarball_provided(self):
         self.assertFormError(
             form,
             "checksum",
-            "This field is required when an artifact has been uploaded",
+            "This field is required when an artifact has been uploaded.",
         )
 
     def test_checksum_required_if_wheel_provided(self):
@@ -231,7 +271,7 @@ def test_checksum_required_if_wheel_provided(self):
         self.assertFormError(
             form,
             "checksum",
-            "This field is required when an artifact has been uploaded",
+            "This field is required when an artifact has been uploaded.",
         )
 
     def test_artifact_filename_validation_valid(self):
@@ -340,6 +380,7 @@ class RedirectViewTestCase(TestCase):
     def test_redirect(self):
         Release.objects.create(
             version="1.0",
+            is_active=True,
             tarball="test.tar.gz",
             wheel="test.whl",
             checksum="test.checksum.txt",
@@ -355,13 +396,40 @@ def test_redirect(self):
                 self.assertRedirects(response, url, 301, fetch_redirect_response=False)
 
     def test_redirect_404(self):
-        Release.objects.create(version="1.0")
+        Release.objects.create(version="1.0", is_active=True)
 
         for kind in ["tarball", "wheel", "checksum"]:
             response = self.client.get(f"/download/1.0/{kind}/")
             with self.subTest(kind=kind):
                 self.assertEqual(response.status_code, 404)
 
+    def test_redirect_is_not_published(self):
+        today = now().date()
+        future = today + datetime.timedelta(days=1)
+        past = today - datetime.timedelta(days=1)
+        cases = [
+            ({"date": None, "is_active": True}, 404),
+            ({"date": None, "is_active": False}, 404),
+            ({"date": today, "is_active": True}, 301),
+            ({"date": today, "is_active": False}, 404),
+            ({"date": past, "is_active": True}, 301),
+            ({"date": past, "is_active": False}, 404),
+            ({"date": future, "is_active": True}, 404),
+            ({"date": future, "is_active": False}, 404),
+        ]
+        for i, (params, status_code) in enumerate(cases):
+            release = Release.objects.create(
+                version=f"{i}.0",
+                tarball="test.tar.gz",
+                wheel="test.whl",
+                checksum="test.checksum.txt",
+                **params,
+            )
+            for kind in ["tarball", "wheel", "checksum"]:
+                response = self.client.get(f"/download/{i}.0/{kind}/")
+                with self.subTest(kind=kind, **params):
+                    self.assertEqual(response.status_code, status_code)
+
 
 class CorporateMembersTestCase(TestCase):
     @classmethod

releases/views.py

@@ -41,7 +41,7 @@ def index(request):
 def redirect(request, version, kind):
     release = get_object_or_404(Release, version=version)
 
-    if not (artifact := getattr(release, kind, None)):
+    if not release.is_published or not (artifact := getattr(release, kind, None)):
         raise Http404
 
     return HttpResponsePermanentRedirect(artifact.url)