nonebot-bison/docs/dev

sidebar
auto

基本开发须知

语言以及工具

1. 本项目使用了python3.9的特性进行开发，所以请确保你的 Python 版本>=3.9
2. 本项目使用 poetry 进行依赖管理，请确保开发之前已经进行过poetry install，运行时在poetry shell的环境中进行运行
3. 本项目使用的 node 项目管理工具是 yarn

前端

本项目使用了前端，如果单独 clone 仓库本身，里面是不包含编译过的前端的，请使用yarn && yarn build进行前端的构建。 如果想要开发前端，推荐在.env.dev中加入BISON_OUTER_URL="http://localhost:3000/bison/"，然后分别运行 bot 和yarn dev ::: warning 请在开发前端的时候删除项目根目录中的node_modules，否则编译和运行的时候可能会出现奇怪的问题。 :::

文档

文档的相关部分在docs目录中，可以在项目根目录执行yarn docs:dev预览文件更改效果。

代码格式

本项目使用了 pre-commit 来进行代码美化和格式化。在poetry shell状态下执行pre-commit install来安装 git hook，可自动在 commit 时 格式化代码。

适配新网站

本插件需要你的帮助！只需要会写简单的爬虫，就能给本插件适配新的网站。

::: danger Nonebot 项目使用了全异步的处理方式，所以你需要对异步，Python asyncio 的机制有一定了解，当然， 依葫芦画瓢也是足够的 :::

基本概念

• nonebot_bison.post: 可以理解为推送内容，其中包含需要发送的文字，图片，链接，平台信息等，分为：
  • nonebot_bison.post.Post: 简单的推送内容格式，需要发送的内容由 bison 处理
  • nonebot_bison.post.CustomPost: 基于 markdown 语法的，自由度较高的推送内容格式
  • 详细的介绍可参见生成 bison 的推送文本
• nonebot_bison.types.RawPost: 从站点/平台中爬到的单条信息
• nonebot_bison.types.Target: 目标账号，Bilibili，微博等社交媒体中的账号
• nonebot_bison.types.Category: 信息分类，例如视频，动态，图文，文章等
• nonebot_bison.types.Tag: 信息标签，例如微博中的超话或者 hashtag

快速上手

上车！我们走

先明确需要适配的站点类型，先明确两个问题：

我要发送什么样的推送

• nonebot_bison.platform.platform.NewMessage 最常见的类型，每次爬虫向特定接口爬取一个消息列表， 与之前爬取的信息对比，过滤出新的消息，再根据用户自定义的分类和标签进行过滤，最后处理消息，把 处理过后的消息发送给用户
  例如：微博，Bilibili
• nonebot_bison.platform.platform.StatusChange 每次爬虫获取一个状态，在状态改变时发布推送
  例如：游戏开服提醒，主播上播提醒
• nonebot_bison.platform.platform.SimplePost 与NewMessage相似，但是不过滤之前发过的 ，每次发送全部消息
  例如：每日榜单定时发送

这个平台是否有账号的概念

• 有账号的概念
  例如：B 站用户动态，微博用户动态，网易云电台更新
• 没有账号的概念
  例如：游戏公告，教务处公告

实现方法

现在你需要在src/plugins/nonebot_bison/platform下新建一个 py 文件， 在里面新建一个类，继承推送类型的基类，重载一些关键的函数，然后……就完成了，不需要修改别的东西了。

不同类型 Platform 的实现适配以及逻辑

• nonebot_bison.platform.platform.NewMessage 需要实现：

  • async get_sub_list(Target) -> list[RawPost]
  • get_id(RawPost)
  • get_date(RawPost) (可选)

  ::: details 大致流程

  1. 调用get_sub_list拿到 RawPost 列表
  2. 调用get_id判断是否重复，如果没有重复就说明是新的 RawPost
  3. 如果有get_category和get_date，则调用判断 RawPost 是否满足条件
  4. 调用parse生成正式推文 :::

  参考nonebot_bison.platform.Weibo

