118 lines
5.8 KiB
Python
118 lines
5.8 KiB
Python
# +======================================================================
|
|
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
|
# +----------------------------------------------------------------------
|
|
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
|
# +----------------------------------------------------------------------
|
|
# | 开源协议: Apache-2.0
|
|
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
|
# +----------------------------------------------------------------------
|
|
# | 官方网站: https://www.djangoadmin.cn
|
|
# +----------------------------------------------------------------------
|
|
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
|
# +======================================================================
|
|
# | 版权和免责声明:
|
|
# | 一、知识产权声明
|
|
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
|
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
|
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
|
# | 二、使用限制与禁止条款
|
|
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
|
# | 1. 任何违反中华人民共和国法律法规的用途；
|
|
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
|
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
|
# | 三、责任豁免
|
|
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
|
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
|
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
|
# | 四、违约与法律责任
|
|
# | 如发现任何违反本声明的行为，本团队有权：
|
|
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
|
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
|
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
|
# | 五、许可范围说明
|
|
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
|
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
|
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
|
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
|
# | 成的一切经济损失及商誉损害。
|
|
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
|
# | 许可协议》附件为准。
|
|
# +======================================================================
|
|
|
|
"""
|
|
表单错误处理工具模块
|
|
=============================================================
|
|
|
|
该模块提供统一的表单验证错误信息提取功能。
|
|
用于处理Django表单验证失败时的错误信息，将复杂的错误数据结构
|
|
转换为简洁易读的字符串格式，便于前端展示和日志记录。
|
|
|
|
主要功能：
|
|
1. 提取表单验证错误信息
|
|
2. 将错误列表转换为字符串格式
|
|
3. 支持多字段错误信息的合并展示
|
|
|
|
所属包： utils
|
|
所在文件： utils/form_errors.py
|
|
依赖模块： django.forms - Django表单模块
|
|
"""
|
|
|
|
|
|
def get_err(form):
|
|
"""
|
|
获取表单错误文本
|
|
=============================================================
|
|
|
|
从Django表单对象中提取所有错误信息，并将其合并为单个字符串。
|
|
主要用于表单验证失败时，向前端返回统一的错误提示。
|
|
|
|
参数:
|
|
form (django.forms.Form): Django表单实例，包含验证后的错误信息
|
|
|
|
返回:
|
|
str: 合并后的错误信息字符串，多个错误用'/'分隔
|
|
如果没有错误，返回空字符串
|
|
|
|
使用示例:
|
|
>>> form = UserForm(request.POST)
|
|
>>> if not form.is_valid():
|
|
... error_msg = get_err(form)
|
|
... return R.failed(msg=error_msg)
|
|
|
|
处理流程:
|
|
1. 从form.errors中获取JSON格式的错误数据
|
|
2. 遍历每个字段的错误信息
|
|
3. 提取每个错误的具体消息内容
|
|
4. 将所有错误消息合并为字符串
|
|
|
|
错误格式说明:
|
|
form.errors.get_json_data() 返回格式示例:
|
|
{
|
|
'username': [{'message': '用户名不能为空', 'code': 'required'}],
|
|
'password': [{'message': '密码长度至少6位', 'code': 'min_length'}]
|
|
}
|
|
"""
|
|
|
|
# 初始化错误列表
|
|
# 说明：用于收集所有字段的错误消息
|
|
error_list = []
|
|
|
|
# 遍历所有字段的错误信息
|
|
# 方法：form.errors.get_json_data()
|
|
# 说明：获取表单错误的JSON表示，包含每个字段的所有错误详情
|
|
for item in form.errors.get_json_data().values():
|
|
# 提取错误消息
|
|
# 说明：每个字段可能有多个错误，取第一个错误的message字段
|
|
# item[0]：获取该字段的第一个错误对象
|
|
# get('message')：从错误对象中获取具体的错误消息文本
|
|
error_list.append(item[0].get('message'))
|
|
|
|
# 合并错误字符串
|
|
# 方法：'/'.join(error_list)
|
|
# 说明：将所有错误消息用'/'连接成一个字符串
|
|
# 例如：['用户名不能为空', '密码不能为空'] -> '用户名不能为空/密码不能为空'
|
|
err_str = '/'.join(error_list)
|
|
|
|
# 返回合并后的错误字符串
|
|
return err_str
|