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
|
#! /usr/bin/env python3
# $Id: test_raw.py 9906 2024-08-15 08:43:38Z grubert $
# Author: David Goodger <goodger@python.org>
# Copyright: This module has been placed in the public domain.
"""
Tests for misc.py "raw" directive.
"""
import os.path
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
from docutils.utils import new_document
# TEST_ROOT is ./test/ from the docutils root
TEST_ROOT = os.path.abspath(os.path.join(__file__, '..', '..', '..', '..'))
class ParserTestCase(unittest.TestCase):
def test_parser(self):
parser = Parser()
settings = get_default_settings(Parser)
settings.warning_stream = ''
settings.halt_level = 5
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)
mydir = os.path.join(TEST_ROOT, 'test_parsers/test_rst/test_directives')
raw1 = os.path.relpath(
os.path.join(mydir, 'raw1.rst'),
os.getcwd()).replace('\\', '/')
utf_16_file = os.path.relpath(
os.path.join(TEST_ROOT, 'data/utf-16-le-sig.rst'),
os.getcwd()).replace('\\', '/')
utf_16_error_str = ("UnicodeDecodeError: 'ascii' codec can't decode byte 0xff "
"in position 0: ordinal not in range(128)")
totest = {}
totest['raw'] = [
["""\
.. raw:: html
<span>This is some plain old raw text.</span>
""",
"""\
<document source="test data">
<raw format="html" xml:space="preserve">
<span>This is some plain old raw text.</span>
"""],
[f"""\
.. raw:: html
:file: {raw1}
""",
f"""\
<document source="test data">
<raw format="html" source="{raw1}" xml:space="preserve">
<p>This file is used by <tt>test_raw.py</tt>.</p>
"""],
["""\
.. raw:: html
:file: rawfile.html
:url: http://example.org/
""",
"""\
<document source="test data">
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
The "file" and "url" options may not be simultaneously specified for the "raw" directive.
<literal_block xml:space="preserve">
.. raw:: html
:file: rawfile.html
:url: http://example.org/
"""],
["""\
.. raw:: html
:file: rawfile.html
<p>Can't have both content and file attribute.</p>
""",
"""\
<document source="test data">
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
"raw" directive may not both specify an external file and have content.
<literal_block xml:space="preserve">
.. raw:: html
:file: rawfile.html
\n\
<p>Can't have both content and file attribute.</p>
"""],
[r"""
.. raw:: latex html
\[ \sum_{n=1}^\infty \frac{1}{n} \text{ etc.} \]
""",
"""\
<document source="test data">
<raw format="latex html" xml:space="preserve">
\\[ \\sum_{n=1}^\\infty \\frac{1}{n} \\text{ etc.} \\]
"""],
[f"""\
.. raw:: html
:file: {utf_16_file}
:encoding: utf-16
""",
f"""\
<document source="test data">
<raw format="html" source="{utf_16_file}" xml:space="preserve">
Grüße
"""],
[f"""\
Raw input file is UTF-16-encoded, and is not valid ASCII.
.. raw:: html
:file: {utf_16_file}
:encoding: ascii
""",
f"""\
<document source="test data">
<paragraph>
Raw input file is UTF-16-encoded, and is not valid ASCII.
<system_message level="4" line="3" source="test data" type="SEVERE">
<paragraph>
Problem with "raw" directive:
{utf_16_error_str}
<literal_block xml:space="preserve">
.. raw:: html
:file: {utf_16_file}
:encoding: ascii
"""],
["""\
.. raw:: html
:encoding: utf-8
Should the parser complain becau\xdfe there is no :file:? BUG?
""",
"""\
<document source="test data">
<raw format="html" xml:space="preserve">
Should the parser complain becau\xdfe there is no :file:? BUG?
"""],
["""\
.. raw:: html
""",
"""\
<document source="test data">
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
Content block expected for the "raw" directive; none found.
<literal_block xml:space="preserve">
.. raw:: html
"""],
["""\
.. raw:: html
:file: non-existent.file
""",
"""\
<document source="test data">
<system_message level="4" line="1" source="test data" type="SEVERE">
<paragraph>
Problems with "raw" directive path:
InputError: [Errno 2] No such file or directory: 'non-existent.file'.
<literal_block xml:space="preserve">
.. raw:: html
:file: non-existent.file
"""],
# note that this output is rewritten below for certain python versions
]
if __name__ == '__main__':
unittest.main()
|