mirror of
https://github.com/fastapiadmin/FastapiAdmin.git
synced 2026-09-21 04:46:26 +00:00
zhangtao
b0ae6af3b1
- Added *.pyc and *.pyo to .gitignore to prevent compiled Python files from being tracked. - Improved docstrings in various modules, providing clearer descriptions of functions, parameters, and return values to enhance code readability and maintainability.
126 lines
4.1 KiB
Python
126 lines
4.1 KiB
Python
from fastapi import Query
|
|
from pydantic import (
|
|
BaseModel,
|
|
ConfigDict,
|
|
Field,
|
|
field_validator,
|
|
model_validator,
|
|
)
|
|
|
|
from app.api.v1.module_system.dept.schema import DeptOutSchema
|
|
from app.api.v1.module_system.menu.schema import MenuOutSchema
|
|
from app.common.enums import QueueEnum
|
|
from app.core.base_schema import BaseSchema
|
|
from app.core.validator import (
|
|
DateTimeStr,
|
|
code_validator,
|
|
role_permission_request_validator,
|
|
)
|
|
|
|
|
|
class RoleCreateSchema(BaseModel):
|
|
"""角色创建模型"""
|
|
|
|
name: str = Field(..., max_length=64, description="角色名称")
|
|
code: str | None = Field(default=None, max_length=16, description="角色编码")
|
|
order: int | None = Field(default=1, ge=1, description="显示排序")
|
|
data_scope: int | None = Field(
|
|
default=1,
|
|
description="数据权限范围(1:仅本人 2:本部门 3:本部门及以下 4:全部 5:自定义)",
|
|
)
|
|
status: str = Field(default="0", description="是否启用")
|
|
description: str | None = Field(default=None, max_length=255, description="描述")
|
|
|
|
@field_validator("code")
|
|
@classmethod
|
|
def validate_code(cls, value: str | None):
|
|
"""
|
|
校验角色编码（委托到 `code_validator`）。
|
|
|
|
参数:
|
|
- value (str | None): 角色编码。
|
|
|
|
返回:
|
|
- str | None: 校验后的角色编码。
|
|
|
|
异常:
|
|
- CustomException: 不满足编码规则时抛出。
|
|
"""
|
|
return code_validator(value)
|
|
|
|
|
|
class RolePermissionSettingSchema(BaseModel):
|
|
"""角色权限配置模型"""
|
|
|
|
data_scope: int = Field(
|
|
default=1,
|
|
description="数据权限范围(1:仅本人 2:本部门 3:本部门及以下 4:全部 5:自定义)",
|
|
)
|
|
role_ids: list[int] = Field(default_factory=list, description="角色ID列表")
|
|
menu_ids: list[int] = Field(default_factory=list, description="菜单ID列表")
|
|
dept_ids: list[int] = Field(default_factory=list, description="部门ID列表")
|
|
|
|
@model_validator(mode="after")
|
|
def validate_fields(self):
|
|
"""
|
|
校验角色权限配置字段（数据范围与关联 ID 等）。
|
|
|
|
参数:
|
|
- self: 当前模型实例（校验后状态）。
|
|
|
|
返回:
|
|
- RolePermissionSettingSchema: 通过 `role_permission_request_validator` 校验后的同一实例。
|
|
|
|
异常:
|
|
- CustomException: 不满足权限配置约束时抛出。
|
|
"""
|
|
return role_permission_request_validator(self)
|
|
|
|
|
|
class RoleUpdateSchema(RoleCreateSchema):
|
|
"""角色更新模型"""
|
|
|
|
|
|
class RoleOutSchema(RoleCreateSchema, BaseSchema):
|
|
"""角色信息响应模型"""
|
|
|
|
model_config = ConfigDict(from_attributes=True)
|
|
|
|
menus: list[MenuOutSchema] = Field(default_factory=list, description="角色菜单列表")
|
|
depts: list[DeptOutSchema] = Field(default_factory=list, description="角色部门列表")
|
|
|
|
|
|
class RoleQueryParam:
|
|
"""角色管理查询参数"""
|
|
|
|
def __init__(
|
|
self,
|
|
name: str | None = Query(None, description="角色名称"),
|
|
description: str | None = Query(None, description="描述"),
|
|
status: str | None = Query(None, description="是否启用"),
|
|
created_time: list[DateTimeStr] | None = Query(
|
|
None,
|
|
description="创建时间范围",
|
|
examples=["2025-01-01 00:00:00", "2025-12-31 23:59:59"],
|
|
),
|
|
updated_time: list[DateTimeStr] | None = Query(
|
|
None,
|
|
description="更新时间范围",
|
|
examples=["2025-01-01 00:00:00", "2025-12-31 23:59:59"],
|
|
),
|
|
) -> None:
|
|
# 模糊查询字段
|
|
self.name = (QueueEnum.like.value, name)
|
|
if description:
|
|
self.description = (QueueEnum.like.value, description)
|
|
|
|
# 精确查询字段
|
|
if status:
|
|
self.status = (QueueEnum.eq.value, status)
|
|
|
|
# 时间范围查询
|
|
if created_time and len(created_time) == 2:
|
|
self.created_time = (QueueEnum.between.value, (created_time[0], created_time[1]))
|
|
if updated_time and len(updated_time) == 2:
|
|
self.updated_time = (QueueEnum.between.value, (updated_time[0], updated_time[1]))
|