Python: module irssi

irssi | index /usr/local/share/irssi/scripts/irssi.py

Modules
`` |  |
_irssi | sys |  |

Classes
`` |  | __builtin__.object Ban Command Ignore IrssiBase Dcc DccChat DccGet DccSend IrssiChatBase Chatnet Connect IrcConnect Nick Server IrcServer WindowItem Channel IrcChannel Query Log Logitem MainWindow Netsplit NetsplitChannel NetsplitServer Notifylist Process Rawlog Reconnect Script StatusbarItem TextDest Theme Window
class Ban(__builtin__.object)
`` | `PyBan objects`
| Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` ban = <attribute 'ban' of 'irssi.Ban' objects> `The ban` setby = <attribute 'setby' of 'irssi.Ban' objects> `Nick of who set the ban` time = <attribute 'time' of 'irssi.Ban' objects> `Timestamp when ban was set`
class Channel(WindowItem)
`` | `PyChannel objects`
| Method resolution order: Channel WindowItem IrssiChatBase IrssiBase __builtin__.object Methods defined here: nick_find(...) `nick_find(nick) -> Nick object or None Find nick from nicklist.` nick_insert_obj(...) `nick_insert(nick) -> None Insert nick object into nicklist.` nick_remove(...) `nick_remove(nick) -> None Remove nick from nicklist.` nicks(...) `nicks() -> list of Nick objects Return a list of nicks in the channel.` nicks_find_mask(...) `nicks_find_mask(mask) -> Nick object or None Find nick mask from nicklist, wildcards allowed.` Data and other attributes defined here: chanop = <attribute 'chanop' of 'irssi.Channel' objects> `You are channel operator` joined = <attribute 'joined' of 'irssi.Channel' objects> `JOIN event for this channel has been received` key = <attribute 'key' of 'irssi.Channel' objects> `Channel key (password)` kicked = <attribute 'kicked' of 'irssi.Channel' objects> `You were just kicked out of the channel (for 'channel destroyed' event)` left = <attribute 'left' of 'irssi.Channel' objects> `You just left the channel (for 'channel destroyed' event)` limit = <attribute 'limit' of 'irssi.Channel' objects> `Max. users in channel (+l mode)` mode = <attribute 'mode' of 'irssi.Channel' objects> `Channel mode` names_got = <attribute 'names_got' of 'irssi.Channel' objects> `/NAMES list has been received` no_modes = <attribute 'no_modes' of 'irssi.Channel' objects> `Channel is modeless` synced = <attribute 'synced' of 'irssi.Channel' objects> `Channel is fully synchronized` topic = <attribute 'topic' of 'irssi.Channel' objects> `Channel topic` topic_by = <attribute 'topic_by' of 'irssi.Channel' objects> `Nick who set the topic` topic_time = <attribute 'topic_time' of 'irssi.Channel' objects> `Timestamp when the topic was set` wholist = <attribute 'wholist' of 'irssi.Channel' objects> `/WHO list has been received` Methods inherited from WindowItem: activity(...) `activity(data_level, hilight_color) -> None` change_server(...) `change_server(server) -> None Change server for window item` command(...) `command(cmd) -> None Send command to window item` destroy(...) `destroy() -> None Destroy channel or query` get_dcc(...) `get_dcc() -> DccChat object or None If item is a query of a =nick, return DCC chat record of nick` is_active(...) `is_active() -> bool Returns true if window item is active` printformat(...) `for Server objects: printformat(target, level, format, ...) -> None For all else: printformat(level, format, ...) -> None` prnt(...) `prnt(str, level) -> None Print to window item` set_active(...) `set_active() -> None Set window item active` window(...) `window() -> Window object or None Return parent window for window item` Data and other attributes inherited from WindowItem: createtime = <attribute 'createtime' of 'irssi.WindowItem' objects> `Time the witem was created` data_level = <attribute 'data_level' of 'irssi.WindowItem' objects> `0=no new data, 1=text, 2=msg, 3=highlighted text` hilight_color = <attribute 'hilight_color' of 'irssi.WindowItem' objects> `Color of the last highlighted text` name = <attribute 'name' of 'irssi.WindowItem' objects> `Name of the item` server = <attribute 'server' of 'irssi.WindowItem' objects> `Active name for item` Data and other attributes inherited from IrssiChatBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` chat_type = <attribute 'chat_type' of 'irssi.IrssiChatBase' objects> `Chat name (str)` chat_type_id = <attribute 'chat_type_id' of 'irssi.IrssiChatBase' objects> `Chat Type id (int)` Data and other attributes inherited from IrssiBase: type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class Chatnet(IrssiChatBase)
`` | `PyChatnet objects`
| Method resolution order: Chatnet IrssiChatBase IrssiBase __builtin__.object Data and other attributes defined here: autosendcmd = <attribute 'autosendcmd' of 'irssi.Chatnet' objects> `command to send after connecting to this network` name = <attribute 'name' of 'irssi.Chatnet' objects> `name of chat network` nick = <attribute 'nick' of 'irssi.Chatnet' objects> `if not empty, nick preferred in this network` own_host = <attribute 'own_host' of 'irssi.Chatnet' objects> `address to use when connecting to this network` realname = <attribute 'realname' of 'irssi.Chatnet' objects> `if not empty, realname preferred in this network` username = <attribute 'username' of 'irssi.Chatnet' objects> `if not empty, username preferred in this network` Data and other attributes inherited from IrssiChatBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` chat_type = <attribute 'chat_type' of 'irssi.IrssiChatBase' objects> `Chat name (str)` chat_type_id = <attribute 'chat_type_id' of 'irssi.IrssiChatBase' objects> `Chat Type id (int)` Data and other attributes inherited from IrssiBase: type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class Command(__builtin__.object)
`` | `PyCommand objects`
| Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` category = <attribute 'category' of 'irssi.Command' objects> `Category` cmd = <attribute 'cmd' of 'irssi.Command' objects> `Command name`
class Connect(IrssiChatBase)
`` | `PyConnect objects`
| Method resolution order: Connect IrssiChatBase IrssiBase __builtin__.object Data and other attributes defined here: address = <attribute 'address' of 'irssi.Connect' objects> `Address where we connected (irc.blah.org)` chatnet = <attribute 'chatnet' of 'irssi.Connect' objects> `Chat network` password = <attribute 'password' of 'irssi.Connect' objects> `Password we used in connection.` port = <attribute 'port' of 'irssi.Connect' objects> `Port where we're connected` realname = <attribute 'realname' of 'irssi.Connect' objects> `Real name` username = <attribute 'username' of 'irssi.Connect' objects> `User name` wanted_nick = <attribute 'wanted_nick' of 'irssi.Connect' objects> `Nick which we would prefer to use` Data and other attributes inherited from IrssiChatBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` chat_type = <attribute 'chat_type' of 'irssi.IrssiChatBase' objects> `Chat name (str)` chat_type_id = <attribute 'chat_type_id' of 'irssi.IrssiChatBase' objects> `Chat Type id (int)` Data and other attributes inherited from IrssiBase: type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class Dcc(IrssiBase)
`` | `PyDcc objects`
| Method resolution order: Dcc IrssiBase __builtin__.object Methods defined here: close(...) `close() -> None Close and destroy DCC connection.` destroy(...) `destroy() -> None Destroy DCC connection` reject(...) `reject() -> None ?` Data and other attributes defined here: addr = <attribute 'addr' of 'irssi.Dcc' objects> `Other side's IP address.` arg = <attribute 'arg' of 'irssi.Dcc' objects> `Given argument .. file name usually` chat = <attribute 'chat' of 'irssi.Dcc' objects> `Dcc chat record if the request came through DCC chat` created = <attribute 'created' of 'irssi.Dcc' objects> `Time stamp when the DCC record was created` mynick = <attribute 'mynick' of 'irssi.Dcc' objects> `Our nick to use in DCC chat.` nick = <attribute 'nick' of 'irssi.Dcc' objects> `Other side's nick name.` orig_type = <attribute 'orig_type' of 'irssi.Dcc' objects> `Original DCC type that was sent to us - same as type except GET and SEND are swapped` port = <attribute 'port' of 'irssi.Dcc' objects> `Port we're connecting in.` server = <attribute 'server' of 'irssi.Dcc' objects> `Server record where the DCC was initiated.` servertag = <attribute 'servertag' of 'irssi.Dcc' objects> `Tag of the server where the DCC was initiated.` starttime = <attribute 'starttime' of 'irssi.Dcc' objects> `Unix time stamp when the DCC transfer was started` target = <attribute 'target' of 'irssi.Dcc' objects> `Who the request was sent to - your nick, channel or empty if you sent the request` transfd = <attribute 'transfd' of 'irssi.Dcc' objects> `Bytes transferred` Data and other attributes inherited from IrssiBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class DccChat(Dcc)
`` | `PyDccChat objects`
| Method resolution order: DccChat Dcc IrssiBase __builtin__.object Methods defined here: chat_send(...) `chat_send(data) -> None Send data to a dcc chat session.` Data and other attributes defined here: connection_lost = <attribute 'connection_lost' of 'irssi.DccChat' objects> `Other side closed connection` id = <attribute 'id' of 'irssi.DccChat' objects> `Unique identifier - usually same as nick` mirc_ctcp = <attribute 'mirc_ctcp' of 'irssi.DccChat' objects> `Send CTCPs without the CTCP_MESSAGE prefix` Methods inherited from Dcc: close(...) `close() -> None Close and destroy DCC connection.` destroy(...) `destroy() -> None Destroy DCC connection` reject(...) `reject() -> None ?` Data and other attributes inherited from Dcc: addr = <attribute 'addr' of 'irssi.Dcc' objects> `Other side's IP address.` arg = <attribute 'arg' of 'irssi.Dcc' objects> `Given argument .. file name usually` chat = <attribute 'chat' of 'irssi.Dcc' objects> `Dcc chat record if the request came through DCC chat` created = <attribute 'created' of 'irssi.Dcc' objects> `Time stamp when the DCC record was created` mynick = <attribute 'mynick' of 'irssi.Dcc' objects> `Our nick to use in DCC chat.` nick = <attribute 'nick' of 'irssi.Dcc' objects> `Other side's nick name.` orig_type = <attribute 'orig_type' of 'irssi.Dcc' objects> `Original DCC type that was sent to us - same as type except GET and SEND are swapped` port = <attribute 'port' of 'irssi.Dcc' objects> `Port we're connecting in.` server = <attribute 'server' of 'irssi.Dcc' objects> `Server record where the DCC was initiated.` servertag = <attribute 'servertag' of 'irssi.Dcc' objects> `Tag of the server where the DCC was initiated.` starttime = <attribute 'starttime' of 'irssi.Dcc' objects> `Unix time stamp when the DCC transfer was started` target = <attribute 'target' of 'irssi.Dcc' objects> `Who the request was sent to - your nick, channel or empty if you sent the request` transfd = <attribute 'transfd' of 'irssi.Dcc' objects> `Bytes transferred` Data and other attributes inherited from IrssiBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class DccGet(Dcc)
`` | `PyDccGet objects`
| Method resolution order: DccGet Dcc IrssiBase __builtin__.object Data and other attributes defined here: file = <attribute 'file' of 'irssi.DccGet' objects> `The real file name which we use.` file_quoted = <attribute 'file_quoted' of 'irssi.DccGet' objects> `true if file name was received quoted ("file name")` get_type = <attribute 'get_type' of 'irssi.DccGet' objects> `What to do if file exists? 0=default, 1=rename, 2=overwrite, 3=resume` size = <attribute 'size' of 'irssi.DccGet' objects> `File size` skipped = <attribute 'skipped' of 'irssi.DccGet' objects> `Bytes skipped from start (resuming file)` Methods inherited from Dcc: close(...) `close() -> None Close and destroy DCC connection.` destroy(...) `destroy() -> None Destroy DCC connection` reject(...) `reject() -> None ?` Data and other attributes inherited from Dcc: addr = <attribute 'addr' of 'irssi.Dcc' objects> `Other side's IP address.` arg = <attribute 'arg' of 'irssi.Dcc' objects> `Given argument .. file name usually` chat = <attribute 'chat' of 'irssi.Dcc' objects> `Dcc chat record if the request came through DCC chat` created = <attribute 'created' of 'irssi.Dcc' objects> `Time stamp when the DCC record was created` mynick = <attribute 'mynick' of 'irssi.Dcc' objects> `Our nick to use in DCC chat.` nick = <attribute 'nick' of 'irssi.Dcc' objects> `Other side's nick name.` orig_type = <attribute 'orig_type' of 'irssi.Dcc' objects> `Original DCC type that was sent to us - same as type except GET and SEND are swapped` port = <attribute 'port' of 'irssi.Dcc' objects> `Port we're connecting in.` server = <attribute 'server' of 'irssi.Dcc' objects> `Server record where the DCC was initiated.` servertag = <attribute 'servertag' of 'irssi.Dcc' objects> `Tag of the server where the DCC was initiated.` starttime = <attribute 'starttime' of 'irssi.Dcc' objects> `Unix time stamp when the DCC transfer was started` target = <attribute 'target' of 'irssi.Dcc' objects> `Who the request was sent to - your nick, channel or empty if you sent the request` transfd = <attribute 'transfd' of 'irssi.Dcc' objects> `Bytes transferred` Data and other attributes inherited from IrssiBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class DccSend(Dcc)
`` | `PyDccSend objects`
| Method resolution order: DccSend Dcc IrssiBase __builtin__.object Data and other attributes defined here: file_quoted = <attribute 'file_quoted' of 'irssi.DccSend' objects> `True if file name was received quoted ("file name")` gotalldata = <attribute 'gotalldata' of 'irssi.DccSend' objects> `Got all acks from the other end` size = <attribute 'size' of 'irssi.DccSend' objects> `File size` skipped = <attribute 'skipped' of 'irssi.DccSend' objects> `Bytes skipped from start (resuming file)` waitforend = <attribute 'waitforend' of 'irssi.DccSend' objects> `File is sent, just wait for the replies from the other side` Methods inherited from Dcc: close(...) `close() -> None Close and destroy DCC connection.` destroy(...) `destroy() -> None Destroy DCC connection` reject(...) `reject() -> None ?` Data and other attributes inherited from Dcc: addr = <attribute 'addr' of 'irssi.Dcc' objects> `Other side's IP address.` arg = <attribute 'arg' of 'irssi.Dcc' objects> `Given argument .. file name usually` chat = <attribute 'chat' of 'irssi.Dcc' objects> `Dcc chat record if the request came through DCC chat` created = <attribute 'created' of 'irssi.Dcc' objects> `Time stamp when the DCC record was created` mynick = <attribute 'mynick' of 'irssi.Dcc' objects> `Our nick to use in DCC chat.` nick = <attribute 'nick' of 'irssi.Dcc' objects> `Other side's nick name.` orig_type = <attribute 'orig_type' of 'irssi.Dcc' objects> `Original DCC type that was sent to us - same as type except GET and SEND are swapped` port = <attribute 'port' of 'irssi.Dcc' objects> `Port we're connecting in.` server = <attribute 'server' of 'irssi.Dcc' objects> `Server record where the DCC was initiated.` servertag = <attribute 'servertag' of 'irssi.Dcc' objects> `Tag of the server where the DCC was initiated.` starttime = <attribute 'starttime' of 'irssi.Dcc' objects> `Unix time stamp when the DCC transfer was started` target = <attribute 'target' of 'irssi.Dcc' objects> `Who the request was sent to - your nick, channel or empty if you sent the request` transfd = <attribute 'transfd' of 'irssi.Dcc' objects> `Bytes transferred` Data and other attributes inherited from IrssiBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class Ignore(__builtin__.object)
`` | `PyIgnore objects`
| Methods defined here: add_rec(...) `add_rec() -> None Add ignore record` channels(...) `channels() -> list of str Ignore only in channels (list of names)` update_rec(...) `update_rec() -> None Update ignore record in configuration` Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` exception = <attribute 'exception' of 'irssi.Ignore' objects> `This is an exception ignore` fullword = <attribute 'fullword' of 'irssi.Ignore' objects> `Pattern matches only full words` level = <attribute 'level' of 'irssi.Ignore' objects> `Ignore level` mask = <attribute 'mask' of 'irssi.Ignore' objects> `Ignore mask` pattern = <attribute 'pattern' of 'irssi.Ignore' objects> `Ignore text patern` regexp = <attribute 'regexp' of 'irssi.Ignore' objects> `Regexp pattern matching` replies = <attribute 'replies' of 'irssi.Ignore' objects> `Ignore replies to nick in channel` servertag = <attribute 'servertag' of 'irssi.Ignore' objects> `Ignore only in server`
class IrcChannel(Channel)
`` | `PyIrcChannel objects`
| Method resolution order: IrcChannel Channel WindowItem IrssiChatBase IrssiBase __builtin__.object Methods defined here: ban_get_mask(...) `ban_get_mask(nick, ban_type=0) -> str Get ban mask for 'nick'.` banlist_add(...) `banlist_add(ban, nick, time) -> Ban object or None Add a new ban to channel. Return None if duplicate.` banlist_remove(...) `banlist_remove(ban, nick) -> None Remove a new ban from channel.` bans(...) `bans() -> list of Ban objects Returns a list of bans in the channel.` Methods inherited from Channel: nick_find(...) `nick_find(nick) -> Nick object or None Find nick from nicklist.` nick_insert_obj(...) `nick_insert(nick) -> None Insert nick object into nicklist.` nick_remove(...) `nick_remove(nick) -> None Remove nick from nicklist.` nicks(...) `nicks() -> list of Nick objects Return a list of nicks in the channel.` nicks_find_mask(...) `nicks_find_mask(mask) -> Nick object or None Find nick mask from nicklist, wildcards allowed.` Data and other attributes inherited from Channel: chanop = <attribute 'chanop' of 'irssi.Channel' objects> `You are channel operator` joined = <attribute 'joined' of 'irssi.Channel' objects> `JOIN event for this channel has been received` key = <attribute 'key' of 'irssi.Channel' objects> `Channel key (password)` kicked = <attribute 'kicked' of 'irssi.Channel' objects> `You were just kicked out of the channel (for 'channel destroyed' event)` left = <attribute 'left' of 'irssi.Channel' objects> `You just left the channel (for 'channel destroyed' event)` limit = <attribute 'limit' of 'irssi.Channel' objects> `Max. users in channel (+l mode)` mode = <attribute 'mode' of 'irssi.Channel' objects> `Channel mode` names_got = <attribute 'names_got' of 'irssi.Channel' objects> `/NAMES list has been received` no_modes = <attribute 'no_modes' of 'irssi.Channel' objects> `Channel is modeless` synced = <attribute 'synced' of 'irssi.Channel' objects> `Channel is fully synchronized` topic = <attribute 'topic' of 'irssi.Channel' objects> `Channel topic` topic_by = <attribute 'topic_by' of 'irssi.Channel' objects> `Nick who set the topic` topic_time = <attribute 'topic_time' of 'irssi.Channel' objects> `Timestamp when the topic was set` wholist = <attribute 'wholist' of 'irssi.Channel' objects> `/WHO list has been received` Methods inherited from WindowItem: activity(...) `activity(data_level, hilight_color) -> None` change_server(...) `change_server(server) -> None Change server for window item` command(...) `command(cmd) -> None Send command to window item` destroy(...) `destroy() -> None Destroy channel or query` get_dcc(...) `get_dcc() -> DccChat object or None If item is a query of a =nick, return DCC chat record of nick` is_active(...) `is_active() -> bool Returns true if window item is active` printformat(...) `for Server objects: printformat(target, level, format, ...) -> None For all else: printformat(level, format, ...) -> None` prnt(...) `prnt(str, level) -> None Print to window item` set_active(...) `set_active() -> None Set window item active` window(...) `window() -> Window object or None Return parent window for window item` Data and other attributes inherited from WindowItem: createtime = <attribute 'createtime' of 'irssi.WindowItem' objects> `Time the witem was created` data_level = <attribute 'data_level' of 'irssi.WindowItem' objects> `0=no new data, 1=text, 2=msg, 3=highlighted text` hilight_color = <attribute 'hilight_color' of 'irssi.WindowItem' objects> `Color of the last highlighted text` name = <attribute 'name' of 'irssi.WindowItem' objects> `Name of the item` server = <attribute 'server' of 'irssi.WindowItem' objects> `Active name for item` Data and other attributes inherited from IrssiChatBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` chat_type = <attribute 'chat_type' of 'irssi.IrssiChatBase' objects> `Chat name (str)` chat_type_id = <attribute 'chat_type_id' of 'irssi.IrssiChatBase' objects> `Chat Type id (int)` Data and other attributes inherited from IrssiBase: type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class IrcConnect(Connect)
`` | `PyIrcConnect objects`
| Method resolution order: IrcConnect Connect IrssiChatBase IrssiBase __builtin__.object Data and other attributes defined here: alternate_nick = <attribute 'alternate_nick' of 'irssi.IrcConnect' objects> `Alternate nick to use if default nick is taken` Data and other attributes inherited from Connect: address = <attribute 'address' of 'irssi.Connect' objects> `Address where we connected (irc.blah.org)` chatnet = <attribute 'chatnet' of 'irssi.Connect' objects> `Chat network` password = <attribute 'password' of 'irssi.Connect' objects> `Password we used in connection.` port = <attribute 'port' of 'irssi.Connect' objects> `Port where we're connected` realname = <attribute 'realname' of 'irssi.Connect' objects> `Real name` username = <attribute 'username' of 'irssi.Connect' objects> `User name` wanted_nick = <attribute 'wanted_nick' of 'irssi.Connect' objects> `Nick which we would prefer to use` Data and other attributes inherited from IrssiChatBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` chat_type = <attribute 'chat_type' of 'irssi.IrssiChatBase' objects> `Chat name (str)` chat_type_id = <attribute 'chat_type_id' of 'irssi.IrssiChatBase' objects> `Chat Type id (int)` Data and other attributes inherited from IrssiBase: type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class IrcServer(Server)
`` | `PyIrcServer objects`
| Method resolution order: IrcServer Server IrssiChatBase IrssiBase __builtin__.object Methods defined here: ctcp_send_reply(...) `ctcp_send_reply(data) -> None Send CTCP reply. This will be 'CTCP flood protected' so if there's too many CTCP requests in buffer, this reply might not get sent. The data is the full raw command to be sent to server, like 'NOTICE nick :VERSION irssi'` get_channels(...) `get_channels() -> str Return a string of all channels (and keys, if any have them) in server, like '#a,#b,#c,#d x,b_chan_key,x,x' or just '#e,#f,#g'` isupport(...) `isupport(name) -> str or None Returns the value of the named item in the ISUPPORT (005) numeric to the script. If the item is not present returns undef, if the item has no value then '' is returned use defined server.isupport('name') if you need to check whether a property is present. See http://www.ietf.org/internet-drafts/draft-brocklesby-irc-isupport-01.txt for more information on the ISUPPORT numeric.` netsplit_find(...) `netsplit_find(nick, address) -> Netsplit object or None Check if nick!address is on the other side of netsplit. Netsplit records are automatically removed after 30 minutes (current default)..` netsplit_find_channel(...) `netsplit_find_channel(nick, address, channel) -> NetsplitChannel object or None Find nick record for nick!address in channel `channel'.` notifylist_ison(...) `notifylist_ison(nick) -> bool Check if nick is on server` redirect_event(...) `redirect_event(command, signals, arg=None, count=1, remote=-1, failure_signal=None) -> None Specify that the next command sent to server will be redirected. NOTE: This command MUST be called before sending the command to server. `command' - Name of the registered redirection that we're using. `count' - How many times to execute the redirection. Some commands may send multiple stop events, like MODE #a,#b. `arg' - The argument to be compared in event strings. You can give multiple arguments separated with space. `remote' - Specifies if the command is a remote command, -1 = use default. `failure_signal' - If irssi can't find the stop signal for the redirection, this signal is called. `signals' - hash reference with "event" => "redir signal" entries. If the event is , all the events belonging to the redirection but not specified here, will be sent there. Example: # ignore all events generated by whois query, except 311. server.redirect_event("whois", remote = 0, arg = "cras", signals = [ ('event 311', 'redir whois'), ('', 'event empty') ] ) server.send_raw("WHOIS :cras")` redirect_get_signal(...) `redirect_get_signal(event, args) -> str` redirect_peek_signal(...) `redirect_peek_signal(event, args) -> str` send_raw(...) `send_raw(cmd) -> None Send raw message to server, it will be flood protected so you don't need to worry about it.` send_raw_now(...) `send_raw_now(cmd) -> None Send raw message to server immediately without flood protection.` send_raw_split(...) `send_raw_split(cmd, nickarg, max_nicks) -> None Split the `cmd' into several commands so `nickarg' argument has only `max_nicks' number of nicks. Example: server.send_raw_split('KICK #channel nick1,nick2,nick3 :byebye', 3, 2) Irssi will send commands 'KICK #channel nick1,nick2 :byebye' and 'KICK #channel nick3 :byebye' to server.` Data and other attributes defined here: real_address = <attribute 'real_address' of 'irssi.IrcServer' objects> `Address the IRC server gives` userhost = <attribute 'userhost' of 'irssi.IrcServer' objects> `Your user host in server` usermode = <attribute 'usermode' of 'irssi.IrcServer' objects> `User mode in server` Methods inherited from Server: channel_find(...) `channel_find(name) -> Channel object or None Find channel from this server` channels(...) `channels() -> list of Channel objects Return list of channels for server` channels_join(...) `channels_join(channels, automatic=False) -> None Join to channels in server. `channels' may also contain keys for channels just like with /JOIN command. `automatic' specifies if this channel was joined 'automatically' or if it was joined because join was requested by user. If channel join is 'automatic', irssi doesn't jump to the window where the channel was joined.` command(...) `command(cmd) -> None Send command` disconnect(...) `disconnect() -> None Disconnect from server` get_nick_flags(...) `get_nick_flags() -> str Returns nick flag characters in order: op, voice, halfop ("@+%") in IRC` ignore_check(...) `ignore_check(nick, host, channel, text, level) -> bool Return True if ignore matches` ischannel(...) `ischannel(data) -> bool Returns True if start of `data' seems to mean channel.` isnickflag(...) `isnickflag(flag) -> bool Returns True if flag is a nick mode flag (@, + or % in IRC)` mask_match(...) `mask_match(mask, nick, user, host) -> bool Return true if mask matches nick!user@host` mask_match_address(...) `mask_match_address(mask, nick, address) -> bool Return True if mask matches nick!address` masks_match(...) `masks_match(masks, nick, address) -> bool Return True if any mask in the masks (string separated by spaces) matches nick!address` nicks_get_same(...) `nicks_get_same(nick) Return all nick objects in all channels in server. List is in format: [(Channel, Nick), (Channel, Nick), ...]` printformat(...) `for Server objects: printformat(target, level, format, ...) -> None For all else: printformat(level, format, ...) -> None` prnt(...) `prnt(channel, str, level) -> None Print to server` queries(...) `queries() -> list of Query objects Return a list of queries for server.` query_find(...) `query_find(nick) -> Query object or None Find a query on this server.` send_message(...) `send_message(target, msg, target_type) -> None Sends a message to nick/channel. target_type 0 = channel, 1 = nick` window_find_closest(...) `window_find_closest(name, level) -> Window object or None Find window that matches best to given arguments. `name' can be either window name or name of one of the window items.` window_find_item(...) `window_find_item(name) -> Window object or None Find window which contains window item with specified name/server` window_find_level(...) `window_find_level(level) -> Window object or None Find window with level` window_item_find(...) `window_item_find(name) -> WindowItem object or None Find window item that matches best to given arguments` Data and other attributes inherited from Server: away_reason = <attribute 'away_reason' of 'irssi.Server' objects> `Away reason message` banned = <attribute 'banned' of 'irssi.Server' objects> `Were we banned from this server? 1|0` connect = <attribute 'connect' of 'irssi.Server' objects> `Connect object for the server` connect_time = <attribute 'connect_time' of 'irssi.Server' objects> `Time when connect() to server finished` connected = <attribute 'connected' of 'irssi.Server' objects> `Is connection finished? 1|0` connection_lost = <attribute 'connection_lost' of 'irssi.Server' objects> `Did we lose the connection (1) or was the connection just /DISCONNECTed (0)` lag = <attribute 'lag' of 'irssi.Server' objects> `Current lag to server in milliseconds` last_invite = <attribute 'last_invite' of 'irssi.Server' objects> `Last channel we were invited to` nick = <attribute 'nick' of 'irssi.Server' objects> `Current nick` rawlog = <attribute 'rawlog' of 'irssi.Server' objects> `Rawlog object for the server` real_connect_time = <attribute 'real_connect_time' of 'irssi.Server' objects> `Time when server sent 'connected' message` server_operator = <attribute 'server_operator' of 'irssi.Server' objects> `Are we server operator (IRC op) 1|0` tag = <attribute 'tag' of 'irssi.Server' objects> `Unique server tag` usermode_away = <attribute 'usermode_away' of 'irssi.Server' objects> `Are we marked as away? 1|0` version = <attribute 'version' of 'irssi.Server' objects> `Server version` Data and other attributes inherited from IrssiChatBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` chat_type = <attribute 'chat_type' of 'irssi.IrssiChatBase' objects> `Chat name (str)` chat_type_id = <attribute 'chat_type_id' of 'irssi.IrssiChatBase' objects> `Chat Type id (int)` Data and other attributes inherited from IrssiBase: type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class IrssiBase(__builtin__.object)
`` | `PyIrssiBase objects`
| Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class IrssiChatBase(IrssiBase)
`` | `PyIrssiChatBase objects`
| Method resolution order: IrssiChatBase IrssiBase __builtin__.object Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` chat_type = <attribute 'chat_type' of 'irssi.IrssiChatBase' objects> `Chat name (str)` chat_type_id = <attribute 'chat_type_id' of 'irssi.IrssiChatBase' objects> `Chat Type id (int)` Data and other attributes inherited from IrssiBase: type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class Log(__builtin__.object)
`` | `__init__(fname, level=MSGLEVEL_ALL) Create a log`
| Methods defined here: __init__(...) `x.__init__(...) initializes x; see x.__class__.__doc__ for signature` close(...) `destroy() -> None Destroy the log file` item_add(...) `item_add(item, servertag=None, type=0, target=False, window=False) -> None Add a log item to log. Add a target item (nick, chan): item_add('#linux', target=True) item_add('#linux', type=0) Add a window ref: item_add('2', window=True) item_add('2', type=1)` item_destroy(...) `item_destroy(item) -> None Remove log item from log.` item_find(...) `item_find(item, servertag=None, type=-1, target=False, window=False) -> item or None Find item from log.` items(...) `items() -> list of Log objects Return a list of log items` start_logging(...) `start_logging() -> None Open log file and start logging.` stop_logging(...) `stop_logging() -> None Stop and close the log file.` update(...) `update() -> None Add log to list of logs / save changes to config file.` Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` autoopen = <attribute 'autoopen' of 'irssi.Log' objects> `Automatically open log at startup` failed = <attribute 'failed' of 'irssi.Log' objects> `Opening log failed last time` fname = <attribute 'fname' of 'irssi.Log' objects> `Log file name` last = <attribute 'last' of 'irssi.Log' objects> `Timestamp when last message was written` level = <attribute 'level' of 'irssi.Log' objects> `Log only these levels` opened = <attribute 'opened' of 'irssi.Log' objects> `Log file is open` real_fname = <attribute 'real_fname' of 'irssi.Log' objects> `The actual opened log file (after %d.%m.Y etc. are expanded)` temp = <attribute 'temp' of 'irssi.Log' objects> `Log isn't saved to config file`
class Logitem(__builtin__.object)
`` | `PyLogitem objects`
| Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` name = <attribute 'name' of 'irssi.Logitem' objects> `Name` servertag = <attribute 'servertag' of 'irssi.Logitem' objects> `Server tag` type = <attribute 'type' of 'irssi.Logitem' objects> `0=target, 1=window refnum`
class MainWindow(__builtin__.object)
`` | `PyMainWindow objects`
| Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` active = <attribute 'active' of 'irssi.MainWindow' objects> `active window object` first_line = <attribute 'first_line' of 'irssi.MainWindow' objects> `first line used by this window (0..x) (includes statusbars)` height = <attribute 'height' of 'irssi.MainWindow' objects> `height of the window (includes statusbars)` last_line = <attribute 'last_line' of 'irssi.MainWindow' objects> `last line used by this window (0..x) (includes statusbars)` statusbar_lines = <attribute 'statusbar_lines' of 'irssi.MainWindow' objects> `???` width = <attribute 'width' of 'irssi.MainWindow' objects> `width of the window (includes statusbars)`
class Netsplit(__builtin__.object)
`` | `PyNetsplit objects`
| Methods defined here: channels(...) `channels() -> list of NetsplitChannel objects Return list of NetsplitChannel objects` Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` address = <attribute 'address' of 'irssi.Netsplit' objects> `Nick's host` destroy = <attribute 'destroy' of 'irssi.Netsplit' objects> `Timestamp when this record should be destroyed` nick = <attribute 'nick' of 'irssi.Netsplit' objects> `Nick` server = <attribute 'server' of 'irssi.Netsplit' objects> `Netsplitserver object`
class NetsplitChannel(__builtin__.object)
`` | `PyNetsplitChannel objects`
| Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` halfop = <attribute 'halfop' of 'irssi.NetsplitChannel' objects> `is halfop` name = <attribute 'name' of 'irssi.NetsplitChannel' objects> `Channel name` op = <attribute 'op' of 'irssi.NetsplitChannel' objects> `is op` other = <attribute 'other' of 'irssi.NetsplitChannel' objects> `?` voice = <attribute 'voice' of 'irssi.NetsplitChannel' objects> `is voice`
class NetsplitServer(__builtin__.object)
`` | `PyNetsplitServer objects`
| Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` count = <attribute 'count' of 'irssi.NetsplitServer' objects> `Number of splits in server` destserver = <attribute 'destserver' of 'irssi.NetsplitServer' objects> `The other server where split occured.` server = <attribute 'server' of 'irssi.NetsplitServer' objects> `The server nick was in`
class Nick(IrssiChatBase)
`` | `PyNick objects`
| Method resolution order: Nick IrssiChatBase IrssiBase __builtin__.object Data and other attributes defined here: gone = <attribute 'gone' of 'irssi.Nick' objects> `User status` halfop = <attribute 'halfop' of 'irssi.Nick' objects> `User status` hops = <attribute 'hops' of 'irssi.Nick' objects> `Hop count to the server the nick is using` host = <attribute 'host' of 'irssi.Nick' objects> `Host address` last_check = <attribute 'last_check' of 'irssi.Nick' objects> `timestamp when last checked gone/ircop status.` nick = <attribute 'nick' of 'irssi.Nick' objects> `Plain nick` op = <attribute 'op' of 'irssi.Nick' objects> `User status` realname = <attribute 'realname' of 'irssi.Nick' objects> `Real name` send_massjoin = <attribute 'send_massjoin' of 'irssi.Nick' objects> `Waiting to be sent in a 'massjoin' signal, True or False` serverop = <attribute 'serverop' of 'irssi.Nick' objects> `User status` voice = <attribute 'voice' of 'irssi.Nick' objects> `User status` Data and other attributes inherited from IrssiChatBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` chat_type = <attribute 'chat_type' of 'irssi.IrssiChatBase' objects> `Chat name (str)` chat_type_id = <attribute 'chat_type_id' of 'irssi.IrssiChatBase' objects> `Chat Type id (int)` Data and other attributes inherited from IrssiBase: type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class Notifylist(__builtin__.object)
`` | `PyNotifylist objects`
| Methods defined here: ircnets(...) `ircnets() -> list of str Return list of ircnets the notify is checked` ircnets_match(...) `ircnets_match(ircnet) -> bool Return True if notify is checked in ircnet` Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` away_check = <attribute 'away_check' of 'irssi.Notifylist' objects> `Notify away status changes` idle_check_time = <attribute 'idle_check_time' of 'irssi.Notifylist' objects> `Notify when idle time is reset and idle was bigger than this (seconds)` mask = <attribute 'mask' of 'irssi.Notifylist' objects> `Notify nick mask`
class Process(__builtin__.object)
`` | `PyProcess objects`
| Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` args = <attribute 'args' of 'irssi.Process' objects> `The command that is being executed` id = <attribute 'id' of 'irssi.Process' objects> `ID for the process` name = <attribute 'name' of 'irssi.Process' objects> `Name for the process (if given)` notice = <attribute 'notice' of 'irssi.Process' objects> `send text with /notice, not /msg if target is set` pid = <attribute 'pid' of 'irssi.Process' objects> `PID for the executed command` shell = <attribute 'shell' of 'irssi.Process' objects> `start the program via /bin/sh` silent = <attribute 'silent' of 'irssi.Process' objects> `don't print "process exited with level xx"` target = <attribute 'target' of 'irssi.Process' objects> `send text with /msg <target> ...` target_win = <attribute 'target_win' of 'irssi.Process' objects> `print text to this window`
class Query(WindowItem)
`` | `PyQuery objects`
| Method resolution order: Query WindowItem IrssiChatBase IrssiBase __builtin__.object Methods defined here: change_server(...) `change_server(server) -> None Change the active server for the query.` Data and other attributes defined here: address = <attribute 'address' of 'irssi.Query' objects> `Host address of the queries nick` server_tag = <attribute 'server_tag' of 'irssi.Query' objects> `Server tag used for this nick (doesn't get erased if server gets disconnected)` unwanted = <attribute 'unwanted' of 'irssi.Query' objects> `1 if the other side closed or some error occured (DCC chats)` Methods inherited from WindowItem: activity(...) `activity(data_level, hilight_color) -> None` command(...) `command(cmd) -> None Send command to window item` destroy(...) `destroy() -> None Destroy channel or query` get_dcc(...) `get_dcc() -> DccChat object or None If item is a query of a =nick, return DCC chat record of nick` is_active(...) `is_active() -> bool Returns true if window item is active` printformat(...) `for Server objects: printformat(target, level, format, ...) -> None For all else: printformat(level, format, ...) -> None` prnt(...) `prnt(str, level) -> None Print to window item` set_active(...) `set_active() -> None Set window item active` window(...) `window() -> Window object or None Return parent window for window item` Data and other attributes inherited from WindowItem: createtime = <attribute 'createtime' of 'irssi.WindowItem' objects> `Time the witem was created` data_level = <attribute 'data_level' of 'irssi.WindowItem' objects> `0=no new data, 1=text, 2=msg, 3=highlighted text` hilight_color = <attribute 'hilight_color' of 'irssi.WindowItem' objects> `Color of the last highlighted text` name = <attribute 'name' of 'irssi.WindowItem' objects> `Name of the item` server = <attribute 'server' of 'irssi.WindowItem' objects> `Active name for item` Data and other attributes inherited from IrssiChatBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` chat_type = <attribute 'chat_type' of 'irssi.IrssiChatBase' objects> `Chat name (str)` chat_type_id = <attribute 'chat_type_id' of 'irssi.IrssiChatBase' objects> `Chat Type id (int)` Data and other attributes inherited from IrssiBase: type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class Rawlog(__builtin__.object)
`` | `PyRawlog objects`
| Methods defined here: close(...) `close() -> None Stop logging to file` destroy(...) `destroy() -> None Destroy rawlog` get_lines(...) `get_lines() -> list of str Return a list of lines for rawlog.` input(...) `input(str) -> None Send str to rawlog as input text.` open(...) `open(fname) -> None Start logging new messages in rawlog to specified file.` output(...) `output(str) -> None Send str to rawlog as output text.` redirect(...) `redirect(str) -> None Send str to rawlog as redirection text.` save(...) `save(fname) -> None Save the current rawlog history to specified file.` Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` logging = <attribute 'logging' of 'irssi.Rawlog' objects> `The raw log is being written to file currently.` nlines = <attribute 'nlines' of 'irssi.Rawlog' objects> `Number of lines in rawlog.`
class Reconnect(__builtin__.object)
`` | `PyReconnect objects`
| Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` connect = <attribute 'connect' of 'irssi.Reconnect' objects> `Connection object` next_connect = <attribute 'next_connect' of 'irssi.Reconnect' objects> `Unix time stamp when the next connection occurs` tag = <attribute 'tag' of 'irssi.Reconnect' objects> `Unique numeric tag`
class Script(__builtin__.object)
`` | `PyScript objects`
| Methods defined here: command_bind(...) `command_bind(command, func, catetory=None, priority=SIGNAL_PRIORITY_DEFAULT) -> None Add handler for a command` command_unbind(...) `command_unbind(command, func=None) -> None Remove command handler` io_add_watch(...) `io_add_watch(fd, func, data=None, condition=IO_IN|IO_PRI) -> int source tag` settings_add_bool(...) `settings_add_bool(section, key, def) -> None` settings_add_int(...) `settings_add_int(section, key, def) -> None` settings_add_level(...) `settings_add_level(section, key, def) -> None` settings_add_size(...) `settings_add_size(section, key, def) -> None` settings_add_str(...) `settings_add_str(section, key, def) -> None` settings_add_time(...) `settings_add_time(section, key, def) -> None` settings_remove(...) `settings_remove(key) -> bool` signal_add(...) `signal_add(signal, func, priority=SIGNAL_PRIORITY_DEFAULT) -> None Add handler for signal` signal_register(...) `signal_register(signal, arglist) -> None Register a new dynamic signal for use with irssi_python arglist is a string of character codes representing the type of each argument of the signal handler function. Scalars s -> char * i -> int Chat objects c -> CHATNET_REC S -> SERVER_REC C -> CHANNEL_REC q -> QUERY_REC n -> NICK_REC W -> WI_ITEM_REC Irssi objects d -> DCC_REC Other objects r -> RECONNECT_REC o -> COMMAND_REC l -> LOG_REC a -> RAWLOG_REC g -> IGNORE_REC b -> BAN_REC N -> NETSPLIT_REC e -> NETSPLIT_SERVER_REC O -> NOTIFYLIST_REC p -> PROCESS_REC t -> TEXT_DEST_REC w -> WINDOW_REC` signal_remove(...) `signal_remove(signal, func=None) -> None Remove signal handler` signal_unregister(...) `signal_unregister(signal) -> None Unregister dynamic signal` source_remove(...) `source_remove(tag) -> bool Remove IO or timeout source by tag. Return True if tag found and removed.` statusbar_item_register(...) `statusbar_item_register(name, value=None, func=None) -> None` theme_register(...) `theme_register(list) -> None` timeout_add(...) `timeout_add(msecs, func, data=None) -> int source tag Add a timeout handler called every 'msecs' milliseconds until func returns False or the source is removed with source_remove(). func is called as func(data) or func(), depending on whether data is specified or not.` Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` argv = <member 'argv' of 'irssi.Script' objects> `Script arguments` module = <member 'module' of 'irssi.Script' objects> `Script module` modules = <member 'modules' of 'irssi.Script' objects> `Imported modules`
class Server(IrssiChatBase)
`` | `PyServer objects`
| Method resolution order: Server IrssiChatBase IrssiBase __builtin__.object Methods defined here: channel_find(...) `channel_find(name) -> Channel object or None Find channel from this server` channels(...) `channels() -> list of Channel objects Return list of channels for server` channels_join(...) `channels_join(channels, automatic=False) -> None Join to channels in server. `channels' may also contain keys for channels just like with /JOIN command. `automatic' specifies if this channel was joined 'automatically' or if it was joined because join was requested by user. If channel join is 'automatic', irssi doesn't jump to the window where the channel was joined.` command(...) `command(cmd) -> None Send command` disconnect(...) `disconnect() -> None Disconnect from server` get_nick_flags(...) `get_nick_flags() -> str Returns nick flag characters in order: op, voice, halfop ("@+%") in IRC` ignore_check(...) `ignore_check(nick, host, channel, text, level) -> bool Return True if ignore matches` ischannel(...) `ischannel(data) -> bool Returns True if start of `data' seems to mean channel.` isnickflag(...) `isnickflag(flag) -> bool Returns True if flag is a nick mode flag (@, + or % in IRC)` mask_match(...) `mask_match(mask, nick, user, host) -> bool Return true if mask matches nick!user@host` mask_match_address(...) `mask_match_address(mask, nick, address) -> bool Return True if mask matches nick!address` masks_match(...) `masks_match(masks, nick, address) -> bool Return True if any mask in the masks (string separated by spaces) matches nick!address` nicks_get_same(...) `nicks_get_same(nick) Return all nick objects in all channels in server. List is in format: [(Channel, Nick), (Channel, Nick), ...]` printformat(...) `for Server objects: printformat(target, level, format, ...) -> None For all else: printformat(level, format, ...) -> None` prnt(...) `prnt(channel, str, level) -> None Print to server` queries(...) `queries() -> list of Query objects Return a list of queries for server.` query_find(...) `query_find(nick) -> Query object or None Find a query on this server.` send_message(...) `send_message(target, msg, target_type) -> None Sends a message to nick/channel. target_type 0 = channel, 1 = nick` window_find_closest(...) `window_find_closest(name, level) -> Window object or None Find window that matches best to given arguments. `name' can be either window name or name of one of the window items.` window_find_item(...) `window_find_item(name) -> Window object or None Find window which contains window item with specified name/server` window_find_level(...) `window_find_level(level) -> Window object or None Find window with level` window_item_find(...) `window_item_find(name) -> WindowItem object or None Find window item that matches best to given arguments` Data and other attributes defined here: away_reason = <attribute 'away_reason' of 'irssi.Server' objects> `Away reason message` banned = <attribute 'banned' of 'irssi.Server' objects> `Were we banned from this server? 1|0` connect = <attribute 'connect' of 'irssi.Server' objects> `Connect object for the server` connect_time = <attribute 'connect_time' of 'irssi.Server' objects> `Time when connect() to server finished` connected = <attribute 'connected' of 'irssi.Server' objects> `Is connection finished? 1|0` connection_lost = <attribute 'connection_lost' of 'irssi.Server' objects> `Did we lose the connection (1) or was the connection just /DISCONNECTed (0)` lag = <attribute 'lag' of 'irssi.Server' objects> `Current lag to server in milliseconds` last_invite = <attribute 'last_invite' of 'irssi.Server' objects> `Last channel we were invited to` nick = <attribute 'nick' of 'irssi.Server' objects> `Current nick` rawlog = <attribute 'rawlog' of 'irssi.Server' objects> `Rawlog object for the server` real_connect_time = <attribute 'real_connect_time' of 'irssi.Server' objects> `Time when server sent 'connected' message` server_operator = <attribute 'server_operator' of 'irssi.Server' objects> `Are we server operator (IRC op) 1|0` tag = <attribute 'tag' of 'irssi.Server' objects> `Unique server tag` usermode_away = <attribute 'usermode_away' of 'irssi.Server' objects> `Are we marked as away? 1|0` version = <attribute 'version' of 'irssi.Server' objects> `Server version` Data and other attributes inherited from IrssiChatBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` chat_type = <attribute 'chat_type' of 'irssi.IrssiChatBase' objects> `Chat name (str)` chat_type_id = <attribute 'chat_type_id' of 'irssi.IrssiChatBase' objects> `Chat Type id (int)` Data and other attributes inherited from IrssiBase: type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`
class StatusbarItem(__builtin__.object)
`` | `PyStatusbarItem objects`
| Methods defined here: default_handler(...) `default_handler(get_size_only, str=None, data=, escape_vars=True) -> None Run default handler of item to print to statusbar` Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` max_size = <attribute 'max_size' of 'irssi.StatusbarItem' objects> `max size` min_size = <attribute 'min_size' of 'irssi.StatusbarItem' objects> `min size` size = <attribute 'size' of 'irssi.StatusbarItem' objects> `size` window = <attribute 'window' of 'irssi.StatusbarItem' objects> `parent window for statusbar item` xpos = <attribute 'xpos' of 'irssi.StatusbarItem' objects> `x position`
class TextDest(__builtin__.object)
`` | `__init__(target, level=MSGLEVEL_CLIENTNOTICE, server=None, window=None) Create a TextDest`
| Methods defined here: __init__(...) `x.__init__(...) initializes x; see x.__class__.__doc__ for signature` prnt(...) `prnt(str) -> None Print str to TextDest` Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` hilight_color = <attribute 'hilight_color' of 'irssi.TextDest' objects> `Color for the hilighted text` hilight_priority = <attribute 'hilight_priority' of 'irssi.TextDest' objects> `Priority for the hilighted text` level = <attribute 'level' of 'irssi.TextDest' objects> `Text level` server = <attribute 'server' of 'irssi.TextDest' objects> `Target server` target = <attribute 'target' of 'irssi.TextDest' objects> `Target channel/query/etc name` window = <attribute 'window' of 'irssi.TextDest' objects> `Window where the text will be written`
class Theme(__builtin__.object)
`` |  | Methods defined here: format_expand(...) `format_expand(format, flags=0) -> str or None` get_format(...) `get_format(module, tag) -> str` Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T`
class Window(__builtin__.object)
`` | `PyWindow objects`
| Methods defined here: activity(...) `activity(data_level, hilight_color) -> None` change_server(...) `change_server(server) -> None Change server in window` command(...) `command(cmd) -> None Send command to window` destroy(...) `destroy() -> None Destroy the window.` get_active_name(...) `get_active_name() -> str or None Return active item's name, or if none is active, window's name.` item_add(...) `item_add(item, automatic=False) -> None Add window item` item_destroy(...) `item_destroy(item) -> None Destroy window item` item_find(...) `item_find(server, name) -> WindowItem or None Find window item that matches best to given arguments` item_next(...) `item_next() -> None Change to next window item` item_prev(...) `item_prev() -> None Change to previous window item` item_remove(...) `item_remove(item) -> None Remove window item` items(...) `items() -> list of WindowItem objects Return a list of items in window.` printformat(...) `for Server objects: printformat(target, level, format, ...) -> None For all else: printformat(level, format, ...) -> None` prnt(...) `prnt(str, level=MSGLEVEL_CLIENTNOTICE) -> None Print to window` set_active(...) `set_active() -> None Set window active.` set_history(...) `set_history(history) -> None Set window history` set_level(...) `set_level(level) -> None Set window level` set_name(...) `set_name(name) -> None Set window name` set_refnum(...) `set_refnum(refnum) -> None Set window refnum` Data and other attributes defined here: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` active = <attribute 'active' of 'irssi.Window' objects> `Active window item` active_server = <attribute 'active_server' of 'irssi.Window' objects> `Active server` data_level = <attribute 'data_level' of 'irssi.Window' objects> `Current data level` height = <attribute 'height' of 'irssi.Window' objects> `Height` hilight_color = <attribute 'hilight_color' of 'irssi.Window' objects> `Current activity hilight color` history_name = <attribute 'history_name' of 'irssi.Window' objects> `Name of named historylist for this window` last_line = <attribute 'last_line' of 'irssi.Window' objects> `Last time text was written in window` last_timestamp = <attribute 'last_timestamp' of 'irssi.Window' objects> `Last time timestamp was written in window` level = <attribute 'level' of 'irssi.Window' objects> `Current window level` name = <attribute 'name' of 'irssi.Window' objects> `Name` refnum = <attribute 'refnum' of 'irssi.Window' objects> `Reference number` servertag = <attribute 'servertag' of 'irssi.Window' objects> `active_server must be either None or have this same tag(unless there's items in this window). This is used by/WINDOW SERVER -sticky` sticky_refnum = <attribute 'sticky_refnum' of 'irssi.Window' objects> `True if reference number is sticky` theme_name = <attribute 'theme_name' of 'irssi.Window' objects> `Active theme in window, None = default` width = <attribute 'width' of 'irssi.Window' objects> `Width`
class WindowItem(IrssiChatBase)
`` | `PyWindowItem objects`
| Method resolution order: WindowItem IrssiChatBase IrssiBase __builtin__.object Methods defined here: activity(...) `activity(data_level, hilight_color) -> None` change_server(...) `change_server(server) -> None Change server for window item` command(...) `command(cmd) -> None Send command to window item` destroy(...) `destroy() -> None Destroy channel or query` get_dcc(...) `get_dcc() -> DccChat object or None If item is a query of a =nick, return DCC chat record of nick` is_active(...) `is_active() -> bool Returns true if window item is active` printformat(...) `for Server objects: printformat(target, level, format, ...) -> None For all else: printformat(level, format, ...) -> None` prnt(...) `prnt(str, level) -> None Print to window item` set_active(...) `set_active() -> None Set window item active` window(...) `window() -> Window object or None Return parent window for window item` Data and other attributes defined here: createtime = <attribute 'createtime' of 'irssi.WindowItem' objects> `Time the witem was created` data_level = <attribute 'data_level' of 'irssi.WindowItem' objects> `0=no new data, 1=text, 2=msg, 3=highlighted text` hilight_color = <attribute 'hilight_color' of 'irssi.WindowItem' objects> `Color of the last highlighted text` name = <attribute 'name' of 'irssi.WindowItem' objects> `Name of the item` server = <attribute 'server' of 'irssi.WindowItem' objects> `Active name for item` Data and other attributes inherited from IrssiChatBase: __new__ = <built-in method __new__ of type object> `T.__new__(S, ...) -> a new object with type S, a subtype of T` chat_type = <attribute 'chat_type' of 'irssi.IrssiChatBase' objects> `Chat name (str)` chat_type_id = <attribute 'chat_type_id' of 'irssi.IrssiChatBase' objects> `Chat Type id (int)` Data and other attributes inherited from IrssiBase: type = <attribute 'type' of 'irssi.IrssiBase' objects> `Irssi's name for object` type_id = <attribute 'type_id' of 'irssi.IrssiBase' objects> `Irssi's type id for object` valid = <attribute 'valid' of 'irssi.IrssiBase' objects> `True if the object is valid`

