constance

commit b310f46eee5ea79e09fe3e00d6d28b41f379bb17
parent 45fd1fbee916811051f1f2cb1e85785e68ff4167
Author: Dan Callaghan <djc@djc.id.au>
Date:   Mon,  7 Apr 2008 11:55:22 +1000

python-markdown metadata extension from <https://code.achinghead.com/browser/mdx/meta/trunk/mdx_meta.py?format=raw>

committer: Dan Callaghan <djc@djc.id.au>

--HG--
extra : convert_revision : b8fedd1156fc371791edb04347749851474571ab

Diffstat:
A
mdx_meta.py
 | 
81
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

1 file changed, 81 insertions(+), 0 deletions(-)
diff --git a/mdx_meta.py b/mdx_meta.py
@@ -0,0 +1,81 @@
+#!usr/bin/python
+
+'''
+Meta Data Extension for Python-Markdown
+==========================================
+
+This extension adds Meta Data handling to markdown.
+
+    >>> import markdown
+    >>> text = """Title: A Test Doc.
+    ... Author: Waylan Limberg
+    ...         John Doe
+    ... Blank_Data:
+    ...
+    ... The body. This is paragraph one.
+    ... """
+    >>> md = markdown.Markdown(text, ['meta'])
+    >>> str(md)
+    '<p>The body. This is paragraph one.\\n</p>'
+    >>> md.Meta
+    {'blank_data': [''], 'author': ['Waylan Limberg', 'John Doe'], 'title': ['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(text, ['meta'])
+    >>> str(md)
+    '<pre><code>Some Code - not extra lines of meta data.\\n</code></pre>'
+    >>> md.Meta
+    {}
+
+'''
+
+import markdown, 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 (markdown.Extension) :
+    def __init__(self, configs):
+        pass
+
+    def extendMarkdown(self, md, md_globals) :
+        self.md = md
+
+        # Insert meta preprocessor first
+        META_PREPROCESSOR = MetaPreprocessor()
+        META_PREPROCESSOR.md = md
+        md.preprocessors.insert(0, META_PREPROCESSOR)
+        
+class MetaPreprocessor(markdown.Preprocessor) :
+    def run(self, lines) :
+        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()
+                meta[key] = [m1.group('value').strip()]
+            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.md.Meta = meta
+        return lines
+        
+
+def makeExtension(configs=None) :
+    return MetaExtension(configs=configs)
+
+if __name__ == "__main__":
+    import doctest
+    doctest.testmod()