feat: Add support for django5.2

Author: Talha-Rizwan

.github/workflows/ci.yml

@@ -37,7 +37,7 @@ jobs:
     strategy:
       matrix:
         python-version: ["3.12"]
-        django-version: ["django42"]
+        django-version: ["django42", "django52"]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
@@ -63,7 +63,7 @@ jobs:
           make static
           make tests
       - name: Run code coverage
-        if: matrix.python-version == '3.12' && matrix.django-version == 'django42'
+        if: matrix.python-version == '3.12' && matrix.django-version == 'django52'
         uses: codecov/codecov-action@v5
         with:
           flags: unittests

credentials/apps/api/v2/decorators.py

@@ -26,7 +26,7 @@ def wrapper(*args, **kwargs):
                 data = request.body
                 logger.info(
                     f"{request.method} request received to endpoint [{request.get_full_path()}] from user "
-                    f"[{request.user.username}] originating from [{request.META.get('HTTP_HOST', 'Unknown')}] "
+                    f"[{request.user.username}] originating from [{request.headers.get('host', 'Unknown')}] "
                     f"with data: [{data}]"
                 )
             except Exception as exc:

credentials/apps/api/v2/tests/test_serializers.py

@@ -2,9 +2,9 @@
 from datetime import datetime
 from logging import WARNING
 from uuid import uuid4
+from zoneinfo import ZoneInfo
 
 import ddt
-import pytz
 from django.test import TestCase
 from django.urls import reverse
 from rest_framework.exceptions import ValidationError
@@ -204,7 +204,7 @@ def test_to_internal_value(self):
         Request = namedtuple("Request", ["site"])
         serializer = UserGradeSerializer(context={"request": Request(site=self.site)})
         updated_at_dt = datetime.now()
