Merge pull request #96 from shinonomeow/shino_aio

update pydantic to v2

Author: shinonomeow

backend/src/module/conf/config.py

@@ -34,32 +34,12 @@
 CONFIG_PATH = (CONFIG_ROOT / CONFIX_NAME).resolve()
 
 
-def model_dump(
-    model: BaseModel,
-    include: set[str] | None = None,
-    exclude: set[str] | None = None,
-    by_alias: bool = False,
-    exclude_unset: bool = False,
-    exclude_defaults: bool = False,
-    exclude_none: bool = False,
-) -> dict[str, Any]:
-    return model.dict(
-        include=include,
-        exclude=exclude,
-        by_alias=by_alias,
-        exclude_unset=exclude_unset,
-        exclude_defaults=exclude_defaults,
-        exclude_none=exclude_none,
-    )
-
-
 # 判断给定的 data 的 key 是否在 setting 中
 def check_config_key(
     data: dict | BaseModel, updated_data: BaseModel, config_name: str
 ) -> bool:
     if isinstance(data, BaseModel):
         data = data.model_dump()
-        # data = data.dict()
 
     updated_data = updated_data.model_dump()
     for key in updated_data.keys():
@@ -70,7 +50,7 @@ def check_config_key(
 
 def get_plugin_config(config: T_BaseModel, config_name: str) -> T_BaseModel:
     """从全局配置获取当前插件需要的配置项，更新 data 中的缺失项。"""
-    global_data = model_dump(settings)
+    global_data = settings.model_dump()
     data = global_data.get(config_name, {})
     # data 可能是 dict 和 BaseModel 的实例
     # 尝试从配置文件中读取配置, 如果不足则使用默认配置
@@ -85,8 +65,7 @@ def get_plugin_config(config: T_BaseModel, config_name: str) -> T_BaseModel:
 
 def type_validate_python(type_: BaseModel, data: Any) -> BaseModel:
     """Validate data with given type, checking required fields exist."""
-    validated_data = type_.__class__.validate(data)
-
+    validated_data = type_.__class__.model_validate(data)
     return validated_data
 
 
@@ -99,11 +78,9 @@ def update_config(base_config: BaseModel | dict, data: dict):
     # # 获取 baseconfig 的当前字段数据
     if isinstance(base_config, BaseModel):
         updated_data = base_config.model_dump()
-        # updated_data = base_config.dict()
         updated_data = deep_update(updated_data, data)
-        updated_instance = base_config.__class__.validate(updated_data)
+        updated_instance = base_config.__class__.model_validate(updated_data)
         updata_dict = updated_instance.model_dump()
-        # updata_dict = updated_instance.dict()
     else:
         # 当 baseconfig 是 dict 类型时, 直接更新
         updated_data = base_config
@@ -170,7 +147,7 @@ def __load_from_env(self):
                     else:
                         attr_name = attr[0] if isinstance(attr, tuple) else attr
                         config_dict[key][attr_name] = self.__val_from_env(env, attr)
-        config_obj = Config.validate(config_dict)
+        config_obj = Config.model_validate(config_dict)
         self.__dict__.update(config_obj.__dict__)
         logger.info("Config loaded from env")
 
@@ -182,9 +159,5 @@ def __val_from_env(env: str, attr: tuple[str, Callable[..., Any]] | str):
         else:
             return os.environ[env]
 
-    @property
-    def group_rules(self):
-        return self.__dict__["group_rules"]
-
 
 settings = Settings()

backend/src/module/conf/log.py

@@ -59,17 +59,6 @@ def setup_logger(level: int = logging.INFO, reset: bool = False):
     for logger_name in loggers_to_silence:
         logger = logging.getLogger(logger_name)
         logger.setLevel(logging.WARNING)
-        # logger.propagate = False
-        # logger.handlers = [NullHandler()]
 
     # 对于 bcrypt 有一个 适配的问题,就藏起来吧
     logging.getLogger("passlib").setLevel(logging.ERROR)
-    # 完全抑制 httpx 的日志输出
-    # httpx_logger = logging.getLogger("httpx")
-    # http_coro_logger = logging.getLogger("httpcore")
-    # httpx_logger.setLevel(logging.WARNING)
-    # http_coro_logger.setLevel(logging.WARNING)
-    # httpx_logger.addHandler(NullHandler())
-    # http_coro_logger.addHandler(NullHandler())
-    # httpx_logger.propagate = False
-    # http_coro_logger.propagate = False

backend/src/module/models/config.py

@@ -1,79 +1,35 @@
-from typing import Literal
+from typing import Self
 
-from pydantic import BaseModel, Field, validator
-from pydantic import ConfigDict as ConfigDict
+from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
 
 
 class Program(BaseModel):
     # rss_time must be greater than 300,if less than 300,it will be set to 300
     rss_time: int = Field(default=900, description="Sleep time")
-    # rename_time must be greater than 30,if less than 0,it will be set to 30
-    rename_time: int = Field(default=60, description="Rename times in one loop")
     webui_port: int = Field(default=7892, description="WebUI port")
 
-    @validator("rss_time")
-    def validate_rss_time(cls, v: int) -> int:
-        if v < 300:
-            return 300
-        return v
-
-    @validator("rename_time")
-    def validate_rename_time(cls, v: int) -> int:
-        if v < 30:
-            return 30
-        return v
+    @model_validator(mode="after")
+    def validate_rss_time(self) -> Self:
+        self.rss_time = max(self.rss_time, 300)
+        return self
 
 
 class Downloader(BaseModel):
     type: str = Field(default="qbittorrent", description="Downloader type")
     path: str = Field(default="/downloads/Bangumi", description="Downloader path")
-    host: str = Field(default="172.17.0.1:8080", alias="host", description="Downloader host")
-    ssl: bool = Field(default=False, description="Downloader ssl")
-
-    class Config:
-        extra: str = "allow"  # This allows extra fields not defined in the model
-
-    @validator("host", pre=True)
-    def validate_host(cls, value: str) -> str:
-        # 如果输入值没有以 http:// 或 https:// 开头，自动加上 http://
-        if not value.startswith(("http://", "https://")):
-            value = f"http://{value}"
-        return value
-
-    # username: str = Field("admin", alias="username", description="Downloader username")
-    # password: str = Field(
-    #     "adminadmin", alias="password", description="Downloader password"
-    # )
-
-
-class QbDownloader(Downloader):
-    type: str = Field(default="qbittorrent", description="Downloader type")
     host: str = Field(
         default="172.17.0.1:8080", alias="host", description="Downloader host"
     )
-    username: str = Field(
-        default="admin", alias="username", description="Downloader username"
-    )
-    password: str = Field(
-        default="adminadmin", alias="password", description="Downloader password"
-    )
-    path: str = Field(default="/downloads/Bangumi", description="Downloader path")
     ssl: bool = Field(default=False, description="Downloader ssl")
 
+    model_config = ConfigDict(extra="allow")
 
-class TrDownloader(Downloader):
-    type: str = Field(default="transmission", description="Downloader type")
-    host_: str = Field(
-        default="172.17.0.1:9091", alias="host", description="Downloader host"
-    )
-    username_: str = Field(
-        default="admin", alias="username", description="Downloader username"
-    )
-    password_: str = Field(
-        default="admin", alias="password", description="Downloader password"
-    )
-    path: str = Field(default="/downloads/Bangumi", description="Downloader path")
-    ssl: bool = Field(default=False, description="Downloader ssl")
+    @model_validator(mode="after")
+    def validate_host(self) -> Self:
+        # 如果输入值没有以 http:// 或 https:// 开头，自动加上 http://
+        if not self.host.startswith(("http://", "https://")):
+            self.host = f"http://{self.host}"
+        return self
 
 
 class RSSParser(BaseModel):
@@ -108,14 +64,6 @@ class Proxy(BaseModel):
     username: str = Field(default="", alias="username", description="Proxy username")
     password: str = Field(default="", alias="password", description="Proxy password")
 
-    # @property
-    # def username(self):
-    #     return expandvars(self.username_)
-    #
-    # @property
-    # def password(self):
-    #     return expandvars(self.password_)
-
 
 class Notification(BaseModel):
     enable: bool = Field(default=False, description="Enable notification")
@@ -125,33 +73,25 @@ class Notification(BaseModel):
         default="", alias="chat_id", description="Notification chat id"
     )
 
