Mercurial > piecrust2

annotate piecrust/formatting/markdownformatter.py @ 182:a54d3c0b5f4a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
tests: Patch `os.path.exists` and improve patching for `open`. You can specify additional modules for which to patch `open`. Also, it was incorrectly updating the opened file, even when it was opened for read only. Now it only updates the contents if the file was opened for write, and supports appending to the end. Last, it supports opening text files in binary mode.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 04 Jan 2015 14:55:41 -0800
parents fdb08d986384
children cd049786c008
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
1 from markdown import markdown
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
2 from piecrust.formatting.base import Formatter
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
3
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
4
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
5 class MarkdownFormatter(Formatter):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
6 FORMAT_NAMES = ['markdown', 'mdown', 'md']
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
7 OUTPUT_FORMAT = 'html'
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
8
20
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
9 def __init__(self):
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
10 super(MarkdownFormatter, self).__init__()
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
11 self._extensions = None
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
12
3
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
13 def render(self, format_name, txt):
76
fdb08d986384 Add SmartyPants formatting.
Ludovic Chabant <ludovic@chabant.com>
parents: 58
diff changeset
14 assert format_name in self.FORMAT_NAMES
20
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
15 self._ensureInitialized()
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
16 return markdown(txt, extensions=self._extensions)
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
17
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
18 def _ensureInitialized(self):
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
19 if self._extensions is not None:
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
20 return
3
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
21
58
95590732e4c9 More robust Markdown configuration handling.
Ludovic Chabant <ludovic@chabant.com>
parents: 20
diff changeset
22 config = self.app.config.get('markdown')
95590732e4c9 More robust Markdown configuration handling.
Ludovic Chabant <ludovic@chabant.com>
parents: 20
diff changeset
23 if config is None:
95590732e4c9 More robust Markdown configuration handling.
Ludovic Chabant <ludovic@chabant.com>
parents: 20
diff changeset
24 config = {}
95590732e4c9 More robust Markdown configuration handling.
Ludovic Chabant <ludovic@chabant.com>
parents: 20
diff changeset
25 elif not isinstance(config, dict):
95590732e4c9 More robust Markdown configuration handling.
Ludovic Chabant <ludovic@chabant.com>
parents: 20
diff changeset
26 raise Exception("The `markdown` configuration setting must be "
95590732e4c9 More robust Markdown configuration handling.
Ludovic Chabant <ludovic@chabant.com>
parents: 20
diff changeset
27 "a dictionary.")
95590732e4c9 More robust Markdown configuration handling.
Ludovic Chabant <ludovic@chabant.com>
parents: 20
diff changeset
28
95590732e4c9 More robust Markdown configuration handling.
Ludovic Chabant <ludovic@chabant.com>
parents: 20
diff changeset
29 extensions = config.get('extensions')
20
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
30 if extensions is None:
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
31 extensions = []
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
32 # Compatibility with PieCrust 1.x
58
95590732e4c9 More robust Markdown configuration handling.
Ludovic Chabant <ludovic@chabant.com>
parents: 20
diff changeset
33 if config.get('use_markdown_extra'):
20
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
34 extensions.append('extra')
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
35 self._extensions = extensions
c95c90c82263 Add support for Markdown extensions.
Ludovic Chabant <ludovic@chabant.com>
parents: 3
diff changeset
36