1 #! /usr/bin/env python3
4 # Author: David Goodger <goodger@python.org>
5 # Copyright: This module has been placed in the public domain.
8 Tests for docutils.transforms.references.Substitutions.
11 from pathlib
import Path
15 if __name__
== '__main__':
16 # prepend the "docutils root" to the Python library path
17 # so we import the local `docutils` package.
18 sys
.path
.insert(0, str(Path(__file__
).resolve().parents
[2]))
20 from docutils
.frontend
import get_default_settings
21 from docutils
.parsers
.rst
import Parser
22 from docutils
.transforms
.references
import Substitutions
23 from docutils
.transforms
.universal
import TestMessages
24 from docutils
.utils
import new_document
27 class TransformTestCase(unittest
.TestCase
):
28 def test_transforms(self
):
30 settings
= get_default_settings(Parser
)
31 settings
.warning_stream
= ''
32 for name
, (transforms
, cases
) in totest
.items():
33 for casenum
, (case_input
, case_expected
) in enumerate(cases
):
34 with self
.subTest(id=f
'totest[{name!r}][{casenum}]'):
35 document
= new_document('test data', settings
.copy())
36 parser
.parse(case_input
, document
)
37 # Don't do a ``populate_from_components()`` because that
38 # would enable the Transformer's default transforms.
39 document
.transformer
.add_transforms(transforms
)
40 document
.transformer
.add_transform(TestMessages
)
41 document
.transformer
.apply_transforms()
42 output
= document
.pformat()
43 self
.assertEqual(case_expected
, output
)
48 totest
['substitutions'] = ((Substitutions
,), [
50 The |biohazard| symbol is deservedly scary-looking.
52 .. |biohazard| image:: biohazard.png
55 <document source="test data">
58 <image alt="biohazard" uri="biohazard.png">
59 symbol is deservedly scary-looking.
60 <substitution_definition names="biohazard">
61 <image alt="biohazard" uri="biohazard.png">
64 Here's an |unknown| substitution.
67 <document source="test data">
70 <problematic ids="problematic-1" refid="system-message-1">
73 <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="1" source="test data" type="ERROR">
75 Undefined substitution referenced: "unknown".
78 Substitutions support case differences:
80 .. |eacute| replace:: \u00E9
81 .. |Eacute| replace:: \u00C9
83 |Eacute|\\t\\ |eacute|, and even |EACUTE|.
86 <document source="test data">
88 Substitutions support case differences:
89 <substitution_definition names="eacute">
91 <substitution_definition names="Eacute">
102 Indirect substitution definitions with multiple references:
104 |substitute| my coke for gin
105 |substitute| you for my mum
106 at least I'll get my washing done
108 .. |substitute| replace:: |replace|
109 .. |replace| replace:: swap
112 <document source="test data">
114 Indirect substitution definitions with multiple references:
120 at least I'll get my washing done
121 <substitution_definition names="substitute">
123 <substitution_definition names="replace">
127 .. |l| unicode:: U+00AB .. left chevron
128 .. |r| unicode:: U+00BB .. right chevron
129 .. |.| replace:: |l|\\ ``.``\\ |r|
131 .. Delete either of the following lines, and there is no error.
133 Regular expression |.| will match any character
135 .. Note:: Note that |.| matches *exactly* one character
138 <document source="test data">
139 <substitution_definition names="l">
141 <substitution_definition names="r">
143 <substitution_definition names=".">
148 <comment xml:space="preserve">
149 Delete either of the following lines, and there is no error.
151 Regular expression \n\
156 will match any character
170 .. |sub| replace:: |sub|
173 <document source="test data">
174 <system_message level="3" line="1" names="sub" source="test data" type="ERROR">
176 Circular substitution definition detected:
177 <literal_block xml:space="preserve">
178 .. |sub| replace:: |sub|
181 .. |sub| replace:: |indirect1|
182 .. |indirect1| replace:: |indirect2|
183 .. |indirect2| replace:: |Sub|
186 <document source="test data">
187 <system_message level="3" line="1" names="sub" source="test data" type="ERROR">
189 Circular substitution definition detected:
190 <literal_block xml:space="preserve">
191 .. |sub| replace:: |indirect1|
192 <system_message level="3" line="2" names="indirect1" source="test data" type="ERROR">
194 Circular substitution definition detected:
195 <literal_block xml:space="preserve">
196 .. |indirect1| replace:: |indirect2|
197 <system_message level="3" line="3" names="indirect2" source="test data" type="ERROR">
199 Circular substitution definition detected:
200 <literal_block xml:space="preserve">
201 .. |indirect2| replace:: |Sub|
204 .. |indirect1| replace:: |indirect2|
205 .. |indirect2| replace:: |Sub|
206 .. |sub| replace:: |indirect1|
208 Use |sub| and |indirect1| and |sub| again (and |sub| one more time).
211 <document source="test data">
212 <system_message level="3" line="1" names="indirect1" source="test data" type="ERROR">
214 Circular substitution definition detected:
215 <literal_block xml:space="preserve">
216 .. |indirect1| replace:: |indirect2|
217 <system_message level="3" line="2" names="indirect2" source="test data" type="ERROR">
219 Circular substitution definition detected:
220 <literal_block xml:space="preserve">
221 .. |indirect2| replace:: |Sub|
222 <system_message level="3" line="3" names="sub" source="test data" type="ERROR">
224 Circular substitution definition detected:
225 <literal_block xml:space="preserve">
226 .. |sub| replace:: |indirect1|
229 <problematic ids="problematic-4" refid="system-message-4">
232 <problematic ids="problematic-1" refid="system-message-1">
235 <problematic ids="problematic-2" refid="system-message-2">
238 <problematic ids="problematic-3" refid="system-message-3">
241 <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="5" source="test data" type="ERROR">
243 Circular substitution definition referenced: "indirect1".
244 <system_message backrefs="problematic-2" ids="system-message-2" level="3" line="5" source="test data" type="ERROR">
246 Circular substitution definition referenced: "sub".
247 <system_message backrefs="problematic-3" ids="system-message-3" level="3" line="5" source="test data" type="ERROR">
249 Circular substitution definition referenced: "sub".
250 <system_message backrefs="problematic-4" ids="system-message-4" level="3" line="5" source="test data" type="ERROR">
252 Circular substitution definition referenced: "Sub".
255 Substitution reference with |reference-in-content|.
257 .. |reference-in-content| replace:: text and hyperlink-reference_
260 <document source="test data">
262 Substitution reference with \n\
264 <reference name="hyperlink-reference" refname="hyperlink-reference">
267 <substitution_definition names="reference-in-content">
269 <reference name="hyperlink-reference" refname="hyperlink-reference">
274 totest
['unicode'] = ((Substitutions
,), [
276 Insert an em-dash (|mdash|), a copyright symbol (|copy|), a non-breaking
277 space (|nbsp|), a backwards-not-equals (|bne|), and a captial omega (|Omega|).
279 .. |mdash| unicode:: 0x02014
280 .. |copy| unicode:: \\u00A9
281 .. |nbsp| unicode::  
282 .. |bne| unicode:: U0003D U020E5
283 .. |Omega| unicode:: U+003A9
286 <document source="test data">
290 ), a copyright symbol (
295 ), a backwards-not-equals (
298 ), and a captial omega (
301 <substitution_definition names="mdash">
303 <substitution_definition names="copy">
305 <substitution_definition names="nbsp">
307 <substitution_definition names="bne">
310 <substitution_definition names="Omega">
314 Testing comments and extra text.
316 Copyright |copy| 2003, |BogusMegaCorp (TM)|.
318 .. |copy| unicode:: 0xA9 .. copyright sign
319 .. |BogusMegaCorp (TM)| unicode:: BogusMegaCorp U+2122
320 .. with trademark sign
323 <document source="test data">
325 Testing comments and extra text.
333 <substitution_definition names="copy">
335 <substitution_definition names="BogusMegaCorp\\ (TM)">
340 Insert an em-dash |---| automatically trimming whitespace.
341 Some substitutions |TM| only need |rarrow| trimming on one side.
343 .. |---| unicode:: U+02014
345 .. |TM| unicode:: U+02122
347 .. |rarrow| unicode:: U+2192
351 <document source="test data">
355 automatically trimming whitespace.
360 trimming on one side.
361 <substitution_definition ltrim="1" names="---" rtrim="1">
363 <substitution_definition ltrim="1" names="TM">
365 <substitution_definition names="rarrow" rtrim="1">
369 Substitution definition with an illegal element:
371 .. |target| replace:: _`target`
373 Make sure this substitution definition is not registered: |target|
376 <document source="test data">
378 Substitution definition with an illegal element:
379 <system_message level="3" line="3" source="test data" type="ERROR">
381 Substitution definition contains illegal element <target>:
382 <literal_block xml:space="preserve">
383 <target ids="target" names="target">
385 <literal_block xml:space="preserve">
386 .. |target| replace:: _`target`
388 Make sure this substitution definition is not registered: \n\
389 <problematic ids="problematic-1" refid="system-message-1">
391 <system_message backrefs="problematic-1" ids="system-message-1" level="3" line="5" source="test data" type="ERROR">
393 Undefined substitution referenced: "target".
398 if __name__
== '__main__':