Merge pull request #269 from mobinghoveoud/add-django-jalali-settings

Add django jalali settings

Author: slashmili

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### Changed
+- Add Jalali settings
+
 ## [7.2.0] - 2024-08-20
 ### Changed
 - Confirm Django 5.1 support

README.rst

@@ -61,9 +61,41 @@ Usage
 
   $ python manage.py startapp foo
 
-3. Edit settings.py_ and add django_jalali and your foo to your INSTALLED_APPS (also config DATABASES setting)
-
-    django_jalali should be added **before** your apps in order to work properly
+3. Edit your Django project's ``settings.py`` file to include ``django_jalali`` and your application in the ``INSTALLED_APPS`` list. Make sure that ``django_jalali`` is listed **before** your apps for proper functionality.
+
+   Additionally, you can configure library settings using the ``JALALI_SETTINGS`` dictionary. If a setting is not explicitly defined, the default values will be used.
+
+   .. code-block:: python
+
+      # settings.py
+      INSTALLED_APPS = [
+          "django.contrib.admin",
+          "django.contrib.auth",
+          "django.contrib.contenttypes",
+          "django.contrib.sessions",
+          "django.contrib.messages",
+          "django.contrib.staticfiles",
+          "django_jalali",  # Place this before your custom apps
+      ]
+
+      JALALI_SETTINGS = {
+          # JavaScript static files for the admin Jalali date widget
+          "ADMIN_JS_STATIC_FILES": [
+              "admin/jquery.ui.datepicker.jalali/scripts/jquery-1.10.2.min.js",
+              "admin/jquery.ui.datepicker.jalali/scripts/jquery.ui.core.js",
+              "admin/jquery.ui.datepicker.jalali/scripts/jquery.ui.datepicker-cc.js",
+              "admin/jquery.ui.datepicker.jalali/scripts/calendar.js",
+              "admin/jquery.ui.datepicker.jalali/scripts/jquery.ui.datepicker-cc-fa.js",
+              "admin/main.js",
+          ],
+          # CSS static files for the admin Jalali date widget
+          "ADMIN_CSS_STATIC_FILES": {
+              "all": [
+                  "admin/jquery.ui.datepicker.jalali/themes/base/jquery-ui.min.css",
+                  "admin/css/main.css",
+              ]
+          },
+      }
 
 4. Edit foo/models.py_
 
@@ -308,6 +340,16 @@ If you wish to limit the testing to specific environment(s), you can parametrize
 
     $ tox -e py39-django42
 
+To add a new value to the Jalali settings, just add its default value to the ``DEFAULTS`` dictionary located in ``django_jalali/setting.py``.
+
+You can access the new setting in your code as shown below:
+
+.. code-block:: python
+
+    from django_jalali.settings import jalali_settings
+
+    custom_settings = jalali_settings.CUSTOM_SETTINGS
+
 .. _jdatetime: https://github.com/slashmili/python-jalali
 .. _Django: https://www.djangoproject.com/
 .. _settings.py: https://github.com/slashmili/django-jalali/blob/master/jalali_test/jalali_test/settings.py#L40

django_jalali/admin/widgets.py

@@ -1,32 +1,17 @@
 from django import forms
 from django.contrib.admin.widgets import AdminTimeWidget
-from django.templatetags.static import static
 from django.utils.safestring import mark_safe
 from django.utils.translation import gettext as _
 
 from django_jalali import forms as jforms
+from django_jalali.settings import jalali_settings
 
 
 class AdminjDateWidget(jforms.jDateInput):
