Django Jalali 技术文档

2024-12-26 09:08:42作者：冯爽妲Honey

1. 安装指南

Django Jalali 是一个 Django 扩展模块，提供了对波斯历（Jalali 日历）的支持。安装 Django Jalali 非常简单，只需使用 pip 命令即可：

pip install django_jalali

如果您需要使用 Django REST Framework（DRF）的相关功能，请使用以下命令安装：

pip install django_jalali[drf]

2. 项目使用说明

Django Jalali 允许您在 Django 项目中使用波斯历日期字段。以下是基本使用步骤：

创建一个 Django 项目：

django-admin startproject jalali_test

创建一个应用：

python manage.py startapp foo

在项目的 settings.py 文件中，将 django_jalali 和您的应用 foo 添加到 INSTALLED_APPS 中，并确保 django_jalali 在您的应用之前添加。

INSTALLED_APPS = [
    'django_jalali',
    'foo',
]

在您的应用模型中，使用 jmodels.jDateField 和 jmodels.jDateTimeField 替代 Django 的 DateField 和 DateTimeField。

from django.db import models
from django_jalali.db import models as jmodels

class Bar(models.Model):
    objects = jmodels.jManager()
    name = models.CharField(max_length=200)
    date = jmodels.jDateField()

    def __str__(self):
        return "%s, %s" % (self.name, self.date)

应用迁移：

python manage.py makemigrations
python manage.py migrate

使用 Django shell 测试功能：

python manage.py shell

在 shell 中，您可以创建和查询基于波斯历的日期数据。

3. 项目API使用文档

Django Jalali 提供了以下字段类型供模型使用：

jmodels.jDateField: 用于存储波斯历日期。
jmodels.jDateTimeField: 用于存储波斯历日期和时间。

对于 Django REST Framework，有相应的序列化字段：

JDateField: 用于序列化和反序列化 jmodels.jDateField。
JDateTimeField: 用于序列化和反序列化 jmodels.jDateTimeField。

示例序列化器：

from django_jalali.serializers.serializerfield import JDateField, JDateTimeField
from rest_framework.serializers import ModelSerializer
from foo.models import Bar, BarTime

class JDateFieldSerializer(ModelSerializer):
    date = JDateField()

    class Meta:
        model = Bar
        exclude = []

class JDateTimeFieldSerializer(ModelSerializer):
    datetime = JDateTimeField()

    class Meta:
        model = BarTime
        exclude = []