Implemented a comprehensive update to handle Nepali (Bikram Sambat) localization more robustly across models, forms, admin, and API serializers. This includes native support for Devanagari script output and a complete documentation overhaul. Models & Fields: - Added [NepaliFieldMixin](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/models.py:15:0-36:39) to support [ne](cci:1://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/admin.py:146:4-163:67) (Nepali) and [en](cci:1://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/widgets.py:4:0-10:16) (English) toggles for all custom fields. - Updated [NepaliDateField](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/models.py:48:0-134:44), [NepaliDateTimeField](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/models.py:144:0-217:44), and [NepaliTimeField](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/models.py:137:0-141:34) with the new mixin and improved deconstruction. - Enhanced address fields ([ProvinceField](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/models.py:220:0-262:23), [DistrictField](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/models.py:265:0-286:66), [MunicipalityField](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/models.py:289:0-310:66)) to support bilingual choices. Admin Enhancements: - Refactored date formatting into a common utility supporting Devanagari via `strftime_ne`. - Updated [NepaliModelAdmin](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/admin.py:186:0-294:9) and [NepaliAdminMixin](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/admin.py:118:0-183:75) to auto-detect [ne](cci:1://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/admin.py:146:4-163:67) settings from model fields for [list_display](cci:1://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/admin.py:230:4-250:21). - Improved widget injection in the admin to respect field-level localization settings. - Added a JS bridge for admin jQuery compatibility with the Nepali datepicker. Forms & Widgets: - Introduced [NepaliWidgetMixin](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/widgets.py:13:0-38:12) to handle localization data attributes in the frontend. - Updated [NepaliDatePickerWidget](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/widgets.py:63:0-99:42) with improved asset loading and Devanagari support. - Fixed [NepaliDateFormField](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/forms.py:10:0-41:13) to correctly handle `empty_value` passed by the Django admin. DRF (Serializers): - Added [BaseNepaliBSField](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/serializers.py:21:0-106:48) to DRF serializers with support for `ne=True` for Devanagari output. - Implemented specialized [NepaliDateSerializerField](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/serializers.py:114:0-122:28) and [NepaliDateTimeSerializerField](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/serializers.py:130:0-138:32). Documentation: - Completely revamped [README.md](cci:7://file:///home/sankalp/Projects/prod-django-nepkit/README.md:0:0-0:0) with professional design, badges, and detailed usage guides. - Added explicit instructions for address chaining URLs and [NepaliAdminMixin](cci:2://file:///home/sankalp/Projects/prod-django-nepkit/django_nepkit/admin.py:118:0-183:75) usage. Misc: - Optimized address chaining JS logic. - Updated example demo app models and migrations to reflect new field capabilities.
100 lines
3.1 KiB
Python
100 lines
3.1 KiB
Python
from django import forms
|
|
from django.urls import reverse_lazy
|
|
from nepali.datetime import nepalidate
|
|
|
|
|
|
def _append_css_class(attrs, class_name: str):
|
|
"""
|
|
Django-idiomatic helper to append a CSS class without clobbering existing ones.
|
|
"""
|
|
existing = (attrs.get("class") or "").strip()
|
|
attrs["class"] = (f"{existing} {class_name}").strip() if existing else class_name
|
|
return attrs
|
|
|
|
|
|
class NepaliWidgetMixin:
|
|
def __init__(self, *args, **kwargs):
|
|
self.ne = kwargs.pop("ne", False)
|
|
en_value = kwargs.pop("en", True)
|
|
if self.ne:
|
|
self.en = False
|
|
else:
|
|
self.en = en_value
|
|
|
|
attrs = kwargs.get("attrs", {}) or {}
|
|
|
|
# Add data attributes
|
|
if self.ne:
|
|
attrs["data-ne"] = "true"
|
|
if self.en:
|
|
attrs["data-en"] = "true"
|
|
|
|
# Hook for subclasses to add specific classes/attrs
|
|
self._configure_attrs(attrs)
|
|
|
|
kwargs["attrs"] = attrs
|
|
super().__init__(*args, **kwargs)
|
|
|
|
def _configure_attrs(self, attrs):
|
|
"""Override in subclasses to add specific classes or attributes."""
|
|
pass
|
|
|
|
|
|
class ChainedSelectWidget(forms.Select):
|
|
class Media:
|
|
js = ("django_nepkit/js/address-chaining.js",)
|
|
|
|
|
|
class ProvinceSelectWidget(NepaliWidgetMixin, ChainedSelectWidget):
|
|
def _configure_attrs(self, attrs):
|
|
_append_css_class(attrs, "nepkit-province-select")
|
|
|
|
|
|
class DistrictSelectWidget(NepaliWidgetMixin, ChainedSelectWidget):
|
|
def _configure_attrs(self, attrs):
|
|
_append_css_class(attrs, "nepkit-district-select")
|
|
attrs["data-url"] = reverse_lazy("django_nepkit:district-list")
|
|
|
|
|
|
class MunicipalitySelectWidget(NepaliWidgetMixin, ChainedSelectWidget):
|
|
def _configure_attrs(self, attrs):
|
|
_append_css_class(attrs, "nepkit-municipality-select")
|
|
attrs["data-url"] = reverse_lazy("django_nepkit:municipality-list")
|
|
|
|
|
|
class NepaliDatePickerWidget(NepaliWidgetMixin, forms.TextInput):
|
|
input_type = "text"
|
|
|
|
class Media:
|
|
css = {
|
|
"all": (
|
|
"https://nepalidatepicker.sajanmaharjan.com.np/v5/nepali.datepicker/css/nepali.datepicker.v5.0.6.min.css",
|
|
)
|
|
}
|
|
js = (
|
|
"https://code.jquery.com/jquery-3.5.1.slim.min.js",
|
|
"https://nepalidatepicker.sajanmaharjan.com.np/v5/nepali.datepicker/js/nepali.datepicker.v5.0.6.min.js",
|
|
"django_nepkit/js/nepali-datepicker-init.js",
|
|
)
|
|
|
|
def _configure_attrs(self, attrs):
|
|
# Clean up Django admin class if present
|
|
classes = attrs.get("class", "")
|
|
if "vDateField" in classes:
|
|
classes = classes.replace("vDateField", "")
|
|
attrs["class"] = classes
|
|
|
|
_append_css_class(attrs, "nepkit-datepicker")
|
|
attrs["autocomplete"] = "off"
|
|
attrs["placeholder"] = "YYYY-MM-DD"
|
|
|
|
def format_value(self, value):
|
|
if value is None:
|
|
return None
|
|
|
|
if self.ne and isinstance(value, nepalidate):
|
|
if hasattr(value, "strftime_ne"):
|
|
return value.strftime_ne("%Y-%m-%d")
|
|
|
|
return super().format_value(value)
|