Update the ruff rules and format the code (#846)

* Update the ruff rules and format the code

* Update the per-file-ignores

* Update the ci

* Update rules

* Fix codes

* Fix pagination

* Update rules

Author: wu-clan

.github/workflows/lint.yml

@@ -12,7 +12,7 @@ jobs:
     name: lint ${{ matrix.python-version }}
     strategy:
       matrix:
-        python-version: [ '3.10', '3.11', '3.12', '3.13' ]
+        python-version: [ '3.10', '3.11', '3.12', '3.13', '3.14' ]
       fail-fast: false
     steps:
       - uses: actions/checkout@v4

.ruff.toml

@@ -0,0 +1,174 @@
+line-length = 120
+preview = true
+fix = true
+unsafe-fixes = true
+show-fixes = true
+required-version = ">=0.13.0"
+
+[lint]
+select = [
+    "FAST",
+    "ANN001",
+    "ANN201",
+    "ANN202",
+    "ANN204",
+    "ANN205",
+    "ANN206",
+    "ASYNC110",
+    "ASYNC116",
+    "ASYNC210",
+    "ASYNC212",
+    "ASYNC230",
+    "ASYNC240",
+    "ASYNC250",
+    "ASYNC251",
+    "S310",
+    "FBT001",
+    "FBT002",
+    "B002",
+    "B005",
+    "B006",
+    "B007",
+    "B008",
+    "B009",
+    "B010",
+    "B013",
+    "B014",
+    "B019",
+    "B020",
+    "B021",
+    "B024",
+    "B025",
+    "B026",
+    "B027",
+    "B039",
+    "COM",
+    "C402",
+    "C403",
+    "C404",
+    "C408",
+    "C410",
+    "C411",
+    "C414",
+    "C416",
+    "C417",
+    "C418",
+    "C419",
+    "C420",
+    "DTZ",
+    "EXE",
+    "ISC001",
+    "ISC002",
+    "ISC003",
+    "PIE",
+    "PYI009",
+    "PYI010",
+    "PYI011",
+    "PYI012",
+    "PYI013",
+    "PYI016",
+    "PYI017",
+    "PYI019",
+    "PYI020",
+    "PYI021",
+    "PYI024",
+    "PYI026",
+    "PYI030",
+    "PYI033",
+    "PYI034",
+    "PYI036",
+    "PYI041",
+    "PYI042",
+    "PYI055",
+    "PYI061",
+    "PYI062",
+    "PYI063",
+    "Q001",
+    "Q002",
+    "RSE102",
+    "RET501",
+    "RET505",
+    "RET506",
+    "RET507",
+    "RET508",
+    "SIM101",
+    "SIM102",
+    "SIM103",
+    "SIM107",
+    "SIM108",
+    "SIM109",
+    "SIM110",
+    "SIM114",
+    "SIM115",
+    "SIM201",
+    "SIM202",
+    "SIM210",
+    "SIM211",
+    "SIM212",
+    "SIM300",
+    "SIM401",
+    "SIM910",
+    "TID252",
+    "TC",
+    "FLY",
+    "I",
+    "C901",
+    "N",
+    "PERF",
+    "E",
+    "W",
+    "D404",
+    "D417",
+    "D419",
+    "F",
+    "PGH",
+    "PLC1901",
+    "UP",
+    "FURB",
+    "RUF",
+    "TRY",
+]
+ignore = [
+    "COM812",
+    "PGH003",
+    "RUF001",
+    "RUF002",
+    "RUF003",
+    "RUF006",
+    "RUF012",
+    "TRY400",
+    "TRY003",
+    "TRY301"
+]
+
+[lint.per-file-ignores]
+"**/model/*.py" = ["TC003"]
+"backend/common/socketio/server.py" = ["ANN001"]
+"backend/common/exception/exception_handler.py" = ["ANN202","RUF029"]
+
+[lint.flake8-pytest-style]
+parametrize-names-type = "list"
+parametrize-values-row-type = "list"
+parametrize-values-type = "list"
+
+[lint.flake8-quotes]
+inline-quotes = "single"
+
+[lint.flake8-type-checking]
+runtime-evaluated-base-classes = ["pydantic.BaseModel", "sqlalchemy.orm.DeclarativeBase"]
+
+[lint.flake8-unused-arguments]
+ignore-variadic-names = true
+
+[lint.isort]
+case-sensitive = true
+lines-between-types = 1
+order-by-type = true
+
+[lint.pylint]
+allow-dunder-method-names = ["__tablename__", "__table_args__"]
+
+[format]
+docstring-code-format = true
+preview = true
+quote-style = "single"

backend/.ruff.toml

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 from backend.common.i18n import i18n
 
 __version__ = '1.8.2'

backend/__init__.py

@@ -1,8 +1,6 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# ruff: noqa: F403, F401, I001, RUF100
 import asyncio
 import os
+
 from logging.config import fileConfig
 
 from alembic import context
@@ -40,11 +38,12 @@
 
 # other values from the config, defined by the needs of env.py,
 alembic_config.set_main_option(
-    'sqlalchemy.url', SQLALCHEMY_DATABASE_URL.render_as_string(hide_password=False).replace('%', '%%')
+    'sqlalchemy.url',
+    SQLALCHEMY_DATABASE_URL.render_as_string(hide_password=False).replace('%', '%%'),
 )
 
 
-def run_migrations_offline():
+def run_migrations_offline() -> None:
     """Run migrations in 'offline' mode.
 
     This configures the context with just a URL
@@ -73,7 +72,7 @@ def run_migrations_offline():
 
 def do_run_migrations(connection: Connection) -> None:
     # 当迁移无变化时，不生成迁移记录
-    def process_revision_directives(context, revision, directives):
+    def process_revision_directives(context, revision, directives) -> None:  # noqa: ANN001
         if alembic_config.cmd_opts.autogenerate:
             script = directives[0]
             if script.upgrade_ops.is_empty():

backend/alembic/env.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 import os.path
 
 from backend.core.path_conf import BASE_PATH
@@ -8,14 +6,10 @@
 
 def get_app_models() -> list[type]:
     """获取 app 所有模型类"""
-    app_path = os.path.join(BASE_PATH, 'app')
+    app_path = BASE_PATH / 'app'
     list_dirs = os.listdir(app_path)
 
-    apps = []
-
-    for d in list_dirs:
-        if os.path.isdir(os.path.join(app_path, d)) and d != '__pycache__':
-            apps.append(d)
+    apps = [d for d in list_dirs if os.path.isdir(os.path.join(app_path, d)) and d != '__pycache__']
 
     objs = []
 

backend/app/__init__.py

@@ -1,2 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-

backend/app/admin/__init__.py

@@ -1,2 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-

backend/app/admin/api/__init__.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 from fastapi import APIRouter
 
 from backend.app.admin.api.v1.auth import router as auth_router

backend/app/admin/api/router.py

@@ -1,2 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-