| # markdown is released under the BSD license |
| # Copyright 2007, 2008 The Python Markdown Project (v. 1.7 and later) |
| # Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b) |
| # Copyright 2004 Manfred Stienstra (the original version) |
| # |
| # All rights reserved. |
| # |
| # Redistribution and use in source and binary forms, with or without |
| # modification, are permitted provided that the following conditions are met: |
| # |
| # * Redistributions of source code must retain the above copyright |
| # notice, this list of conditions and the following disclaimer. |
| # * Redistributions in binary form must reproduce the above copyright |
| # notice, this list of conditions and the following disclaimer in the |
| # documentation and/or other materials provided with the distribution. |
| # * Neither the name of the <organization> nor the |
| # names of its contributors may be used to endorse or promote products |
| # derived from this software without specific prior written permission. |
| # |
| # THIS SOFTWARE IS PROVIDED BY THE PYTHON MARKDOWN PROJECT ''AS IS'' AND ANY |
| # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| # DISCLAIMED. IN NO EVENT SHALL ANY CONTRIBUTORS TO THE PYTHON MARKDOWN PROJECT |
| # BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| # POSSIBILITY OF SUCH DAMAGE. |
| |
| |
| """ |
| Meta Data Extension for Python-Markdown |
| ======================================= |
| |
| This extension adds Meta Data handling to markdown. |
| |
| Basic Usage: |
| |
| >>> import markdown |
| >>> text = '''Title: A Test Doc. |
| ... Author: Waylan Limberg |
| ... John Doe |
| ... Blank_Data: |
| ... |
| ... The body. This is paragraph one. |
| ... ''' |
| >>> md = markdown.Markdown(['meta']) |
| >>> print md.convert(text) |
| <p>The body. This is paragraph one.</p> |
| >>> print md.Meta |
| {u'blank_data': [u''], u'author': [u'Waylan Limberg', u'John Doe'], u'title': [u'A Test Doc.']} |
| |
| Make sure text without Meta Data still works (markdown < 1.6b returns a <p>). |
| |
| >>> text = ' Some Code - not extra lines of meta data.' |
| >>> md = markdown.Markdown(['meta']) |
| >>> print md.convert(text) |
| <pre><code>Some Code - not extra lines of meta data. |
| </code></pre> |
| >>> md.Meta |
| {} |
| |
| Copyright 2007-2008 [Waylan Limberg](http://achinghead.com). |
| |
| Project website: <http://packages.python.org/Markdown/meta_data.html> |
| Contact: markdown@freewisdom.org |
| |
| License: BSD (see ../LICENSE.md for details) |
| |
| """ |
| |
| from __future__ import absolute_import |
| from __future__ import unicode_literals |
| from . import Extension |
| from ..preprocessors import Preprocessor |
| import re |
| |
| # Global Vars |
| META_RE = re.compile(r'^[ ]{0,3}(?P<key>[A-Za-z0-9_-]+):\s*(?P<value>.*)') |
| META_MORE_RE = re.compile(r'^[ ]{4,}(?P<value>.*)') |
| |
| class MetaExtension (Extension): |
| """ Meta-Data extension for Python-Markdown. """ |
| |
| def extendMarkdown(self, md, md_globals): |
| """ Add MetaPreprocessor to Markdown instance. """ |
| |
| md.preprocessors.add("meta", MetaPreprocessor(md), "_begin") |
| |
| |
| class MetaPreprocessor(Preprocessor): |
| """ Get Meta-Data. """ |
| |
| def run(self, lines): |
| """ Parse Meta-Data and store in Markdown.Meta. """ |
| meta = {} |
| key = None |
| while 1: |
| line = lines.pop(0) |
| if line.strip() == '': |
| break # blank line - done |
| m1 = META_RE.match(line) |
| if m1: |
| key = m1.group('key').lower().strip() |
| value = m1.group('value').strip() |
| try: |
| meta[key].append(value) |
| except KeyError: |
| meta[key] = [value] |
| else: |
| m2 = META_MORE_RE.match(line) |
| if m2 and key: |
| # Add another line to existing key |
| meta[key].append(m2.group('value').strip()) |
| else: |
| lines.insert(0, line) |
| break # no meta data - done |
| self.markdown.Meta = meta |
| return lines |
| |
| |
| def makeExtension(configs={}): |
| return MetaExtension(configs=configs) |