# -*- coding: utf-8 -*-
-
-# Copyright (C) 2007-2012 Thomas Perl <thp.io/about>
-# Copyright (C) 2014, 2020 kaliko <kaliko@azylum.org>
-
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3 only.
-
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# SPDX-FileCopyrightText: 2007-2012 Thomas Perl <thp.io/about>
+# SPDX-FileCopyrightText: 2014, 2020 kaliko <kaliko@azylum.org>
+# SPDX-License-Identifier: GPL-3.0-or-later
from .plugin import Plugin, botcmd
+
class Echo(Plugin):
- """Drop a message to be sent when someone gets online.
+ """Drops a message to be sent when someone gets online.
"""
def __init__(self, bot):
# any presences you send yourself. To limit event handling
# to a single room, use the events muc::room@server::presence,
# muc::room@server::got_online, or muc::room@server::got_offline.
- bot.add_event_handler("muc::%s::presence" % self.bot.room, self.log_presence)
+ bot.add_event_handler("muc::%s::presence" %
+ self.bot.room, self.log_presence)
def log_presence(self, pres):
- """Register presence"""
+ """Handler method registering MUC participants presence"""
self.log.debug('%s: %s', pres['muc']['nick'], pres['type'])
nick = pres['muc']['nick']
self.presence.update({nick: (pres['muc']['role'], pres['type'])})
@botcmd
def tell(self, message, args):
- """drop a message to be sent when someone gets online.
- !tell queue : messages in queue
- !tell <nick> <msg> : append <msg> to <nick> in queue"""
+ """Drops a message to be sent when someone gets online.
+
+ * ``!tell queue`` : messages in queue
+ * ``!tell <nick> <msg>``: append <msg> to <nick> in queue"""
if not len(args):
msg = 'Missing arguments:\n{}'.format(self.tell.__doc__)
self.reply(message, msg)