Functions
`` |  | active_mainwin(...) `active_mainwin() -> MainWindow object return active main window` active_server(...) `active_server() -> Server object or None Return active server` active_win(...) `active_win() -> Window object Return active window` bits2level(...) `bits2level(bits) -> str Level number -> string` channel_find(...) `channel_find(name) -> Channel object or None Find channel from any server` channels(...) `channels() -> list of Channel objects Return channel list` chatnet_find(...) `chatnet_find(name) -> Chatnet object or None Find chat network with name` chatnets(...) `chatnets() -> list of Chatnet objects Return a list of all chatnets` combine_level(...) `combine_level(level, str) -> long Combine level number to level string ('+level -level'). Return new level number.` command(...) `command(cmd) -> None Execute command` command_bind(*args, **kwargs) `see Script.command_bind()` command_runsub(...) `command_runsub(cmd, data, server=None, item=None) -> None Run subcommands for `cmd'. First word in `data' is parsed as subcommand. `server' is Server object for current WindowItem `item'. Call command_runsub in handler function for `cmd' and bind with command_bind("`cmd' `subcmd'", subcmdfunc[, category]);` command_unbind(*args, **kwargs) `see Script.command_unbind()` commands(...) `commands() -> list of Command objects Return a list of all commands.` current_theme(...) `current_theme() -> Theme object` dcc_chat_find_id(...) `dcc_chat_find_id(id) -> Dcc object or None ???` dcc_find_request(...) `dcc_find_request(type, nick, arg) -> Dcc object or None ???` dcc_find_request_latest(...) `dcc_find_request_latest(type) -> Dcc object or None ???` dcc_get_download_path(...) `dcc_get_download(fname) -> str ???` dcc_register_type(...) `dcc_register_type(type) -> None ???` dcc_str2type(...) `dcc_str2type(type) -> int ???` dcc_type2str(...) `dcc_type2str(type) -> str or None ???` dcc_unregister_type(...) `dcc_unregister_type(type) -> None ???` dccs(...) `dccs() -> list of Dcc objects Return list of active DCCs` format_get_length(...) `format_get_length(str) -> int length` format_real_length(...) `format_real_length(str, len) -> int length` get_script(...) `get_script() -> Script object Find current Irssi script object` ignore_check(...) `ignore_check(nick, host, channel, text, level) -> bool Return True if ignore matches` ignores(...) `ignores() -> list of Ignore objects Return a list of ignore entries` io_add_watch(*args, **kwargs) `see Script.io_add_watch()` level2bits(...) `level2bits(level) -> long Level string -> number` log_find(...) `log_find(fname) -> Log object or None Find log by file name.` logs(...) `logs() -> list of Log objects Return list of logs.` mainwindows(...) `mainwindows() -> list of MainWindow objects return a list of mainwindows` mask_match(...) `mask_match(mask, nick, user, host) -> bool Return true if mask matches nick!user@host` mask_match_address(...) `mask_match_address(mask, nick, address) -> bool Return True if mask matches nick!address` masks_match(...) `masks_match(masks, nick, address) -> bool Return True if any mask in the masks (string separated by spaces) matches nick!address` notifies(...) `notifies() -> list of Notifylist objects Return list of notifies` notifylist_add(...) `notifylist_add(mask, ircnets=None, away_check=0, idle_time_check=0) -> Notifylist object Add new item to notify list` notifylist_find(...) `notifylist_find(mask, ircnet=None) -> Notifylist object Find notify` notifylist_ison(...) `notifylist_ison(nick, serverlist="") -> IrcServer object Check if nick is in IRC. serverlist is a space separated list of server tags. If it's empty string, all servers will be checked` notifylist_remove(...) `notifylist_remove(mask) -> None Remove notify item from notify list` pidwait_add(...) `pidwait_add(pid) -> None Add pid to wait list` pidwait_remove(...) `pidwait_remove(pid) -> None Remove pid from wait list` printformat(...) `for Server objects: printformat(target, level, format, ...) -> None For all else: printformat(level, format, ...) -> None` prnt(...) `prnt(text, msglvl=MSGLEVEL_CLIENTNOTICE) -> None print output` queries(...) `queries() -> list of Query objects Return a list of open queries.` query_find(...) `query_find(nick) -> Query object or None Find a query from any server.` rawlog_set_size(...) `rawlog_set_size(lines) -> None Set the default rawlog size for new rawlogs.` reconnects(...) `reconnects() -> list of Reconnect objects Return a list of all reconnects` server_find_chatnet(...) `server_find_chatnet(chatnet) -> Server object or None Find first server that is in chatnet` server_find_tag(...) `server_find_tag(tag) -> Server object or None Find server with tag` server_redirect_register(...) `server_redirect_register(command, stop, start=None, opt=None, remote=False, timeout=0) -> None Register new redirection command. By default irssi has already registered at least: whois, whowas, who, list, ison, userhost, ping, "mode channel" (/MODE #channel), "mode b" (/MODE #channel b), "mode e" and "mode I". `command' specifies the name of the command to register, it doesn't have to be a real command name, but something you just specify to Server.redirect_event() when using this redirection. `start', `stop', `opt' - lists of ('event', argpos) tuples. List of events that start and stop this redirection. Start event list may be empty, but there must be at least one stop event. Optional events are checked only if they are received immediately after one of the stop-events. `argpos' specifies the word number in event string which is compared to wanted argument, -1 = don't compare, TRUE always. `remote' specifies if the command is by default a remote command (eg. sent to another server). Server.redirect_event() may override this. `timeout' - If remote is TRUE, specifies how many seconds to wait for reply before aborting. Example (already done by irssi): server_redirect_register('mode channel', start = None, stop = [ ('event 324', 1), # MODE-reply ('event 403', 1), # no such channel ('event 442', 1), # "you're not on that channel" ('event 479', 1) # "Cannot join channel (illegal name)" ], opt = [ ('event 329', 1) # Channel create time ] )` servers(...) `servers() -> list of Server objects Return a list of all servers` settings_add_bool(*args, **kwargs) `see Script.settings_add_bool()` settings_add_int(*args, **kwargs) `see Script.settings_add_int()` settings_add_level(*args, **kwargs) `see Script.settings_add_level()` settings_add_size(*args, **kwargs) `see Script.settings_add_size()` settings_add_str(*args, **kwargs) `see Script.settings_add_str()` settings_add_time(*args, **kwargs) `see Script.settings_add_time()` settings_get_bool(...) `settings_get_bool(key) -> bool Get value for setting.` settings_get_int(...) `settings_get_int(key) -> int Get value for setting.` settings_get_level(...) `settings_get_level(key) -> int Get value for setting.` settings_get_size(...) `settings_get_size(key) -> long Get value for setting.` settings_get_str(...) `settings_get_str(key) -> str Get value for setting.` settings_get_time(...) `settings_get_time(key) -> long Get value for setting.` settings_set_bool(...) `settings_set_bool(key, value) -> None Set bool value for setting` settings_set_int(...) `settings_set_int(key, value) -> None Set int value for setting` settings_set_level(...) `settings_set_level(key, value) -> bool Set string value for setting` settings_set_size(...) `settings_set_size(key, value) -> bool Set string value for setting` settings_set_str(...) `settings_set_str(key, value) -> None Set string value for setting` settings_set_time(...) `settings_set_time(key, value) -> bool Set string value for setting` signal_add(*args, **kwargs) `see Script.signal_add()` signal_continue(...) `signal_continue(*args) -> None Continue (reemit?) the current Irssi signal with up to 6 arguments` signal_emit(...) `signal_emit(signal, *args) -> None Emit an Irssi signal with up to 6 arguments` signal_get_emitted(...) `signal_get_emmited() -> signal name string Get name of current signal` signal_get_emitted_id(...) `signal_get_emmited_id() -> signal id int Get id of current signal` signal_remove(*args, **kwargs) `see Script.signal_remove()` signal_stop(...) `signal_stop() -> None Stop the signal that's currently being emitted.` signal_stop_by_name(...) `signal_stop_by_name(signal) -> None Stop the signal, 'signal', thats currently being emitted by name` statusbar_item_register(*args, **kwargs) `see Script.statusbar_item_register()` statusbar_item_unregister(...) `statusbar_item_unregister(name) -> None` statusbar_items_redraw(...) `statusbar_items_redraw(name) -> None` statusbars_recreate_items(...) `statusbars_recreate_items() -> None` strip_codes(...) `strip_codes(input) -> str` themes_reload(...) `themes_reload() -> None` timeout_add(*args, **kwargs) `see Script.timeout_add()` window_create(...) `window_create(item=None, automatic=False) -> Window object Create a new window` window_find_closest(...) `window_find_closest(name, level) -> Window object or None Find window that matches best to given arguments. `name' can be either window name or name of one of the window items.` window_find_item(...) `window_find_item(name) -> Window object or None Find window which contains window item with specified name.` window_find_level(...) `window_find_level(level) -> Window object or None Find window with level.` window_find_name(...) `window_find_name(name) -> Window object or None Find window with name` window_find_refnum(...) `window_find_refnum(refnum) -> Window object or None Find window with reference number` window_item_find(...) `window_item_find(name) -> WindowItem object or None Find window item that matches best to given arguments.` window_refnum_next(...) `window_refnum_next(refnum, wrap) -> int Return refnum for window that's next in window list` window_refnum_prev(...) `window_refnum_prev(refnum, wrap) -> int Return refnum for window that's previous in window list` windows(...) `windows() -> list of Window objects Get a list of all windows` windows_refnum_last(...) `windows_refnum_last() -> int Return refnum for last window.`

