public/FastapiAdmin
1
0
Fork 0
mirror of https://github.com/fastapiadmin/FastapiAdmin.git synced 2026-09-20 20:39:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: 优化代码注释和文档字符串格式

Browse Source 
style: 统一代码风格和格式

docs: 完善函数和方法的文档字符串

refactor(base_model): 移除冗余的表名和表参数生成方法

refactor(constant): 更新返回码注释格式

refactor(router_class): 添加路由处理器的详细文档

refactor(database): 完善数据库连接函数的文档

refactor(security): 添加认证类和方法的详细文档

refactor(validator): 更新验证器函数的文档格式

refactor(serialize): 优化序列化工具类的文档

refactor(response): 完善响应类的文档字符串

refactor(dependencies): 添加依赖函数的详细文档

refactor(initialize): 完善初始化脚本的文档

refactor(plugin): 添加生命周期和中间件注册的文档

refactor(service): 完善服务层方法的文档

refactor(controller): 添加控制器方法的详细文档

refactor(crud): 完善CRUD操作的文档字符串

refactor(schema): 简化模型类并移除冗余字段

refactor(param): 更新查询参数类的注释格式

refactor(template): 优化代码生成模板的格式

refactor(console): 添加控制台输出功能的实现

refactor(util): 完善工具函数的文档字符串
This commit is contained in:
zhangtao
2025-10-18 16:31:28 +08:00
parent 0ea88c3320
commit c2ca6d19ac
101 changed files with 6914 additions and 2295 deletions
Download Patch File Download Diff File Expand all files Collapse all files
backend/app/core/redis_crud.py
+107 -19
View File
@@ -10,18 +10,18 @@ from app.core.logger import logger
class RedisCURD:
"""缓存工具类"""
def __init__(self, redis: Redis):
def __init__(self, redis: Redis) -> None:
"""初始化"""
self.redis = redis
async def mget(self, keys: list) -> list:
"""批量获取缓存
Args:
keys: 键名列表
参数:
- keys (list): 键名列表
Returns:
list: 返回缓存值列表
返回:
- list: 返回缓存值列表,如果获取失败则返回空列表
"""
try:
data = await self.redis.mget(*[str(key) for key in keys])
@@ -31,7 +31,14 @@ class RedisCURD:
return []
async def get_keys(self, pattern: str = "*") -> list:
"""获取缓存键名"""
"""获取缓存键名
参数:
- pattern (str, optional): 匹配模式,默认值为"*"。
返回:
- list: 返回匹配的缓存键名列表,如果获取失败则返回空列表
"""
try:
keys = await self.redis.keys(f"{pattern}")
return keys
@@ -41,7 +48,14 @@ class RedisCURD:
async def get(self, key: str) -> Any:
"""获取缓存"""
"""获取缓存
参数:
- key (str): 缓存键名
返回:
- Any: 返回缓存值,如果缓存不存在则返回None
"""
try:
data = await self.redis.get(f"{key}")
@@ -55,7 +69,16 @@ class RedisCURD:
return None
async def set(self, key: str, value: Any, expire: Optional[int] = None) -> bool:
"""设置缓存"""
"""设置缓存
参数:
- key (str): 缓存键名
- value (Any): 缓存值
- expire (Optional[int], optional): 过期时间,单位为秒,默认值为None。
返回:
- bool: 如果设置缓存成功则返回True,否则返回False
"""
try:
# 根据数据类型选择序列化方式
if isinstance(value, (int, float, str)):
@@ -79,7 +102,14 @@ class RedisCURD:
return False
async def delete(self, *keys: str) -> bool:
"""删除缓存"""
"""删除缓存
参数:
- keys (str): 缓存键名
返回:
- bool: 如果删除缓存成功则返回True,否则返回False
"""
try:
await self.redis.delete(*keys)
return True
@@ -88,7 +118,14 @@ class RedisCURD:
return False
async def clear(self, pattern: str = "*") -> bool:
"""清空缓存"""
"""清空缓存
参数:
- pattern (str, optional): 匹配模式,默认值为"*"。
返回:
- bool: 如果清空缓存成功则返回True,否则返回False
"""
try:
keys = await self.redis.keys(f"{pattern}")
if keys:
@@ -99,7 +136,14 @@ class RedisCURD:
return False
async def exists(self, key: str) -> bool:
"""判断缓存是否存在"""
"""判断缓存是否存在
参数:
- key (str): 缓存键名
返回:
- bool: 如果缓存存在则返回True,否则返回False
"""
try:
return await self.redis.exists(f"{key}")
except Exception as e:
@@ -107,7 +151,14 @@ class RedisCURD:
return False
async def ttl(self, key: str) -> int:
"""获取缓存过期时间"""
"""获取缓存过期时间
参数:
- key (str): 缓存键名
返回:
- int: 返回缓存过期时间,单位为秒,如果缓存没有设置过期时间则返回-1
"""
try:
return await self.redis.ttl(f"{key}")
except Exception as e:
@@ -115,7 +166,15 @@ class RedisCURD:
return -1
async def expire(self, key: str, expire: int) -> bool:
"""设置缓存过期时间"""
"""设置缓存过期时间
参数:
- key (str): 缓存键名
- expire (int): 过期时间,单位为秒
返回:
- bool: 如果设置缓存过期时间成功则返回True,否则返回False
"""
try:
return await self.redis.expire(f"{key}", expire)
except Exception as e:
@@ -123,7 +182,11 @@ class RedisCURD:
return False
async def info(self) -> dict:
"""获取缓存信息"""
"""获取缓存信息
返回:
- dict: 返回缓存信息字典,如果获取失败则返回空字典
"""
try:
return await self.redis.info()
except Exception as e:
@@ -131,14 +194,22 @@ class RedisCURD:
return {}
async def db_size(self) -> int:
"""获取数据库大小"""
"""获取数据库大小
返回:
- int: 返回数据库大小,如果获取失败则返回0
"""
try:
return await self.redis.dbsize()
except Exception as e:
logger.error(f"获取数据库大小失败: {str(e)}")
return 0
async def commandstats(self):
"""获取命令统计信息"""
async def commandstats(self) -> dict:
"""获取命令统计信息
返回:
- dict: 返回命令统计信息字典,如果获取失败则返回空字典
"""
try:
return await self.redis.info("commandstats")
except Exception as e:
@@ -146,7 +217,16 @@ class RedisCURD:
return {}
async def hash_set(self, name: str, key: str, value: Any) -> bool:
"""设置哈希缓存"""
"""设置哈希缓存
参数:
- name (str): 哈希缓存名称
- key (str): 哈希缓存键名
- value (Any): 哈希缓存值
返回:
- bool: 如果设置哈希缓存成功则返回True,否则返回False
"""
try:
self.redis.hset(name=name, key=key, value=value)
return True
@@ -155,7 +235,15 @@ class RedisCURD:
return False
async def hash_get(self, name: str, keys: list[str]) -> Awaitable[List[Any]] | List[Any]:
"""获取哈希缓存"""
"""获取哈希缓存
参数:
- name (str): 哈希缓存名称
- keys (list[str]): 哈希缓存键名列表
返回:
- Awaitable[List[Any]] | List[Any]: 返回哈希缓存值列表,如果获取失败则返回空列表
"""
try:
data = self.redis.hmget(name=name, keys=keys)
return data