twisted.words.test.test_irc_service.MocksyIRCUser

class documentation

class MocksyIRCUser(IRCUser): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method sendMessage Send a line formatted as an IRC message.
Instance Variable mockedCodes Undocumented
Instance Variable realm Undocumented

Inherited from IRCUser:

Method connectionLost Called when the connection is shut down.
Method connectionMade Called when a connection is made.
Method groupMetaUpdate Callback notifying this user that the metadata for the given group has changed.
Method irc_JOIN Join message
Method irc_LIST List query
Method irc_MODE User mode message
Method irc_NAMES Names message
Method irc_NICK Nick message -- Set your nickname.
Method irc_NICKSERV_PRIVMSG Send a (private) message.
Method irc_OPER Oper message
Method irc_PART Part message
Method irc_PASS Password message -- Register a password.
Method irc_PING Ping message
Method irc_PRIVMSG Send a (private) message.
Method irc_QUIT Quit
Method irc_TOPIC Topic message
Method irc_USER User message -- Set your realname.
Method irc_USERHOST Userhost message
Method irc_WHO Who query
Method irc_WHOIS Whois query
Method list Send a group of LIST response lines
Method logInAs Undocumented
Method receive Callback notifying this user of the given message sent by the given user.
Method userJoined Callback notifying this user that the given user has joined the given group.
Method userLeft Callback notifying this user that the given user has left the given group for the given reason.
Class Variable encoding Undocumented
Class Variable groups Undocumented
Instance Variable avatar Undocumented
Instance Variable hostname Undocumented
Instance Variable logout Undocumented
Instance Variable name A short string, unique among users. This will be set by the IChatService at login time.
Instance Variable nickname Undocumented
Instance Variable password Undocumented
Instance Variable realname Undocumented
Method _cbLogin Undocumented
Method _channelMode Undocumented
Method _channelWho Undocumented
Method _ebLogin Undocumented
Method _getTopic Undocumented
Method _sendTopic Send the topic of the given group to this user, if it has one.
Method _setTopic Undocumented
Method _userMode Undocumented
Method _userWho Undocumented
Class Variable _motdMessages Undocumented
Class Variable _welcomeMessages Undocumented

Inherited from IRC (via IRCUser):

Method action Send an action to a channel or user.
Method channelMode Send information about the mode of a channel.
Method dataReceived This hack is to support mIRC, which sends LF only, even though the RFC says CRLF. (Also, the flexibility of LineReceiver to turn "line mode" on and off was not required.)
Method handleCommand Determine the function to call for the given command and call it with the given arguments.
Method irc_unknown Called by handleCommand on a command that doesn't have a defined handler. Subclasses should override this method.
Method join Send a join message.
Method names Send the names of a channel's participants to a user.
Method notice Send a "notice" to a channel or user.
Method part Send a part message.
Method privmsg Send a message to a channel or user
Method sendCommand Send to the remote peer a line formatted as an IRC message.
Method sendLine Undocumented
Method topic Send the topic to a user.
Method topicAuthor Send the author of and time at which a topic was set for the given channel.
Method who Send a list of users participating in a channel.
Method whois Send information about the state of a particular user.
Instance Variable buffer Undocumented
Instance Variable channels Undocumented
Method _escapeTagValue Escape the given tag value according to escaping rules in IRCv3.
Method _stringTags Converts a tag dictionary to a string.
Method _validateTags Checks the tag dict for errors and raises ValueError if an error is found.

Inherited from Protocol (via IRCUser, IRC):

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable factory Undocumented

Inherited from BaseProtocol (via IRCUser, IRC, Protocol):

Method makeConnection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented
def __init__(self): (source)

Undocumented

def sendMessage(self, code, *_, **__): (source)
overrides twisted.words.service.IRCUser.sendMessage

Send a line formatted as an IRC message.

First argument is the command, all subsequent arguments are parameters to that command. If a prefix is desired, it may be specified with the keyword argument 'prefix'.

The sendCommand method is generally preferred over this one. Notably, this method does not support sending message tags, while the sendCommand method does.

mockedCodes: list = (source)

Undocumented

realm = (source)
overrides twisted.words.service.IRCUser.realm

Undocumented