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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
|
#! /usr/bin/env python
# $Id: test_include.py 5015 2007-03-12 20:25:40Z wiemann $
# Author: David Goodger <goodger@python.org>
# Copyright: This module has been placed in the public domain.
"""
Tests for misc.py "include" directive.
"""
import os.path
import sys
from __init__ import DocutilsTestSupport
from docutils.parsers.rst import states
def suite():
s = DocutilsTestSupport.ParserTestSuite()
s.generateTests(totest)
return s
mydir = 'test_parsers/test_rst/test_directives/'
include1 = os.path.join(mydir, 'include1.txt')
include1rel = DocutilsTestSupport.utils.relative_path(None, include1)
include2 = os.path.join(mydir, 'include2.txt')
include3 = os.path.join(mydir, 'include3.txt')
include8 = os.path.join(mydir, 'include8.txt')
include10 = os.path.join(mydir, 'include10.txt')
include10rel = DocutilsTestSupport.utils.relative_path(None, include10)
include11 = os.path.join(mydir, 'include 11.txt')
include11rel = DocutilsTestSupport.utils.relative_path(None, include11)
include12 = os.path.join(mydir, 'include12.txt')
include13 = os.path.join(mydir, 'include13.txt')
include13rel = DocutilsTestSupport.utils.relative_path(None, include13)
utf_16_file = os.path.join(mydir, 'utf-16.csv')
utf_16_file_rel = DocutilsTestSupport.utils.relative_path(None, utf_16_file)
nonexistent = os.path.join(os.path.dirname(states.__file__),
'include', 'nonexistent')
nonexistent_rel = DocutilsTestSupport.utils.relative_path(
os.path.join(DocutilsTestSupport.testroot, 'dummy'), nonexistent)
totest = {}
totest['include'] = [
["""\
Include Test
============
.. include:: %s
A paragraph.
""" % include1,
"""\
<document source="test data">
<section ids="include-test" names="include\ test">
<title>
Include Test
<section ids="inclusion-1" names="inclusion\ 1">
<title>
Inclusion 1
<paragraph>
This file is used by \n\
<literal>
test_include.py
.
<paragraph>
A paragraph.
"""],
["""\
Include Test
============
.. include:: %s
:literal:
A paragraph.
""" % include1,
"""\
<document source="test data">
<section ids="include-test" names="include\ test">
<title>
Include Test
<literal_block source="%s" xml:space="preserve">
Inclusion 1
-----------
\n\
This file is used by ``test_include.py``.
<paragraph>
A paragraph.
""" % include1rel],
["""\
Let's test the parse context.
This paragraph is in a block quote.
.. include:: %s
The included paragraphs should also be in the block quote.
""" % include2,
"""\
<document source="test data">
<paragraph>
Let's test the parse context.
<block_quote>
<paragraph>
This paragraph is in a block quote.
<paragraph>
Here are some paragraphs
that can appear at any level.
<paragraph>
This file (include2.txt) is used by
<literal>
test_include.py
.
<paragraph>
The included paragraphs should also be in the block quote.
"""],
["""\
Include Test
============
.. include:: nonexistent.txt
A paragraph.
""",
"""\
<document source="test data">
<section ids="include-test" names="include\ test">
<title>
Include Test
<system_message level="4" line="4" source="test data" type="SEVERE">
<paragraph>
Problems with "include" directive path:
IOError: [Errno 2] No such file or directory: 'nonexistent.txt'.
<literal_block xml:space="preserve">
.. include:: nonexistent.txt
<paragraph>
A paragraph.
"""],
["""\
Include Test
============
.. include:: %s
.. include:: %s
A paragraph.
""" % (include1, include1),
"""\
<document source="test data">
<section ids="include-test" names="include\ test">
<title>
Include Test
<section dupnames="inclusion\ 1" ids="inclusion-1">
<title>
Inclusion 1
<paragraph>
This file is used by
<literal>
test_include.py
.
<section dupnames="inclusion\ 1" ids="id1">
<title>
Inclusion 1
<system_message backrefs="id1" level="1" line="2" source="%s" type="INFO">
<paragraph>
Duplicate implicit target name: "inclusion 1".
<paragraph>
This file is used by
<literal>
test_include.py
.
<paragraph>
A paragraph.
""" % include1rel],
["""\
Include Test
============
.. include:: %s
----------
.. include:: %s
A paragraph.
""" % (include1, include1),
"""\
<document source="test data">
<section ids="include-test" names="include\ test">
<title>
Include Test
<section dupnames="inclusion\ 1" ids="inclusion-1">
<title>
Inclusion 1
<paragraph>
This file is used by \n\
<literal>
test_include.py
.
<transition>
<section dupnames="inclusion\ 1" ids="id1">
<title>
Inclusion 1
<system_message backrefs="id1" level="1" line="2" source="%s" type="INFO">
<paragraph>
Duplicate implicit target name: "inclusion 1".
<paragraph>
This file is used by \n\
<literal>
test_include.py
.
<paragraph>
A paragraph.
""" % include1rel],
["""\
In test data
.. include:: %s
""" % include3,
"""\
<document source="test data">
<paragraph>
In test data
<paragraph>
In include3.txt
<paragraph>
In includes/include4.txt
<paragraph>
In includes/include5.txt
<paragraph>
In includes/more/include6.txt
<paragraph>
In includes/sibling/include7.txt
"""],
["""\
In test data
Section
=======
(Section contents in nested parse; slice of input_lines ViewList.)
.. include:: %s
""" % include3,
"""\
<document source="test data">
<paragraph>
In test data
<section ids="section" names="section">
<title>
Section
<paragraph>
(Section contents in nested parse; slice of input_lines ViewList.)
<paragraph>
In include3.txt
<paragraph>
In includes/include4.txt
<paragraph>
In includes/include5.txt
<paragraph>
In includes/more/include6.txt
<paragraph>
In includes/sibling/include7.txt
"""],
["""\
Testing relative includes:
.. include:: %s
""" % include8,
"""\
<document source="test data">
<paragraph>
Testing relative includes:
<paragraph>
In include8.txt
<paragraph>
In ../includes/include9.txt.
<paragraph>
Here are some paragraphs
that can appear at any level.
<paragraph>
This file (include2.txt) is used by
<literal>
test_include.py
.
"""],
["""\
Encoding:
.. include:: %s
:encoding: utf-16
""" % utf_16_file_rel,
u"""\
<document source="test data">
<paragraph>
Encoding:
<paragraph>
"Treat", "Quantity", "Description"
"Albatr\xb0\xdf", 2.99, "\xa1On a \\u03c3\\u03c4\\u03b9\\u03ba!"
"Crunchy Frog", 1.49, "If we took the b\xf6nes out, it wouldn\\u2019t be
crunchy, now would it?"
"Gannet Ripple", 1.99, "\xbfOn a \\u03c3\\u03c4\\u03b9\\u03ba?"
"""],
["""\
Include file is UTF-16-encoded, and is not valid ASCII.
.. include:: %s
:encoding: ascii
""" % utf_16_file_rel,
"""\
<document source="test data">
<paragraph>
Include file is UTF-16-encoded, and is not valid ASCII.
<system_message level="4" line="3" source="test data" type="SEVERE">
<paragraph>
Problem with "include" directive:
UnicodeError: Unable to decode input data. Tried the following encodings: 'ascii'.
(UnicodeDecodeError: 'ascii' codec can't decode byte 0xfe in position 0: ordinal not in range(128))
<literal_block xml:space="preserve">
.. include:: %s
:encoding: ascii
""" % utf_16_file_rel],
# @@@ BUG with errors reported with incorrect "source" & "line":
# ["""\
# Testing bad charent includes:
#
# .. include:: %s
# """ % include10,
# """\
# <document source="test data">
# <paragraph>
# Testing bad charent includes:
# <system_message level="3" line="1" source="%s" type="ERROR">
# <paragraph>
# Invalid character code: 0xFFFFFFFFF
# int() literal too large: FFFFFFFFF
# <literal_block xml:space="preserve">
# unicode:: 0xFFFFFFFFF
# <system_message level="2" line="1" source="%s" type="WARNING">
# <paragraph>
# Substitution definition "bad" empty or invalid.
# <literal_block xml:space="preserve">
# .. |bad| unicode:: 0xFFFFFFFFF
# """ % (include10rel, include10rel)],
["""\
Include file with whitespace in the path:
.. include:: %s
""" % include11rel,
"""\
<document source="test data">
<paragraph>
Include file with whitespace in the path:
<paragraph>
some text
"""],
["""\
Standard include data file:
.. include:: <isogrk4.txt>
""",
"""\
<document source="test data">
<paragraph>
Standard include data file:
<comment xml:space="preserve">
This data file has been placed in the public domain.
<comment xml:space="preserve">
Derived from the Unicode character mappings available from
<http://www.w3.org/2003/entities/xml/>.
Processed by unicode2rstsubs.py, part of Docutils:
<http://docutils.sourceforge.net>.
<substitution_definition names="b.Gammad">
\\u03dc
<substitution_definition names="b.gammad">
\\u03dd
"""],
["""\
Nonexistent standard include data file:
.. include:: <nonexistent>
""",
"""\
<document source="test data">
<paragraph>
Nonexistent standard include data file:
<system_message level="4" line="3" source="test data" type="SEVERE">
<paragraph>
Problems with "include" directive path:
IOError: [Errno 2] No such file or directory: '%s'.
<literal_block xml:space="preserve">
.. include:: <nonexistent>
""" % nonexistent_rel],
["""\
Include start-after/end-before Test
.. include:: %s
:start-after: .. start here
:end-before: .. stop here
A paragraph.
""" % include12,
"""\
<document source="test data">
<paragraph>
Include start-after/end-before Test
<paragraph>
In include12.txt (after "start here", before "stop here")
<paragraph>
A paragraph.
"""],
["""\
Include start-after/end-before Test, single option variant
.. include:: %s
:end-before: .. start here
.. include:: %s
:start-after: .. stop here
A paragraph.
""" % (include12, include12),
"""\
<document source="test data">
<paragraph>
Include start-after/end-before Test, single option variant
<paragraph>
In include12.txt (but before "start here")
<paragraph>
In include12.txt (after "stop here")
<paragraph>
A paragraph.
"""],
["""\
Include start-after/end-before multi-line test.
.. include:: %s
:start-after: From: me
To: you
:end-before: -------
-- mork of ork
.. include:: %s
:start-after: From: me
To: you
:end-before:
-------
-- mork of ork
A paragraph.
""" % (include13, include13),
"""\
<document source="test data">
<paragraph>
Include start-after/end-before multi-line test.
<system_message level="4" line="3" source="test data" type="SEVERE">
<paragraph>
Problem with "end-before" option of "include" directive:
Text not found.
<literal_block xml:space="preserve">
.. include:: %s
:start-after: From: me
To: you
:end-before: -------
-- mork of ork
<paragraph>
In include13.txt (between header and signature)
<paragraph>
A paragraph.
""" % include13],
["""\
Error handling test; "end-before" error handling tested in previous test.
.. include:: %s
:start-after: bad string
:end-before: mork of ork
""" % include13,
"""\
<document source="test data">
<paragraph>
Error handling test; "end-before" error handling tested in previous test.
<system_message level="4" line="3" source="test data" type="SEVERE">
<paragraph>
Problem with "start-after" option of "include" directive:
Text not found.
<literal_block xml:space="preserve">
.. include:: %s
:start-after: bad string
:end-before: mork of ork
""" % include13],
]
# Skip tests whose output contains "UnicodeDecodeError" if we are not
# using Python 2.3 or higher.
if sys.version_info < (2, 3):
for i in range(len(totest['include'])):
if totest['include'][i][1].find('UnicodeDecodeError') != -1:
del totest['include'][i]
print ("Test totest['include'][%s] skipped; "
"Python 2.3+ required for expected output." % i)
# Assume we have only one of these tests.
break
if __name__ == '__main__':
import unittest
unittest.main(defaultTest='suite')
|