Package buildbot :: Package status :: Module words :: Class IrcStatusBot

Class IrcStatusBot

twisted.internet.protocol.BaseProtocol --+            
                                         |            
        twisted.internet.protocol.Protocol --+        
                                             |        
   twisted.protocols.basic._PauseableMixin --+        
                                             |        
          twisted.protocols.basic.LineReceiver --+    
                                                 |    
             twisted.words.protocols.irc.IRCClient --+
                                                     |
                                                    IrcStatusBot

I represent the buildbot to an IRC server.

Nested Classes
	contactClass

Instance Methods

__init__(self, nickname, password, channels, status, categories, notify_events, noticeOnChannel=False, showBlameList=False)

source code

msgOrNotice(self, dest, message)

source code

addContact(self, name, contact)

source code

getContact(self, name)

source code

deleteContact(self, contact)

source code

log(self, msg)

source code

privmsg(self, user, channel, message)
Called when I have a message from a user to me or a channel.

source code

action(self, user, channel, data)
Called when I see a user perform an ACTION on a channel.

source code

signedOn(self)
Called after sucessfully signing on to the server.

source code

joined(self, channel)
Called when I finish joining a channel.

source code

left(self, channel)
Called when I have left a channel.

source code

kickedFrom(self, channel, kicker, message)
Called when I am kicked from a channel.

source code

__provides__(...)
Special descriptor for class __provides__

Inherited from twisted.words.protocols.irc.IRCClient: __getstate__, alterCollidedNick, away, back, badMessage, bounce, connectionMade, created, ctcpMakeQuery, ctcpMakeReply, ctcpQuery, ctcpQuery_ACTION, ctcpQuery_CLIENTINFO, ctcpQuery_DCC, ctcpQuery_ERRMSG, ctcpQuery_FINGER, ctcpQuery_PING, ctcpQuery_SOURCE, ctcpQuery_TIME, ctcpQuery_USERINFO, ctcpQuery_VERSION, ctcpReply, ctcpReply_PING, ctcpUnknownQuery, ctcpUnknownReply, dataReceived, dccAcceptResume, dccDoAcceptResume, dccDoChat, dccDoResume, dccDoSend, dccResume, dccSend, dcc_ACCEPT, dcc_CHAT, dcc_RESUME, dcc_SEND, describe, getChannelModeParams, getUserModeParams, handleCommand, invite, irc_ERR_ERRONEUSNICKNAME, irc_ERR_NICKNAMEINUSE, irc_ERR_PASSWDMISMATCH, irc_JOIN, irc_KICK, irc_MODE, irc_NICK, irc_NOTICE, irc_PART, irc_PING, irc_PRIVMSG, irc_QUIT, irc_RPL_BOUNCE, irc_RPL_CREATED, irc_RPL_ENDOFMOTD, irc_RPL_ISUPPORT, irc_RPL_LUSERCHANNELS, irc_RPL_LUSERCLIENT, irc_RPL_LUSERME, irc_RPL_LUSEROP, irc_RPL_MOTD, irc_RPL_MOTDSTART, irc_RPL_MYINFO, irc_RPL_NOTOPIC, irc_RPL_TOPIC, irc_RPL_WELCOME, irc_RPL_YOURHOST, irc_TOPIC, irc_unknown, isupport, join, kick, leave, lineReceived, luserChannels, luserClient, luserMe, luserOp, me, mode, modeChanged, msg, myInfo, nickChanged, notice, noticed, part, ping, pong, quirkyMessage, quit, receivedMOTD, register, say, sendLine, setNick, topic, topicUpdated, userJoined, userKicked, userLeft, userQuit, userRenamed, whois, yourHost

Inherited from twisted.protocols.basic.LineReceiver: clearLineBuffer, lineLengthExceeded, rawDataReceived, setLineMode, setRawMode

Inherited from twisted.internet.protocol.Protocol: connectionLost

