Files
2026-09-12 11:46:38 +08:00

435 lines
16 KiB
Python
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
用户表单验证模块
=============================================================
该模块定义了用户管理功能中使用的表单验证类。
用于对前端提交的用户数据进行验证,确保数据符合业务规则和数据库约束。
用户是系统的基本操作主体,包含个人信息、登录信息、组织归属等数据。
"""
from django import forms
from application.user import models
# =============================================================
# 用户基本信息表单验证类
# =============================================================
class UserForm(forms.ModelForm):
"""
用户基本信息表单验证类
用于创建和更新用户信息时的表单验证。
包含用户的完整信息,包括基本资料、联系方式、组织归属、登录信息等。
验证字段包括:
- 基本信息: realname, gender, avatar
- 联系方式: mobile, email
- 组织归属: deptId, levelId, positionId
- 地址信息: city, address
- 登录信息: username, password
- 其他: intro, status, note, sort, roles
"""
# ----------------------------------------------------------
# 用户姓名
# ----------------------------------------------------------
# 字段说明: 用户的真实姓名
# 字段类型: 字符型(CharField)
# 验证规则: 必填(required=True),最大长度100字符
realname = forms.CharField(
required=True,
max_length=100,
error_messages={
'required': '用户姓名不能为空',
'max_length': '用户姓名长度不得超过100个字符',
}
)
# ----------------------------------------------------------
# 性别
# ----------------------------------------------------------
# 字段说明: 用户的性别信息
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),取值范围1-3
# 可选值: 1-男, 2-女, 3-保密
gender = forms.IntegerField(
required=True,
min_value=1,
max_value=3,
error_messages={
'required': '性别不能为空',
'min_value': '性别值在1~3之间',
'max_value': '性别值在1~3之间',
}
)
# ----------------------------------------------------------
# 头像
# ----------------------------------------------------------
# 字段说明: 用户头像图片的URL地址
# 字段类型: 字符型(CharField)
# 验证规则: 必填(required=True),最大长度255字符
avatar = forms.CharField(
required=True,
max_length=255,
error_messages={
'required': '头像不能为空',
'max_length': '头像长度不得超过255个字符',
}
)
# ----------------------------------------------------------
# 手机号
# ----------------------------------------------------------
# 字段说明: 用户的手机号码
# 字段类型: 字符型(CharField)
# 验证规则: 必填(required=True),最大长度30字符
mobile = forms.CharField(
required=True,
max_length=30,
error_messages={
'required': '手机号不能为空',
'max_length': '手机号长度不得超过30个字符',
}
)
# ----------------------------------------------------------
# 邮箱
# ----------------------------------------------------------
# 字段说明: 用户的电子邮箱
# 字段类型: 字符型(CharField)
# 验证规则: 必填(required=True),最大长度30字符
email = forms.CharField(
required=True,
max_length=30,
error_messages={
'required': '邮箱不能为空',
'max_length': '邮箱长度不得超过30个字符',
}
)
# ----------------------------------------------------------
# 部门ID
# ----------------------------------------------------------
# 字段说明: 用户所属部门
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),最小值0
deptId = forms.IntegerField(
required=True,
min_value=0,
error_messages={
'required': '部门ID不能为空',
'min_value': '部门ID不得小于0',
}
)
# ----------------------------------------------------------
# 职级ID
# ----------------------------------------------------------
# 字段说明: 用户所属职级
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),最小值0
levelId = forms.IntegerField(
required=True,
min_value=0,
error_messages={
'required': '职级ID不能为空',
'min_value': '职级ID不得小于0',
}
)
# ----------------------------------------------------------
# 岗位ID
# ----------------------------------------------------------
# 字段说明: 用户所属岗位
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),最小值0
positionId = forms.IntegerField(
required=True,
min_value=0,
error_messages={
'required': '岗位ID不能为空',
'min_value': '岗位ID不得小于0',
}
)
# ----------------------------------------------------------
# 行政区划
# ----------------------------------------------------------
# 字段说明: 用户所在地区的行政区划信息
# 字段类型: 任意类型(Field基类)
# 验证规则: 必填(required=True)
city = forms.Field(
required=True,
error_messages={
'required': '所在城市不能为空',
}
)
# ----------------------------------------------------------
# 详细地址
# ----------------------------------------------------------
# 字段说明: 用户的详细街道地址
# 字段类型: 字符型(CharField)
# 验证规则: 必填(required=True),最大长度255字符
address = forms.CharField(
required=True,
max_length=255,
error_messages={
'required': '详细地址不能为空',
'max_length': '详细地址长度不得超过255个字符',
}
)
# ----------------------------------------------------------
# 用户名
# ----------------------------------------------------------
# 字段说明: 用户的登录用户名
# 字段类型: 字符型(CharField)
# 验证规则: 必填(required=True),最大长度30字符
username = forms.CharField(
required=True,
max_length=30,
error_messages={
'required': '用户名不能为空',
'max_length': '用户名长度不得超过30个字符',
}
)
# ----------------------------------------------------------
# 密码
# ----------------------------------------------------------
# 字段说明: 用户密码
# 字段类型: 字符型(CharField)
# 验证规则: 可选填(required=False),最大长度255字符
password = forms.CharField(
required=False,
max_length=255,
error_messages={
'max_length': '密码长度不得超过255个字符',
}
)
# ----------------------------------------------------------
# 个人简介
# ----------------------------------------------------------
# 字段说明: 用户的个人介绍或签名
# 字段类型: 字符型(CharField)
# 验证规则: 可选填(required=False),最大长度255字符
intro = forms.CharField(
required=False,
max_length=255,
error_messages={
'max_length': '个人简介长度不得超过255个字符',
}
)
# ----------------------------------------------------------
# 用户状态
# ----------------------------------------------------------
# 字段说明: 用户账号的可用状态
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),取值范围1-2
# 可选值: 1-正常, 2-禁用
status = forms.IntegerField(
required=True,
min_value=1,
max_value=2,
error_messages={
'required': '用户状态不能为空',
'min_value': '用户状态值在1~2之间',
'max_value': '用户状态值在1~2之间',
}
)
# ----------------------------------------------------------
# 备注
# ----------------------------------------------------------
# 字段说明: 用户的备注信息
# 字段类型: 字符型(CharField)
# 验证规则: 可选填(required=False),最大长度255字符
note = forms.CharField(
required=False,
max_length=255,
error_messages={
'max_length': '备注长度不得超过255个字符',
}
)
# ----------------------------------------------------------
# 排序
# ----------------------------------------------------------
# 字段说明: 用户的显示顺序
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),取值范围0-99999
sort = forms.IntegerField(
required=True,
min_value=0,
max_value=99999,
error_messages={
'required': '排序不能为空',
'min_value': '排序值在0~99999之间',
'max_value': '排序值在0~99999之间',
}
)
# ----------------------------------------------------------
# 用户角色
# ----------------------------------------------------------
# 字段说明: 分配给用户的角色ID列表
# 字段类型: 任意类型(Field基类)
# 验证规则: 可选填(required=False)
roles = forms.Field(
required=False,
error_messages={
'required': '用户角色不能为空',
}
)
# =============================================================
# 表单元数据配置
# =============================================================
class Meta:
"""
表单元数据配置类
定义表单绑定的模型和需要验证的字段。
"""
# 绑定模型
# 指定该表单对应的数据模型为 User(用户)
model = models.User
# 指定需要验证的字段
fields = [
'realname',
'gender',
'avatar',
'mobile',
'email',
'deptId',
'levelId',
'positionId',
'city',
'address',
'username',
'password',
'intro',
'status',
'note',
'sort',
'roles'
]
# =============================================================
# 用户状态设置表单验证类
# =============================================================
class UserStatusForm(forms.ModelForm):
"""
用户状态设置表单验证类
专门用于更新用户状态的操作,只验证 ID 和状态字段。
适用于 API 接口的状态更新操作,简化状态变更的验证流程。
验证字段:
- id: 用户ID
- status: 用户状态(1-正常, 2-禁用)
"""
# ----------------------------------------------------------
# 用户ID
# ----------------------------------------------------------
# 字段说明: 要更新的用户记录ID
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),最小值1
id = forms.IntegerField(
required=True,
min_value=1,
error_messages={
'required': '用户ID不能为空',
'min_value': '用户ID不得小于1',
}
)
# ----------------------------------------------------------
# 用户状态
# ----------------------------------------------------------
# 字段说明: 用户的新状态
# 字段类型: 整型(IntegerField)
# 验证规则: 必填(required=True),取值范围1-2
# 可选值: 1-正常, 2-禁用
status = forms.IntegerField(
required=True,
min_value=1,
max_value=2,
error_messages={
'required': '用户状态不能为空',
'min_value': '用户状态值在1~2之间',
'max_value': '用户状态值在1~2之间',
}
)
# =============================================================
# 表单元数据配置
# =============================================================
class Meta:
"""
表单元数据配置类
定义表单绑定的模型和需要验证的字段。
"""
# 绑定模型
# 指定该表单对应的数据模型为 User(用户)
model = models.User
# 指定需要验证的字段
fields = ["id", "status"]