add black support

wu-clan · wu-clan · commit 5b09237835ba · 2023-04-24T18:47:40.000+08:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -10,4 +10,16 @@ repos:
     rev: v0.0.262
     hooks:
       - id: ruff
-        args: [ '--config', '.ruff.toml' ]
+        args:
+          - '--config'
+          - '.ruff.toml'
+          - '--fix'
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+        language_version: python3.8
+        args:
+          - '--skip-string-normalization'
+          - '--line-length'
+          - '120'
diff --git a/backend/app/api/service/user_service.py b/backend/app/api/service/user_service.py
@@ -14,7 +14,6 @@
 
 
 class UserService:
-
     @staticmethod
     async def login(form_data: OAuth2PasswordRequestForm):
         async with async_db_session() as db:
diff --git a/backend/app/api/v1/task_demo.py b/backend/app/api/v1/task_demo.py
@@ -22,31 +22,28 @@ async def task_demo_async():
 async def task_demo_get():
     tasks = []
     for job in scheduler.get_jobs():
-        tasks.append({
-            "id": job.id,
-            "func_name": job.func_ref,
-            "trigger": str(job.trigger),
-            "executor": job.executor,
-            # "args": str(job.args),
-            # "kwargs": job.kwargs,
-            "name": job.name,
-            "misfire_grace_time": job.misfire_grace_time,
-            "coalesce": job.coalesce,
-            "max_instances": job.max_instances,
-            "next_run_time": job.next_run_time,
-        })
+        tasks.append(
+            {
+                "id": job.id,
+                "func_name": job.func_ref,
+                "trigger": str(job.trigger),
+                "executor": job.executor,
+                # "args": str(job.args),
+                # "kwargs": job.kwargs,
+                "name": job.name,
+                "misfire_grace_time": job.misfire_grace_time,
+                "coalesce": job.coalesce,
+                "max_instances": job.max_instances,
+                "next_run_time": job.next_run_time,
+            }
+        )
     return {'msg': 'success', 'data': tasks}
 
 
 @router.post('', summary='添加同步任务')
 async def task_demo_add():
     scheduler.add_job(
-        task_demo,
-        'interval',
-        seconds=1,
-        id='task_demo',
-        replace_existing=True,
-        start_date=datetime.datetime.now()
+        task_demo, 'interval', seconds=1, id='task_demo', replace_existing=True, start_date=datetime.datetime.now()
     )
 
     return {'msg': 'success'}
@@ -60,7 +57,7 @@ async def task_demo_add_async():
         seconds=1,
         id='task_demo_async',
         replace_existing=True,
-        start_date=datetime.datetime.now()
+        start_date=datetime.datetime.now(),
     )
 
     return {'msg': 'success'}
diff --git a/backend/app/common/enums.py b/backend/app/common/enums.py
@@ -4,7 +4,6 @@
 
 
 class EnumBase(Enum):
-
     @classmethod
     def get_member_values(cls):
         return [item.value for item in cls._member_map_.values()]
@@ -16,9 +15,11 @@ def get_member_names(cls):
 
 class IntEnum(int, EnumBase):
     """整型枚举"""
+
     pass
 
 
 class StrEnum(str, EnumBase):
     """字符串枚举"""
+
     pass
diff --git a/backend/app/common/exception/errors.py b/backend/app/common/exception/errors.py
@@ -55,7 +55,6 @@ def __init__(self, *, msg: str = 'Bad Gateway', data: Any = None):
 
 
 class CodeError(BaseExceptionMixin):
-
     def __init__(self, *, error: CodeEnum, data: Any = None):
         self.code = error.code
         super().__init__(msg=error.msg, data=data)
diff --git a/backend/app/common/exception/exception_handler.py b/backend/app/common/exception/exception_handler.py
@@ -47,7 +47,7 @@ def http_exception_handler(request: Request, exc: HTTPException):  # noqa
         return JSONResponse(
             status_code=_get_exception_code(exc.status_code),
             content=response_base.fail(code=exc.status_code, msg=exc.detail),
-            headers=exc.headers
+            headers=exc.headers,
         )
 
     @app.exception_handler(Exception)
