1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
|
#!/usr/bin/env python3
# :Copyright: © 2020 Günter Milde.
# :License: Released under the terms of the `2-Clause BSD license`_, in short:
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved.
# This file is offered as-is, without any warranty.
#
# .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
"""
Test for bullet lists in CommonMark parsers.
Cf. the `CommonMark Specification <https://spec.commonmark.org/>`__
"""
from pathlib import Path
import sys
import unittest
if __name__ == '__main__':
# prepend the "docutils root" to the Python library path
# so we import the local `docutils` package.
sys.path.insert(0, str(Path(__file__).resolve().parents[3]))
from docutils.frontend import get_default_settings
from docutils.parsers.recommonmark_wrapper import Parser
from docutils.utils import new_document
class RecommonmarkParserTestCase(unittest.TestCase):
def test_parser(self):
parser = Parser()
settings = get_default_settings(Parser)
for name, cases in totest.items():
for casenum, (case_input, case_expected) in enumerate(cases):
with self.subTest(id=f'totest[{name!r}][{casenum}]'):
document = new_document('test data', settings.copy())
parser.parse(case_input, document)
output = document.pformat()
self.assertEqual(case_expected, output)
totest = {}
totest['bullet_lists'] = [
["""\
- item
""",
"""\
<document source="test data">
<bullet_list>
<list_item>
<paragraph>
item
"""],
["""\
* item 1
* item 2
""",
"""\
<document source="test data">
<bullet_list>
<list_item>
<paragraph>
item 1
<list_item>
<paragraph>
item 2
"""],
["""\
No blank line between:
+ item 1
+ item 2
""",
"""\
<document source="test data">
<paragraph>
No blank line between:
<bullet_list>
<list_item>
<paragraph>
item 1
<list_item>
<paragraph>
item 2
"""],
["""\
- item 1, paragraph 1.
item 1, paragraph 2.
- item 2
""",
"""\
<document source="test data">
<bullet_list>
<list_item>
<paragraph>
item 1, paragraph 1.
<paragraph>
item 1, paragraph 2.
<list_item>
<paragraph>
item 2
"""],
["""\
- item 1, line 1
item 1, line 2
- item 2
""",
"""\
<document source="test data">
<bullet_list>
<list_item>
<paragraph>
item 1, line 1
item 1, line 2
<list_item>
<paragraph>
item 2
"""],
["""\
Different bullets start different lists:
- item 1
+ item 1
* no blank line
- required between lists
""",
"""\
<document source="test data">
<paragraph>
Different bullets start different lists:
<bullet_list>
<list_item>
<paragraph>
item 1
<bullet_list>
<list_item>
<paragraph>
item 1
<bullet_list>
<list_item>
<paragraph>
no blank line
<bullet_list>
<list_item>
<paragraph>
required between lists
"""],
["""\
- item 1
continuation of item 1
""",
"""\
<document source="test data">
<bullet_list>
<list_item>
<paragraph>
item 1
continuation of item 1
"""],
["""\
-
empty item above
""",
"""\
<document source="test data">
<bullet_list>
<list_item>
<paragraph>
empty item above
"""],
["""\
-
empty item above, no blank line
""",
"""\
<document source="test data">
<bullet_list>
<list_item>
<paragraph>
empty item above, no blank line
"""],
["""\
Unicode bullets are not supported by CommonMark.
• BULLET
‣ TRIANGULAR BULLET
⁃ HYPHEN BULLET
""",
"""\
<document source="test data">
<paragraph>
Unicode bullets are not supported by CommonMark.
<paragraph>
• BULLET
<paragraph>
‣ TRIANGULAR BULLET
<paragraph>
⁃ HYPHEN BULLET
"""],
]
if __name__ == '__main__':
unittest.main()
|