view core/markup.py @ 842:b8c401cf99ca

For issue #77, add comments to contests.
author Brian Neal <bgneal@gmail.com>
date Sun, 12 Oct 2014 14:59:43 -0500
parents 7429c98c8ece
children 32ebe22f0cad
line wrap: on
line source
"""
Markup related utitlities useful for the entire project.
"""
import markdown as _markdown
from django.utils.encoding import force_unicode

from smiley import SmilifyMarkdown

class Markdown(object):
    """
    This is a thin wrapper around the Markdown class.

    """
    def __init__(self, safe_mode='escape'):
        self.md = _markdown.Markdown(safe_mode=safe_mode,
                                extensions=['urlize', 'nl2br', 'del'])

    def convert(self, s):
        return self.md.convert(force_unicode(s))


def markdown(s):
    """
    A convenience function for one-off markdown jobs.
    """
    md = Markdown()
    return md.convert(s)


class SiteMarkup(object):
    """
    This class provides site markup by combining markdown and
    our own smiley markup.

    The relative_urls parameter controls whether the smileys are generated with
    relative or absolute URLs.

    """
    def __init__(self, relative_urls=True):
        self.md = Markdown()
        self.smiley = SmilifyMarkdown(relative_urls=relative_urls)

    def convert(self, s):
        return self.md.convert(self.smiley.convert(s))


def site_markup(s, relative_urls=True):
    """
    Convenience function for one-off site markup jobs.
    """
    sm = SiteMarkup(relative_urls=relative_urls)
    return sm.convert(s)