-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added Markdown Formatter and Full Markdown Support
Removed Old Markdown Formatter and Unused Functions Updated README Added Tags From Issue #15
- Loading branch information
Showing
50 changed files
with
7,262 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
""" | ||
Python Markdown | ||
A Python implementation of John Gruber's Markdown. | ||
Documentation: https://python-markdown.github.io/ | ||
GitHub: https://github.com/Python-Markdown/markdown/ | ||
PyPI: https://pypi.org/project/Markdown/ | ||
Started by Manfred Stienstra (http://www.dwerg.net/). | ||
Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org). | ||
Currently maintained by Waylan Limberg (https://github.com/waylan), | ||
Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser). | ||
Copyright 2007-2018 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) | ||
License: BSD (see LICENSE.md for details). | ||
""" | ||
|
||
from .core import Markdown, markdown, markdownFromFile | ||
from .__meta__ import __version__, __version_info__ # noqa | ||
|
||
# For backward compatibility as some extensions expect it... | ||
from .extensions import Extension # noqa | ||
|
||
__all__ = ['Markdown', 'markdown', 'markdownFromFile'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,151 @@ | ||
""" | ||
Python Markdown | ||
A Python implementation of John Gruber's Markdown. | ||
Documentation: https://python-markdown.github.io/ | ||
GitHub: https://github.com/Python-Markdown/markdown/ | ||
PyPI: https://pypi.org/project/Markdown/ | ||
Started by Manfred Stienstra (http://www.dwerg.net/). | ||
Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org). | ||
Currently maintained by Waylan Limberg (https://github.com/waylan), | ||
Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser). | ||
Copyright 2007-2018 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) | ||
License: BSD (see LICENSE.md for details). | ||
""" | ||
|
||
import sys | ||
import optparse | ||
import codecs | ||
import warnings | ||
import markdown | ||
try: | ||
# We use `unsafe_load` because users may need to pass in actual Python | ||
# objects. As this is only available from the CLI, the user has much | ||
# worse problems if an attacker can use this as an attach vector. | ||
from yaml import unsafe_load as yaml_load | ||
except ImportError: # pragma: no cover | ||
try: | ||
# Fall back to PyYAML <5.1 | ||
from yaml import load as yaml_load | ||
except ImportError: | ||
# Fall back to JSON | ||
from json import load as yaml_load | ||
|
||
import logging | ||
from logging import DEBUG, WARNING, CRITICAL | ||
|
||
logger = logging.getLogger('MARKDOWN') | ||
|
||
|
||
def parse_options(args=None, values=None): | ||
""" | ||
Define and parse `optparse` options for command-line usage. | ||
""" | ||
usage = """%prog [options] [INPUTFILE] | ||
(STDIN is assumed if no INPUTFILE is given)""" | ||
desc = "A Python implementation of John Gruber's Markdown. " \ | ||
"https://Python-Markdown.github.io/" | ||
ver = "%%prog %s" % markdown.__version__ | ||
|
||
parser = optparse.OptionParser(usage=usage, description=desc, version=ver) | ||
parser.add_option("-f", "--file", dest="filename", default=None, | ||
help="Write output to OUTPUT_FILE. Defaults to STDOUT.", | ||
metavar="OUTPUT_FILE") | ||
parser.add_option("-e", "--encoding", dest="encoding", | ||
help="Encoding for input and output files.",) | ||
parser.add_option("-o", "--output_format", dest="output_format", | ||
default='xhtml', metavar="OUTPUT_FORMAT", | ||
help="Use output format 'xhtml' (default) or 'html'.") | ||
parser.add_option("-n", "--no_lazy_ol", dest="lazy_ol", | ||
action='store_false', default=True, | ||
help="Observe number of first item of ordered lists.") | ||
parser.add_option("-x", "--extension", action="append", dest="extensions", | ||
help="Load extension EXTENSION.", metavar="EXTENSION") | ||
parser.add_option("-c", "--extension_configs", | ||
dest="configfile", default=None, | ||
help="Read extension configurations from CONFIG_FILE. " | ||
"CONFIG_FILE must be of JSON or YAML format. YAML " | ||
"format requires that a python YAML library be " | ||
"installed. The parsed JSON or YAML must result in a " | ||
"python dictionary which would be accepted by the " | ||
"'extension_configs' keyword on the markdown.Markdown " | ||
"class. The extensions must also be loaded with the " | ||
"`--extension` option.", | ||
metavar="CONFIG_FILE") | ||
parser.add_option("-q", "--quiet", default=CRITICAL, | ||
action="store_const", const=CRITICAL+10, dest="verbose", | ||
help="Suppress all warnings.") | ||
parser.add_option("-v", "--verbose", | ||
action="store_const", const=WARNING, dest="verbose", | ||
help="Print all warnings.") | ||
parser.add_option("--noisy", | ||
action="store_const", const=DEBUG, dest="verbose", | ||
help="Print debug messages.") | ||
|
||
(options, args) = parser.parse_args(args, values) | ||
|
||
if len(args) == 0: | ||
input_file = None | ||
else: | ||
input_file = args[0] | ||
|
||
if not options.extensions: | ||
options.extensions = [] | ||
|
||
extension_configs = {} | ||
if options.configfile: | ||
with codecs.open( | ||
options.configfile, mode="r", encoding=options.encoding | ||
) as fp: | ||
try: | ||
extension_configs = yaml_load(fp) | ||
except Exception as e: | ||
message = "Failed parsing extension config file: %s" % \ | ||
options.configfile | ||
e.args = (message,) + e.args[1:] | ||
raise | ||
|
||
opts = { | ||
'input': input_file, | ||
'output': options.filename, | ||
'extensions': options.extensions, | ||
'extension_configs': extension_configs, | ||
'encoding': options.encoding, | ||
'output_format': options.output_format, | ||
'lazy_ol': options.lazy_ol | ||
} | ||
|
||
return opts, options.verbose | ||
|
||
|
||
def run(): # pragma: no cover | ||
"""Run Markdown from the command line.""" | ||
|
||
# Parse options and adjust logging level if necessary | ||
options, logging_level = parse_options() | ||
if not options: | ||
sys.exit(2) | ||
logger.setLevel(logging_level) | ||
console_handler = logging.StreamHandler() | ||
logger.addHandler(console_handler) | ||
if logging_level <= WARNING: | ||
# Ensure deprecation warnings get displayed | ||
warnings.filterwarnings('default') | ||
logging.captureWarnings(True) | ||
warn_logger = logging.getLogger('py.warnings') | ||
warn_logger.addHandler(console_handler) | ||
|
||
# Run | ||
markdown.markdownFromFile(**options) | ||
|
||
|
||
if __name__ == '__main__': # pragma: no cover | ||
# Support running module as a commandline command. | ||
# `python -m markdown [options] [args]`. | ||
run() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
""" | ||
Python Markdown | ||
A Python implementation of John Gruber's Markdown. | ||
Documentation: https://python-markdown.github.io/ | ||
GitHub: https://github.com/Python-Markdown/markdown/ | ||
PyPI: https://pypi.org/project/Markdown/ | ||
Started by Manfred Stienstra (http://www.dwerg.net/). | ||
Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org). | ||
Currently maintained by Waylan Limberg (https://github.com/waylan), | ||
Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser). | ||
Copyright 2007-2018 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) | ||
License: BSD (see LICENSE.md for details). | ||
""" | ||
|
||
# __version_info__ format: | ||
# (major, minor, patch, dev/alpha/beta/rc/final, #) | ||
# (1, 1, 2, 'dev', 0) => "1.1.2.dev0" | ||
# (1, 1, 2, 'alpha', 1) => "1.1.2a1" | ||
# (1, 2, 0, 'beta', 2) => "1.2b2" | ||
# (1, 2, 0, 'rc', 4) => "1.2rc4" | ||
# (1, 2, 0, 'final', 0) => "1.2" | ||
__version_info__ = (3, 4, 1, 'final', 0) | ||
|
||
|
||
def _get_version(version_info): | ||
" Returns a PEP 440-compliant version number from version_info. " | ||
assert len(version_info) == 5 | ||
assert version_info[3] in ('dev', 'alpha', 'beta', 'rc', 'final') | ||
|
||
parts = 2 if version_info[2] == 0 else 3 | ||
v = '.'.join(map(str, version_info[:parts])) | ||
|
||
if version_info[3] == 'dev': | ||
v += '.dev' + str(version_info[4]) | ||
elif version_info[3] != 'final': | ||
mapping = {'alpha': 'a', 'beta': 'b', 'rc': 'rc'} | ||
v += mapping[version_info[3]] + str(version_info[4]) | ||
|
||
return v | ||
|
||
|
||
__version__ = _get_version(__version_info__) |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
""" | ||
Python Markdown | ||
A Python implementation of John Gruber's Markdown. | ||
Documentation: https://python-markdown.github.io/ | ||
GitHub: https://github.com/Python-Markdown/markdown/ | ||
PyPI: https://pypi.org/project/Markdown/ | ||
Started by Manfred Stienstra (http://www.dwerg.net/). | ||
Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org). | ||
Currently maintained by Waylan Limberg (https://github.com/waylan), | ||
Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser). | ||
Copyright 2007-2018 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) | ||
License: BSD (see LICENSE.md for details). | ||
""" | ||
|
||
import xml.etree.ElementTree as etree | ||
from . import util | ||
|
||
|
||
class State(list): | ||
""" Track the current and nested state of the parser. | ||
This utility class is used to track the state of the BlockParser and | ||
support multiple levels if nesting. It's just a simple API wrapped around | ||
a list. Each time a state is set, that state is appended to the end of the | ||
list. Each time a state is reset, that state is removed from the end of | ||
the list. | ||
Therefore, each time a state is set for a nested block, that state must be | ||
reset when we back out of that level of nesting or the state could be | ||
corrupted. | ||
While all the methods of a list object are available, only the three | ||
defined below need be used. | ||
""" | ||
|
||
def set(self, state): | ||
""" Set a new state. """ | ||
self.append(state) | ||
|
||
def reset(self): | ||
""" Step back one step in nested state. """ | ||
self.pop() | ||
|
||
def isstate(self, state): | ||
""" Test that top (current) level is of given state. """ | ||
if len(self): | ||
return self[-1] == state | ||
else: | ||
return False | ||
|
||
|
||
class BlockParser: | ||
""" Parse Markdown blocks into an ElementTree object. | ||
A wrapper class that stitches the various BlockProcessors together, | ||
looping through them and creating an ElementTree object. | ||
""" | ||
|
||
def __init__(self, md): | ||
self.blockprocessors = util.Registry() | ||
self.state = State() | ||
self.md = md | ||
|
||
def parseDocument(self, lines): | ||
""" Parse a markdown document into an ElementTree. | ||
Given a list of lines, an ElementTree object (not just a parent | ||
Element) is created and the root element is passed to the parser | ||
as the parent. The ElementTree object is returned. | ||
This should only be called on an entire document, not pieces. | ||
""" | ||
# Create a ElementTree from the lines | ||
self.root = etree.Element(self.md.doc_tag) | ||
self.parseChunk(self.root, '\n'.join(lines)) | ||
return etree.ElementTree(self.root) | ||
|
||
def parseChunk(self, parent, text): | ||
""" Parse a chunk of markdown text and attach to given etree node. | ||
While the ``text`` argument is generally assumed to contain multiple | ||
blocks which will be split on blank lines, it could contain only one | ||
block. Generally, this method would be called by extensions when | ||
block parsing is required. | ||
The ``parent`` etree Element passed in is altered in place. | ||
Nothing is returned. | ||
""" | ||
self.parseBlocks(parent, text.split('\n\n')) | ||
|
||
def parseBlocks(self, parent, blocks): | ||
""" Process blocks of markdown text and attach to given etree node. | ||
Given a list of ``blocks``, each blockprocessor is stepped through | ||
until there are no blocks left. While an extension could potentially | ||
call this method directly, it's generally expected to be used | ||
internally. | ||
This is a public method as an extension may need to add/alter | ||
additional BlockProcessors which call this method to recursively | ||
parse a nested block. | ||
""" | ||
while blocks: | ||
for processor in self.blockprocessors: | ||
if processor.test(parent, blocks[0]): | ||
if processor.run(parent, blocks) is not False: | ||
# run returns True or None | ||
break |
Oops, something went wrong.