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
|
#! /usr/bin/env python3
# $Id: test_target_notes.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 `docutils.transforms.references.TargetNotes` (via
`docutils.transforms.universal.LastReaderPending`).
"""
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[2]))
from docutils.frontend import get_default_settings
from docutils.parsers.rst import Parser
from docutils.transforms.references import (PropagateTargets, AnonymousHyperlinks,
IndirectHyperlinks, ExternalTargets,
InternalTargets, DanglingReferences)
from docutils.transforms.universal import TestMessages
from docutils.utils import new_document
class TransformTestCase(unittest.TestCase):
def test_transforms(self):
parser = Parser()
settings = get_default_settings(Parser)
settings.warning_stream = ''
for name, (transforms, 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)
# Don't do a ``populate_from_components()`` because that
# would enable the Transformer's default transforms.
document.transformer.add_transforms(transforms)
document.transformer.add_transform(TestMessages)
document.transformer.apply_transforms()
output = document.pformat()
self.assertEqual(case_expected, output)
totest = {}
totest['tables_of_contents'] = ((PropagateTargets, AnonymousHyperlinks,
IndirectHyperlinks,
ExternalTargets, InternalTargets,
DanglingReferences,
), [
["""\
.. _target: http://example.org
A reference to a target_.
.. target-notes::
""",
"""\
<document source="test data">
<target ids="target" names="target" refuri="http://example.org">
<paragraph>
A reference to a \n\
<reference name="target" refuri="http://example.org">
target
\n\
<footnote_reference auto="1" ids="footnote-reference-1" refid="footnote-1">
.
<footnote auto="1" ids="footnote-1" names="TARGET_NOTE:\\ footnote-1">
<paragraph>
<reference refuri="http://example.org">
http://example.org
"""],
["""\
.. _target: http://example.org
A reference to a target_.
.. target-notes:: :class: custom
""",
"""\
<document source="test data">
<target ids="target" names="target" refuri="http://example.org">
<paragraph>
A reference to a \n\
<reference name="target" refuri="http://example.org">
target
<inline classes="custom">
\n\
<footnote_reference auto="1" classes="custom" ids="footnote-reference-1" refid="footnote-1">
.
<footnote auto="1" ids="footnote-1" names="TARGET_NOTE:\\ footnote-1">
<paragraph>
<reference refuri="http://example.org">
http://example.org
"""],
])
if __name__ == '__main__':
unittest.main()
|