🔍 FAQ 问题汇总

[stdrc]

请不要在本帖提问，提问请登录后点击此处

FAQ, 全称 Frequently Asked Questions, 即"经常问到的问题"
顾名思义, 这里提供了一些在NoneBot开发过程中常见问题的解答

如果你觉得这里的回答有帮助, 请点击回答左下角给予支持
如果您有其他这里没有提及的常见问题想要补充, 也可以随时向这里进行补充

通用

• Nonebot 文档使用的主题是什么？
• Linux 怎么把 bot 挂到后台？
• 初始化时出现 ModuleNotFoundError: no module named xxx
• ActionFailed（nonebot.adapters.cqhttp.exception.ActionFailed 或 aiocqhttp.exceptions.ActionFailed）
• 如何避免同步函数调用导致的事件循环阻塞?
• 如何进行不会阻塞事件循环的网络请求?

---

NoneBot v2

• 为什么更新后无法导入 adapter？
• 启动后无法连接上
• 启动后出现 TypeError/Type xxx 报错
• 定时任务如何获取 bot 实例
• nb-cli 运行出错
• 为何 NoneBot 2 调用 matcher.finish 之类的方法发送的消息 CQ 码未解析/为纯文本？
• 如何在Windows下进行异步子进程调用(如使用Playwright等)?
• 如何替换ASGI服务器
• NoneBot 2 的不同事件处理/逻辑控制函数之间究竟有何区别？

---

NoneBot v1

[SK-415]

ActionFailed（nonebot.adapters.onebot.exception.ActionFailed 或 aiocqhttp.exceptions.ActionFailed）

此问题与 NoneBot 无关，请参考协议端（如 go-cqhttp）的输出。

[j1g5awi]

这应该是两个问题，因为发图片用的是 CQCode，发文件只有 go-cqhttp 支持而且是调用 API。

[j1g5awi]

Nonebot 文档使用的主题是什么？

nonebot/docusaurus-theme-nonepress

一款基于Docusaurus和React的文档主题, 由NoneBot团队自行研发 (当然, 你也可以用!)

[j1g5awi]

Linux 怎么把 bot 挂到后台？

使用 shell & 运算符、tmux、screen、pm2、supervisord 等工具都可以将 bot 放到后台运行，请选择最适合自己的工具。

[jexjws]

有 & 运算符 的使用示例吗

[zty012]

有 & 运算符 的使用示例吗

我只知道powershell的

& nb run  # 挂后台
Get-Job  # 查看后台
Stop-Job <job-id>  # 杀后台
Remove-Job <job-id>  # 移除后台

[SuperKenVery]

也推荐一下用systemd（）

[j1g5awi]

初始化时出现 ModuleNotFoundError: no module named xxx

请先同时卸载 NoneBot 1 和 NoneBot 2：

pip uninstall nonebot
pip uninstall nonebot2

然后重新安装所需要的版本。

为了保证依赖版本不会冲突，我们强烈推荐您使用虚拟环境

[j1g5awi]

启动后无法连接上

建议检查 host 与 port 配置，检查端口占用，检查 adapter 是否注册。

[j1g5awi]

启动后出现 TypeError/Type xxx 报错

请使用 Python 3.8+。

[j1g5awi]

定时任务如何获取 bot 实例

• nonebot.get_bots()

• 在nonebot2.0.0a14之后，我们添加了nonebot.get_bot()

[j1g5awi]

nb-cli 运行出错

出现 httpx 字样时，多为无法获取 NoneBot 2 的云端资源（插件/bot/adapter 列表）或是代理服务器有问题，推荐切换或关闭代理后重试

请确保系统环境变量 PATH 中有 pip 的脚本目录

[j1g5awi]

升级 adapter 或 NoneBot 2 本体后运行出现报错

尝试同时升级 adapter 与本体。

[StarHeartHunt]

为何 NoneBot 2 调用 matcher.finish 之类的方法发送的消息 CQ 码未解析/为纯文本？

为避免 SSRF 等注入问题，NoneBot 2 默认对使用这些方法发送的消息中的 CQ 码进行转义，作为纯文本发送，推荐使用 MessageSegment 构造 CQ 码消息段。

详情请见： nonebot/nonebot2#212 (comment)

[mnixry]

如何避免同步函数调用导致的事件循环阻塞?

我们提供了以下工具函数, 通过调用线程池将任意同步步函数调用变为异步, 以避免主线程事件循环被阻塞:

• 在NoneBot1中, 可以使用aiocqhttp.utils.ensure_async
• 在NoneBot2中, 可以使用nonebot.utils.run_sync

以上函数的推荐用法是作为装饰器使用的

@run_sync
def some_sync_function(a,b,c):
    do_something()

await some_sync_function(1,2,3)

如果你不想把它当作装饰器使用, 可以使用下面这种代码

def some_sync_function(a,b,c):
    do_something()

await run_sync(some_sync_function)(1,2,3)

因为后者看起来很丑所以不推荐

source: #22

[cleoold]