-    # @property
-    # def token(self):
-    #     return expandvars(self.token_)
-    #
-    # @property
-    # def chat_id(self):
-    #     return expandvars(self.chat_id_)
-
 
-class ExperimentalOpenAI(BaseModel):
-    enable: bool = Field(False, description="Enable experimental OpenAI")
-    api_key: str = Field("", description="OpenAI api key")
-    api_base: str = Field(
-        "https://api.openai.com/v1", description="OpenAI api base url"
-    )
-    api_type: Literal["azure", "openai"] = Field(
-        "openai", description="OpenAI api type, usually for azure"
-    )
-    api_version: str = Field(
-        "2023-05-15", description="OpenAI api version, only for Azure"
-    )
-    model: str = Field(
-        "gpt-3.5-turbo", description="OpenAI model, ignored when api type is azure"
-    )
-    deployment_id: str = Field(
-        "", description="Azure OpenAI deployment id, ignored when api type is openai"
-    )
+# class ExperimentalOpenAI(BaseModel):
+#     enable: bool = Field(False, description="Enable experimental OpenAI")
+#     api_key: str = Field("", description="OpenAI api key")
+#     api_base: str = Field(
+#         "https://api.openai.com/v1", description="OpenAI api base url"
+#     )
+#     api_type: Literal["azure", "openai"] = Field(
+#         "openai", description="OpenAI api type, usually for azure"
+#     )
+#     api_version: str = Field(
+#         "2023-05-15", description="OpenAI api version, only for Azure"
+#     )
+#     model: str = Field(
+#         "gpt-3.5-turbo", description="OpenAI model, ignored when api type is azure"
+#     )
+#     deployment_id: str = Field(
+#         "", description="Azure OpenAI deployment id, ignored when api type is openai"
+#     )
 
 
 class Config(BaseModel):
@@ -163,16 +103,6 @@ class Config(BaseModel):
     proxy: Proxy = Proxy()
     notification: Notification = Notification()
 
-    class Config:
-        extra = "allow"  # This allows extra fields not defined in the model
+    model_config = ConfigDict(extra="allow")
 
     # experimental_openai: ExperimentalOpenAI = ExperimentalOpenAI()
-
-    # @override
-    # def model_dump(self, *args, by_alias=True, **kwargs):
-    #     return super().model_dump(*args, by_alias=by_alias, **kwargs)
-
-
-if __name__ == "__main__":
-    pass
-    # t = Program(rss_time="1")

backend/src/module/parser/analyser/torrent_parser.py

@@ -36,15 +36,15 @@ def torrent_parser(
     suffix = Path(torrent_name).suffix
     if file_type == "media":
         return EpisodeFile(
-            **media_info.dict(),
+            **media_info.model_dump(),
             media_path=torrent_name,
             title=media_info.get_title(),
             suffix=suffix,
         )
     else:
         language = get_subtitle_lang(torrent_name)
         return SubtitleFile(
-            **media_info.dict(),
+            **media_info.model_dump(),
             media_path=torrent_name,
             language=language,
             title=media_info.get_title(),