A Python robot that edits Wikipedia and interacts with people over IRC https://en.wikipedia.org/wiki/User:EarwigBot
選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

customizing.rst 14 KiB

12年前
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. Customizing
  2. ===========
  3. The bot's working directory contains a :file:`commands` subdirectory and a
  4. :file:`tasks` subdirectory. Custom IRC commands can be placed in the former,
  5. whereas custom wiki bot tasks go into the latter. Developing custom modules is
  6. explained in detail in this documentation.
  7. Note that custom commands will override built-in commands and tasks with the
  8. same name.
  9. :py:class:`~earwigbot.bot.Bot` and :py:class:`~earwigbot.bot.BotConfig`
  10. -----------------------------------------------------------------------
  11. :py:class:`earwigbot.bot.Bot` is EarwigBot's main class. You don't have to
  12. instantiate this yourself, but it's good to be familiar with its attributes and
  13. methods, because it is the main way to communicate with other parts of the bot.
  14. A :py:class:`~earwigbot.bot.Bot` object is accessible as an attribute of
  15. commands and tasks (i.e., :py:attr:`self.bot`).
  16. The most useful attributes are:
  17. - :py:attr:`~earwigbot.bot.Bot.config`: an instance of
  18. :py:class:`~earwigbot.config.BotConfig`, for accessing the bot's
  19. configuration data (see below).
  20. - :py:attr:`~earwigbot.bot.Bot.commands`: the bot's
  21. :py:class:`~earwigbot.managers.CommandManager`, which is used internally to
  22. run IRC commands (through
  23. :py:meth:`commands.call() <earwigbot.managers.CommandManager.call>`, which
  24. you shouldn't have to use); you can safely reload all commands with
  25. :py:meth:`commands.load() <earwigbot.managers._ResourceManager.load>`.
  26. - :py:attr:`~earwigbot.bot.Bot.tasks`: the bot's
  27. :py:class:`~earwigbot.managers.TaskManager`, which can be used to start tasks
  28. with :py:meth:`tasks.start(task_name, **kwargs)
  29. <earwigbot.managers.TaskManager.start>`. :py:meth:`tasks.load()
  30. <earwigbot.managers._ResourceManager.load>` can be used to safely reload all
  31. tasks.
  32. - :py:attr:`~earwigbot.bot.Bot.frontend` /
  33. :py:attr:`~earwigbot.bot.Bot.watcher`: instances of
  34. :py:class:`earwigbot.irc.Frontend <earwigbot.irc.frontend.Frontend>` and
  35. :py:class:`earwigbot.irc.Watcher <earwigbot.irc.watcher.Watcher>`,
  36. respectively, which represent the bot's connections to these two servers; you
  37. can, for example, send a message to the frontend with
  38. :py:meth:`frontend.say(chan, msg)
  39. <earwigbot.irc.connection.IRCConnection.say>` (more on communicating with IRC
  40. below).
  41. - :py:attr:`~earwigbot.bot.Bot.wiki`: interface with the
  42. :doc:`Wiki Toolset <toolset>`.
  43. - Finally, :py:meth:`~earwigbot.bot.Bot.restart` (restarts IRC components and
  44. reloads config, commands, and tasks) and :py:meth:`~earwigbot.bot.Bot.stop`
  45. can be used almost anywhere. Both take an optional "reason" that will be
  46. logged and used as the quit message when disconnecting from IRC.
  47. :py:class:`earwigbot.config.BotConfig` stores configuration information for the
  48. bot. Its docstrings explains what each attribute is used for, but essentially
  49. each "node" (one of :py:attr:`config.components
  50. <earwigbot.config.BotConfig.components>`,
  51. :py:attr:`~earwigbot.config.BotConfig.wiki`,
  52. :py:attr:`~earwigbot.config.BotConfig.irc`,
  53. :py:attr:`~earwigbot.config.BotConfig.commands`,
  54. :py:attr:`~earwigbot.config.BotConfig.tasks`, or
  55. :py:attr:`~earwigbot.config.BotConfig.metadata`) maps to a section
  56. of the bot's :file:`config.yml` file. For example, if :file:`config.yml`
  57. includes something like::
  58. irc:
  59. frontend:
  60. nick: MyAwesomeBot
  61. channels:
  62. - "##earwigbot"
  63. - "#channel"
  64. - "#other-channel"
  65. ...then :py:attr:`config.irc["frontend"]["nick"]` will be ``"MyAwesomeBot"``
  66. and :py:attr:`config.irc["frontend"]["channels"]` will be
  67. ``["##earwigbot", "#channel", "#other-channel"]``.
  68. Custom IRC commands
  69. -------------------
  70. Custom commands are subclasses of :py:class:`earwigbot.commands.BaseCommand`
  71. that override :py:class:`~earwigbot.commands.BaseCommand`'s
  72. :py:meth:`~earwigbot.commands.BaseCommand.process` (and optionally
  73. :py:meth:`~earwigbot.commands.BaseCommand.check` or
  74. :py:meth:`~earwigbot.commands.BaseCommand.setup`) methods.
  75. :py:class:`~earwigbot.commands.BaseCommand`'s docstrings should explain what
  76. each attribute and method is for and what they should be overridden with, but
  77. these are the basics:
  78. - Class attribute :py:attr:`~earwigbot.commands.BaseCommand.name` is the name
  79. of the command. This must be specified.
  80. - Class attribute :py:attr:`~earwigbot.commands.BaseCommand.commands` is a list
  81. of names that will trigger this command. It defaults to the command's
  82. :py:attr:`~earwigbot.commands.BaseCommand.name`, but you can override it with
  83. multiple names to serve as aliases. This is handled by the default
  84. :py:meth:`~earwigbot.commands.BaseCommand.check` implementation (see below),
  85. so if :py:meth:`~earwigbot.commands.BaseCommand.check` is overridden, this is
  86. ignored by everything except the help_ command (so ``!help alias`` will
  87. trigger help for the actual command).
  88. - Class attribute :py:attr:`~earwigbot.commands.BaseCommand.hooks` is a list of
  89. the "IRC events" that this command might respond to. It defaults to
  90. ``["msg"]``, but options include ``"msg_private"`` (for private messages
  91. only), ``"msg_public"`` (for channel messages only), and ``"join"`` (for when
  92. a user joins a channel). See the afc_status_ plugin for a command that
  93. responds to other hook types.
  94. - Method :py:meth:`~earwigbot.commands.BaseCommand.setup` is called *once* with
  95. no arguments immediately after the command is first loaded. Does nothing by
  96. default; treat it like an :py:meth:`__init__` if you want
  97. (:py:meth:`~earwigbot.tasks.BaseCommand.__init__` does things by default and
  98. a dedicated setup method is often easier than overriding
  99. :py:meth:`~earwigbot.tasks.BaseCommand.__init__` and using :py:obj:`super`).
  100. - Method :py:meth:`~earwigbot.commands.BaseCommand.check` is passed a
  101. :py:class:`~earwigbot.irc.data.Data` [1]_ object, and should return ``True``
  102. if you want to respond to this message, or ``False`` otherwise. The default
  103. behavior is to return ``True`` only if :py:attr:`data.is_command` is ``True``
  104. and :py:attr:`data.command` ``==``
  105. :py:attr:`~earwigbot.commands.BaseCommand.name` (or :py:attr:`data.command
  106. <earwigbot.irc.data.Data.command>` is in
  107. :py:attr:`~earwigbot.commands.BaseCommand.commands` if that list is
  108. overriden; see above), which is suitable for most cases. A possible reason
  109. for overriding is if you want to do something in response to events from a
  110. specific channel only. Note that by returning ``True``, you prevent any other
  111. commands from responding to this message.
  112. - Method :py:meth:`~earwigbot.commands.BaseCommand.process` is passed the same
  113. :py:class:`~earwigbot.irc.data.Data` object as
  114. :py:meth:`~earwigbot.commands.BaseCommand.check`, but only if
  115. :py:meth:`~earwigbot.commands.BaseCommand.check` returned ``True``. This is
  116. where the bulk of your command goes. To respond to IRC messages, there are a
  117. number of methods of :py:class:`~earwigbot.commands.BaseCommand` at your
  118. disposal. See the the test_ command for a simple example, or look in
  119. :py:class:`~earwigbot.commands.BaseCommand`'s
  120. :py:meth:`~earwigbot.commands.BaseCommand.__init__` method for the full list.
  121. The most common ones are :py:meth:`say(chan_or_user, msg)
  122. <earwigbot.irc.connection.IRCConnection.say>`, :py:meth:`reply(data, msg)
  123. <earwigbot.irc.connection.IRCConnection.reply>` (convenience function; sends
  124. a reply to the issuer of the command in the channel it was received),
  125. :py:meth:`action(chan_or_user, msg)
  126. <earwigbot.irc.connection.IRCConnection.action>`,
  127. :py:meth:`notice(chan_or_user, msg)
  128. <earwigbot.irc.connection.IRCConnection.notice>`, :py:meth:`join(chan)
  129. <earwigbot.irc.connection.IRCConnection.join>`, and
  130. :py:meth:`part(chan) <earwigbot.irc.connection.IRCConnection.part>`.
  131. Commands have access to :py:attr:`config.commands[command_name]` for config
  132. information, which is a node in :file:`config.yml` like every other attribute
  133. of :py:attr:`bot.config`. This can be used to store, for example, API keys or
  134. SQL connection info, so that these can be easily changed without modifying the
  135. command itself.
  136. It's important to name the command class :py:class:`Command` within the file,
  137. or else the bot might not recognize it as a command. The name of the file
  138. doesn't really matter and need not match the command's name, but this is
  139. recommended for readability.
  140. The bot has a wide selection of built-in commands and plugins to act as sample
  141. code and/or to give ideas. Start with test_, and then check out chanops_ and
  142. afc_status_ for some more complicated scripts.
  143. Custom bot tasks
  144. ----------------
  145. Custom tasks are subclasses of :py:class:`earwigbot.tasks.BaseTask` that
  146. override :py:class:`~earwigbot.tasks.BaseTask`'s
  147. :py:meth:`~earwigbot.tasks.BaseTask.run` (and optionally
  148. :py:meth:`~earwigbot.tasks.BaseTask.setup`) methods.
  149. :py:class:`~earwigbot.tasks.BaseTask`'s docstrings should explain what each
  150. attribute and method is for and what they should be overridden with, but these
  151. are the basics:
  152. - Class attribute :py:attr:`~earwigbot.tasks.BaseTask.name` is the name of the
  153. task. This must be specified.
  154. - Class attribute :py:attr:`~earwigbot.tasks.BaseTask.number` can be used to
  155. store an optional "task number", possibly for use in edit summaries (to be
  156. generated with :py:meth:`~earwigbot.tasks.BaseTask.make_summary`). For
  157. example, EarwigBot's :py:attr:`config.wiki["summary"]` is
  158. ``"([[WP:BOT|Bot]]; [[User:EarwigBot#Task $1|Task $1]]): $2"``, which the
  159. task class's :py:meth:`make_summary(comment)
  160. <earwigbot.tasks.BaseTask.make_summary>` method will take and replace
  161. ``$1`` with the task number and ``$2`` with the details of the edit.
  162. Additionally, :py:meth:`~earwigbot.tasks.BaseTask.shutoff_enabled` (which
  163. checks whether the bot has been told to stop on-wiki by checking the content
  164. of a particular page) can check a different page for each task using similar
  165. variables. EarwigBot's :py:attr:`config.wiki["shutoff"]["page"]` is
  166. ``"User:$1/Shutoff/Task $2"``; ``$1`` is substituted with the bot's username,
  167. and ``$2`` is substituted with the task number, so, e.g., task #14 checks the
  168. page ``[[User:EarwigBot/Shutoff/Task 14]].`` If the page's content does *not*
  169. match :py:attr:`config.wiki["shutoff"]["disabled"]` (``"run"`` by default),
  170. then shutoff is considered to be *enabled* and
  171. :py:meth:`~earwigbot.tasks.BaseTask.shutoff_enabled` will return ``True``,
  172. indicating the task should not run. If you don't intend to use either of
  173. these methods, feel free to leave this attribute blank.
  174. - Method :py:meth:`~earwigbot.tasks.BaseTask.setup` is called *once* with no
  175. arguments immediately after the task is first loaded. Does nothing by
  176. default; treat it like an :py:meth:`__init__` if you want
  177. (:py:meth:`~earwigbot.tasks.BaseTask.__init__` does things by default and a
  178. dedicated setup method is often easier than overriding
  179. :py:meth:`~earwigbot.tasks.BaseTask.__init__` and using :py:obj:`super`).
  180. - Method :py:meth:`~earwigbot.tasks.BaseTask.run` is called with any number of
  181. keyword arguments every time the task is executed (by
  182. :py:meth:`tasks.start(task_name, **kwargs)
  183. <earwigbot.managers.TaskManager.start>`, usually). This is where the bulk of
  184. the task's code goes. For interfacing with MediaWiki sites, read up on the
  185. :doc:`Wiki Toolset <toolset>`.
  186. Tasks have access to :py:attr:`config.tasks[task_name]` for config information,
  187. which is a node in :file:`config.yml` like every other attribute of
  188. :py:attr:`bot.config`. This can be used to store, for example, edit summaries
  189. or templates to append to user talk pages, so that these can be easily changed
  190. without modifying the task itself.
  191. It's important to name the task class :py:class:`Task` within the file, or else
  192. the bot might not recognize it as a task. The name of the file doesn't really
  193. matter and need not match the task's name, but this is recommended for
  194. readability.
  195. See the built-in wikiproject_tagger_ task for a relatively straightforward
  196. task, or the afc_statistics_ plugin for a more complicated one.
  197. .. rubric:: Footnotes
  198. .. [1] :py:class:`~earwigbot.irc.data.Data` objects are instances of
  199. :py:class:`earwigbot.irc.Data <earwigbot.irc.data.Data>` that contain
  200. information about a single message sent on IRC. Their useful attributes
  201. are :py:attr:`~earwigbot.irc.data.Data.chan` (channel the message was
  202. sent from, equal to :py:attr:`~earwigbot.irc.data.Data.nick` if it's a
  203. private message), :py:attr:`~earwigbot.irc.data.Data.nick` (nickname of
  204. the sender), :py:attr:`~earwigbot.irc.data.Data.ident` (ident_ of the
  205. sender), :py:attr:`~earwigbot.irc.data.Data.host` (hostname of the
  206. sender), :py:attr:`~earwigbot.irc.data.Data.msg` (text of the sent
  207. message), :py:attr:`~earwigbot.irc.data.Data.is_command` (boolean
  208. telling whether or not this message is a bot command, e.g., whether it
  209. is prefixed by ``!``), :py:attr:`~earwigbot.irc.data.Data.command` (if
  210. the message is a command, this is the name of the command used), and
  211. :py:attr:`~earwigbot.irc.data.Data.args` (if the message is a command,
  212. this is a list of the command arguments - for example, if issuing
  213. "``!part ##earwig Goodbye guys``",
  214. :py:attr:`~earwigbot.irc.data.Data.args` will equal
  215. ``["##earwig", "Goodbye", "guys"]``). Note that not all
  216. :py:class:`~earwigbot.irc.data.Data` objects will have all of these
  217. attributes: :py:class:`~earwigbot.irc.data.Data` objects generated by
  218. private messages will, but ones generated by joins will only have
  219. :py:attr:`~earwigbot.irc.data.Data.chan`,
  220. :py:attr:`~earwigbot.irc.data.Data.nick`,
  221. :py:attr:`~earwigbot.irc.data.Data.ident`,
  222. and :py:attr:`~earwigbot.irc.data.Data.host`.
  223. .. _help: https://github.com/earwig/earwigbot/blob/develop/earwigbot/commands/help.py
  224. .. _afc_status: https://github.com/earwig/earwigbot-plugins/blob/develop/commands/afc_status.py
  225. .. _chanops: https://github.com/earwig/earwigbot/blob/develop/earwigbot/commands/chanops.py
  226. .. _test: https://github.com/earwig/earwigbot/blob/develop/earwigbot/commands/test.py
  227. .. _wikiproject_tagger: https://github.com/earwig/earwigbot/blob/develop/earwigbot/tasks/wikiproject_tagger.py
  228. .. _afc_statistics: https://github.com/earwig/earwigbot-plugins/blob/develop/tasks/afc_statistics.py
  229. .. _ident: http://en.wikipedia.org/wiki/Ident