Inherited from twisted.internet.protocol.BaseProtocol: __providedBy__, makeConnection

Inherited from twisted.protocols.basic._PauseableMixin: pauseProducing, resumeProducing, stopProducing

Class Variables

__implemented__ = <implementedBy buildbot.status.words.IrcStat...

Inherited from twisted.words.protocols.irc.IRCClient: __pychecker__, dcc_destdir, dcc_sessions, delimiter, performLogin

Inherited from twisted.protocols.basic.LineReceiver: MAX_LENGTH, line_mode

Inherited from twisted.internet.protocol.BaseProtocol: connected, transport

Inherited from twisted.protocols.basic._PauseableMixin: paused

Instance Variables
Inherited from `twisted.words.protocols.irc.IRCClient`: `erroneousNickFallback`, `fingerReply`, `lineRate`, `motd`, `nickname`, `password`, `realname`, `sourceURL`, `supported`, `userinfo`, `username`, `versionEnv`, `versionName`, `versionNum`

Method Details

init(self, nickname, password, channels, status, categories, notify_events, noticeOnChannel=False, showBlameList=False)
(Constructor)

source code

Parameters:

nickname (string) - the nickname by which this bot should be known
password (string) - the password to use for identifying with Nickserv
channels (list of dictionaries) - the bot will maintain a presence in these channels
status (buildbot.status.builder.Status) - the build master's Status object, through which the bot retrieves all status information
noticeOnChannel (boolean) - Defaults to False. If True, error messages for bot commands will be sent to the channel as notices. Otherwise they are sent as a msg.

privmsg(self, user, channel, message)

source code

Called when I have a message from a user to me or a channel.

Overrides: twisted.words.protocols.irc.IRCClient.privmsg: (inherited documentation)

action(self, user, channel, data)

source code

Called when I see a user perform an ACTION on a channel.

Overrides: twisted.words.protocols.irc.IRCClient.action: (inherited documentation)

signedOn(self)

source code

Called after sucessfully signing on to the server.

Overrides: twisted.words.protocols.irc.IRCClient.signedOn: (inherited documentation)

joined(self, channel)

source code

Called when I finish joining a channel.

channel has the starting character ('#', '&', '!', or '+') intact.

Overrides: twisted.words.protocols.irc.IRCClient.joined: (inherited documentation)

left(self, channel)

source code

Called when I have left a channel.

channel has the starting character ('#', '&', '!', or '+') intact.

Overrides: twisted.words.protocols.irc.IRCClient.left: (inherited documentation)

kickedFrom(self, channel, kicker, message)

source code

Called when I am kicked from a channel.

Overrides: twisted.words.protocols.irc.IRCClient.kickedFrom: (inherited documentation)

provides(...)

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that
we can get declarations for objects without instance-specific
interfaces a bit quicker.

For example:

  >>> from zope.interface import Interface
  >>> class IFooFactory(Interface):
  ...     pass
  >>> class IFoo(Interface):
  ...     pass
  >>> class C(object):
  ...     implements(IFoo)
  ...     classProvides(IFooFactory)
  >>> [i.getName() for i in C.__provides__]
  ['IFooFactory']

  >>> [i.getName() for i in C().__provides__]
  ['IFoo']

Overrides: twisted.protocols.basic._PauseableMixin.__provides__

Class Variable Details

implemented

Value:

<implementedBy buildbot.status.words.IrcStatusBot>

Class IrcStatusBot

__init__(self, nickname, password, channels, status, categories, notify_events, noticeOnChannel=False, showBlameList=False) (Constructor)

privmsg(self, user, channel, message)

action(self, user, channel, data)

signedOn(self)

joined(self, channel)

left(self, channel)

kickedFrom(self, channel, kicker, message)

__provides__(...)

__implemented__

init(self, nickname, password, channels, status, categories, notify_events, noticeOnChannel=False, showBlameList=False)
(Constructor)

provides(...)

implemented