irclog.messages
— Various message types¶
Objects¶
-
class
irclog.messages.
BaseMessage
(messaged_at)[source]¶ Bases:
object
Abstract base type for all IRC log messages.
Parameters: messaged_at ( datetime.datetime
) – adatetime.datetime
logged-
messaged_at
¶ The naive
datetime.datetime
logged.
-
-
class
irclog.messages.
Message
(messaged_at, nick, line)[source]¶ Bases:
irclog.messages.BaseMessage
Abstract base type for
PublicMessage
,ActionMessage
andNoticeMessage
.Parameters: - messaged_at (
datetime.datetime
) – adatetime.datetime
logged - nick (
basestring
) – a nickname - line (
basestring
) – a message body
-
nick
¶ The nickname.
-
line
¶ The message body.
- messaged_at (
-
class
irclog.messages.
PublicMessage
(messaged_at, nick, line)[source]¶ Bases:
irclog.messages.Message
Most commonly used message type.
Parameters: - messaged_at (
datetime.datetime
) – adatetime.datetime
logged - nick (
basestring
) – a nickname - line (
basestring
) – a message body
- messaged_at (
-
class
irclog.messages.
ActionMessage
(messaged_at, nick, line)[source]¶ Bases:
irclog.messages.Message
ACTION
message type.Parameters: - messaged_at (
datetime.datetime
) – adatetime.datetime
logged - nick (
basestring
) – a nickname - line (
basestring
) – a message body
- messaged_at (
-
class
irclog.messages.
NoticeMessage
(messaged_at, nick, line, channel)[source]¶ Bases:
irclog.messages.Message
Notice message type.
Parameters: - messaged_at (
datetime.datetime
) – adatetime.datetime
logged - nick (
basestring
) – a nickname - line (
basestring
) – a message body - channel (
basestring
) – a channel name
-
channel
¶ The channel name.
- messaged_at (
-
class
irclog.messages.
BaseNickMessage
(messaged_at, to)[source]¶ Bases:
irclog.messages.BaseMessage
Abstract base type for nickname changing message types.
Parameters: - messaged_at (
datetime.datetime
) – adatetime.datetime
logged - to (
basestring
) – a new nickname
-
to
¶ The new nickname.
- messaged_at (
-
class
irclog.messages.
NickMessage
(messaged_at, from_, to)[source]¶ Bases:
irclog.messages.BaseNickMessage
Nickname changing message type.
Parameters: - messaged_at (
datetime.datetime
) – adatetime.datetime
logged - from (
basestring
) – a old nickname - to (
basestring
) – a new nickname
-
from_
¶ The old nickname.
- messaged_at (
-
class
irclog.messages.
SelfNickMessage
(messaged_at, to)[source]¶ Bases:
irclog.messages.BaseNickMessage
My nickname chaning message type.
Parameters: - messaged_at (
datetime.datetime
) – adatetime.datetime
logged - to (
basestring
) – a new nickname
- messaged_at (
-
class
irclog.messages.
JoinMessage
(messaged_at, nick, ident, channel)[source]¶ Bases:
irclog.messages.BaseMessage
Join message type.
Parameters: - messaged_at (
datetime.datetime
) – adatetime.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.
- messaged_at (
-
class
irclog.messages.
ModeMessage
(messaged_at, server, channel, modelist, nick)[source]¶ Bases:
irclog.messages.BaseMessage
MODE
message type.Parameters: - messaged_at (
datetime.datetime
) – adatetime.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.
- messaged_at (
-
class
irclog.messages.
PartMessage
(messaged_at, nick, ident, channel, reason)[source]¶ 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.
- nick (
-
class
irclog.messages.
QuitMessage
(messaged_at, nick, ident, reason)[source]¶ 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.
- nick (
-
class
irclog.messages.
KickMessage
(messaged_at, nick, channel, by, reason)[source]¶ 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.
- nick (
-
class
irclog.messages.
BaseTopicMessage
(messaged_at, nick, channel)[source]¶ Bases:
irclog.messages.BaseMessage
Abstract base class for topic changing message types.
Parameters: - messaged_at (
datetime.datetime
) – adatetime.datetime
logged - nick (
basestring
) – a nickname - channel (
basestring
) – a channel name
-
nick
¶ The nickname.
-
channel
¶ The channel name.
- messaged_at (
-
class
irclog.messages.
TopicMessage
(messaged_at, nick, channel, topic)[source]¶ Bases:
irclog.messages.BaseTopicMessage
Topic changing message types.
Parameters: - messaged_at (
datetime.datetime
) – adatetime.datetime
logged - nick (
basestring
) – a nickname - channel (
basestring
) – a channel name - topic (
basestring
) – a new topic
-
topic
¶ The new topic
- messaged_at (
-
class
irclog.messages.
NoTopicMessage
(messaged_at, nick, channel)[source]¶ Bases:
irclog.messages.BaseTopicMessage
Empty topic message types.
Parameters: - messaged_at (
datetime.datetime
) – adatetime.datetime
logged - nick (
basestring
) – a nickname - channel (
basestring
) – a channel name
- messaged_at (