-    @property
-    def media(self):
-        js = [
-            "jquery.ui.datepicker.jalali/scripts/jquery-1.10.2.min.js",
-            "jquery.ui.datepicker.jalali/scripts/jquery.ui.core.js",
-            "jquery.ui.datepicker.jalali/scripts/jquery.ui.datepicker-cc.js",
-            "jquery.ui.datepicker.jalali/scripts/calendar.js",
-            "jquery.ui.datepicker.jalali/scripts/jquery.ui.datepicker-cc-fa.js",
-            "main.js",
-        ]
-
-        css = {
-            "all": [
-                "admin/jquery.ui.datepicker.jalali/themes/base/jquery-ui.min.css",
-                "admin/css/main.css",
-            ]
-        }
-
-        return forms.Media(js=[static("admin/%s" % path) for path in js], css=css)
+
+    class Media:
+        js = jalali_settings.ADMIN_JS_STATIC_FILES
+        css = jalali_settings.ADMIN_CSS_STATIC_FILES
 
     def __init__(self, attrs=None, format=None):
         final_attrs = {"class": "vjDateField", "size": "10"}

django_jalali/settings.py

@@ -0,0 +1,69 @@
+from django.conf import settings
+from django.core.signals import setting_changed
+
+DEFAULTS = {
+    # JavaScript static files for the admin Jalali date widget
+    "ADMIN_JS_STATIC_FILES": [
+        "admin/jquery.ui.datepicker.jalali/scripts/jquery-1.10.2.min.js",
+        "admin/jquery.ui.datepicker.jalali/scripts/jquery.ui.core.js",
+        "admin/jquery.ui.datepicker.jalali/scripts/jquery.ui.datepicker-cc.js",
+        "admin/jquery.ui.datepicker.jalali/scripts/calendar.js",
+        "admin/jquery.ui.datepicker.jalali/scripts/jquery.ui.datepicker-cc-fa.js",
+        "admin/main.js",
+    ],
+    # CSS static files for the admin Jalali date widget
+    "ADMIN_CSS_STATIC_FILES": {
+        "all": [
+            "admin/jquery.ui.datepicker.jalali/themes/base/jquery-ui.min.css",
+            "admin/css/main.css",
+        ]
+    },
+}
+
+
+class JalaliSetting:
+    def __init__(self, defaults=None):
+        self._defaults = defaults or DEFAULTS
+        self._attrs = set()
+
+    @property
+    def user_settings(self):
+        if not hasattr(self, "_user_settings"):
+            self._user_settings = getattr(settings, "JALALI_SETTINGS", {})
+
+        return self._user_settings
+
+    def __getattr__(self, attr):
+        if attr not in self._defaults:
+            raise AttributeError(f"Invalid Jalali setting: {attr}")
+
+        try:
+            val = self.user_settings[attr]
+        except KeyError:
+            val = self._defaults[attr]
+
+        # Cache the result
+        self._attrs.add(attr)
+        setattr(self, attr, val)
+
+        return val
+
+    def reload(self):
+        for attr in self._attrs:
+            delattr(self, attr)
+
+        self._attrs.clear()
+        if hasattr(self, "_user_settings"):
+            delattr(self, "_user_settings")
+
+
+jalali_settings = JalaliSetting()
+
+
+def reload_jalali_settings(*args, **kwargs):
+    setting = kwargs["setting"]
+    if setting == "JALALI_SETTINGS":
+        jalali_settings.reload()
+
+
+setting_changed.connect(reload_jalali_settings)

tests/test_settings.py

@@ -0,0 +1,22 @@
+from django.test import TestCase, override_settings
+
+from django_jalali.settings import DEFAULTS, jalali_settings
+
+
+class TestJalaliSettings(TestCase):
+    def test_default_settings_loaded(self):
+        for key, value in DEFAULTS.items():
+            self.assertEqual(getattr(jalali_settings, key), value)
+
+    def test_override_settings(self):
+        js = ["admin/scripts/custom.js"]
+        with override_settings(JALALI_SETTINGS={"ADMIN_JS_STATIC_FILES": js}):
+            self.assertEqual(jalali_settings.ADMIN_JS_STATIC_FILES, js)
+
+        self.assertEqual(
+            jalali_settings.ADMIN_JS_STATIC_FILES, DEFAULTS["ADMIN_JS_STATIC_FILES"]
+        )
+
+    def test_invalid_setting_access_raise_attribute_error(self):
+        with self.assertRaises(AttributeError):
+            jalali_settings.INVALID_SETTING