DjangoAdmin_Flask_EleVue/application/forms/dict.py

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

"""
字典表单验证模块
=============================================================

提供字典相关的表单验证功能，包括：
- 字典添加/更新表单验证
"""

from wtforms import ValidationError, IntegerField, StringField
from wtforms.validators import NumberRange, DataRequired, Length, Optional

from application.forms.base_form import BaseForm
from application.models.dict import Dict


# ============================================================
# 字典表单验证（添加和更新共用）
# ============================================================

class DictForm(BaseForm):
    """
    字典表单验证类

    用于添加和更新字典时的数据验证。
    添加时 id 为 None，更新时 id 必须有值。

    Attributes:
        id: 字典ID（更新时必填，添加时可选）
        name: 字典名称（必填，最长150字符，不可重复）
        code: 字典编码（必填，最长150字符，不可重复）
        sort: 字典排序（必填，0-99999之间的整数）
        note: 字典备注（可选，最长255字符）
    """

    # ============================================================
    # 字典ID
    # ============================================================
    id = IntegerField(
        label='字典ID',
        validators=[
            Optional(),  # 允许为空（添加时）
            NumberRange(min=1, message='字典ID必须大于0')
        ],
        description='字典唯一标识，更新时必填，添加时自动生成'
    )

    # ============================================================
    # 字典名称
    # ============================================================
    name = StringField(
        label='字典名称',
        validators=[
            DataRequired(message='字典名称不能为空'),
            Length(max=150, message='字典名称长度不得超过150个字符')
        ],
        description='字典显示名称，如：性别、状态'
    )

    # ============================================================
    # 字典编码
    # ============================================================
    code = StringField(
        label='字典编码',
        validators=[
            DataRequired(message='字典编码不能为空'),
            Length(max=150, message='字典编码长度不得超过150个字符')
        ],
        description='字典唯一标识编码，如：gender、status'
    )

    # ============================================================
    # 字典排序
    # ============================================================
    sort = IntegerField(
        label='字典排序',
        validators=[
            Optional(),
            NumberRange(min=0, max=99999, message='字典排序值在0~99999之间')
        ],
        description='排序值，数值越小越靠前'
    )

    # ============================================================
    # 字典备注
    # ============================================================
    note = StringField(
        label='字典备注',
        validators=[
            Length(max=255, message='字典备注长度不得超过255个字符')
        ],
        description='字典补充说明'
    )

    # ============================================================
    # 自定义验证方法
    # ============================================================

    def validate_name(self, field):
        """
        自定义验证：字典名称不能重复

        验证逻辑：
            1. 添加时：检查数据库中是否存在同名记录
            2. 更新时：排除当前记录自身，检查其他记录是否同名

        Args:
            field: name 字段对象

        Raises:
            ValidationError: 字典名称已存在时抛出验证错误
        """
        if not field.data:
            return

        # 获取当前记录的ID（更新时存在，添加时为None）
        current_id = self.id.data if self.id.data else None

        # 构建查询：查找同名记录
        query = Dict.query.filter(Dict.name == field.data, Dict.is_delete == 0)

        # 如果是更新操作，排除当前记录自身
        if current_id:
            query = query.filter(Dict.id != current_id)

        # 如果存在同名记录，抛出验证错误
        if query.first():
            raise ValidationError("字典名称已存在")

    def validate_code(self, field):
        """
        自定义验证：字典编码不能重复

        验证逻辑：
            1. 添加时：检查数据库中是否存在相同编码记录
            2. 更新时：排除当前记录自身，检查其他记录是否相同编码

        Args:
            field: code 字段对象

        Raises:
            ValidationError: 字典编码已存在时抛出验证错误
        """
        if not field.data:
            return

        # 获取当前记录的ID（更新时存在，添加时为None）
        current_id = self.id.data if self.id.data else None

        # 构建查询：查找相同编码记录
        query = Dict.query.filter(Dict.code == field.data, Dict.is_delete == 0)

        # 如果是更新操作，排除当前记录自身
        if current_id:
            query = query.filter(Dict.id != current_id)

        # 如果存在相同编码记录，抛出验证错误
        if query.first():
            raise ValidationError("字典编码已存在")