style: 优化部分文件中的函数及类注释

This commit is contained in:
insistence
2024-07-13 18:15:35 +08:00
parent c23a3ccfaf
commit e3b422cc6e
41 changed files with 353 additions and 19 deletions

View File

@@ -1,6 +1,7 @@
class CommonConstant:
"""
常用常量
WWW: www主域
HTTP: http请求
HTTPS: https请求
@@ -26,6 +27,7 @@ class CommonConstant:
class HttpStatusConstant:
"""
返回状态码
SUCCESS: 操作成功
CREATED: 对象创建成功
ACCEPTED: 请求已经被接受
@@ -67,6 +69,7 @@ class HttpStatusConstant:
class MenuConstant:
"""
菜单常量
TYPE_DIR: 菜单类型(目录)
TYPE_MENU: 菜单类型(菜单)
TYPE_BUTTON: 菜单类型(按钮)

View File

@@ -4,6 +4,7 @@ from enum import Enum
class BusinessType(Enum):
"""
业务操作类型
OTHER: 其它
INSERT: 新增
UPDATE: 修改

View File

@@ -5,6 +5,7 @@ from utils.log_util import logger
async def get_db():
"""
每一个请求处理完毕后会关闭当前连接,不同的请求使用不同的连接
:return:
"""
async with AsyncSessionLocal() as current_db:
@@ -14,6 +15,7 @@ async def get_db():
async def init_create_table():
"""
应用启动时初始化数据库连接
:return:
"""
logger.info('初始化数据库连接...')

View File

@@ -16,6 +16,7 @@ class RedisUtil:
async def create_redis_pool(cls) -> aioredis.Redis:
"""
应用启动时初始化redis连接
:return: Redis连接对象
"""
logger.info('开始连接redis...')
@@ -46,6 +47,7 @@ class RedisUtil:
async def close_redis_pool(cls, app):
"""
应用关闭时关闭redis连接
:param app: fastapi对象
:return:
"""
@@ -56,6 +58,7 @@ class RedisUtil:
async def init_sys_dict(cls, redis):
"""
应用启动时缓存字典表
:param redis: redis对象
:return:
"""
@@ -66,6 +69,7 @@ class RedisUtil:
async def init_sys_config(cls, redis):
"""
应用启动时缓存参数配置表
:param redis: redis对象
:return:
"""

View File

@@ -118,6 +118,7 @@ class SchedulerUtil:
async def init_system_scheduler(cls):
"""
应用启动时初始化定时任务
:return:
"""
logger.info('开始启动定时任务...')
@@ -136,6 +137,7 @@ class SchedulerUtil:
async def close_system_scheduler(cls):
"""
应用关闭时关闭定时任务
:return:
"""
scheduler.shutdown()
@@ -145,6 +147,7 @@ class SchedulerUtil:
def get_scheduler_job(cls, job_id):
"""
根据任务id获取任务对象
:param job_id: 任务id
:return: 任务对象
"""
@@ -156,6 +159,7 @@ class SchedulerUtil:
def add_scheduler_job(cls, job_info):
"""
根据输入的任务对象信息添加任务
:param job_info: 任务对象信息
:return:
"""
@@ -177,6 +181,7 @@ class SchedulerUtil:
def execute_scheduler_job_once(cls, job_info):
"""
根据输入的任务对象执行一次任务
:param job_info: 任务对象信息
:return:
"""
@@ -199,6 +204,7 @@ class SchedulerUtil:
def remove_scheduler_job(cls, job_id):
"""
根据任务id移除任务
:param job_id: 任务id
:return:
"""