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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
|
#! /usr/bin/env python3
# $Id: test_role.py 9425 2023-06-30 14:56:47Z milde $
# Author: David Goodger <goodger@python.org>
# Copyright: This module has been placed in the public domain.
"""
Tests for misc.py "role" directive.
"""
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[4]))
from docutils.frontend import get_default_settings
from docutils.parsers.rst import Parser, roles
from docutils.utils import new_document
class ParserTestCase(unittest.TestCase):
def test_parser(self):
parser = Parser()
settings = get_default_settings(Parser)
settings.warning_stream = ''
for name, cases in totest.items():
for casenum, (case_input, case_expected) in enumerate(cases):
# Language-specific roles and roles added by the
# "default-role" and "role" directives are currently stored
# globally in the roles._roles dictionary. This workaround
# empties that dictionary.
roles._roles = {}
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['role'] = [
["""\
.. role:: custom
.. role:: special
:custom:`interpreted` and :special:`interpreted`
""",
"""\
<document source="test data">
<paragraph>
<inline classes="custom">
interpreted
and \n\
<inline classes="special">
interpreted
"""],
["""\
.. role:: custom
:class: custom-class
.. role:: special
:class: special-class
:custom:`interpreted` and :special:`interpreted`
""",
"""\
<document source="test data">
<paragraph>
<inline classes="custom-class">
interpreted
and \n\
<inline classes="special-class">
interpreted
"""],
["""\
Must define :custom:`interpreted` before using it.
.. role:: custom
Now that it's defined, :custom:`interpreted` works.
""",
"""\
<document source="test data">
<paragraph>
Must define \n\
<problematic ids="problematic-1" refid="system-message-1">
:custom:`interpreted`
before using it.
<system_message level="1" line="1" source="test data" type="INFO">
<paragraph>
No role entry for "custom" in module "docutils.parsers.rst.languages.en".
Trying "custom" as canonical role name.
<system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
<paragraph>
Unknown interpreted text role "custom".
<paragraph>
Now that it's defined, \n\
<inline classes="custom">
interpreted
works.
"""],
["""\
.. role:: custom(emphasis)
:custom:`text`
""",
"""\
<document source="test data">
<paragraph>
<emphasis classes="custom">
text
"""],
["""\
.. role:: custom ( emphasis )
:custom:`text`
""",
"""\
<document source="test data">
<paragraph>
<emphasis classes="custom">
text
"""],
["""\
.. role:: custom(emphasis)
:class: special
:custom:`text`
""",
"""\
<document source="test data">
<paragraph>
<emphasis classes="special">
text
"""],
["""\
.. role:: custom(unknown-role)
""",
"""\
<document source="test data">
<system_message level="1" line="1" source="test data" type="INFO">
<paragraph>
No role entry for "unknown-role" in module "docutils.parsers.rst.languages.en".
Trying "unknown-role" as canonical role name.
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
Unknown interpreted text role "unknown-role".
<literal_block xml:space="preserve">
.. role:: custom(unknown-role)
"""],
["""\
.. role:: custom
:class: 1
""",
"""\
<document source="test data">
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
Error in "role" directive:
invalid option value: (option: "class"; value: '1')
cannot make "1" into a class name.
<literal_block xml:space="preserve">
.. role:: custom
:class: 1
"""],
["""\
.. role:: 1
""",
"""\
<document source="test data">
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
Invalid argument for "role" directive:
cannot make "1" into a class name.
<literal_block xml:space="preserve">
.. role:: 1
"""],
["""\
.. role:: (error)
""",
"""\
<document source="test data">
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
"role" directive arguments not valid role names: "(error)".
<literal_block xml:space="preserve">
.. role:: (error)
"""],
["""\
.. role::
""",
"""\
<document source="test data">
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
"role" directive requires arguments on the first line.
<literal_block xml:space="preserve">
.. role::
"""],
["""\
Test
----
.. role:: fileref(emphasis)
Testing a :fileref:`role` in a nested parse.
""",
"""\
<document source="test data">
<section ids="test" names="test">
<title>
Test
<paragraph>
Testing a \n\
<emphasis classes="fileref">
role
in a nested parse.
"""],
["""\
.. role:: custom
.. role:: special
Empty :custom:`\\ ` and empty `\\ `:special:
""",
"""\
<document source="test data">
<paragraph>
Empty \n\
<inline classes="custom">
and empty \n\
<inline classes="special">
"""],
["""\
.. role:: CaSiNg
Role names are :cAsInG:`case-insensitive`.
""",
"""\
<document source="test data">
<paragraph>
Role names are \n\
<inline classes="casing">
case-insensitive
.
"""],
]
totest['raw_role'] = [
["""\
.. role:: html(raw)
:format: html
Here's some :html:`<i>raw HTML data</i>`.
""",
"""\
<document source="test data">
<paragraph>
Here's some \n\
<raw classes="html" format="html" xml:space="preserve">
<i>raw HTML data</i>
.
"""],
["""\
.. role:: itex(raw)
:format: latex html
Here's some itex markup: :itex:`$x^\\infty$`.
""",
"""\
<document source="test data">
<paragraph>
Here's some itex markup: \n\
<raw classes="itex" format="latex html" xml:space="preserve">
$x^\\infty$
.
"""],
["""\
Can't use the :raw:`role` directly.
""",
"""\
<document source="test data">
<paragraph>
Can't use the \n\
<problematic ids="problematic-1" refid="system-message-1">
:raw:`role`
directly.
<system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
<paragraph>
No format (Writer name) is associated with this role: "raw".
The "raw" role cannot be used directly.
Instead, use the "role" directive to create a new role with an associated format.
"""],
]
if __name__ == '__main__':
unittest.main()
|