# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意，禁止将本产品用于以下任何行为：
# | 1. 任何违反中华人民共和国法律法规的用途；
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为，本团队有权：
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================

"""
{{ module_comment }}表单验证模块模板
=============================================================

该模板用于生成{{ module_comment }}管理功能中使用的表单验证类。
用于对前端提交的{{ module_comment }}数据进行验证，确保数据符合业务规则和数据库约束。
{{ module_comment }}用于{{ business_description }}。

模板变量说明：
    - module_comment: 模块注释，如"文章管理"
    - app_name: 应用名称，如"article"
    - model_class_name: 模型类名，如"Article"
    - form_fields: 表单字段列表
    - has_unique_code: 是否包含唯一编码字段
    - business_description: 业务描述
    - business_description_detail: 详细业务描述
"""

from django import forms

from application.{{ app_name }} import models


# =============================================================
# {{ module_comment }}表单验证类
# =============================================================

class {{ model_class_name }}Form(forms.ModelForm):
    """
    {{ module_comment }}表单验证类

    用于创建和更新{{ module_comment }}信息时的表单验证。
    {{ business_description_detail }}

    验证字段包括：
{% for field in form_fields %}
    - {{ field.camel_name }}: {{ field.comment }}
{% endfor %}
    """

{% for field in form_fields %}
    # ----------------------------------------------------------
    # {{ field.comment }}
    # ----------------------------------------------------------
    # 字段说明: {{ field.purpose }}
    # 字段类型: {{ field.type_display }}
    # 验证规则: {% if field.required %}必填（required=True）{% else %}可选填（required=False）{% endif %}{% if field.max_length %}，最大长度{{ field.max_length }}字符{% endif %}{% if field.min_value != None %}，最小值{{ field.min_value }}{% endif %}{% if field.max_value != None %}，最大值{{ field.max_value }}{% endif %}
    # 业务说明: {{ field.purpose }}
    # 示例: {{ field.example }}
    {{ field.camel_name }} = forms.{{ field.form_field_type }}(
        {% if field.required %}
        required=True,
        {% else %}
        required=False,
        {% endif %}
        {% if field.max_length %}
        max_length={{ field.max_length }},
        {% endif %}
        {% if field.min_value != None %}
        min_value={{ field.min_value }},
        {% endif %}
        {% if field.max_value != None %}
        max_value={{ field.max_value }},
        {% endif %}
        error_messages={
            {% if field.required %}
            'required': '{{ field.label }}不能为空',
            {% endif %}
            {% if field.max_length %}
            'max_length': '{{ field.label }}长度不得超过{{ field.max_length }}个字符',
            {% endif %}
            {% if field.min_value != None %}
            'min_value': '{{ field.label }}不能小于{{ field.min_value }}',
            {% endif %}
            {% if field.max_value != None %}
            'max_value': '{{ field.label }}不能大于{{ field.max_value }}',
            {% endif %}
        }
    )

{% endfor %}
    # =============================================================
    # 表单元数据配置
    # =============================================================

    class Meta:
        """
        表单元数据配置类

        定义表单绑定的模型和需要验证的字段。
        """

        # 绑定模型
        # 指定该表单对应的数据模型为 {{ model_class_name }}（{{ module_comment }}）
        model = models.{{ model_class_name }}

        # 指定需要验证的字段
        # 只验证以下字段，其他字段不进行表单验证
        fields = [
            {% for field in form_fields %}
            '{{ field.camel_name }}',
            {% endfor %}
        ]

{% if has_unique_code %}
    # =============================================================
    # 自定义验证方法
    # =============================================================

    def clean_code(self):
        """
        自定义编码唯一性验证

        验证编码的唯一性，确保编码不重复。

        Returns:
            str: 清洗后的编码

        Raises:
            forms.ValidationError: 编码格式错误或编码已存在时抛出
        """
        code = self.cleaned_data.get('code')

        if code:
            # 验证编码格式：只允许大写字母、数字和下划线
            if not code.replace('_', '').isalnum() or not code.isupper():
                raise forms.ValidationError('编码只能包含大写字母、数字和下划线')

            # 验证编码唯一性（排除当前实例）
            instance = getattr(self, 'instance', None)
            queryset = models.{{ model_class_name }}.objects.filter(code=code)

            # 如果是更新操作，排除当前记录本身
            if instance and instance.pk:
                queryset = queryset.exclude(pk=instance.pk)

            # 如果编码已存在，抛出验证错误
            if queryset.exists():
                raise forms.ValidationError('编码已存在，请使用其他编码')

        return code
{% endif %}