python-frontmatter 0.2.0__tar.gz → 0.3.0__tar.gz

{python-frontmatter-0.2.0 → Users/chris_amico/code/frontmatter/lib/python2.7/site-packages}/frontmatter/__init__.py

@@ -6,53 +6,70 @@ from __future__ import unicode_literals
 
 import codecs
 import re
-import yaml
 
+import six
+
+import yaml
 try:
     from yaml import CSafeDumper as SafeDumper
 except ImportError:
     from yaml import SafeDumper
 
 from .util import u
+from .handlers import YAMLHandler, JSONHandler, TOMLHandler
 
-__all__ = ['parse', 'load', 'loads', 'dump', 'dumps']
 
-# match three or more dashes
-# split on this
-FM_BOUNDARY = re.compile(r'^-{3,}$', re.MULTILINE)
+__all__ = ['parse', 'load', 'loads', 'dump', 'dumps']
 
 POST_TEMPLATE = """\
----
+{start_delimiter}
 {metadata}
----
+{end_delimiter}
 
 {content}
 """
 
+# global handlers
+handlers = {
+    '---': YAMLHandler(),
+    '{': JSONHandler(),
+}
+
+# if toml is installed
+if TOMLHandler is not None:
+    handlers['+++'] = TOMLHandler()
+
 
 def parse(text, **defaults):
     """
-    Parse text with YAML frontmatter, return metadata and content.
+    Parse text with frontmatter, return metadata and content.
     Pass in optional metadata defaults as keyword args.
 
     If frontmatter is not found, returns an empty metadata dictionary
-    and original text content.
+    (or defaults) and original text content.
     """
     # ensure unicode first
-    text = u(text)
+    text = u(text).strip()
 
     # metadata starts with defaults
     metadata = defaults.copy()
 
-    # split on the first two triple-dashes
+    for delim in handlers:
+        if text.startswith(delim):
+            handler = handlers[delim]
+            break
+    else:
+        return metadata, text
+
+    # split on the delimiters
     try:
-        _, fm, content = FM_BOUNDARY.split(text, 2)
+        fm, content = handler.split(text)
     except ValueError:
         # if we can't split, bail
         return metadata, text
 
-    # parse yaml, now that we have frontmatter
-    fm = yaml.safe_load(fm)
+    # parse, now that we have frontmatter
+    fm = handler.load(fm)
     if isinstance(fm, dict):
         metadata.update(fm)
 
@@ -100,23 +117,30 @@ def dumps(post, **kwargs):
     """
     kwargs.setdefault('Dumper', SafeDumper)
     kwargs.setdefault('default_flow_style', False)
+    
+    start_delimiter = kwargs.pop('start_delimiter', '---')
+    end_delimiter = kwargs.pop('end_delimiter', '---')
 
     metadata = yaml.dump(post.metadata, **kwargs).strip()
     metadata = u(metadata) # ensure unicode
-    return POST_TEMPLATE.format(metadata=metadata, content=post.content).strip()
+
+    return POST_TEMPLATE.format(
+        metadata=metadata, content=post.content,
+        start_delimiter=start_delimiter,
+        end_delimiter=end_delimiter).strip()
 
 
 class Post(object):
     """