不建議 aiocqhttp.utils.ensure_async。請自己使用綫程池或進程池再 run_in_executor，或使用 quart.utils.run_sync

[mnixry]

不建議 aiocqhttp.utils.ensure_async。請自己使用綫程池或進程池再 run_in_executor，或使用 quart.utils.run_sync

请解释原因并给出您所推荐的代码使用示例

[mnixry]

如何在Windows下进行异步子进程调用(如使用Playwright等)?

由于Uvicorn在Windows下选择的事件循环(SelectorEventLoop)实现原因, 它无法在Windows下异步地创建子进程 (相关Issue: nonebot/nonebot2#376)

不过所幸, 目前我们可以通过猴子补丁(monkeypatch)来解决这个问题

• 注意: 启用这段代码后, 会在Windows平台下带来包括但不限于以下的副作用, 请酌情修改
  • uvicorn代码修改检测重载不再可用
    • 相关链接: Iocp drop encode/uvicorn#535
  • aiohttp的代理设置不再可用
    • 相关链接: Problems when using proxy under Windows aio-libs/aiohttp#4536 (comment)

以下代码参考自 @SK-415 nonebot/nonebot2#376 (comment)
从理论上, 如果在nonebot.run()执行之前导入, 这段代码将会起到强制Uvicorn使用平台默认的事件循环(在Windows下它是ProactorEventLoop)的作用

import asyncio
import platform
from uvicorn.loops import asyncio as _asyncio
from uvicorn import config
from nonebot.log import logger


def asyncio_setup():
    loop = asyncio.new_event_loop()
    asyncio.set_event_loop(loop)


@property
def should_reload(self):
    return False


if platform.system() == "Windows":
    _asyncio.asyncio_setup = asyncio_setup
    config.Config.should_reload = should_reload

[FYWinds]

如何进行不会阻塞事件循环的网络请求？

因为NoneBot是一款异步框架，所以如果直接在代码中使用我们常用的requests或者urllib3等同步网络请求库，会导致事件循环阻塞，所以请在网络请求代码中使用异步的网络请求库：

由于aiohttp在代理方面的实现在跨平台方面兼容性较差，推荐使用httpx

• 如果举例来说，你可以将

  • 以下的同步请求

    import requests
    
    def request_example():
        response = requests.get(url="https://www.example.com/)
        return response.content

  • 变成以下的异步请求

    import httpx
    
    async def request_example():
        async with httpx.AsyncClient() as client:
            r = await client.get(url="https://www.example.com/")
        return r.content

• 更多的实例以及说明请移步httpx异步用法文档(英文)

  • 如果有哪位大佬把这个文档翻译成中文贴在这个FAQ下就更好了

[synodriver]

如何替换ASGI服务器

uvicorn太拉跨了不支持某些高级特性，比如http2之类的，这样可以换个先进的ASGI服务器

• 使用hypercorn，功能最丰富的ASGI服务器，在需要http2支持以及asgi extension支持的时候使用

  # file: bot.py
  import asyncio
  
  from pathlib import Path
  
  import nonebot
  from nonebot.adapters.cqhttp import Bot
  
  nonebot.init(_env_file=r".env")
  driver = nonebot.get_driver()
  driver.register_adapter("cqhttp", Bot)
  
  nonebot.load_plugins(str(Path(".") / "plugins"))
  app = nonebot.get_app()
  
  if __name__ == "__main__":
      from hypercorn.asyncio import serve
      from hypercorn.config import Config
      try:
          import uvloop
          uvloop.install()
      except ImportError:
          pass
  
      config = Config()
      config.bind = ["0.0.0.0:8090"]
      config.accesslog = "-"
      config.loglevel = "DEBUG"
      # config.keyfile ="./key.pem"
      # config.certfile="./cert.pem"
      asyncio.run(serve(app, config))

• 使用NGINX UNIT，最快的ASGI服务器，在需要极致性能的时候使用（比如我同时1000个群，数十个bot）

  • 官方文档提供的配置参考

  • 配置文件config.json:

  {
    "listeners": {
      "*:9000": {
        "pass": "applications/nonebot"
      }
    },
    "applications": {
      "nonebot": {
        "type": "python 3.8",
        "path": "你的bot.py的路径",
        "module": "bot",
        "callable": "app",
          "processes": 1
      }
    }
  }

  • 然后执行以下指令更新UNIT配置

  curl -X PUT --data-binary @config.json --unix-socket /path/to/control.unit.sock http://localhost/config/

[synodriver]

为什么onebot的客户端莫名其妙的unexpected EOF 记录一下刚才遇到的坑

属于ASGI服务器配置问题。千万不要设置读取超时时间，可能的话，让ASGI服务器自己定时ping。如果设置了读取超时，则一旦客户端长时间不上报数据就会被服务器主动关闭连接。

[yanyongyu]

请不要在汇总帖进行提问

脚手架使用方法或问题请参考

• https://v2.nonebot.dev/docs/next/start/nb-cli
• 🔍 FAQ 问题汇总 #13 (comment)

[zty012]

控制台里全是心跳包事件？

关闭心跳包或者修改log-level为debug以上