✨ subs-io适配引入saa后的新数据库结构 (#219的subs-io部分) (#224)

* 🚚 将nbesf_model统一放到目录中

* ✨ 添加v2版本的nbesf

* ✨ 使subs_import支持导入多个版本的nbesf文件

* ✨ 使用saa的AllSupportedPlatformTarget

* 🚧 use deserialize

---------

Co-authored-by: felinae98 <731499577@qq.com>

nonebot_bison/config/subs_io/nbesf_model/__init__.py

@@ -0,0 +1,6 @@
+""" nbesf is Nonebot Bison Enchangable Subscribes File! """
+
+from . import v1, v2
+from .base import NBESFBase
+
+__all__ = ["v1", "v2", "NBESFBase"]

nonebot_bison/config/subs_io/nbesf_model/base.py

@@ -0,0 +1,31 @@
+from abc import ABC
+
+from nonebot_plugin_saa.utils import AllSupportedPlatformTarget as UserInfo
+from pydantic import BaseModel
+
+from ....types import Category, Tag
+
+
+class NBESFBase(BaseModel, ABC):
+
+    version: int  # 表示nbesf格式版本，有效版本从1开始
+    groups: list = list()
+
+    class Config:
+        orm_mode = True
+
+
+class SubReceipt(BaseModel):
+    """
+    快递包中每件货物的收据
+
+    导入订阅时的Model
+    """
+
+    user: UserInfo
+    target: str
+    target_name: str
+    platform_name: str
+    cats: list[Category]
+    tags: list[Tag]
+    # default_schedule_weight: int

nonebot_bison/config/subs_io/nbesf_model/v1.py

@@ -0,0 +1,111 @@
+""" nbesf is Nonebot Bison Enchangable Subscribes File! ver.1"""
+
+from functools import partial
+from typing import Any
+
+from nonebot.log import logger
+from nonebot_plugin_saa import TargetQQGroup, TargetQQPrivate
+from pydantic import BaseModel
+
+from ....types import Category, Tag
+from ...db_config import SubscribeDupException, config
+from ..utils import NBESFParseErr
+from .base import NBESFBase, SubReceipt
+
+# ===== nbesf 定义格式 ====== #
+NBESF_VERSION = 1
+
+
+class UserHead(BaseModel, orm_mode=True):
+    """Bison快递包收货信息"""
+
+    type: str
+    uid: int
+
+
+class Target(BaseModel, orm_mode=True):
+    """Bsion快递包发货信息"""
+
+    target_name: str
+    target: str
+    platform_name: str
+    default_schedule_weight: int
+
+
+class SubPayload(BaseModel, orm_mode=True):
+    """Bison快递包里的单件货物"""
+
+    categories: list[Category]
+    tags: list[Tag]
+    target: Target
+
+
+class SubPack(BaseModel):
+    """Bison给指定用户派送的快递包"""
+
+    user: UserHead
+    subs: list[SubPayload]
+
+
+class SubGroup(
+    NBESFBase,
+):
+    """
+    Bison的全部订单(按用户分组)
+
+    结构参见`nbesf_model`下的对应版本
+    """
+
+    version = NBESF_VERSION
+    groups: list[SubPack]
+
+
+# ======================= #
+
+
+async def subs_receipt_gen(nbesf_data: SubGroup):
+    for item in nbesf_data.groups:
+
+        match item.user.type:
+            case "group":
+                user = TargetQQGroup(group_id=item.user.uid)
+            case "private":
+                user = TargetQQPrivate(user_id=item.user.uid)
+            case _:
+                raise NotImplementedError(f"nbesf v1 不支持的用户类型：{item.user.type}")
+
+        sub_receipt = partial(SubReceipt, user=user)
+
+        for sub in item.subs:
+            receipt = sub_receipt(
+                target=sub.target.target,
+                target_name=sub.target.target_name,
+                platform_name=sub.target.platform_name,
+                cats=sub.categories,
+                tags=sub.tags,
+            )
+            try:
+                await config.add_subscribe(
+                    receipt.user, **receipt.dict(exclude={"user"})
+                )
+            except SubscribeDupException:
+                logger.warning(f"！添加订阅条目 {repr(receipt)} 失败: 相同的订阅已存在")
+            except Exception as e:
+                logger.error(f"！添加订阅条目 {repr(receipt)} 失败: {repr(e)}")
+            else:
+                logger.success(f"添加订阅条目 {repr(receipt)} 成功！")
+
+
+def nbesf_parser(raw_data: Any) -> SubGroup:
+    try:
+        if isinstance(raw_data, str):
+            nbesf_data = SubGroup.parse_raw(raw_data)
+        else:
+            nbesf_data = SubGroup.parse_obj(raw_data)
+
+    except Exception as e:
+        logger.error("数据解析失败，该数据格式可能不满足NBESF格式标准！")
+        raise NBESFParseErr("数据解析失败") from e
+    else:
+        logger.success("NBESF文件解析成功.")
+        return nbesf_data

nonebot_bison/config/subs_io/nbesf_model/v2.py

@@ -0,0 +1,94 @@
+""" nbesf is Nonebot Bison Enchangable Subscribes File! ver.2"""
+
+from functools import partial
+from typing import Any
+
+from nonebot.log import logger
+from nonebot_plugin_saa.utils import AllSupportedPlatformTarget
+from pydantic import BaseModel
+
+from ....types import Category, Tag
+from ...db_config import SubscribeDupException, config
+from ..utils import NBESFParseErr
+from .base import NBESFBase, SubReceipt
+
+# ===== nbesf 定义格式 ====== #
+NBESF_VERSION = 2
+
+
+class Target(BaseModel, orm_mode=True):
+    """Bsion快递包发货信息"""
+
+    target_name: str
+    target: str
+    platform_name: str
+    default_schedule_weight: int
+
+
+class SubPayload(BaseModel, orm_mode=True):
+    """Bison快递包里的单件货物"""
+
+    categories: list[Category]
+    tags: list[Tag]
+    target: Target
+
+
+class SubPack(BaseModel):
+    """Bison给指定用户派送的快递包"""
+
+    # user_target: Bison快递包收货信息
+    user_target: AllSupportedPlatformTarget
+    subs: list[SubPayload]
+
+
+class SubGroup(NBESFBase):
+    """
+    Bison的全部订单(按用户分组)
+
+    结构参见`nbesf_model`下的对应版本
+    """
+
+    version: int = NBESF_VERSION
+    groups: list[SubPack]
+
+
+# ======================= #
+
+
+async def subs_receipt_gen(nbesf_data: SubGroup):
+    for item in nbesf_data.groups:
+
+        sub_receipt = partial(SubReceipt, user=item.user_target)
+
+        for sub in item.subs:
+            receipt = sub_receipt(
+                target=sub.target.target,
+                target_name=sub.target.target_name,
+                platform_name=sub.target.platform_name,
+                cats=sub.categories,
+                tags=sub.tags,
+            )
+            try:
+                await config.add_subscribe(
+                    receipt.user, **receipt.dict(exclude={"user"})
+                )
+            except SubscribeDupException:
+                logger.warning(f"！添加订阅条目 {repr(receipt)} 失败: 相同的订阅已存在")
+            except Exception as e:
+                logger.error(f"！添加订阅条目 {repr(receipt)} 失败: {repr(e)}")
+            else:
+                logger.success(f"添加订阅条目 {repr(receipt)} 成功！")
+
+
+def nbesf_parser(raw_data: Any) -> SubGroup:
+    try:
+        if isinstance(raw_data, str):
+            nbesf_data = SubGroup.parse_raw(raw_data)
+        else:
+            nbesf_data = SubGroup.parse_obj(raw_data)
+
+    except Exception as e:
+        logger.error("数据解析失败，该数据格式可能不满足NBESF格式标准！")
+        raise NBESFParseErr("数据解析失败") from e
+    else:
+        return nbesf_data