feat: add database session dependency for FastAPI routes
- Introduced a new dependency in `middleware/dependencies.py` to provide an asynchronous database session using SQLModel. - This dependency can be utilized in route functions to facilitate database operations.
This commit is contained in:
@@ -1,36 +1,36 @@
|
||||
|
||||
from typing import Optional, Literal
|
||||
from sqlmodel import Field, UniqueConstraint, Column, func, DateTime
|
||||
from sqlmodel import Field, UniqueConstraint
|
||||
from .base import TableBase
|
||||
from datetime import datetime
|
||||
from enum import StrEnum
|
||||
|
||||
SETTINGS_TYPE = Literal[
|
||||
"auth",
|
||||
"authn",
|
||||
"avatar",
|
||||
"basic",
|
||||
"captcha",
|
||||
"cron",
|
||||
"file_edit",
|
||||
"login",
|
||||
"mail",
|
||||
"mail_template",
|
||||
"mobile",
|
||||
"path",
|
||||
"preview",
|
||||
"pwa",
|
||||
"register",
|
||||
"retry",
|
||||
"share",
|
||||
"slave",
|
||||
"task",
|
||||
"thumb",
|
||||
"timeout",
|
||||
"upload",
|
||||
"version",
|
||||
"view",
|
||||
"wopi"
|
||||
]
|
||||
class SettingsType(StrEnum):
|
||||
"""设置类型枚举"""
|
||||
|
||||
ARIA2 = "aria2"
|
||||
AUTH = "auth"
|
||||
AUTHN = "authn"
|
||||
AVATAR = "avatar"
|
||||
BASIC = "basic"
|
||||
CAPTCHA = "captcha"
|
||||
CRON = "cron"
|
||||
FILE_EDIT = "file_edit"
|
||||
LOGIN = "login"
|
||||
MAIL = "mail"
|
||||
MAIL_TEMPLATE = "mail_template"
|
||||
MOBILE = "mobile"
|
||||
PATH = "path"
|
||||
PREVIEW = "preview"
|
||||
PWA = "pwa"
|
||||
REGISTER = "register"
|
||||
RETRY = "retry"
|
||||
SHARE = "share"
|
||||
SLAVE = "slave"
|
||||
TASK = "task"
|
||||
THUMB = "thumb"
|
||||
TIMEOUT = "timeout"
|
||||
UPLOAD = "upload"
|
||||
VERSION = "version"
|
||||
VIEW = "view"
|
||||
WOPI = "wopi"
|
||||
|
||||
# 数据库模型
|
||||
class Setting(TableBase, table=True):
|
||||
@@ -38,149 +38,6 @@ class Setting(TableBase, table=True):
|
||||
|
||||
__table_args__ = (UniqueConstraint("type", "name", name="uq_setting_type_name"),)
|
||||
|
||||
type: str = Field(max_length=255, description="设置类型/分组")
|
||||
type: SettingsType = Field(max_length=255, description="设置类型/分组")
|
||||
name: str = Field(max_length=255, description="设置项名称")
|
||||
value: str | None = Field(default=None, description="设置值")
|
||||
|
||||
@staticmethod
|
||||
async def add(
|
||||
type: SETTINGS_TYPE = None,
|
||||
name: str = None,
|
||||
value: str | None = None
|
||||
) -> None:
|
||||
"""
|
||||
向数据库内添加设置项目。
|
||||
|
||||
:param type: 设置类型/分组
|
||||
:type type: SETTINGS_TYPE
|
||||
:param name: 设置项名称
|
||||
:type name: str
|
||||
:param value: 设置值，默认为 None
|
||||
:type value: str | None
|
||||
"""
|
||||
from .database import get_session
|
||||
|
||||
if isinstance(value, (dict, list)):
|
||||
value = str(value)
|
||||
|
||||
async for session in get_session():
|
||||
new_setting = Setting(type=type, name=name, value=value)
|
||||
session.add(new_setting)
|
||||
|
||||
await session.commit()
|
||||
|
||||
@staticmethod
|
||||
async def get(
|
||||
type: SETTINGS_TYPE,
|
||||
name: str,
|
||||
format: Literal['int', 'float', 'bool', 'str'] = 'str'
|
||||
) -> Optional['Setting']:
|
||||
"""
|
||||
从数据库中获取指定类型和名称的设置项。
|
||||
|
||||
:param type: 设置类型/分组
|
||||
:type type: SETTINGS_TYPE
|
||||
:param name: 设置项名称
|
||||
:type name: str
|
||||
|
||||
:return: 返回设置项对象，如果不存在则返回 None
|
||||
:rtype: Optional[Setting]
|
||||
"""
|
||||
from .database import get_session
|
||||
from sqlmodel import select
|
||||
|
||||
async for session in get_session():
|
||||
statment = select(Setting).where(
|
||||
Setting.type == type,
|
||||
Setting.name == name
|
||||
)
|
||||
|
||||
statment = await session.exec(statment)
|
||||
result = statment.one_or_none()
|
||||
result = result.value if result else None
|
||||
|
||||
# 根据 format 参数转换结果类型
|
||||
if format == 'int':
|
||||
return int(result) if result is not None else None
|
||||
elif format == 'float':
|
||||
return float(result) if result is not None else None
|
||||
elif format == 'bool':
|
||||
return result.lower() in ['true', '1'] if isinstance(result, str) else bool(result)
|
||||
elif format == 'str':
|
||||
return str(result) if result is not None else None
|
||||
else:
|
||||
raise ValueError(f"Unsupported format: {format}")
|
||||
|
||||
@staticmethod
|
||||
async def set(
|
||||
type: SETTINGS_TYPE,
|
||||
name: str,
|
||||
value: str | None = None
|
||||
) -> None:
|
||||
"""
|
||||
更新指定类型和名称的设置项的值。
|
||||
|
||||
:param type: 设置类型/分组
|
||||
:type type: SETTINGS_TYPE
|
||||
:param name: 设置项名称
|
||||
:type name: str
|
||||
:param value: 新的设置值，默认为 None
|
||||
:type value: str | None
|
||||
|
||||
:raises ValueError: 如果设置项不存在，则抛出异常
|
||||
"""
|
||||
from .database import get_session
|
||||
from sqlmodel import select
|
||||
|
||||
if isinstance(value, (dict, list)):
|
||||
value = str(value)
|
||||
|
||||
async for session in get_session():
|
||||
statment = select(Setting).where(
|
||||
Setting.type == type,
|
||||
Setting.name == name
|
||||
)
|
||||
|
||||
result = await session.exec(statment)
|
||||
setting = result.one_or_none()
|
||||
|
||||
if not setting:
|
||||
raise ValueError(f"Setting {type}.{name} does not exist.")
|
||||
|
||||
# 设置项存在，更新数据
|
||||
setting.value = value
|
||||
await session.commit()
|
||||
|
||||
@staticmethod
|
||||
async def delete(
|
||||
type: SETTINGS_TYPE,
|
||||
name: str
|
||||
) -> None:
|
||||
"""
|
||||
删除指定类型和名称的设置项。
|
||||
|
||||
:param type: 设置类型/分组
|
||||
:type type: SETTINGS_TYPE
|
||||
:param name: 设置项名称
|
||||
:type name: str
|
||||
|
||||
:raises ValueError: 如果设置项不存在，则抛出异常
|
||||
"""
|
||||
from .database import get_session
|
||||
from sqlmodel import select, delete
|
||||
|
||||
async for session in get_session():
|
||||
statment = select(Setting).where(
|
||||
Setting.type == type,
|
||||
Setting.name == name
|
||||
)
|
||||
|
||||
result = await session.exec(statment)
|
||||
setting = result.one_or_none()
|
||||
|
||||
if not setting:
|
||||
raise ValueError(f"Setting {type}.{name} does not exist.")
|
||||
|
||||
# 设置项存在，删除数据
|
||||
await session.delete(setting)
|
||||
await session.commit()
|
||||
value: str | None = Field(default=None, description="设置值")
|
||||
Reference in New Issue
Block a user