DjangoAdmin_Flask_EleVue/application/models/user.py

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

"""
用户模型模块
=============================================================

提供用户管理的数据模型定义，用于存储系统用户基本信息。
"""

from application.models.base_db import BaseDB
from application.models.base_model import BaseModel
from config import DB_PREFIX
from extensions import db
from utils.case_converter import convert_camel_to_snake


# ============================================================
# 用户模型
# ============================================================

class User(BaseModel, BaseDB):
    """
    用户模型

    用于存储系统用户信息，包括基本信息、联系方式、地址等。
    继承自 BaseModel（通用字段）和 BaseDB（数据库操作方法）。

    Attributes:
        id: 主键ID（继承自 BaseModel）
        realname: 用户姓名（String(150)，必填）
        gender: 性别（Integer，1-男，2-女，3-保密，默认1）
        avatar: 用户头像（String(255)，必填）
        mobile: 手机号（String(30)，必填）
        email: 邮箱（String(30)，必填）
        dept_id: 部门ID（Integer，默认0）
        level_id: 职级ID（Integer，默认0）
        position_id: 岗位ID（Integer，默认0）
        province_code: 省份编码（String(30)，必填）
        city_code: 城市编码（String(30)，必填）
        district_code: 县区编码（String(30)，必填）
        street_code: 街道编码（String(30)，必填）
        city_info: 省市区信息（String(255)，可选）
        address: 详细地址（String(255)，必填）
        username: 用户名（String(30)，可选，登录账号）
        password: 密码（String(255)，可选，加密存储）
        salt: 加密盐（String(30)，可选）
        intro: 个人简介（String(255)，可选）
        status: 用户状态（Integer，1-正常，2-禁用，默认1）
        sort: 排序（Integer，默认0，数值越小越靠前）
        note: 个人备注（String(255)，可选）
    """

    # ============================================================
    # 表配置
    # ============================================================

    # 设置表名
    __tablename__ = DB_PREFIX + "user"

    # ============================================================
    # 字段定义
    # ============================================================

    # 用户姓名
    realname = db.Column(
        db.String(150),
        nullable=False,
        comment="用户姓名"
    )

    # 性别：1-男 2-女 3-保密
    gender = db.Column(
        db.Integer,
        default=1,
        comment="性别：1-男 2-女 3-保密"
    )

    # 用户头像
    avatar = db.Column(
        db.String(255),
        nullable=False,
        comment="用户头像"
    )

    # 手机号
    mobile = db.Column(
        db.String(30),
        nullable=False,
        comment="手机号"
    )

    # 邮箱
    email = db.Column(
        db.String(30),
        nullable=False,
        comment="邮箱"
    )

    # 部门ID
    dept_id = db.Column(
        db.Integer,
        default=0,
        comment="部门ID"
    )

    # 职级ID
    level_id = db.Column(
        db.Integer,
        default=0,
        comment="职级ID"
    )

    # 岗位ID
    position_id = db.Column(
        db.Integer,
        default=0,
        comment="岗位ID"
    )

    # 省份编码
    province_code = db.Column(
        db.String(30),
        nullable=False,
        comment="省份编码"
    )

    # 城市编码
    city_code = db.Column(
        db.String(30),
        nullable=False,
        comment="城市编码"
    )

    # 县区编码
    district_code = db.Column(
        db.String(30),
        nullable=False,
        comment="县区编码"
    )

    # 街道编码
    street_code = db.Column(
        db.String(30),
        nullable=False,
        comment="街道编码"
    )

    # 省市区信息
    city_info = db.Column(
        db.String(255),
        nullable=True,
        comment="省市区信息"
    )

    # 详细地址
    address = db.Column(
        db.String(255),
        nullable=False,
        comment="详细地址"
    )

    # 用户名
    username = db.Column(
        db.String(30),
        nullable=True,
        comment="用户名"
    )

    # 密码
    password = db.Column(
        db.String(255),
        nullable=True,
        comment="密码"
    )

    # 加密盐
    salt = db.Column(
        db.String(30),
        nullable=True,
        comment="加密盐"
    )

    # 个人简介
    intro = db.Column(
        db.String(255),
        nullable=True,
        comment="个人简介"
    )

    # 状态：1-正常 2-禁用
    status = db.Column(
        db.Integer,
        default=1,
        comment="状态：1-正常 2-禁用"
    )

    # 排序
    sort = db.Column(
        db.Integer,
        default=0,
        comment="排序"
    )

    # 个人备注
    note = db.Column(
        db.String(255),
        nullable=True,
        comment="个人备注"
    )

    # ============================================================
    # 魔法方法
    # ============================================================

    def __str__(self):
        """
        返回模型的字符串表示

        Returns:
            str: 格式为 "用户{id}" 的字符串
        """
        return "用户{}".format(self.id)