irclog.messages — Various message types

Hierarchy

It provides a hierarchy of IRC log message types.

• BaseMessage

• Message

• PublicMessage
• ActionMessage
• NoticeMessage

• BaseNickMessage

• NickMessage
• SelfNickMessage

• JoinMessage
• ModeMessage
• PartMessage
• QuitMessage
• KickMessage
• BaseTopicMessage

• TopicMessage
• NoTopicMessage

Objects

class irclog.messages.BaseMessage(messaged_at)

Bases: object

Abstract base type for all IRC log messages.

Parameters:messaged_at (datetime.datetime) – a datetime.datetime logged

messaged_at

The naive datetime.datetime logged.

class irclog.messages.Message(messaged_at, nick, line)

Bases: irclog.messages.BaseMessage

Abstract base type for PublicMessage, ActionMessage and NoticeMessage.

Parameters:

• messaged_at (datetime.datetime) – a datetime.datetime logged
• nick (basestring) – a nickname
• line (basestring) – a message body

nick

The nickname.

line

The message body.

class irclog.messages.PublicMessage(messaged_at, nick, line)

Bases: irclog.messages.Message

Most commonly used message type.

Parameters:

• messaged_at (datetime.datetime) – a datetime.datetime logged
• nick (basestring) – a nickname
• line (basestring) – a message body

class irclog.messages.ActionMessage(messaged_at, nick, line)

Bases: irclog.messages.Message

ACTION message type.

Parameters:

• messaged_at (datetime.datetime) – a datetime.datetime logged
• nick (basestring) – a nickname
• line (basestring) – a message body

class irclog.messages.NoticeMessage(messaged_at, nick, line, channel)

Bases: irclog.messages.Message

Notice message type.

Parameters:

• messaged_at (datetime.datetime) – a datetime.datetime logged
• nick (basestring) – a nickname
• line (basestring) – a message body
• channel (basestring) – a channel name

channel

The channel name.

class irclog.messages.BaseNickMessage(messaged_at, to)

Bases: irclog.messages.BaseMessage

Abstract base type for nickname changing message types.

Parameters:

• messaged_at (datetime.datetime) – a datetime.datetime logged
• to (basestring) – a new nickname

to

The new nickname.

class irclog.messages.NickMessage(messaged_at, from_, to)

Bases: irclog.messages.BaseNickMessage

Nickname changing message type.

Parameters:

• messaged_at (datetime.datetime) – a datetime.datetime logged
• from (basestring) – a old nickname
• to (basestring) – a new nickname

from_

The old nickname.

class irclog.messages.SelfNickMessage(messaged_at, to)

Bases: irclog.messages.BaseNickMessage

My nickname chaning message type.

Parameters:

• messaged_at (datetime.datetime) – a datetime.datetime logged
• to (basestring) – a new nickname

class irclog.messages.JoinMessage(messaged_at, nick, ident, channel)

Bases: irclog.messages.BaseMessage

Join message type.

Parameters:

• messaged_at (datetime.datetime) – a datetime.datetime logged
• nick (basestring) – a nickname
• ident (basestring) – an ident
• channel (basestring) – a channel name

nick

The nickname.

ident

The ident.

channel

The channel name.

class irclog.messages.ModeMessage(messaged_at, server, channel, modelist, nick)

Bases: irclog.messages.BaseMessage

MODE message type.

Parameters:

• messaged_at (datetime.datetime) – a datetime.datetime logged
• server (basestring) – a server
• channel (basestring) – a channel name
• modelist – a mode list
• nick (basestring) – a nickname

server

The server.

channel

The channel name.

modelist

The mode list.

nick

The nickname.

class irclog.messages.PartMessage(messaged_at, nick, ident, channel, reason)

Bases: irclog.messages.BaseMessage

PART message type.

Parameters:

• nick (basestring) – a nickname
• ident (basestring) – an ident
• channel (basestring) – a channel name
• reason (basestring) – a reason

nick

The nickname.

ident

The ident.

channel

The channel name.

reason

The reason.

class irclog.messages.QuitMessage(messaged_at, nick, ident, reason)

Bases: irclog.messages.BaseMessage

Quiting message type.

Parameters:

• nick (basestring) – a nickname
• ident (basestring) – an ident
• reason (basestring) – a reason

nick

The nickname.

ident

The ident.

reason

The reason.

class irclog.messages.KickMessage(messaged_at, nick, channel, by, reason)

Bases: irclog.messages.BaseMessage

Kick message type.

Parameters:

• nick (basestring) – a nickname that was kicked
• channel (basestring) – a channel name
• by (basestring) – a nickname that kicks
• reason (basestring) – a reason

nick

The nickname that was kicked.

channel

The channel name.

by

The nickname that kicks.

reason

The reason.

class irclog.messages.BaseTopicMessage(messaged_at, nick, channel)

Bases: irclog.messages.BaseMessage

Abstract base class for topic changing message types.

Parameters:

• messaged_at (datetime.datetime) – a datetime.datetime logged
• nick (basestring) – a nickname
• channel (basestring) – a channel name

nick

The nickname.

channel

The channel name.

class irclog.messages.TopicMessage(messaged_at, nick, channel, topic)

Bases: irclog.messages.BaseTopicMessage

Topic changing message types.

Parameters:

• messaged_at (datetime.datetime) – a datetime.datetime logged
• nick (basestring) – a nickname
• channel (basestring) – a channel name
• topic (basestring) – a new topic

topic

The new topic

class irclog.messages.NoTopicMessage(messaged_at, nick, channel)

Bases: irclog.messages.BaseTopicMessage

Empty topic message types.

Parameters:

• messaged_at (datetime.datetime) – a datetime.datetime logged
• nick (basestring) – a nickname
• channel (basestring) – a channel name