schema.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  1. from typing import Optional
  2. from urllib.parse import urlparse
  3. from fastapi import Query
  4. from pydantic import (
  5. BaseModel,
  6. ConfigDict,
  7. EmailStr,
  8. Field,
  9. field_validator,
  10. model_validator,
  11. )
  12. from app.api.v1.module_system.auth.schema import SmsCodeSchema
  13. from app.api.v1.module_system.menu.schema import MenuOutSchema
  14. from app.api.v1.module_system.role.schema import RoleOutSchema
  15. from app.common.enums import QueueEnum
  16. from app.core.base_schema import BaseSchema, CommonSchema, TenantBySchema, UserBySchema
  17. from app.core.validator import DateTimeStr, email_validator, mobile_validator
  18. class CurrentUserUpdateSchema(BaseModel):
  19. """基础用户信息"""
  20. name: str | None = Field(default=None, description="名称")
  21. mobile: str | None = Field(default=None, description="手机号")
  22. email: EmailStr | None = Field(default=None, description="邮箱")
  23. gender: str | None = Field(default=None, description="性别")
  24. avatar: str | None = Field(default=None, description="头像")
  25. @field_validator("mobile")
  26. @classmethod
  27. def validate_mobile(cls, value: str | None):
  28. """
  29. 校验手机号格式(委托到 `mobile_validator`)。
  30. 参数:
  31. - value (str | None): 手机号。
  32. 返回:
  33. - str | None: 校验后的手机号。
  34. 异常:
  35. - CustomException: 手机号格式非法时抛出。
  36. """
  37. return mobile_validator(value)
  38. @field_validator("email")
  39. @classmethod
  40. def validate_email(cls, value: str | None):
  41. """
  42. 校验邮箱格式(为空则跳过;否则委托到 `email_validator`)。
  43. 参数:
  44. - value (str | None): 邮箱。
  45. 返回:
  46. - str | None: 校验后的邮箱。
  47. 异常:
  48. - CustomException: 邮箱格式非法时抛出。
  49. """
  50. if not value:
  51. return value
  52. return email_validator(value)
  53. @field_validator("avatar")
  54. @classmethod
  55. def validate_avatar(cls, value: str | None):
  56. """
  57. 校验头像地址为合法的 HTTP/HTTPS URL。
  58. 参数:
  59. - value (str | None): 头像 URL。
  60. 返回:
  61. - str | None: 校验后的头像 URL。
  62. 异常:
  63. - ValueError: 头像 URL 非法时抛出。
  64. """
  65. if not value:
  66. return value
  67. parsed = urlparse(value)
  68. if parsed.scheme in ("http", "https") and parsed.netloc:
  69. return value
  70. raise ValueError("头像地址需为有效的HTTP/HTTPS URL")
  71. @model_validator(mode="after")
  72. def check_model(self):
  73. """
  74. 校验基础用户信息的长度约束。
  75. 返回:
  76. - CurrentUserUpdateSchema: 校验后的同一实例。
  77. 异常:
  78. - ValueError: 字段长度超限时抛出。
  79. """
  80. if self.name and len(self.name) > 32:
  81. raise ValueError("名称长度不能超过32个字符")
  82. return self
  83. class UserRegisterSchema(BaseModel):
  84. """注册"""
  85. name: str | None = Field(default=None, description="名称")
  86. template_name: Optional[str] = Field(default="verify", description="模版名称")
  87. invite_code: str = Field(default=None, description="邀请码")
  88. mobile: str = Field(default=None, description="手机号")
  89. sms_code: Optional[str] = Field(default=None, description="验证码")
  90. username: str = Field(..., description="账号")
  91. password: str = Field(..., description="密码哈希值")
  92. role_ids: list[int] | None = Field(default=[1], description="角色ID")
  93. created_id: int | None = Field(default=1, description="创建人ID")
  94. description: str | None = Field(default=None, max_length=255, description="备注")
  95. @field_validator("mobile")
  96. @classmethod
  97. def validate_mobile(cls, value: str | None):
  98. """
  99. 校验手机号格式(委托到 `mobile_validator`)。
  100. 参数:
  101. - value (str | None): 手机号。
  102. 返回:
  103. - str | None: 校验后的手机号。
  104. 异常:
  105. - CustomException: 手机号格式非法时抛出。
  106. """
  107. return mobile_validator(value)
  108. @field_validator("username")
  109. @classmethod
  110. def validate_username(cls, value: str):
  111. """
  112. 校验并规范化账号:字母开头,长度 3-32,仅含字母/数字/_ . -。
  113. 参数:
  114. - value (str): 账号。
  115. 返回:
  116. - str: 规范化后的账号。
  117. 异常:
  118. - ValueError: 账号为空或不满足格式约束时抛出。
  119. """
  120. v = value.strip()
  121. if not v:
  122. raise ValueError("账号不能为空")
  123. # 字母开头,允许字母数字_.-
  124. # import re
  125. #
  126. # if not re.match(r"^[A-Za-z][A-Za-z0-9_.-]{2,31}$", v):
  127. # raise ValueError("账号需字母开头,3-32位,仅含字母/数字/_ . -")
  128. return v
  129. @model_validator(mode="after")
  130. def check_model(self):
  131. """
  132. 校验注册信息的长度约束。
  133. 返回:
  134. - UserRegisterSchema: 校验后的同一实例。
  135. 异常:
  136. - ValueError: 任一字段长度超限时抛出。
  137. """
  138. if self.name and len(self.name) > 32:
  139. raise ValueError("名称长度不能超过32个字符")
  140. if self.username and len(self.username) > 32:
  141. raise ValueError("账号长度不能超过32个字符")
  142. if self.description and len(self.description) > 255:
  143. raise ValueError("备注长度不能超过255个字符")
  144. if self.password and len(self.password) > 128:
  145. raise ValueError("密码长度不能超过128个字符")
  146. return self
  147. class UserForgetPasswordSchema(BaseModel):
  148. """忘记密码"""
  149. username: str = Field(..., max_length=32, description="用户名")
  150. new_password: str = Field(..., max_length=128, description="新密码")
  151. mobile: str | None = Field(default=None, description="手机号")
  152. @field_validator("mobile")
  153. @classmethod
  154. def validate_mobile(cls, value: str | None):
  155. """
  156. 校验手机号格式(委托到 `mobile_validator`)。
  157. 参数:
  158. - value (str | None): 手机号。
  159. 返回:
  160. - str | None: 校验后的手机号。
  161. 异常:
  162. - CustomException: 手机号格式非法时抛出。
  163. """
  164. return mobile_validator(value)
  165. class UserChangePasswordSchema(BaseModel):
  166. """修改密码"""
  167. old_password: str = Field(..., max_length=128, description="旧密码")
  168. new_password: str = Field(..., max_length=128, description="新密码")
  169. class ResetPasswordSchema(BaseModel):
  170. """重置密码"""
  171. id: int = Field(..., description="主键ID")
  172. password: str = Field(..., min_length=6, max_length=128, description="新密码")
  173. class UserCreateSchema(CurrentUserUpdateSchema):
  174. """新增"""
  175. model_config = ConfigDict(from_attributes=True)
  176. username: str | None = Field(default=None, max_length=32, description="用户名")
  177. password: str | None = Field(default=None, max_length=128, description="密码哈希值")
  178. status: str = Field(default="0", description="是否可用")
  179. description: str | None = Field(default=None, max_length=255, description="备注")
  180. is_superuser: bool | None = Field(default=False, description="是否超管")
  181. dept_id: int | None = Field(default=None, description="部门ID")
  182. tenant_id: int | None = Field(default=None, description="租户ID,仅平台管理员创建时可指定")
  183. role_ids: list[int] | None = Field(default=[], description="角色ID")
  184. position_ids: list[int] | None = Field(default=[], description="岗位ID")
  185. class UserUpdateSchema(UserCreateSchema):
  186. """更新"""
  187. model_config = ConfigDict(from_attributes=True)
  188. last_login: DateTimeStr | None = Field(default=None, description="最后登录时间")
  189. class UserOutSchema(UserUpdateSchema, BaseSchema, UserBySchema, TenantBySchema):
  190. """响应"""
  191. model_config = ConfigDict(arbitrary_types_allowed=True, from_attributes=True)
  192. tenant_id: int | None = Field(
  193. default=None,
  194. exclude=True,
  195. description="创建入参使用;列表/详情出参见 tenant",
  196. )
  197. gitee_login: str | None = Field(default=None, max_length=32, description="Gitee登录")
  198. github_login: str | None = Field(default=None, max_length=32, description="Github登录")
  199. wx_login: str | None = Field(default=None, max_length=32, description="微信登录")
  200. qq_login: str | None = Field(default=None, max_length=32, description="QQ登录")
  201. dept_name: str | None = Field(default=None, description="部门名称")
  202. dept: CommonSchema | None = Field(default=None, description="部门")
  203. positions: list[CommonSchema] | None = Field(default=[], description="岗位")
  204. roles: list[RoleOutSchema] | None = Field(default=[], description="角色")
  205. menus: list[MenuOutSchema] | None = Field(default=[], description="菜单")
  206. class UserQueryParam:
  207. """用户管理查询参数"""
  208. def __init__(
  209. self,
  210. username: str | None = Query(None, description="用户名"),
  211. name: str | None = Query(None, description="名称"),
  212. mobile: str | None = Query(None, description="手机号", pattern=r"^1[3-9]\d{9}$"),
  213. email: str | None = Query(
  214. None,
  215. description="邮箱",
  216. pattern=r"^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$",
  217. ),
  218. dept_id: int | None = Query(None, description="部门ID"),
  219. tenant_id: int | None = Query(None, description="租户ID(仅平台管理员可筛选)"),
  220. status: str | None = Query(None, description="是否可用"),
  221. created_time: list[DateTimeStr] | None = Query(
  222. None,
  223. description="创建时间范围",
  224. examples=["2025-01-01 00:00:00", "2025-12-31 23:59:59"],
  225. ),
  226. updated_time: list[DateTimeStr] | None = Query(
  227. None,
  228. description="更新时间范围",
  229. examples=["2025-01-01 00:00:00", "2025-12-31 23:59:59"],
  230. ),
  231. created_id: int | None = Query(None, description="创建人"),
  232. updated_id: int | None = Query(None, description="更新人"),
  233. ) -> None:
  234. # 模糊查询字段
  235. self.username = (QueueEnum.like.value, username)
  236. self.name = (QueueEnum.like.value, name)
  237. self.mobile = (QueueEnum.like.value, mobile)
  238. self.email = (QueueEnum.like.value, email)
  239. # 精确查询字段
  240. self.dept_id = (QueueEnum.eq.value, dept_id)
  241. self.tenant_id = (QueueEnum.eq.value, tenant_id)
  242. self.created_id = (QueueEnum.eq.value, created_id)
  243. self.updated_id = (QueueEnum.eq.value, updated_id)
  244. self.status = (QueueEnum.eq.value, status)
  245. # 时间范围查询
  246. if created_time and len(created_time) == 2:
  247. self.created_time = (QueueEnum.between.value, (created_time[0], created_time[1]))
  248. if updated_time and len(updated_time) == 2:
  249. self.updated_time = (QueueEnum.between.value, (updated_time[0], updated_time[1]))