sopel-irc / sopel

    return actual_decorator

def require_chanmsg(message=None, reply=False):

    """Decorate a function to only be triggerable from a channel message.

    :param str message: optional message said if triggered in private message

    :param bool reply: use :meth:`~.bot.Sopel.reply` instead of

                       :meth:`~.bot.Sopel.say` when ``True``; defaults to

                       ``False``

    If it is triggered in a private message, ``message`` will be said if

    given. By default, it uses :meth:`bot.say() <.bot.Sopel.say>`, but when

    ``reply`` is true, then it uses :meth:`bot.reply() <.bot.Sopel.reply>`

    instead.

    .. versionchanged:: 7.0.0

        Added the ``reply`` parameter.

    """

    def actual_decorator(function):

        @functools.wraps(function)

        def _nop(*args, **kwargs):

            # Assign trigger and bot for easy access later

            bot, trigger = args[0:2]

            if not trigger.is_privmsg:

                return function(*args, **kwargs)

            else:

                if message and not callable(message):

                    if reply:

                        bot.reply(message)

                    else:

                        bot.say(message)

        return _nop

    # Hack to allow decorator without parens

    return add_attribute

def require_privmsg(message=None, reply=False):

    """Decorate a function to only be triggerable from a private message.

    :param str message: optional message said if triggered in a channel

    :param bool reply: use :meth:`~sopel.bot.Sopel.reply` instead of

                       :meth:`~sopel.bot.Sopel.say` when ``True``; defaults to

                       ``False``

    If it is triggered in a channel message, ``message`` will be said if

    given. By default, it uses :meth:`bot.say() <.bot.Sopel.say>`, but when

    ``reply`` is true, then it     uses :meth:`bot.reply() <.bot.Sopel.reply>`

    instead.

    .. versionchanged:: 7.0.0

        Added the ``reply`` parameter.

    """

    def actual_decorator(function):

        @functools.wraps(function)

        def _nop(*args, **kwargs):

            # Assign trigger and bot for easy access later

            bot, trigger = args[0:2]

            if trigger.is_privmsg:

                return function(*args, **kwargs)

            else:

                if message and not callable(message):

                    if reply:

                        bot.reply(message)

                    else:

                        bot.say(message)

        return _nop

    # Hack to allow decorator without parens