sankalp
09f302ceaa
- Implement server-side location chaining with HTMX support via `htmx=True` in fields and widgets. - Update location views to handle HTMX requests and return HTML <option> fragments. - Add NepaliDateYearFilter and NepaliDateRangeFilter for robust DRF API filtering. - Expand default `DATE_INPUT_FORMATS` in configuration to support multiple common Nepali date styles. - Update DRF serializers to automatically respect global `NEPKIT` configuration settings. - Add `django-filter` as an optional dependency under the `drf` extra in pyproject.toml. - Correct underlying dependency references from `nepali-datetime` to nepali library. - Complete overhaul of README.md for premium DX, including new sections for storage behavior, timezone awareness, and API usage.
149 lines
4.3 KiB
Python
149 lines
4.3 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import Any, Optional, Type
|
|
|
|
from nepali.datetime import nepalidate, nepalidatetime
|
|
|
|
try:
|
|
from rest_framework import serializers
|
|
except ModuleNotFoundError as e:
|
|
raise ModuleNotFoundError(
|
|
"django-nepkit DRF support is optional. Install with `django-nepkit[drf]` "
|
|
"to use `django_nepkit.serializers`."
|
|
) from e
|
|
|
|
from django_nepkit.utils import try_parse_nepali_date, try_parse_nepali_datetime
|
|
from django_nepkit.conf import nepkit_settings
|
|
|
|
# --------------------------------------------------
|
|
# Base Serializer Field
|
|
# --------------------------------------------------
|
|
|
|
|
|
class BaseNepaliBSField(serializers.Field):
|
|
"""
|
|
Base DRF field for Nepali (BS) Date / DateTime.
|
|
|
|
- **Input**: BS string, or an already-parsed `nepalidate`/`nepalidatetime`
|
|
- **Output**: formatted BS string (configurable)
|
|
- **ne**: If True, output uses Devanagari script (default: False)
|
|
- **en**: If True, output uses English (default: True). When ne=True, en is False.
|
|
"""
|
|
|
|
format: str = ""
|
|
nepali_type: Type[object] = object
|
|
|
|
default_error_messages = {
|
|
"invalid": "Invalid Bikram Sambat value. Expected format: {format}.",
|
|
"invalid_type": "Invalid type. Expected a string.",
|
|
}
|
|
|
|
def __init__(
|
|
self,
|
|
*,
|
|
format: Optional[str] = None,
|
|
ne: Optional[bool] = None,
|
|
en: Optional[bool] = None,
|
|
**kwargs: Any,
|
|
) -> None:
|
|
"""
|
|
Args:
|
|
format: Optional `strftime` format used for representation.
|
|
If not provided, uses the class default.
|
|
ne: If True, output in Devanagari script. If None, uses DEFAULT_LANGUAGE.
|
|
en: If True, output in English. If None, derived from ne.
|
|
"""
|
|
if format is not None:
|
|
self.format = format
|
|
|
|
default_lang = nepkit_settings.DEFAULT_LANGUAGE
|
|
|
|
if ne is None:
|
|
self.ne = default_lang == "ne"
|
|
else:
|
|
self.ne = ne
|
|
|
|
if en is None:
|
|
self.en = not self.ne
|
|
else:
|
|
self.en = en
|
|
|
|
super().__init__(**kwargs)
|
|
|
|
def _parse(self, value: str):
|
|
if self.nepali_type is nepalidate:
|
|
return try_parse_nepali_date(value)
|
|
if self.nepali_type is nepalidatetime:
|
|
return try_parse_nepali_datetime(value)
|
|
return None
|
|
|
|
def _format_value(self, value: Any) -> str:
|
|
"""Format value using strftime or strftime_ne (Devanagari) based on self.ne."""
|
|
if self.ne and hasattr(value, "strftime_ne"):
|
|
return value.strftime_ne(self.format) # type: ignore[attr-defined]
|
|
return value.strftime(self.format) # type: ignore[attr-defined]
|
|
|
|
def to_representation(self, value: Any) -> Optional[str]:
|
|
if value is None:
|
|
return None
|
|
|
|
if isinstance(value, self.nepali_type):
|
|
return self._format_value(value)
|
|
|
|
# If DB returns string, try to normalize it.
|
|
if isinstance(value, str):
|
|
parsed = self._parse(value)
|
|
if parsed is not None:
|
|
return self._format_value(parsed)
|
|
|
|
# Fallback: best-effort stringify (keeps behavior non-breaking)
|
|
return str(value)
|
|
|
|
def to_internal_value(self, data: Any):
|
|
if data in (None, ""):
|
|
return None
|
|
|
|
if isinstance(data, self.nepali_type):
|
|
return data
|
|
|
|
if not isinstance(data, str):
|
|
self.fail("invalid_type")
|
|
|
|
parsed = self._parse(data)
|
|
if parsed is not None:
|
|
return parsed
|
|
|
|
self.fail("invalid", format=self.format)
|
|
|
|
|
|
# --------------------------------------------------
|
|
# Nepali Date (BS)
|
|
# --------------------------------------------------
|
|
|
|
|
|
class NepaliDateSerializerField(BaseNepaliBSField):
|
|
"""
|
|
DRF field for Nepali BS Date (YYYY-MM-DD).
|
|
|
|
Pass ne=True for Devanagari output; default is English.
|
|
"""
|
|
|
|
format = "%Y-%m-%d"
|
|
nepali_type = nepalidate
|
|
|
|
|
|
# --------------------------------------------------
|
|
# Nepali DateTime (BS)
|
|
# --------------------------------------------------
|
|
|
|
|
|
class NepaliDateTimeSerializerField(BaseNepaliBSField):
|
|
"""
|
|
DRF field for Nepali BS DateTime (YYYY-MM-DD HH:MM:SS).
|
|
|
|
Pass ne=True for Devanagari output; default is English.
|
|
"""
|
|
|
|
format = "%Y-%m-%d %H:%M:%S"
|
|
nepali_type = nepalidatetime
|