• nonebot_bison.platform.platform.StatusChange 需要实现：

  • async get_status(Target) -> Any
  • compare_status(Target, old_status, new_status) -> list[RawPost]

  :::details 大致流程

  1. get_status获取当前状态
  2. 传入compare_status比较前状态
  3. 通过则进入parser生成 Post :::

  参考nonenot_bison.platform.AkVersion

• nonebot_bison.platform.platform.SimplePost 需要实现：

  • async get_sub_list(Target) -> list[RawPost]
  • get_date(RawPost) (可选)

  ::: details 大致流程

  1. 调用get_sub_list拿到 RawPost 列表
  2. 如果有get_category和get_date，则调用判断 RawPost 是否满足条件
  3. 调用parse生成正式推文 :::

公共方法/成员

任何一种订阅类型需要实现的方法/成员如下：

• schedule_type, schedule_kw 调度的参数，本质是使用 apscheduler 的trigger 参数，schedule_type可以是date,interval和cron， schedule_kw是对应的参数，一个常见的配置是schedule_type=interval, schedule_kw={'seconds':30}
• is_common 是否常用，如果被标记为常用，那么和机器人交互式对话添加订阅时，会直接出现在选择列表中，否则 需要输入全部才会出现。
• enabled 是否启用
• name 平台的正式名称，例如微博
• has_target 平台是否有“帐号”
• category 平台的发布内容分类，例如 B 站包括专栏，视频，图文动态，普通动态等，如果不包含分类功能则设为{}
• enable_tag 平台发布内容是否带 Tag，例如微博
• platform_name 唯一的，英文的识别标识，比如weibo
• async get_target_name(Target) -> Optional[str] 通常用于获取帐号的名称，如果平台没有帐号概念，可以直接返回平台的name
• get_tags(RawPost) -> Optional[Collection[Tag]] （可选） 从 RawPost 中提取 Tag
• get_category(RawPos) -> Optional[Category] （可选）从 RawPost 中提取 Category
• async parse(RawPost) -> Post 将获取到的 RawPost 处理成 Post
• async parse_target(str) -> Target （可选）定制化处理传入用户输入的 Target 字符串，返回 Target（一般是把用户的主页链接解析为 Target），如果输入本身就是 Target，则直接返回 Target
• parse_target_promot （可选）在要求用户输入 Target 的时候显示的提示文字

特有的方法/成员

• async get_sub_list(Target) -> list[RawPost] 输入一个Target，输出一个RawPost的 list
  • 对于nonebot_bison.platform.platform.NewMessage
get_sub_list(Target) -> list[RawPost] 用于获取对应 Target 的 RawPost 列表，与上一次get_sub_list获取的列表比较，过滤出新的 RawPost
  • 对于nonebot_bison.platform.platform.SimplePost
get_sub_list 用于获取对应 Target 的 RawPost 列表，但不会与上次获取的结果进行比较，而是直接进行发送
• get_id(RawPost) -> Any 输入一个RawPost，从RawPost中获取一个唯一的 ID，这个 ID 会用来判断这条RawPost是不是之前收到过
• get_date(RawPost) -> Optional[int] 输入一个RawPost，如果可以从RawPost中提取出发文的时间，返回发文时间的 timestamp，否则返回None
• async get_status(Target) -> Any
  • 对于nonebot_bison.platform.platform.StatusChange
get_status用于获取对应 Target 当前的状态，随后将获取的状态作为参数new_status传入compare_status中
• compare_status(self, target: Target, old_status, new_status) -> list[RawPost]
  • 对于nonebot_bison.platform.platform.StatusChange
compare_status 用于比较储存的old_status与新传入的new_status，并返回发生变更的 RawPost 列表

单元测试

当然我们非常希望你对自己适配的平台写一些单元测试

