diff options
author | Isaac Muse <faceless.shop@gmail.com> | 2020-07-27 06:52:58 -0600 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-07-27 08:52:58 -0400 |
commit | 370e17b3923d7d8f4709652bc24b695271a0210d (patch) | |
tree | 0a6f1527bb65377cdf7c6e75b56da3faf15ab942 | |
parent | 611cf6d98297f8cb79c06d2c785c885b88a12cf0 (diff) | |
download | python-markdown-370e17b3923d7d8f4709652bc24b695271a0210d.tar.gz |
Fix complex scenarios with definition, ordered, and unordered lists (#1007)
Fixes #918.
-rw-r--r-- | docs/change_log/release-3.3.md | 3 | ||||
-rw-r--r-- | markdown/extensions/def_list.py | 8 | ||||
-rw-r--r-- | tests/test_syntax/extensions/test_def_list.py | 323 |
3 files changed, 330 insertions, 4 deletions
diff --git a/docs/change_log/release-3.3.md b/docs/change_log/release-3.3.md index eb7fe7c..20272f9 100644 --- a/docs/change_log/release-3.3.md +++ b/docs/change_log/release-3.3.md @@ -75,7 +75,8 @@ The following bug fixes are included in the 3.3 release: * Avoid a `RecursionError` from deeply nested blockquotes (#799). * Fix issues with complex emphasis (#979). * Fix unescaping of HTML characters `<>` in CodeHilite (#990). -* Fix complex scenarios involving lists and admonitions (#1004) +* Fix complex scenarios involving lists and admonitions (#1004). +* Fix complex scenarios with nested ordered and unordered lists in a definition list (#918). [spec]: https://www.w3.org/TR/html5/text-level-semantics.html#the-code-element [fenced_code]: ../extensions/fenced_code_blocks.md diff --git a/markdown/extensions/def_list.py b/markdown/extensions/def_list.py index 5a6541a..0e8e452 100644 --- a/markdown/extensions/def_list.py +++ b/markdown/extensions/def_list.py @@ -87,11 +87,13 @@ class DefListProcessor(BlockProcessor): class DefListIndentProcessor(ListIndentProcessor): """ Process indented children of definition list items. """ - ITEM_TYPES = ['dd'] - LIST_TYPES = ['dl'] + # Defintion lists need to be aware of all list types + ITEM_TYPES = ['dd', 'li'] + LIST_TYPES = ['dl', 'ol', 'ul'] def create_item(self, parent, block): - """ Create a new dd and parse the block with it as the parent. """ + """ Create a new dd or li (depending on parent) and parse the block with it as the parent. """ + dd = etree.SubElement(parent, 'dd') self.parser.parseBlocks(dd, [block]) diff --git a/tests/test_syntax/extensions/test_def_list.py b/tests/test_syntax/extensions/test_def_list.py new file mode 100644 index 0000000..a89f35d --- /dev/null +++ b/tests/test_syntax/extensions/test_def_list.py @@ -0,0 +1,323 @@ +""" +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-2019 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 markdown.test_tools import TestCase + + +class TestDefList(TestCase): + + def test_def_list_with_ol(self): + self.assertMarkdownRenders( + self.dedent( + ''' + + term + + : this is a definition for term. it has + multiple lines in the first paragraph. + + 1. first thing + + first thing details in a second paragraph. + + 1. second thing + + second thing details in a second paragraph. + + 1. third thing + + third thing details in a second paragraph. + ''' + ), + self.dedent( + ''' + <dl> + <dt>term</dt> + <dd> + <p>this is a definition for term. it has + multiple lines in the first paragraph.</p> + <ol> + <li> + <p>first thing</p> + <p>first thing details in a second paragraph.</p> + </li> + <li> + <p>second thing</p> + <p>second thing details in a second paragraph.</p> + </li> + <li> + <p>third thing</p> + <p>third thing details in a second paragraph.</p> + </li> + </ol> + </dd> + </dl> + ''' + ), + extensions=['def_list'] + ) + + def test_def_list_with_ul(self): + self.assertMarkdownRenders( + self.dedent( + ''' + + term + + : this is a definition for term. it has + multiple lines in the first paragraph. + + - first thing + + first thing details in a second paragraph. + + - second thing + + second thing details in a second paragraph. + + - third thing + + third thing details in a second paragraph. + ''' + ), + self.dedent( + ''' + <dl> + <dt>term</dt> + <dd> + <p>this is a definition for term. it has + multiple lines in the first paragraph.</p> + <ul> + <li> + <p>first thing</p> + <p>first thing details in a second paragraph.</p> + </li> + <li> + <p>second thing</p> + <p>second thing details in a second paragraph.</p> + </li> + <li> + <p>third thing</p> + <p>third thing details in a second paragraph.</p> + </li> + </ul> + </dd> + </dl> + ''' + ), + extensions=['def_list'] + ) + + def test_def_list_with_nesting(self): + self.assertMarkdownRenders( + self.dedent( + ''' + + term + + : this is a definition for term. it has + multiple lines in the first paragraph. + + 1. first thing + + first thing details in a second paragraph. + + - first nested thing + + second nested thing details + ''' + ), + self.dedent( + ''' + <dl> + <dt>term</dt> + <dd> + <p>this is a definition for term. it has + multiple lines in the first paragraph.</p> + <ol> + <li> + <p>first thing</p> + <p>first thing details in a second paragraph.</p> + <ul> + <li> + <p>first nested thing</p> + <p>second nested thing details</p> + </li> + </ul> + </li> + </ol> + </dd> + </dl> + ''' + ), + extensions=['def_list'] + ) + + def test_def_list_with_nesting_self(self): + self.assertMarkdownRenders( + self.dedent( + ''' + + term + + : this is a definition for term. it has + multiple lines in the first paragraph. + + inception + + : this is a definition for term. it has + multiple lines in the first paragraph. + + - bullet point + + another paragraph + ''' + ), + self.dedent( + ''' + <dl> + <dt>term</dt> + <dd> + <p>this is a definition for term. it has + multiple lines in the first paragraph.</p> + <dl> + <dt>inception</dt> + <dd> + <p>this is a definition for term. it has + multiple lines in the first paragraph.</p> + <ul> + <li>bullet point</li> + </ul> + <p>another paragraph</p> + </dd> + </dl> + </dd> + </dl> + ''' + ), + extensions=['def_list'] + ) + + def test_def_list_unreasonable_nesting(self): + self.assertMarkdownRenders( + self.dedent( + ''' + + turducken + + : this is a definition for term. it has + multiple lines in the first paragraph. + + 1. ordered list + + - nested list + + term + + : definition + + - item 1 paragraph 1 + + item 1 paragraph 2 + ''' + ), + self.dedent( + ''' + <dl> + <dt>turducken</dt> + <dd> + <p>this is a definition for term. it has + multiple lines in the first paragraph.</p> + <ol> + <li> + <p>ordered list</p> + <ul> + <li> + <p>nested list</p> + <dl> + <dt>term</dt> + <dd> + <p>definition</p> + <ul> + <li> + <p>item 1 paragraph 1</p> + <p>item 1 paragraph 2</p> + </li> + </ul> + </dd> + </dl> + </li> + </ul> + </li> + </ol> + </dd> + </dl> + ''' + ), + extensions=['def_list'] + ) + + def test_def_list_nested_admontions(self): + self.assertMarkdownRenders( + self.dedent( + ''' + term + + : definition + + !!! note "Admontion" + + term + + : defintion + + 1. list + + continue + ''' + ), + self.dedent( + ''' + <dl> + <dt>term</dt> + <dd> + <p>definition</p> + <div class="admonition note"> + <p class="admonition-title">Admontion</p> + <dl> + <dt>term</dt> + <dd> + <p>defintion</p> + <ol> + <li> + <p>list</p> + <p>continue</p> + </li> + </ol> + </dd> + </dl> + </div> + </dd> + </dl> + ''' + ), + extensions=['def_list', 'admonition'] + ) |