Using the Python random module with XCHAT IRC scripts

Question

I'm trying to print random items from a list into my XCHAT channel messages. So far I've only been able to print the random items from my list alone, but not with any specific text.

Example usage would be: "/ran blahblahblah" to produce the desired effect of a channel message such as "blahblahblah [random item]"

__module_name__ = "ran.py"
__module_version__ = "1.0"
__module_description__ = "script to add random text to channel messages"

import xchat
import random

def ran(message):
    message = random.choice(['test1', 'test2', 'test3', 'test4', 'test5'])
    return(message)

def ran_cb(word, word_eol, userdata):
    message = ''
    message = ran(message)
    xchat.command("msg %s %s"%(xchat.get_info('channel'), message))
    return xchat.EAT_ALL

xchat.hook_command("ran", ran_cb, help="/ran to use")

Answer 1

1. You don't allow the caller to specify the arguments to choose from.

   def ran(choices=None):
       if not choices:
           choices = ('test1', 'test2', 'test3', 'test4', 'test5')
       return random.choice(choices)
   

2. You need to get the choices from the command.

   def ran_cb(word, word_eol, userdata):
       message = ran(word_eol[1:])
       xchat.command("msg %s %s"%(xchat.get_info('channel'), message))
       return xchat.EAT_ALL