@@ -81,24 +81,21 @@ def all_exception_handler(request: Request, exc):  # noqa
                 status_code=422,
                 content=response_base.fail(
                     msg='请求参数非法' if len(message) == 0 else f'请求参数非法:{message[:-1]}',
-                    data={'errors': exc.errors()} if message == '' and settings.UVICORN_RELOAD is True else None
-                )
+                    data={'errors': exc.errors()} if message == '' and settings.UVICORN_RELOAD is True else None,
+                ),
             )
 
         # 自定义
         if isinstance(exc, BaseExceptionMixin):
             return JSONResponse(
                 status_code=_get_exception_code(exc.code),
-                content=response_base.fail(
-                    code=exc.code,
-                    msg=str(exc.msg),
-                    data=exc.data if exc.data else None
-                )
+                content=response_base.fail(code=exc.code, msg=str(exc.msg), data=exc.data if exc.data else None),
             )
 
         else:
             return JSONResponse(
                 status_code=500,
-                content=response_base.fail(code=500, msg=str(exc)) if settings.UVICORN_RELOAD else
-                response_base.fail(code=500, msg='Internal Server Error')
+                content=response_base.fail(code=500, msg=str(exc))
+                if settings.UVICORN_RELOAD
+                else response_base.fail(code=500, msg='Internal Server Error'),
             )
diff --git a/backend/app/common/log.py b/backend/app/common/log.py
@@ -11,7 +11,6 @@
 
 
 class Logger:
-
     @staticmethod
     def log() -> loguru.Logger:
         if not os.path.exists(path_conf.LogPath):
diff --git a/backend/app/common/pagination.py b/backend/app/common/pagination.py
@@ -41,10 +41,10 @@ class Page(AbstractPage[T], Generic[T]):
 
     @classmethod
     def create(
-            cls,
-            data: Sequence[T],
-            total: int,
-            params: Params,
+        cls,
+        data: Sequence[T],
+        total: int,
+        params: Params,
     ) -> Page[T]:
         page = params.page
         size = params.size
@@ -54,15 +54,8 @@ def create(
                 "first": {"page": 1, "size": f"{size}"},
                 "last": {"page": f"{math.ceil(total / params.size)}", "size": f"{size}"} if total > 0 else None,
                 "next": {"page": f"{page + 1}", "size": f"{size}"} if (page + 1) <= total_pages else None,
-                "prev": {"page": f"{page - 1}", "size": f"{size}"} if (page - 1) >= 1 else None
+                "prev": {"page": f"{page - 1}", "size": f"{size}"} if (page - 1) >= 1 else None,
             }
         ).dict()
 
-        return cls(
-            data=data,
-            total=total,
-            page=params.page,
-            size=params.size,
-            total_pages=total_pages,
-            links=links
-        )
+        return cls(data=data, total=total, page=params.page, size=params.size, total_pages=total_pages, links=links)
diff --git a/backend/app/common/redis.py b/backend/app/common/redis.py
@@ -9,15 +9,14 @@
 
 
 class RedisCli(Redis):
-
     def __init__(self):
         super(RedisCli, self).__init__(
             host=settings.REDIS_HOST,
             port=settings.REDIS_PORT,
             password=settings.REDIS_PASSWORD,
             db=settings.REDIS_DATABASE,
             socket_timeout=settings.REDIS_TIMEOUT,
-            decode_responses=True  # 转码 utf-8
+            decode_responses=True,  # 转码 utf-8
         )
 
     async def open(self):
diff --git a/backend/app/common/response/response_code.py b/backend/app/common/response/response_code.py
@@ -7,6 +7,7 @@ class CodeEnum(Enum):
     """
     错误码
     """
+
     CAPTCHA_ERROR = (40001, '图形验证码错误')
 
     @property
diff --git a/backend/app/common/response/response_schema.py b/backend/app/common/response/response_schema.py
@@ -8,41 +8,32 @@
 
 _JsonEncoder = Union[Set[Union[int, str]], Dict[Union[int, str], Any]]
 
-__all__ = [
-    'ResponseModel',
-    'response_base'
-]
+__all__ = ['ResponseModel', 'response_base']
 
 
 class ResponseModel(BaseModel):
     """
     统一返回模型, 可在 FastAPI 接口请求中指定 response_model 及更多操作
     """
+
     code: int = 200
     msg: str = 'Success'
     data: Optional[Any] = None
 
     class Config:
-        json_encoders = {
-            datetime: lambda x: x.strftime("%Y-%m-%d %H:%M:%S")
-        }
+        json_encoders = {datetime: lambda x: x.strftime("%Y-%m-%d %H:%M:%S")}
 
 
 class ResponseBase:
-
     @staticmethod
     def __encode_json(data: Any):
