Generic Messaging

generic_msg.py

"""Generic messaging functions.

.. module:: none
    :platform: Unix, Linux
        :synopsis: Generic messaging functions

.. moduleauthor:: jneumann

.. usage:: 
    import generic_msg
    msg = 'I am an info message'
    generic_msg.info(msg)
    warn = 'I am a warning message'
    generic_msg.warning(warn)
    prmpt = 'I am a prompt message'
    generic_msg.prompt(prmpt)
    err = 'I am an error message'
    generic_msg.error(err)
    fin = 'I am multi-colored and awesome because I am final.'
    generic_msg.final(fin)

.. notes:: You can probably take the returns out, but I 
        kept them in to maintain cleanliness (or what I view as cleanliness).

"""
# Built In
import sys
import random

# Third Party

# Custom
#------------------------------------------------------------------ Globals -#
colors = {'red': '\033[31m',
          'green': '\033[32m',
          'yellow': '\033[33m',
          'blue': '\033[34m',
          'magenta': '\033[35m',
          'white': '\033[0m'}

#---------------------------------------------------------------- Functions -#
def info(msg):
    """Information Messages

    Args:
        msg (str): The info message to output.

    """
    sys.stdout.write('%s[INFO] %s%s\n' % (colors['magenta'],
                                          msg,
                                          colors['white']))

    return

def error(msg):
    """Error Messages

    Args:
        msg (str): The error message to output.

    """
    sys.stderr.write('%s[ERROR] %s%s\n' % (colors['red'],
                                           msg,
                                           colors['white']))

    return

def warning(msg):
    """Warning Messages

    Args:
        msg (str): The warning message to output.

    """
    sys.stdout.write('%s[WARNING] %s%s\n' % (colors['yellow'],
                                             msg,
                                             colors['white']))

    return

def prompt(msg):
    """Prompt Messages

    Args:
        msg (str): The prompt message to output.
            It is up to the developer to create the call to read in input.

    """
    sys.stdout.write('%s[USER_INPUT_REQUIRED] %s%s\n' % (colors['green'],
                                                         msg,
                                                         colors['white']))
    return

def final(msg):
    """Final Messages

    Args:
        msg (str): The final message to output. (Rainbow Colored!)

    """
    final_string = []
    for out in '[FINAL] ':
        final_string.append('%s%s' % (random.choice(colors.values()),
                                      out))
    for char in msg:
        final_string.append('%s%s' % (random.choice(colors.values()),
                                      char))
    sys.stdout.write('%s%s\n' % (''.join(final_string), colors['white']))

    return