feat: Enhance models and README with additional features and improvements

- Updated README to include KodBox in project vision.
- Added model descriptions for clarity in Download, File, Folder, Group, Node, Order, Policy, Redeem, Report, Request, Response, Setting, Share, SourceLink, StoragePack, Tag, Task, User, and WebDAV.
- Changed optional fields from Optional[...] to the new union type syntax (e.g., str | None).
- Improved foreign key references in models for consistency.
- Refactored relationships in models to use singular forms where appropriate.
- Updated login service to reflect changes in request model types.
This commit is contained in:
2025-11-27 21:22:40 +08:00
parent 1533d9e89c
commit b364b740ca
21 changed files with 156 additions and 147 deletions

View File

@@ -10,7 +10,8 @@ if TYPE_CHECKING:
from .report import Report
class Share(TableBase, table=True):
__tablename__ = 'shares'
"""分享模型"""
__table_args__ = (
UniqueConstraint("code", name="uq_share_code"),
CheckConstraint("(file_id IS NOT NULL) <> (folder_id IS NOT NULL)", name="ck_share_xor"),
@@ -19,22 +20,22 @@ class Share(TableBase, table=True):
)
code: str = Field(max_length=64, nullable=False, index=True, description="分享码")
password: Optional[str] = Field(default=None, max_length=255, description="分享密码(加密后)")
password: str | None = Field(default=None, max_length=255, description="分享密码(加密后)")
is_dir: bool = Field(default=False, sa_column_kwargs={"server_default": text("false")}, description="是否为目录分享")
file_id: Optional[int] = Field(default=None, foreign_key="files.id", index=True, description="文件ID二选一")
folder_id: Optional[int] = Field(default=None, foreign_key="folders.id", index=True, description="目录ID二选一")
file_id: int | None = Field(default=None, foreign_key="file.id", index=True, description="文件ID二选一")
folder_id: int | None = Field(default=None, foreign_key="folder.id", index=True, description="目录ID二选一")
views: int = Field(default=0, sa_column_kwargs={"server_default": "0"}, description="浏览次数")
downloads: int = Field(default=0, sa_column_kwargs={"server_default": "0"}, description="下载次数")
remain_downloads: Optional[int] = Field(default=None, description="剩余下载次数 (NULL为不限制)")
expires: Optional[datetime] = Field(default=None, description="过期时间 (NULL为永不过期)")
remain_downloads: int | None = Field(default=None, description="剩余下载次数 (NULL为不限制)")
expires: datetime | None = Field(default=None, description="过期时间 (NULL为永不过期)")
preview_enabled: bool = Field(default=True, sa_column_kwargs={"server_default": text("true")}, description="是否允许预览")
source_name: Optional[str] = Field(default=None, max_length=255, index=True, description="源名称(冗余字段,便于展示)")
source_name: str | None = Field(default=None, max_length=255, index=True, description="源名称(冗余字段,便于展示)")
score: int = Field(default=0, sa_column_kwargs={"server_default": "0"}, description="兑换此分享所需的积分")
# 外键
user_id: int = Field(foreign_key="users.id", index=True, description="创建分享的用户ID")
user_id: int = Field(foreign_key="user.id", index=True, description="创建分享的用户ID")
# 关系
user: "User" = Relationship(back_populates="shares")