-        return jsonable_encoder(
-            data,
-            custom_encoder={
-                datetime: lambda x: x.strftime("%Y-%m-%d %H:%M:%S")
-            }
-        )
+        return jsonable_encoder(data, custom_encoder={datetime: lambda x: x.strftime("%Y-%m-%d %H:%M:%S")})
 
     @staticmethod
     @validate_arguments
-    def success(*, code: int = 200, msg: str = 'Success', data: Optional[Any] = None,
-                exclude: Optional[_JsonEncoder] = None):
+    def success(
+        *, code: int = 200, msg: str = 'Success', data: Optional[Any] = None, exclude: Optional[_JsonEncoder] = None
+    ):
         """
         请求成功返回通用方法
 
diff --git a/backend/app/common/task.py b/backend/app/common/task.py
@@ -20,14 +20,12 @@ def _scheduler_conf() -> dict:
         'port': settings.APS_REDIS_PORT,
         'password': settings.APS_REDIS_PASSWORD,
         'db': settings.APS_REDIS_DATABASE,
-        'socket_timeout': settings.APS_REDIS_TIMEOUT
+        'socket_timeout': settings.APS_REDIS_TIMEOUT,
     }
 
     end_conf = {
         # 配置存储器
-        "jobstores": {
-            'default': RedisJobStore(**redis_conf)
-        },
+        "jobstores": {'default': RedisJobStore(**redis_conf)},
         # 配置执行器
         "executors": {
             'default': AsyncIOExecutor(),
@@ -39,14 +37,13 @@ def _scheduler_conf() -> dict:
             "misfire_grace_time": settings.APS_MISFIRE_GRACE_TIME,
         },
         # 时区
-        "timezone": str(tzlocal.get_localzone())
+        "timezone": str(tzlocal.get_localzone()),
     }
 
     return end_conf
 
 
 class Scheduler(AsyncIOScheduler):
-
     def start(self, paused: bool = False):
         try:
             super().start(paused)
diff --git a/backend/app/core/conf.py b/backend/app/core/conf.py
@@ -100,7 +100,7 @@ class Config:
 
 @lru_cache
 def get_settings():
-    """ 读取配置优化写法 """
+    """读取配置优化写法"""
     return Settings()
 
 
diff --git a/backend/app/core/registrar.py b/backend/app/core/registrar.py
@@ -47,7 +47,7 @@ def register_app():
         docs_url=settings.DOCS_URL,
         redoc_url=settings.REDOCS_URL,
         openapi_url=settings.OPENAPI_URL,
-        lifespan=register_init
+        lifespan=register_init,
     )
 
     if settings.STATIC_FILES:
@@ -78,6 +78,7 @@ def register_static_file(app: FastAPI):
     """
     import os
     from fastapi.staticfiles import StaticFiles
+
     if not os.path.exists("./static"):
         os.mkdir("./static")
     app.mount("/static", StaticFiles(directory="static"), name="static")
diff --git a/backend/app/crud/base.py b/backend/app/crud/base.py
@@ -44,8 +44,7 @@ async def create(self, db: AsyncSession, obj_in: CreateSchemaType, user_id: Opti
         db.add(db_obj)
 
     async def update(
-            self, db: AsyncSession, pk: int, obj_in: Union[UpdateSchemaType, Dict[str, Any]],
-            user_id: Optional[int] = None
+        self, db: AsyncSession, pk: int, obj_in: Union[UpdateSchemaType, Dict[str, Any]], user_id: Optional[int] = None
     ) -> int:
         """
         通过主键 id 更新一条数据
@@ -62,11 +61,7 @@ async def update(
             update_data = obj_in.dict(exclude_unset=True)
         if user_id:
             update_data.update({'update_user': user_id})
-        model = await db.execute(
-            update(self.model)
-            .where(self.model.id == pk)
-            .values(**update_data)
-        )
+        model = await db.execute(update(self.model).where(self.model.id == pk).values(**update_data))
         return model.rowcount
 
     async def delete(self, db: AsyncSession, pk: int) -> int:
diff --git a/backend/app/crud/crud_user.py b/backend/app/crud/crud_user.py
diff --git a/backend/app/database/base_class.py b/backend/app/database/base_class.py
diff --git a/backend/app/database/db_mysql.py b/backend/app/database/db_mysql.py
diff --git a/backend/app/init_test_data.py b/backend/app/init_test_data.py
diff --git a/backend/app/main.py b/backend/app/main.py
diff --git a/backend/app/models/user.py b/backend/app/models/user.py
diff --git a/docker_conf.py b/docker_conf.py
