更新函数reStructuredText风格文档

Author: wu-clan

backend/app/api/jwt_security.py

@@ -24,13 +24,19 @@
 
 
 def get_hash_password(password: str) -> str:
-    """使用hash算法加密密码 """
+    """
+    使用hash算法加密密码
+
+    :param password:
+    :return:
+    """
     return pwd_context.hash(password)
 
 
 def verity_password(plain_password: str, hashed_password: str) -> bool:
     """
     密码校验
+
     :param plain_password: 要验证的密码
     :param hashed_password: 要比较的hash密码
     :return: 比较密码之后的结果
@@ -41,6 +47,7 @@ def verity_password(plain_password: str, hashed_password: str) -> bool:
 def create_access_token(data: Union[int, Any], expires_delta: Union[timedelta, None] = None) -> str:
     """
     生成加密 token
+
     :param data: 传进来的值
     :param expires_delta: 增加的到期时间
     :return: 加密token
@@ -57,6 +64,7 @@ def create_access_token(data: Union[int, Any], expires_delta: Union[timedelta, N
 async def get_current_user(db: AsyncSession = Depends(get_db), token: str = Depends(oauth2_schema)) -> User:
     """
     通过token获取当前用户
+
     :param db:
     :param token:
     :return:
@@ -76,6 +84,7 @@ async def get_current_user(db: AsyncSession = Depends(get_db), token: str = Depe
 async def get_current_is_superuser(user: User = Depends(get_current_user)) -> User:
     """
     通过token验证当前用户权限
+
     :param user:
     :return:
     """

backend/app/common/sys_redis.py

@@ -23,6 +23,7 @@ def __init__(self):
     async def init_redis_connect(self):
         """
         触发初始化连接
+
         :return:
         """
         try:

backend/app/datebase/base_class.py

@@ -21,6 +21,7 @@ def __tablename__(cls) -> str:
 def use_uuid() -> str:
     """
     使用uuid
+
     :return:
     """
     return uuid.uuid4().hex

backend/app/middleware/access_middle.py

@@ -12,6 +12,7 @@ class AccessMiddleware(BaseHTTPMiddleware):
     """
     记录请求日志
     """
+
     async def dispatch(self, request: Request, call_next) -> Response:
         start_time = datetime.now()
         response = await call_next(request)

backend/app/utils/encoding_tree.py

@@ -6,6 +6,7 @@
 def list_to_tree(data_list, parent_id=0) -> list:
     """
     递归获取树形结构数据
+
     :param data_list: 数据列表
     :param parent_id: 父级id
     :return:
@@ -21,6 +22,7 @@ def list_to_tree(data_list, parent_id=0) -> list:
 def ram_list_to_tree(data_list: list) -> list:
     """
     利用对象内存共享生成树
+
     :param data_list: 数据列表
     :return:
     """

backend/app/utils/generate_string.py

@@ -6,6 +6,7 @@
 def get_uuid() -> str:
     """
     生成uuid
+
     :return: str(uuid)
     """
     return str(uuid.uuid4())

backend/app/utils/processing_string.py

@@ -14,6 +14,7 @@ def check_string(pattern, text) -> bool:
 def is_mobile(text: str) -> bool:
     """
     检查手机号码
+
     :param text:
     :return:
     """
@@ -23,6 +24,7 @@ def is_mobile(text: str) -> bool:
 def is_wechat(text: str) -> bool:
     """
     检查微信号
+
     :param text:
     :return:
     """
@@ -32,6 +34,7 @@ def is_wechat(text: str) -> bool:
 def is_QQ(text: str) -> bool:
     """
     检查QQ号
+
     :param text:
     :return:
     """

backend/app/utils/send_email.py

@@ -36,7 +36,6 @@ def send_email_verification_code(send_to, code, text=SEND_RESET_PASSWORD_TEXT):
             smtp = smtplib.SMTP_SSL(host=settings.EMAIL_HOST, port=settings.EMAIL_PORT)
         else:
             smtp = smtplib.SMTP(host=settings.EMAIL_HOST, port=settings.EMAIL_PORT)
-        smtp.connect(settings.EMAIL_SERVER)
         smtp.login(settings.EMAIL_USER, settings.EMAIL_PASSWORD)
         smtp.sendmail(message['from'], send_to, message.as_string())
         smtp.quit()