Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reset _toc when convert is run #336

Merged
merged 3 commits into from Nov 25, 2019
Merged

Reset _toc when convert is run #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5628b51
Reset _toc every time markdown conversion happens
ryanvilbrandt Nov 23, 2019
b7946eb
Added unit test for toc_html fix
ryanvilbrandt Nov 25, 2019
83f8068
Added unit test tags property. Not sure if necessary.
ryanvilbrandt Nov 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion lib/markdown2.py
View file
Open in desktop
Expand Up @@ -202,6 +202,8 @@ class Markdown(object):
html_spans = None
html_removed_text = "[HTML_REMOVED]" # for compat with markdown.py

_toc = None

# Used to track when we're inside an ordered or unordered list
# (see _ProcessListItems() for details):
list_level = 0
Expand Down Expand Up @@ -273,6 +275,7 @@ def reset(self):
self._count_from_header_id = defaultdict(int)
if "metadata" in self.extras:
self.metadata = {}
self._toc = None

# Per <https://developer.mozilla.org/en-US/docs/HTML/Element/a> "rel"
# should only be used in <a> tags with an "href" attribute.
Expand Down Expand Up @@ -1509,7 +1512,6 @@ def header_id_from_text(self, text, prefix, n):

return header_id

_toc = None
def _toc_add_entry(self, level, id, name):
if level > self._toc_depth:
return
Expand Down
46 changes: 46 additions & 0 deletions test/test_markdown2.py
View file
Open in desktop
Expand Up @@ -291,6 +291,52 @@ def test_russian(self):
'<h2>%s</h2>\n' % ko)
test_russian.tags = ["unicode", "issue3"]

def test_toc_with_persistent_object(self):
"""
Tests that the toc is the same every time it's run on HTML, even if the Markdown object isn't disposed of.
"""
md = markdown2.Markdown(extras=["toc"])
html = """
# Header 1
## Header 1.1
## Header 1.2
### Header 1.3
# Header 2
## Header 2.1
"""
expected_toc_html = """<ul>
<li><a href="#header-1">Header 1</a>
<ul>
<li><a href="#header-11">Header 1.1</a></li>
<li><a href="#header-12">Header 1.2</a>
<ul>
<li><a href="#header-13">Header 1.3</a></li>
</ul></li>
</ul></li>
<li><a href="#header-2">Header 2</a>
<ul>
<li><a href="#header-21">Header 2.1</a></li>
</ul></li>
</ul>
"""
self.assertEqual(expected_toc_html, md.convert(html).toc_html)
# Do it again, to check if the toc_html is just appended rather than replaced
self.assertEqual(expected_toc_html, md.convert(html).toc_html)
# Create different html, and confirm toc_html is replaced
html = """
# I'm new html
## I don't have to be long, just different
"""
expected_toc_html = """<ul>
<li><a href="#im-new-html">I'm new html</a>
<ul>
<li><a href="#i-dont-have-to-be-long-just-different">I don't have to be long, just different</a></li>
</ul></li>
</ul>
"""
self.assertEqual(expected_toc_html, md.convert(html).toc_html)
test_toc_with_persistent_object.tags = ["toc", "issue208"]


class DocTestsTestCase(unittest.TestCase):
def test_api(self):
Expand Down