Data
`` |  | IO_ERR = 8 IO_HUP = 16 IO_IN = 1 IO_OUT = 4 IO_PRI = 2 IRC_MASK_DOMAIN = 8 IRC_MASK_HOST = 4 IRC_MASK_NICK = 1 IRC_MASK_USER = 2 IRSSI_GUI_GNOME = 3 IRSSI_GUI_GTK = 2 IRSSI_GUI_KDE = 5 IRSSI_GUI_NONE = 0 IRSSI_GUI_QT = 4 IRSSI_GUI_TEXT = 1 MSGLEVEL_ACTIONS = 64 MSGLEVEL_ALL = 4194303 MSGLEVEL_CLIENTCRAP = 524288 MSGLEVEL_CLIENTERROR = 1048576 MSGLEVEL_CLIENTNOTICE = 262144 MSGLEVEL_CRAP = 1 MSGLEVEL_CTCPS = 32 MSGLEVEL_DCC = 65536 MSGLEVEL_DCCMSGS = 131072 MSGLEVEL_HILIGHT = 2097152 MSGLEVEL_INVITES = 16384 MSGLEVEL_JOINS = 128 MSGLEVEL_KICKS = 1024 MSGLEVEL_LASTLOG = 134217728 MSGLEVEL_MODES = 2048 MSGLEVEL_MSGS = 2 MSGLEVEL_NEVER = 67108864 MSGLEVEL_NICKS = 32768 MSGLEVEL_NOHILIGHT = 16777216 MSGLEVEL_NOTICES = 8 MSGLEVEL_NO_ACT = 33554432 MSGLEVEL_PARTS = 256 MSGLEVEL_PUBLIC = 4 MSGLEVEL_QUITS = 512 MSGLEVEL_SNOTES = 16 MSGLEVEL_TOPICS = 4096 MSGLEVEL_WALLOPS = 8192 SIGNAL_PRIORITY_DEFAULT = 0 SIGNAL_PRIORITY_HIGH = -100 SIGNAL_PRIORITY_LOW = 100