-    A post contains content and metadata from YAML Front Matter.
+    A post contains content and metadata from Front Matter.
     For convenience, metadata values are available as proxied item lookups. 
 
     Don't use this class directly. Use module-level functions load, dump, etc.
     """
     def __init__(self, content, **metadata):
-        self.content = content
+        self.content = u(content)
         self.metadata = metadata
-    
+
     def __getitem__(self, name):
         "Get metadata key"
         return self.metadata[name]        
@@ -129,6 +153,17 @@ class Post(object):
         "Delete a metadata key"
         del self.metadata[name]
 
+    def __bytes__(self):
+        return self.content.encode('utf-8')
+
+    def __str__(self):
+        if six.PY2:
+            return self.__bytes__()
+        return self.content
+
+    def __unicode__(self):
+        return self.content
+
     def get(self, key, default=None):
         "Get a key, fallback to default"
         return self.metadata.get(key, default)

Users/chris_amico/code/frontmatter/lib/python2.7/site-packages/frontmatter/handlers.py

@@ -0,0 +1,67 @@
+"""
+Handlers for various kinds of metadata, including YAML, JSON and TOML
+"""
+from __future__ import unicode_literals
+
+import json
+import re
+import yaml
+
+try:
+    import toml
+except ImportError:
+    toml = None
+
+
+class BaseHandler(object):
+    FM_BOUNDARY = None
+
+    def __init__(self, fm_boundary=None):
+        self.FM_BOUNDARY = fm_boundary or self.FM_BOUNDARY
+
+        if self.FM_BOUNDARY is None:
+            raise NotImplementedError('No frontmatter boundary defined. '
+                'Please set {}.FM_BOUNDARY to a regular expression'.format(self.__class__.__name__))
+
+    def load(self, fm):
+        """
+        Parse frontmatter and return a dict
+        """
+        raise NotImplementedError
+
+    def split(self, text):
+        """
+        Split text into frontmatter and content
+        """
+        _, fm, content = self.FM_BOUNDARY.split(text, 2)
+        return fm, content
+
+
+class YAMLHandler(BaseHandler):
+    FM_BOUNDARY = re.compile(r'^-{3,}$', re.MULTILINE)
+
+    def load(self, fm):
+        return yaml.safe_load(fm)
+
+
+
+class JSONHandler(BaseHandler):
+    FM_BOUNDARY = re.compile(r'^(?:{|})$', re.MULTILINE)
+
+    def load(self, fm):
+        return json.loads(fm)
+
+    def split(self, text):
+        _, fm, content = self.FM_BOUNDARY.split(text, 2)
+        return "{" + fm + "}", content
+
+
+if toml:
+    class TOMLHandler(BaseHandler):
+        FM_BOUNDARY = re.compile(r'^\+{3,}$', re.MULTILINE)
+
+        def load(self, fm):
+            return toml.loads(fm)
+
+else:
+    TOMLHandler = None

{python-frontmatter-0.2.0 → Users/chris_amico/code/frontmatter/lib/python2.7/site-packages}/frontmatter/util.py

@@ -8,6 +8,8 @@ def u(text, encoding='utf-8'):
     "Return unicode text, no matter what"
 
     if isinstance(text, six.binary_type):
-        return text.decode(encoding)
+        text = text.decode(encoding)
 
-    return six.text_type(text)
+    # it's already unicode
+    text = text.replace('\r\n', '\n')
+    return text

{python-frontmatter-0.2.0/python_frontmatter.egg-info → Users/chris_amico/code/frontmatter/lib/python2.7/site-packages/python_frontmatter-0.3.0-py2.7.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 1.0
+Metadata-Version: 1.1
 Name: python-frontmatter
-Version: 0.2.0
+Version: 0.3.0
 Summary: Parse and manage posts with YAML frontmatter
 Home-page: https://github.com/eyeseast/python-frontmatter
 Author: Chris Amico
@@ -15,6 +15,12 @@ Description: Python Frontmatter
         
         [![Build Status](https://travis-ci.org/eyeseast/python-frontmatter.svg?branch=master)](https://travis-ci.org/eyeseast/python-frontmatter)
         
+        Install:
+        --------
+        
+            pip install python-frontmatter
+        
+        
         Usage:
         ------
         
@@ -39,6 +45,11 @@ Description: Python Frontmatter
             >>> print(post.content)
             Well, hello there, world.
         
+            # this works, too
+            >>> print(post)
+            Well, hello there, world.
+        
+        
         Use metadata (metadata gets proxied as post keys):
         
             >>> print(post['title'])
@@ -88,7 +99,7 @@ Description: Python Frontmatter
         
 Keywords: frontmatter
 Platform: UNKNOWN
-Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English

{python-frontmatter-0.2.0/python_frontmatter.egg-info → Users/chris_amico/code/frontmatter/lib/python2.7/site-packages/python_frontmatter-0.3.0-py2.7.egg-info}/SOURCES.txt

@@ -3,6 +3,7 @@ MANIFEST.in
 README.md
 setup.py
 frontmatter/__init__.py
+frontmatter/handlers.py
 frontmatter/util.py
 python_frontmatter.egg-info/PKG-INFO
 python_frontmatter.egg-info/SOURCES.txt
@@ -13,7 +14,9 @@ python_frontmatter.egg-info/top_level.txt
 tests/chinese.txt
 tests/empty-frontmatter.txt
 tests/extra-dash.txt
+tests/hello-json.markdown
 tests/hello-markdown.markdown
+tests/hello-toml.markdown
 tests/hello-world.markdown
 tests/network-diagrams.markdown
 tests/no-frontmatter.txt

{python-frontmatter-0.2.0/python_frontmatter.egg-info → Users/chris_amico/code/frontmatter/lib/python2.7/site-packages/python_frontmatter-0.3.0-py2.7.egg-info}/requires.txt

@@ -1,2 +1,2 @@
 PyYAML
-six
+six

python-frontmatter-0.2.0/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2014 Chris Amico, Glass Eye Media LLC
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

python-frontmatter-0.2.0/MANIFEST.in

@@ -1,6 +0,0 @@
-include LICENSE
-include README.md
-
-recursive-include tests *
-
-exclude *.py[co]

python-frontmatter-0.2.0/PKG-INFO

@@ -1,100 +0,0 @@
-Metadata-Version: 1.0
-Name: python-frontmatter
-Version: 0.2.0
-Summary: Parse and manage posts with YAML frontmatter
-Home-page: https://github.com/eyeseast/python-frontmatter
-Author: Chris Amico
-Author-email: eyeseast@gmail.com
-License: MIT
-Description: Python Frontmatter
-        ==================
-        
-        [Jekyll](http://jekyllrb.com/)-style YAML front matter offers a useful way to add arbitrary, structured metadata to text documents, regardless of type.
-        
-        This is a small package to load and parse files (or just text) with YAML front matter.
-        
-        [![Build Status](https://travis-ci.org/eyeseast/python-frontmatter.svg?branch=master)](https://travis-ci.org/eyeseast/python-frontmatter)
-        
-        Usage:
-        ------
-        
-            >>> import frontmatter
-        
-        Load a post from a filename:
-        
-            >>> post = frontmatter.load('tests/hello-world.markdown')
-        
-        Or a file (or file-like object):
-        
-            >>> with open('tests/hello-world.markdown') as f:
-            ...     post = frontmatter.load(f)
-        
-        Or load from text:
-        
-            >>> with open('tests/hello-world.markdown') as f:
-            ...     post = frontmatter.loads(f.read())
-        
-        Access content:
-        
-            >>> print(post.content)
-            Well, hello there, world.
-        
-        Use metadata (metadata gets proxied as post keys):
-        
-            >>> print(post['title'])
-            Hello, world!
-        
-        Metadata is a dictionary, with some handy proxies:
-        
-            >>> sorted(post.keys())
-            ['layout', 'title']
-        
-            >>> from pprint import pprint
-            >>> post['excerpt'] = 'tl;dr'
-            >>> pprint(post.metadata)
-            {'excerpt': 'tl;dr', 'layout': 'post', 'title': 'Hello, world!'}
-        
-        If you don't need the whole post object, just parse:
-        
-            >>> with open('tests/hello-world.markdown') as f:
-            ...     metadata, content = frontmatter.parse(f.read())
-            >>> print(metadata['title'])
-            Hello, world!
-        
-        Write back to plain text, too:
-        
-            >>> print(frontmatter.dumps(post)) # doctest: +NORMALIZE_WHITESPACE
-            ---
-            excerpt: tl;dr
-            layout: post
-            title: Hello, world!
-            ---
-            Well, hello there, world.
-        
-        Or write to a file (or file-like object):
-        
-            >>> from io import StringIO
-            >>> f = StringIO()
-            >>> frontmatter.dump(post, f)
-            >>> print(f.getvalue()) # doctest: +NORMALIZE_WHITESPACE
-            ---
-            excerpt: tl;dr
-            layout: post
-            title: Hello, world!
-            ---
-            Well, hello there, world.
-        
-        
-        
-Keywords: frontmatter
-Platform: UNKNOWN
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.6
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.3
-Classifier: Programming Language :: Python :: 3.4

python-frontmatter-0.2.0/README.md

@@ -1,79 +0,0 @@
-Python Frontmatter
-==================
-
-[Jekyll](http://jekyllrb.com/)-style YAML front matter offers a useful way to add arbitrary, structured metadata to text documents, regardless of type.
-
-This is a small package to load and parse files (or just text) with YAML front matter.
-
-[![Build Status](https://travis-ci.org/eyeseast/python-frontmatter.svg?branch=master)](https://travis-ci.org/eyeseast/python-frontmatter)
-
-Usage:
-------
-
-    >>> import frontmatter
-
-Load a post from a filename:
-
-    >>> post = frontmatter.load('tests/hello-world.markdown')
-
-Or a file (or file-like object):
-
-    >>> with open('tests/hello-world.markdown') as f:
-    ...     post = frontmatter.load(f)
-
-Or load from text:
-
-    >>> with open('tests/hello-world.markdown') as f:
-    ...     post = frontmatter.loads(f.read())
-
-Access content:
-
-    >>> print(post.content)
-    Well, hello there, world.
-
-Use metadata (metadata gets proxied as post keys):
-
-    >>> print(post['title'])
-    Hello, world!
-
-Metadata is a dictionary, with some handy proxies:
-
-    >>> sorted(post.keys())
-    ['layout', 'title']
-
-    >>> from pprint import pprint
-    >>> post['excerpt'] = 'tl;dr'
-    >>> pprint(post.metadata)
-    {'excerpt': 'tl;dr', 'layout': 'post', 'title': 'Hello, world!'}
-
-If you don't need the whole post object, just parse:
-
-    >>> with open('tests/hello-world.markdown') as f:
-    ...     metadata, content = frontmatter.parse(f.read())
-    >>> print(metadata['title'])
-    Hello, world!
-
-Write back to plain text, too:
-
-    >>> print(frontmatter.dumps(post)) # doctest: +NORMALIZE_WHITESPACE
-    ---
-    excerpt: tl;dr
-    layout: post
-    title: Hello, world!
-    ---
-    Well, hello there, world.
-
-Or write to a file (or file-like object):
-
-    >>> from io import StringIO
-    >>> f = StringIO()
-    >>> frontmatter.dump(post, f)
-    >>> print(f.getvalue()) # doctest: +NORMALIZE_WHITESPACE
-    ---
-    excerpt: tl;dr
-    layout: post
-    title: Hello, world!
-    ---
-    Well, hello there, world.
-
-

python-frontmatter-0.2.0/setup.cfg

@@ -1,5 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-tag_svn_revision = 0
-

python-frontmatter-0.2.0/setup.py

@@ -1,50 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-try:
-    from setuptools import setup
-except ImportError:
-    from distutils.core import setup
-
-
-with open('README.md') as f:
-    readme = f.read()
-
-
-requirements = [
-    'PyYAML',
-    'six'
-]
-
-
-VERSION = '0.2.0'
-
-
-setup(
-    name = 'python-frontmatter',
-    version = VERSION,
-    description = 'Parse and manage posts with YAML frontmatter',
-    long_description = readme,
-    author = 'Chris Amico',
-    author_email = 'eyeseast@gmail.com',
-    url = 'https://github.com/eyeseast/python-frontmatter',
-    packages = ['frontmatter'],
-    include_package_data = True,
-    install_requires = requirements,
-    license = 'MIT',
-    zip_safe = False,
-    keywords = 'frontmatter',
-    classifiers=[
-        'Development Status :: 2 - Pre-Alpha',
-        'Intended Audience :: Developers',
-        'License :: OSI Approved :: MIT License',
-        'Natural Language :: English',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.6',
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.3',
-        'Programming Language :: Python :: 3.4',
-    ],
-    test_suite='test',
-)

python-frontmatter-0.2.0/tests/chinese.txt

@@ -1,5 +0,0 @@
----
-title: "Let's try unicode"
----
-
-欢迎来到大连水产学院！

python-frontmatter-0.2.0/tests/empty-frontmatter.txt

@@ -1,4 +0,0 @@
----
----
-
-I have frontmatter but no metadata.

python-frontmatter-0.2.0/tests/extra-dash.txt

@@ -1,6 +0,0 @@
-----
-test: bob
-else: kate
-----
-
-Here's some content.

python-frontmatter-0.2.0/tests/hello-markdown.markdown

@@ -1,18 +0,0 @@
----
-test: tester
-author: bob
-something: else
----
-
-Title
-=====
-
-title2
-------
-
-Hello.
-
-Just need three dashes
----
-
-And this might break.

python-frontmatter-0.2.0/tests/hello-world.markdown

@@ -1,6 +0,0 @@
----
-title: Hello, world!
-layout: post
----
-
-Well, hello there, world.

python-frontmatter-0.2.0/tests/network-diagrams.markdown

@@ -1,12 +0,0 @@
----
-title: "TODO: Understand Network Diagrams"
-layout: post
-published: true
-tags: [todo]
----
-
-Kim Rees, sitting in for Nathan Yau at [Flowing Data](http://flowingdata.com), has been posting examples of [network diagrams](http://flowingdata.com/category/visualization/network-visualization/) lately. I have to confess I'm stumped by most of them them. Or maybe I'm just overwhelmed. Maybe I'm [not alone](http://flowingdata.com/2012/05/28/network-diagrams-simplified/):
-
-> Network diagrams are notoriously messy. Even a small number of nodes can be overwhelmed by their chaotic placement and relationships. [Cody Dunne](http://www.cs.umd.edu/~cdunne/) of [HCIL](http://www.cs.umd.edu/hcil/) showed off [his new work in simplifying these complex structures](http://www.cs.umd.edu/localphp/hcil/tech-reports-search.php?number=2012-11). In essence, he aggregates leaf nodes into a fan glyph that describes the underlying data in its size, arc, and color. Span nodes are similarly captured into crescent glyphs. The result is an easy to read, high level look at the network. You can easily compare different sections of the network, understand areas that may have been occluded by the lines in a traditional diagram, and see relationships far more quickly.
-
-This seems like the kind of thing that could be useful for news, where we're often trying to understand and illustrate complex relationships. I'll have to find a good dataset to play with.

python-frontmatter-0.2.0/tests/no-frontmatter.txt

@@ -1 +0,0 @@
-I have no frontmatter.

python-frontmatter-0.2.0/tests/unpretty.md

@@ -1,21 +0,0 @@
----
-destination:
-  encoding:
-    xz:
-      enabled: true
-      min_size: 5120
-      options:
-      path_filter:
-  result:
-    append_to_file:
-    append_to_lafs_dir:
-    print_to_stdout: true
-  url: http://localhost:3456/uri
-filter:
-  - 'Длинный стринг на русском'
-  - 'Еще одна длинная строка'
----
-
-This is a test of both unicode and prettier dumping. The above metadata comes from the [pretty-yaml](https://github.com/mk-fg/pretty-yaml) readme file.
-
-Metadata should be dumped in order.