fix: storage compatibility issue for django42

Author: Talha-Rizwan

credentials/apps/core/tests/test_storage_settings.py

@@ -0,0 +1,43 @@
+import importlib
+import sys
+import unittest
+from unittest import mock
+
+
+class TestStorageSettings(unittest.TestCase):
+    def setUp(self):
+        self.module_path = "credentials.settings.base"
+
+    def tearDown(self):
+        if self.module_path in sys.modules:
+            del sys.modules[self.module_path]
+
+    @mock.patch("django.VERSION", new=(4, 2))
+    def test_django_42_or_higher(self):
+        if self.module_path in sys.modules:
+            del sys.modules[self.module_path]
+
+        imported = importlib.import_module(self.module_path)
+
+        # Verify correct settings for Django 4.2+
+        self.assertTrue(hasattr(imported, "STORAGES"))
+        self.assertEqual(imported.STORAGES["default"]["BACKEND"], "django.core.files.storage.FileSystemStorage")
+        self.assertEqual(
+            imported.STORAGES["staticfiles"]["BACKEND"], "django.contrib.staticfiles.storage.StaticFilesStorage"
+        )
+        self.assertFalse(hasattr(imported, "DEFAULT_FILE_STORAGE"))
+        self.assertFalse(hasattr(imported, "STATICFILES_STORAGE"))
+
+    @mock.patch("django.VERSION", new=(4, 1))
+    def test_django_below_42(self):
+        if self.module_path in sys.modules:
+            del sys.modules[self.module_path]
+
+        imported = importlib.import_module(self.module_path)
+
+        # Verify correct settings for Django < 4.2
+        self.assertTrue(hasattr(imported, "DEFAULT_FILE_STORAGE"))
+        self.assertTrue(hasattr(imported, "STATICFILES_STORAGE"))
+        self.assertEqual(imported.DEFAULT_FILE_STORAGE, "django.core.files.storage.FileSystemStorage")
+        self.assertEqual(imported.STATICFILES_STORAGE, "django.contrib.staticfiles.storage.StaticFilesStorage")
+        self.assertFalse(hasattr(imported, "STORAGES"))

credentials/settings/base.py

@@ -3,6 +3,7 @@
 from os.path import abspath, dirname, join
 
 from corsheaders.defaults import default_headers as corsheaders_default_headers
+import django
 from django.conf.global_settings import LANGUAGES_BIDI
 from edx_toggles.toggles import WaffleSwitch
 from edx_django_utils.plugins import get_plugin_apps, add_plugins
@@ -230,7 +231,6 @@
 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_I18N = True
@@ -461,14 +461,25 @@
 FILE_STORAGE_BACKEND = {}
 EXTRA_APPS = []
 SESSION_EXPIRE_AT_BROWSER_CLOSE = False
-STORAGES = {
-    "default": {
-        "BACKEND": "django.core.files.storage.FileSystemStorage",
-    },
-    "staticfiles": {
-        "BACKEND": "django.contrib.staticfiles.storage.ManifestStaticFilesStorage",
-    },
-}
+
+DEFAULT_FILE_STORAGE_BACKEND = "django.core.files.storage.FileSystemStorage"
+STATICFILES_STORAGE_BACKEND = "django.contrib.staticfiles.storage.StaticFilesStorage"
+
+if django.VERSION >= (4, 2):
+    # Use new STORAGES setting (available from Django 4.2)
+    STORAGES = {
+        "default": {
+            "BACKEND": DEFAULT_FILE_STORAGE_BACKEND,
+        },
+        "staticfiles": {
+            "BACKEND": STATICFILES_STORAGE_BACKEND,
+        },
+    }
+else:
+    # For Django < 4.2 or packages still using legacy settings
+    DEFAULT_FILE_STORAGE = DEFAULT_FILE_STORAGE_BACKEND
+    STATICFILES_STORAGE = STATICFILES_STORAGE_BACKEND
+
 CACHES = {
     "default": {
         "BACKEND": "django.core.cache.backends.locmem.LocMemCache",

credentials/settings/test.py

@@ -35,15 +35,25 @@
 
 # Local Directories
 TEST_ROOT = path("test_root")
-STORAGES = {
-    **STORAGES,
-    "default": {
-        "BACKEND": "django.core.files.storage.FileSystemStorage",
-    },
-    "staticfiles": {
-        "BACKEND": "django.contrib.staticfiles.storage.StaticFilesStorage",
-    },
-}
+
+DEFAULT_FILE_STORAGE_BACKEND = "django.core.files.storage.FileSystemStorage"
+STATICFILES_STORAGE_BACKEND = "django.contrib.staticfiles.storage.StaticFilesStorage"
+
+if django.VERSION >= (4, 2):
+    # Use new STORAGES setting (available from Django 4.2)
+    STORAGES = {
+        "default": {
+            "BACKEND": DEFAULT_FILE_STORAGE_BACKEND,
+        },
+        "staticfiles": {
+            "BACKEND": STATICFILES_STORAGE_BACKEND,
+        },
+    }
+else:
+    # For Django < 4.2 or packages still using legacy settings
+    DEFAULT_FILE_STORAGE = DEFAULT_FILE_STORAGE_BACKEND
+    STATICFILES_STORAGE = STATICFILES_STORAGE_BACKEND
+
 MEDIA_ROOT = str(TEST_ROOT / "uploads")
 MEDIA_URL = "/static/uploads/"
 

requirements/base.txt

@@ -330,7 +330,7 @@ python-dateutil==2.9.0.post0
 python-memcached==1.59
     # via -r requirements/base.in
 python-slugify==8.0.4
-    # via -r requirements/base.in
+    # via code-annotations
 python3-openid==3.2.0
     # via social-auth-core
 qrcode==7.4.2