diff options
author | Waylan Limberg <waylan.limberg@icloud.com> | 2014-11-20 16:07:03 -0500 |
---|---|---|
committer | Waylan Limberg <waylan.limberg@icloud.com> | 2014-11-20 16:07:03 -0500 |
commit | 8f66a94eab1389d97041944ed24afd2bf7c4389c (patch) | |
tree | 10b53664076650be951468cbbb163f3d637e5891 /markdown/blockparser.py | |
parent | 0c2143819ef7de53be52f7a4d47e027ff194a9b4 (diff) | |
download | markdown-8f66a94eab1389d97041944ed24afd2bf7c4389c.tar.gz markdown-8f66a94eab1389d97041944ed24afd2bf7c4389c.tar.bz2 markdown-8f66a94eab1389d97041944ed24afd2bf7c4389c.zip |
Flake8 cleanup (mostly whitespace).
Got all but a couple files in the tests (ran out of time today).
Apparently I have been using some bad form for years (although a few
things seemed to look better before the update). Anyway, conformant now.
Diffstat (limited to 'markdown/blockparser.py')
-rw-r--r-- | markdown/blockparser.py | 51 |
1 files changed, 26 insertions, 25 deletions
diff --git a/markdown/blockparser.py b/markdown/blockparser.py index 4504a16..32d3254 100644 --- a/markdown/blockparser.py +++ b/markdown/blockparser.py @@ -3,16 +3,17 @@ from __future__ import absolute_import from . import util from . import odict + 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 + """ 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 + 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. @@ -36,9 +37,10 @@ class State(list): else: return False + class BlockParser: - """ Parse Markdown blocks into an ElementTree object. - + """ Parse Markdown blocks into an ElementTree object. + A wrapper class that stitches the various BlockProcessors together, looping through them and creating an ElementTree object. """ @@ -49,12 +51,12 @@ class BlockParser: self.markdown = markdown 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. - + """ 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. """ @@ -64,29 +66,30 @@ class BlockParser: return util.etree.ElementTree(self.root) def parseChunk(self, parent, text): - """ Parse a chunk of markdown text and attach to given etree node. - + """ 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. + 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. - + """ 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. + 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. + 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: @@ -95,5 +98,3 @@ class BlockParser: if processor.run(parent, blocks) is not False: # run returns True or None break - - |