-        updated_at_utc = updated_at_dt.replace(tzinfo=pytz.UTC)
+        updated_at_utc = updated_at_dt.replace(tzinfo=ZoneInfo("UTC"))
 
         data = {
             "username": "alice",

credentials/apps/api/v2/tests/test_views.py

@@ -2,9 +2,9 @@
 import json
 from decimal import Decimal
 from unittest import mock
+from zoneinfo import ZoneInfo
 
 import ddt
-import pytz
 from django.contrib.auth.models import Permission
 from django.core.exceptions import ObjectDoesNotExist
 from django.test import TestCase
@@ -598,7 +598,7 @@ def test_upgrade_with_lms_last_updated_at_data(self):
 
         # simulate updating the existing record with the new field in the data
         dt = datetime.datetime.now()
-        last_updated_at = dt.replace(tzinfo=pytz.UTC)
+        last_updated_at = dt.replace(tzinfo=ZoneInfo("UTC"))
         data = self.serialize_user_grade(grade)
         data["lms_last_updated_at"] = last_updated_at
         response = self.client.post(self.list_path, data=JSONRenderer().render(data), content_type=JSON_CONTENT_TYPE)

credentials/apps/badges/admin.py

@@ -318,6 +318,7 @@ def delete_queryset(self, request, queryset):
             return
         super().delete_queryset(request, queryset)
 
+    @admin.display(description=_("icon"))
     def image(self, obj):
         """
         Badge template preview image.
@@ -326,8 +327,6 @@ def image(self, obj):
             return format_html('<img src="{}" width="50" height="auto" />', obj.icon)
         return None
 
-    image.short_description = _("icon")
-
     def save_model(self, request, obj, form, change):
         pass
 
@@ -391,6 +390,7 @@ class BadgeRequirementAdmin(admin.ModelAdmin):
     def has_add_permission(self, request):
         return False
 
+    @admin.display(description=_("badge template"))
     def template_link(self, instance):
         """
         Interactive link to parent (badge template).
@@ -401,8 +401,6 @@ def template_link(self, instance):
         url = reverse(reverse_name, args=reverse_args)
         return format_html('<a href="{}">{}</a>', url, instance.template)
 
-    template_link.short_description = _("badge template")
-
     def response_change(self, request, obj):
         if "_save" in request.POST:
             reverse_name = ADMIN_CHANGE_VIEW_REVERSE_NAMES.get(obj.template.origin, "admin:index")
@@ -453,6 +451,7 @@ class BadgePenaltyAdmin(admin.ModelAdmin):
     def has_add_permission(self, request):
         return False
 
+    @admin.display(description=_("badge template"))
     def template_link(self, instance):
         """
         Interactive link to parent (badge template).
@@ -462,8 +461,6 @@ def template_link(self, instance):
         url = reverse(reverse_name, args=reverse_args)
         return format_html('<a href="{}">{}</a>', url, instance.template)
 
-    template_link.short_description = _("badge template")
-
     def formfield_for_manytomany(self, db_field, request, **kwargs):
         if db_field.name == "requirements":
             object_id = request.resolver_match.kwargs.get("object_id")

credentials/apps/catalog/tests/factories.py

@@ -4,10 +4,10 @@
 
 import datetime
 from uuid import uuid4
+from zoneinfo import ZoneInfo
 
 import factory
 from factory.fuzzy import FuzzyDateTime, FuzzyInteger, FuzzyText
-from pytz import UTC
 from slugify import slugify
 
 from credentials.apps.catalog.data import PathwayStatus
@@ -35,6 +35,7 @@ class Meta:
 class CourseFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = Course
+        skip_postgeneration_save = True
 
     site = factory.SubFactory(SiteFactory)
     uuid = factory.LazyFunction(uuid4)
@@ -55,13 +56,14 @@ class Meta:
     uuid = factory.LazyFunction(uuid4)
     key = FuzzyText(prefix="course-run-id/", suffix="/fake")
     title_override = None
-    start_date = FuzzyDateTime(datetime.datetime(2014, 1, 1, tzinfo=UTC))
-    end_date = FuzzyDateTime(datetime.datetime(2014, 1, 1, tzinfo=UTC)).end_dt
+    start_date = FuzzyDateTime(datetime.datetime(2014, 1, 1, tzinfo=ZoneInfo("UTC")))
+    end_date = FuzzyDateTime(datetime.datetime(2014, 1, 1, tzinfo=ZoneInfo("UTC"))).end_dt
 
 
 class ProgramFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = Program
+        skip_postgeneration_save = True
 
     site = factory.SubFactory(SiteFactory)
     uuid = factory.LazyFunction(uuid4)

credentials/settings/base.py

@@ -230,13 +230,11 @@
 TIME_ZONE = "UTC"
 TIME_ZONE_CLASS = timezone.utc
 
+# Using zoneinfo from the standard library instead of pytz
 # https://docs.djangoproject.com/en/4.2/releases/4.0/#zoneinfo-default-timezone-implementation
-USE_DEPRECATED_PYTZ = True
 
 USE_I18N = True
 
-USE_L10N = True
-
 USE_TZ = True
 
 LOCALE_PATHS = (root("conf", "locale"),)
@@ -422,6 +420,9 @@
     "EXCEPTION_HANDLER": "credentials.apps.api.v2.views.credentials_throttle_handler",
 }
 
+# DRF-YASG Settings
+SWAGGER_USE_COMPAT_RENDERERS = False
+
 # Django-ratelimit Settings
 RATELIMIT_VIEW = "credentials.apps.records.views.rate_limited"
 
@@ -460,7 +461,14 @@
 FILE_STORAGE_BACKEND = {}
 EXTRA_APPS = []
 SESSION_EXPIRE_AT_BROWSER_CLOSE = False
-STATICFILES_STORAGE = "django.contrib.staticfiles.storage.ManifestStaticFilesStorage"
+STORAGES = {
+    "default": {
+        "BACKEND": "django.core.files.storage.FileSystemStorage",
+    },
+    "staticfiles": {
+        "BACKEND": "django.contrib.staticfiles.storage.ManifestStaticFilesStorage",
+    },
+}
 CACHES = {
     "default": {
         "BACKEND": "django.core.cache.backends.locmem.LocMemCache",

credentials/settings/test.py

@@ -35,7 +35,15 @@
 
 # Local Directories
 TEST_ROOT = path("test_root")
-DEFAULT_FILE_STORAGE = "django.core.files.storage.FileSystemStorage"
+STORAGES = {
+    **STORAGES,
+    "default": {
+        "BACKEND": "django.core.files.storage.FileSystemStorage",
+    },
+    "staticfiles": {
+        "BACKEND": "django.contrib.staticfiles.storage.StaticFilesStorage",
+    },
+}
 MEDIA_ROOT = str(TEST_ROOT / "uploads")
 MEDIA_URL = "/static/uploads/"
 
@@ -49,7 +57,6 @@
         "JWT_AUDIENCE": SOCIAL_AUTH_EDX_OAUTH2_KEY,
     }
 )
-STATICFILES_STORAGE = "django.contrib.staticfiles.storage.StaticFilesStorage"
 
 # Verifiable Credentials
 ENABLE_VERIFIABLE_CREDENTIALS = True

credentials/urls.py

@@ -78,7 +78,7 @@
 
 if is_badges_enabled():
     urlpatterns += [
-        re_path(r"^badges/", include(("credentials.apps.badges.urls", "badges"), namespace="badges")),
+        path("badges/", include(("credentials.apps.badges.urls", "badges"), namespace="badges")),
     ]
 
 # edx-drf-extensions csrf app

requirements/base.in

@@ -46,8 +46,8 @@ openedx-events
 pillow
 pygments
 python-memcached
+python-slugify
 pymemcache
-pytz
 qrcode
 requests
 segment-analytics-python