supybot.irclib

Irc

It is usually the irc object given to plugin commands.

class supybot.irclib.Irc(network, callbacks=[])

Bases: supybot.irclib.IrcCommandDispatcher, supybot.log.Firewalled

The base class for an IRC connection.

Handles PING commands already.

zombie

Whether or not this object represents a living IRC connection.

Type:bool

network

The name of the network this object is connected to.

Type:str

startedAt

Type:float

addCallback(callback)

Adds a callback to the callbacks list.

Parameters:callback (supybot.irclib.IrcCallback) – A callback object

capUpkeep(msg)

Called after getting a CAP ACK/NAK to check it’s consistent with what was requested, and to end the cap negotiation when we received all the ACK/NAKs we were waiting for.

msg is the message that triggered this call.

die(*args, **kwargs)

Makes the Irc object promise to die – but it won’t die (of its own volition) until all its queues are clear. Isn’t that cool?

dispatchCommand(command, args=None)

Given a string ‘command’, dispatches to doCommand.

do002(msg)

Logs the ircd version.

doError(msg)

Handles ERROR messages.

doNick(msg)

Handles NICK messages.

doPing(msg)

Handles PING messages.

doPong(msg)

Handles PONG messages.

feedMsg(*args, **kwargs)

Called by the IrcDriver; feeds a message received.

tag=False is used when simulating echo messages, to skip adding received* tags.

getCallback(name)

Gets a given callback by name.

isChannel(s)

Helper function to check whether a given string is a channel on the network this Irc object is connected to.

monitor(targets)

Increment a counter of how many callbacks monitor each target; and send a MONITOR + to the server if the target is not yet monitored.

queueMsg(msg)

Queues a message to be sent to the server.

removeCallback(name)

Removes a callback from the callback list.

reset()

Resets the Irc object. Called when the driver reconnects.

sendMsg(msg)

Queues a message to be sent to the server immediately

takeMsg(*args, **kwargs)

Called by the IrcDriver; takes a message to be sent.

unmonitor(targets)

Decrements a counter of how many callbacks monitor each target; and send a MONITOR - to the server if the counter drops to 0.

IrcState

Used mainly as the state attribute of supybot.irclib.Irc objects.

class supybot.irclib.IrcState(history=None, supported=None, nicksToHostmasks=None, channels=None, capabilities_req=None, capabilities_ack=None, capabilities_nak=None, capabilities_ls=None)

Bases: supybot.irclib.IrcCommandDispatcher, supybot.log.Firewalled

Maintains state of the Irc connection. Should also become smarter.

addMsg(*args, **kwargs)

Updates the state based on the irc object and the message.

dispatchCommand(command, args=None)

Given a string ‘command’, dispatches to doCommand.

do004(irc, msg)

Handles parsing the 004 reply

Supported user and channel modes are cached

getTopic(channel)

Returns the topic for a given channel.

nickToHostmask(nick)

Returns the hostmask for a given nick.

reset()

Resets the state to normal, unconnected state.

ChannelState

Used mainly as the channels[‘#chan’] attribute of supybot.irclib.Irc objects.

class supybot.irclib.ChannelState

Bases: supybot.utils.python.Object

addUser(user)

Adds a given user to the ChannelState. Power prefixes are handled.

removeUser(user)

Removes a given user from the channel.

replaceUser(oldNick, newNick)

Changes the user oldNick to newNick; used for NICK changes.

Other classes

class supybot.irclib.Batch(type, arguments, messages)

Bases: tuple

arguments

Alias for field number 1

messages

Alias for field number 2

type

Alias for field number 0

class supybot.irclib.IrcCallback(*args, **kwargs)

Bases: supybot.irclib.IrcCommandDispatcher, supybot.log.Firewalled

Base class for standard callbacks.

Callbacks derived from this class should have methods of the form “doCommand” – doPrivmsg, doNick, do433, etc. These will be called on matching messages.

callPrecedence(*args, **kwargs)

Returns a pair of (callbacks to call before me, callbacks to call after me)

die(*args, **kwargs)

Makes the callback die. Called when the parent Irc object dies.

inFilter(*args, **kwargs)

Used for filtering/modifying messages as they’re entering.

ircmsgs.IrcMsg objects are immutable, so this method is expected to return another ircmsgs.IrcMsg object. Obviously the same IrcMsg can be returned.

name(*args, **kwargs)

Returns the name of the callback.

outFilter(*args, **kwargs)

Used for filtering/modifying messages as they’re leaving.

As with inFilter, an IrcMsg is returned.

postTransition(*args, **kwargs)

Called when the state of the IRC connection changes.

msg is the message that triggered the transition, if any.

reset(*args, **kwargs)

Resets the callback. Called when reconnecting to the server.

class supybot.irclib.IrcCommandDispatcher

Bases: object

Base class for classes that must dispatch on a command.

dispatchCommand(command, args=None)

Given a string ‘command’, dispatches to doCommand.

class supybot.irclib.IrcMsgQueue(iterable=())

Bases: object

Class for a queue of IrcMsgs. Eventually, it should be smart.

Probably smarter than it is now, though it’s gotten quite a bit smarter than it originally was. A method to “score” methods, and a heapq to maintain a priority queue of the messages would be the ideal way to do intelligent queuing.

As it stands, however, we simply keep track of ‘high priority’ messages, ‘low priority’ messages, and normal messages, and just make sure to return the ‘high priority’ ones before the normal ones before the ‘low priority’ ones.

dequeue()

Dequeues a given message.

enqueue(msg)

Enqueues a given message.

reset()

Clears the queue.

class supybot.irclib.IrcStateFsm

Bases: object

Finite State Machine keeping track of what part of the connection initialization we are in.

class States

Bases: enum.Enum

An enumeration.

CONNECTED = 70

Normal state of the connections

CONNECTED_SASL = 80

Doing SASL authentication in the middle of a connection.

INIT_CAP_NEGOTIATION = 20

Sent CAP LS, did not send CAP END yet

INIT_MOTD = 60

Waiting for end of MOTD

INIT_SASL = 30

In an AUTHENTICATE session

INIT_WAITING_MOTD = 50

Waiting for start of MOTD

UNINITIALIZED = 10

Nothing received yet (except server notices)

on_cap_end(irc, msg)

When we send CAP END

on_end_motd(irc, msg)

On 376 (RPL_ENDOFMOTD) or 422 (ERR_NOMOTD)

on_init_messages_sent(irc)

As soon as USER/NICK/CAP LS are sent

on_sasl_auth_finished(irc, msg)

When sasl auth either succeeded or failed.

on_sasl_cap(irc, msg)

Whenever we see the ‘sasl’ capability in a CAP LS response

on_start_motd(irc, msg)

On 375 (RPL_MOTDSTART)