earwigbot 0.4

最新版本

EarwigBot可在Python包索引中找到，因此您可以使用以下命令安装最新版本

pip install earwigbot

有一些可选的依赖项集

• crypto：允许在配置中加密机器人密码和机密

• sql：允许与MediaWiki数据库（例如在Toolforge）交互

• copyvios：包括检查版权侵权的解析库

• dev：安装开发依赖项（例如测试运行器）

例如，要安装所有非开发依赖项

pip install ‘earwigbot[crypto,sql,copyvios]’

在pip安装依赖项时可能出现的错误可能是缺少头文件。例如，在Ubuntu上，请参阅这篇StackOverflow帖子。

开发版本

您可以安装机器人的开发版本

git clone https://github.com/earwig/earwigbot.git
cd earwigbot
python3 -m venv venv
. venv/bin/activate
pip install -e '.[crypto,sql,copyvios,dev]'

要运行机器人的单元测试，请运行pytest（需要开发依赖项）。覆盖率目前尚不完整。

Bot 和 BotConfig

earwigbot.bot.Bot 是 EarwigBot 的主要类。您不需要自己实例化它，但了解其属性和方法是很好的，因为这是与其他机器人部分通信的主要方式。一个 Bot 对象可以通过命令和任务（即 self.bot）访问。

earwigbot.config.BotConfig 存储机器人的配置信息。它的文档字符串解释了每个属性的作用，但基本上每个“节点”（即 config.components、wiki、irc、commands、tasks 和 metadata）映射到机器人 config.yml 文件的一个部分。例如，如果 config.yml 包含以下内容

irc:
    frontend:
        nick: MyAwesomeBot
        channels:
            - "##earwigbot"
            - "#channel"
            - "#other-channel"

那么 config.irc["frontend"]["nick"] 将是 "MyAwesomeBot"，而 config.irc["frontend"]["channels"] 将是 ["##earwigbot", "#channel", "#other-channel"]。

自定义IRC命令

自定义命令是 earwigbot.commands.Command 的子类，它覆盖了 Command 的 process()（以及可选的 check()、setup() 或 unload()）方法。

机器人有多种内置命令和插件，可以作为示例代码，也可以提供一些灵感。从 test 开始，然后查看 chanops 和 afc_status 以获取一些更复杂的脚本。

自定义机器人任务

自定义任务是 earwigbot.tasks.Task 的子类，它覆盖了 Task 的 run()（以及可选的 setup() 或 unload()）方法。

查看内置的 wikiproject_tagger 任务以了解相对简单的工作，或者查看 afc_statistics 插件以了解更复杂的工作。