你可以参照tests/platforms/test_*.py中的内容对单元测试进行编写。

为保证多次运行测试的一致性，可以 mock http 的响应，测试的内容应包括获取 RawPost，处理成 Post ，测试分类以及提取 tag 等，当然最好和 rsshub 做一个交叉验证。

一些例子

例如要适配微博，我希望 bot 搬运新的消息，所以微博的类应该这样实现：

class Weibo(NewMessage):

    categories = {
        1: "转发",
        2: "视频",
        3: "图文",
        4: "文字",
    }
    enable_tag = True
    platform_name = "weibo"
    name = "新浪微博"
    enabled = True
    is_common = True
    schedule_type = "interval"
    schedule_kw = {"seconds": 3}
    has_target = True

    async def get_target_name(self, target: Target) -> Optional[str]:
      #获取Target对应的用户名
      ...
    async def get_sub_list(self, target: Target) -> list[RawPost]:
      #获取对应Target的RawPost列表，会与上一次get_sub_list获取的列表比较，过滤出新的RawPost
      ...
    def get_id(self, post: RawPost) -> Any:
      #获取可以标识每个Rawpost的，不与之前RawPost重复的id，用于过滤出新的RawPost
      ...
    def get_date(self, raw_post: RawPost) -> float:
      #获取RawPost的发布时间，若bot过滤出的新RawPost发布时间与当前时间差超过2小时，该RawPost将被忽略，可以返回None
      ...
    def get_tags(self, raw_post: RawPost) -> Optional[list[Tag]]:
      #获取RawPost中包含的微博话题（#xxx#中的内容）
      ...
    def get_category(self, raw_post: RawPost) -> Category:
      #获取该RawPost在该类定义categories的具体分类(转发？视频？图文？...？)
      ...
    async def parse(self, raw_post: RawPost) -> Post:
      #将需要bot推送的RawPost处理成正式推送的Post
      ...

生成 bison 的推送文本

什么是nonebot_bison.post

可以认为nonebot_bison.post是最终要交付给 bison 推送到群内的内容，经过parse函数处理过后的报文应该返回属于nonebot_bison.post下的某个类
目前 bison 所支持的类有：

• nonebot_bison.post.Post
• nonebot_bison.post.CustomPost

什么是nonebot_bison.post.Post

Post 类存在参数text与pics，分别对应接收文本与图片类消息，需要注意的是pics接收的是一个列表 List，列表中的值可以为 url 或者 bytes。
Post 会将text与pics分为若干条消息进行分别发送
可选参数:
使用compress参数将所有消息压缩为一条进行发送。
使用extra_msg可以携带额外的消息进行发送
使用override_use_pic参数可以无视全局配置中的 bison_use_pic 配置进行强制指定
可参考Post 的用法

什么是nonebot_bison.post.CustomPost

CustomPost 类能接受的消息为List[MessageSegment]
::: tip

消息段（Message Segment 或 Segment）
表示聊天消息的一个部分，在一些平台上，聊天消息支持图文混排，其中就会有多个消息段，分别表示每个图片和每段文字。 ::: 准确来说，CustomPost 只支持使用 MessageSegment 内的text和image类型，CustomPost 会将 List 中的每个text类型元素理解为一个单行的 text 文本， 当然，markdown 语法可以在每个text类型元素使用，但如果这样，在不开启bison_use_pic全局配置项 的情况下，bison 会将写在 text 类型元素里的 markdown 语法按原样推送，不会解析。
对于上述情况，建议开启 CustomPost 的override_use_pic选项，这样 CustomPost 只会发送经过 markdown 语法渲染好的图片，而非文本消息。
CustomPost 的可选参数及作用与上文中的Post一致。 ::: details CustomPost 例子

  async def parse(self, raw_post:RawPost) -> str:
    #假定传入的raw_post为List[MessageSegment]
    #do something...
    return CustomPost(message_segments=raw_post, only_pic=True)

:::