admonition.py

"""
Admonition extension for Python-Markdown
========================================

Adds rST-style admonitions. Inspired by [rST][] feature with the same name.

[rST]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions

See <https://pythonhosted.org/Markdown/extensions/admonition.html> 
for documentation.

Original code Copyright [Tiago Serafim](http://www.tiagoserafim.com/).

All changes Copyright The Python Markdown Project

License: [BSD](http://www.opensource.org/licenses/bsd-license.php) 

"""

from __future__ import absolute_import
from __future__ import unicode_literals
from markdown.extensions import Extension
from markdown.blockprocessors import BlockProcessor
from markdown.util import etree
import re


class AdmonitionExtension(Extension):
    """ Admonition extension for Python-Markdown. """

    def extendMarkdown(self, md, md_globals):
        """ Add Admonition to Markdown instance. """
        md.registerExtension(self)

        md.parser.blockprocessors.add('admonition',
                                      AdmonitionProcessor(md.parser),
                                      '_begin')


class AdmonitionProcessor(BlockProcessor):

    CLASSNAME = 'alert'
    CLASSNAME_TITLE = 'alert-info'
    RE = re.compile(r'(?:^|\n)!!!\ ?([\w\-]+)(?:\ "(.*?)")? ?([\w\-]+)(?:\ "(.*?)")?')

    def test(self, parent, block):
        sibling = self.lastChild(parent)
        return self.RE.search(block) or \
            (block.startswith(' ' * self.tab_length) and sibling and \
                sibling.get('class', '').find(self.CLASSNAME) != -1)

    def run(self, parent, blocks):
        sibling = self.lastChild(parent)
        block = blocks.pop(0)
        m = self.RE.search(block)

        if m:
            block = block[m.end() + 1:]  # removes the first line

        block, theRest = self.detab(block)

        if m:
            klass, title, glyph_name = self.get_class_and_title(m)
            div = etree.SubElement(parent, 'div')
            div.set('class', '%s alert-%s' % (self.CLASSNAME, klass))
            if title:
                span = etree.SubElement(div, 'span')
                span.text = title
                span.set('class', 'sr-only')

            # doesn't really work now, we must have the glyph_name
            # otherwise title and klass matching get wonky
            if glyph_name:
                glyph = etree.SubElement(div, 'span')
                glyph.set('class', 'glyphicon glyphicon-%s' % glyph_name)
                glyph.set('style', 'float:left; padding-right: 5px;')
        else:
            div = sibling

        self.parser.parseChunk(div, block)

        if theRest:
            # This block contained unindented line(s) after the first indented
            # line. Insert these lines as the first block of the master blocks
            # list for future processing.
            blocks.insert(0, theRest)

    def get_class_and_title(self, match):
        klass, title, glyph_name = match.group(1).lower(), match.group(2), match.group(3)
        if title is None:
            # no title was provided, use the capitalized classname as title
            # e.g.: `!!! note` will render `<p class="admonition-title">Note</p>`
            title = klass.capitalize()
        elif title == '':
            # an explicit blank title should not be rendered
            # e.g.: `!!! warning ""` will *not* render `p` with a title
            title = None

        if glyph_name is None:
            glyph_name = 'exclamation-sign'
        elif glyph_name == '':
            glyph_name = None

        return klass, title, glyph_name


def makeExtension(*args, **kwargs):
    return AdmonitionExtension(*args, **kwargs)