csbot.core module

exception csbot.core.PluginError

Bases: Exception

class csbot.core.Bot(config=None, loop=None)

Bases: csbot.plugin.SpecialPlugin, csbot.irc.IRCClient

CONFIG_DEFAULTS = {'auth_method': 'pass', 'lineRate': '1', 'plugins': 'example', 'username': 'csyorkbot', 'command_prefix': '!', 'channels': '#cs-york-dev', 'bind_addr': None, 'use_notice': True, 'realname': 'cs-york bot', 'irc_port': '6667', 'password': None, 'nickname': 'csyorkbot', 'irc_host': 'irc.freenode.net', 'sourceURL': 'http://github.com/csyork/csbot/'}

Default configuration values

CONFIG_ENVVARS = {'password': ['IRC_PASS']}

Environment variable fallbacks

available_plugins = {'logger': <class 'csbot.plugins.logger.Logger'>, 'xkcd': <class 'csbot.plugins.xkcd.xkcd'>, 'youtube': <class 'csbot.plugins.youtube.Youtube'>, 'linkinfo': <class 'csbot.plugins.linkinfo.LinkInfo'>, 'topic': <class 'csbot.plugins.topic.Topic'>, 'usertrack': <class 'csbot.plugins.usertrack.UserTrack'>, 'imgur': <class 'csbot.plugins.imgur.Imgur'>, 'helix': <class 'csbot.plugins.helix.Helix'>, 'last': <class 'csbot.plugins.last.Last'>, 'csyork': <class 'csbot.plugins.csyork.CSYork'>, 'termdates': <class 'csbot.plugins.termdates.TermDates'>, 'whois': <class 'csbot.plugins.whois.Whois'>, 'cron': <class 'csbot.plugins.cron.Cron'>, 'mongodb': <class 'csbot.plugins.mongodb.MongoDB'>, 'auth': <class 'csbot.plugins.auth.Auth'>, 'calc': <class 'csbot.plugins.calc.Calc'>, 'hoogle': <class 'csbot.plugins.hoogle.Hoogle'>}

Dictionary containing available plugins for loading, using straight.plugin to discover plugin classes under a namespace.

bot_setup()

Load plugins defined in configuration and run setup methods.

bot_teardown()

Run plugin teardown methods.

post_event(event)

register_command(cmd, metadata, f, tag=None)

unregister_command(cmd, tag=None)

unregister_commands(tag)

signedOn(event)

privmsg(event)

Handle commands inside PRIVMSGs.

fire_command(event)

Dispatch a command event to its callback.

show_commands(e)

show_plugins(e)

emit_new(event_type, data=None)

Shorthand for firing a new event.

emit(event)

Shorthand for firing an existing event.

connection_made()

connection_lost(exc)

send_line(line)

line_received(line)

on_welcome()

on_joined(channel)

on_left(channel)

on_privmsg(user, channel, message)

on_notice(user, channel, message)

on_action(user, channel, message)

on_user_joined(user, channel)

on_user_left(user, channel, message)

on_user_quit(user, message)

on_user_renamed(oldnick, newnick)

on_topic_changed(user, channel, topic)

irc_RPL_NAMREPLY(msg)

irc_RPL_ENDOFNAMES(msg)

on_names(channel, names, raw_names)

Called when the NAMES list for a channel has been received.

on_capabilities_available(capabilities)

identify(target)

Find the account for a user or all users in a channel.

irc_354(msg)

Handle “formatted WHO” responses.

on_user_identified(user, account)

irc_ACCOUNT(msg)

Account change notification from account-notify capability.

PLUGIN_DEPENDS = set()

irc_JOIN(msg)

Re-implement JOIN handler to account for extended-join info.

plugin_cmds = [('help', {'help': 'help [command]: show help for command, or show available commands'}, <function Bot.show_commands>), ('plugins', {}, <function Bot.show_plugins>)]

plugin_hooks = defaultdict(<class 'list'>, {'core.self.connected': [<function Bot.signedOn>], 'core.command': [<function Bot.fire_command>], 'core.message.privmsg': [<function Bot.privmsg>]})

plugin_integrations = []

plugin_provide = []

reply(to, message)

Reply to a nick/channel.

This is not implemented because it should be replaced in the constructor with a reference to a real method, e.g. self.reply = self.msg.