sandbox/dkuhlman/docutils/test/test_writers/test_python_latex.py

   1 #! /usr/bin/env python
   2
   3 # Author: Dave Kuhlman
   4 # Contact: dkuhlman@rexx.com
   5 # Revision: $Revision$
   6 # Date: $Date$
   7 # Copyright: This module has been placed in the public domain.
   8
   9 """
  10 Tests for python_latex writer.
  11 """
  12
  13 from __init__ import DocutilsTestSupport
  14
  15 def suite():
  16     s = DocutilsTestSupport.PythonLatexPublishTestSuite()
  17     s.generateTests(totest)
  18     return s
  19
  20
  21 rest_head = """\
  22
  23 ==========================
  24 Unit Test for Python LaTeX
  25 ==========================
  26
  27
  28 :author: Dave Kuhlman
  29 :address: dkuhlman@rexx.com \\\\
  30     http://www.rexx.com/~dkuhlman
  31
  32 :revision: 1.0a
  33 :date: Aug. 4, 2003
  34
  35 :copyright: Copyright (c) 2003 Dave Kuhlman.
  36     [an Open Source copyright]
  37
  38 :abstract: This document contains input for unit tests for the
  39     Python LaTeX writer for Docutils.
  40
  41 .. sectnum::    :depth: 2
  42
  43 .. contents::
  44
  45
  46 """
  47
  48 latex_head = r"""\documentclass{howto}
  49
  50 % generator -- Docutils: http://docutils.sourceforge.net/
  51 % writer -- documenting_python
  52 % generated on -- Wed Aug 13 16:08:04 2003
  53
  54 \usepackage{html}
  55 \title{Unit Test for Python LaTeX}
  56 \release{1.0a}
  57 \date{Aug. 4, 2003}
  58 \author{Dave Kuhlman}
  59 \authoraddress{dkuhlman@rexx.com \
  60 http://www.rexx.com/\~{}dkuhlman}
  61 \begin{document}
  62 \maketitle
  63 \ifhtml
  64 \chapter*{Front Matter\label{front}}
  65 \fi
  66
  67 Copyright (c) 2003 Dave Kuhlman.
  68 [an Open Source copyright]
  69 \begin{abstract}
  70 \noindent
  71
  72 This document contains input for unit tests for the
  73 Python LaTeX writer for Docutils.
  74 \end{abstract}
  75 \tableofcontents
  76
  77 """
  78
  79 totest = {}
  80
  81 totest['section_headers'] = [
  82 # input
  83 [rest_head + r"""
  84 Section #1
  85 ==========
  86
  87 Content for section #1.
  88
  89 Subsection #1-1
  90 ---------------
  91
  92 Content for sub-section #1-1.
  93
  94 Subsection #1-2
  95 ---------------
  96
  97 Content for sub-section #1-2.
  98
  99 Section #2
 100 ==========
 101
 102 Content for section #2.
 103
 104 """,
 105
 106 # expected output
 107 latex_head + r"""
 108 %___________________________________________________________________________
 109
 110 \section{1   Section {\#}1\label{section-1}}
 111
 112 Content for section {\#}1.
 113
 114
 115 %___________________________________________________________________________
 116
 117 \subsection{1.1   Subsection {\#}1-1\label{subsection-1-1}}
 118
 119 Content for sub-section {\#}1-1.
 120
 121
 122 %___________________________________________________________________________
 123
 124 \subsection{1.2   Subsection {\#}1-2\label{subsection-1-2}}
 125
 126 Content for sub-section {\#}1-2.
 127
 128
 129 %___________________________________________________________________________
 130
 131 \section{2   Section {\#}2\label{section-2}}
 132
 133 Content for section {\#}2.
 134
 135 \end{document}
 136 """],
 137 ]
 138
 139 # ==============================================================
 140
 141 totest['enumerated_lists'] = [
 142 # input
 143 [rest_head + r"""
 144 Enumerated List Test Section
 145 ============================
 146
 147 Here is an enumerated list:
 148
 149 1. This is an item.
 150
 151 2. This is an item.
 152
 153 3. This is an item.
 154
 155 """,
 156
 157 # expected output
 158 latex_head + r"""
 159 %___________________________________________________________________________
 160
 161 \section{1   Enumerated List Test Section\label{enumerated-list-test-section}}
 162
 163 Here is an enumerated list:
 164 \begin{enumerate}
 165 \item
 166 This is an item.
 167
 168 \item
 169 This is an item.
 170
 171 \item
 172 This is an item.
 173
 174 \end{enumerate}
 175
 176 \end{document}
 177 """],
 178 ]
 179
 180
 181 # ==============================================================
 182
 183 totest['itemized_lists'] = [
 184 # input
 185 [rest_head + r"""
 186 Itemized List Test Section
 187 ==========================
 188
 189 Here is an itemized list:
 190
 191 - This is an item.
 192
 193 - This is an item.
 194
 195 - This is an item.
 196
 197 """,
 198
 199 # expected output
 200 latex_head + r"""
 201 %___________________________________________________________________________
 202
 203 \section{1   Itemized List Test Section\label{itemized-list-test-section}}
 204
 205 Here is an itemized list:
 206 \begin{itemize}
 207 \item
 208 This is an item.
 209
 210 \item
 211 This is an item.
 212
 213 \item
 214 This is an item.
 215
 216 \end{itemize}
 217
 218 \end{document}
 219 """],
 220 ]
 221
 222 # ==============================================================
 223
 224 totest['links'] = [
 225 # input
 226 [rest_head + r"""
 227 Section #1
 228 ==========
 229
 230 Content for section #1.
 231
 232 Subsection #1-1
 233 ---------------
 234
 235 Content for sub-section #1-1.
 236
 237 Subsection #1-2
 238 ---------------
 239
 240 Content for sub-section #1-2.
 241
 242 Section #2
 243 ==========
 244
 245 Content for section #2.
 246
 247 Links Test Section
 248 ==================
 249
 250 Here is a link to the section which is the target of this
 251 internal link `Subsection #1-1`_.
 252
 253 """,
 254
 255 # expected output
 256 latex_head + r"""
 257 %___________________________________________________________________________
 258
 259 \section{1   Section {\#}1\label{section-1}}
 260
 261 Content for section {\#}1.
 262
 263
 264 %___________________________________________________________________________
 265
 266 \subsection{1.1   Subsection {\#}1-1\label{subsection-1-1}}
 267
 268 Content for sub-section {\#}1-1.
 269
 270
 271 %___________________________________________________________________________
 272
 273 \subsection{1.2   Subsection {\#}1-2\label{subsection-1-2}}
 274
 275 Content for sub-section {\#}1-2.
 276
 277
 278 %___________________________________________________________________________
 279
 280 \section{2   Section {\#}2\label{section-2}}
 281
 282 Content for section {\#}2.
 283
 284
 285 %___________________________________________________________________________
 286
 287 \section{3   Links Test Section\label{links-test-section}}
 288
 289 Here is a link to the section which is the target of this
 290 internal link \ref{subsection-1-1}.
 291
 292 \end{document}
 293 """],
 294 ]
 295
 296 # ==============================================================
 297
 298 totest['seealso'] = [
 299 # input
 300 [rest_head + r"""
 301 See Also
 302 ========
 303
 304 `Docutils: Python Documentation Utilities`_
 305
 306 .. _`Docutils: Python Documentation Utilities`:
 307     http://docutils.sourceforge.net/
 308
 309 """,
 310
 311 # expected output
 312 latex_head + r"""
 313 %___________________________________________________________________________
 314
 315 \section{1   See Also\label{see-also}}
 316
 317 \ulink{Docutils: Python Documentation Utilities}{http://docutils.sourceforge.net/}
 318
 319 \end{document}
 320 """],
 321 ]
 322
 323
 324 # ==============================================================
 325
 326 totest['emphasis'] = [
 327 # input
 328 [rest_head + r"""
 329 Section #1
 330 ==========
 331
 332 This section contains *some emphaized text*.
 333
 334 It **also has some bold text**.
 335
 336 And ``this is sample text``, or, as it is known in reStructured
 337 Text, an in-line literal.
 338
 339 """,
 340
 341 # expected output
 342 latex_head + r"""
 343 %___________________________________________________________________________
 344
 345 \section{1   Section {\#}1\label{section-1}}
 346
 347 This section contains \emph{some emphaized text}.
 348
 349 It \strong{also has some bold text}.
 350
 351 And \samp{this is sample text}, or, as it is known in reStructured
 352 Text, an in-line literal.
 353
 354 \end{document}
 355 """],
 356 ]
 357
 358
 359 # ==============================================================
 360
 361 totest['blockquote'] = [
 362 # input
 363 [rest_head + r"""
 364 Block Quote Test
 365 ================
 366
 367 This section contains a paragraph which is followed by a block
 368 quote.  The block quote is a simple paragraph that is indented.
 369
 370     This is the block quoted paragraph.  It has several sentences.
 371     These sentences have empty content because they are only a
 372     test.  This is a test.  This is a test.  This is a test.  This
 373     is a test.  This is a test.  This is a test.
 374
 375
 376 Python Iteractive Session Test
 377 ==============================
 378
 379 This section has a Python interactive session.  It is a test.
 380 Here is the example session.
 381
 382 >>> import sys
 383 >>> print sys.version
 384 2.3 (#1, Jul 31 2003, 15:26:15)
 385 [GCC 3.2.3 20030415 (Debian prerelease)]
 386 >>> a = [11,22,33]
 387 >>> for x in a:
 388 ...   print x
 389 ...
 390 11
 391 22
 392 33
 393
 394
 395 Literal Block Test
 396 ==================
 397
 398 This section has a literal block.  In Python LaTeX it will be
 399 formatted in a verbatim environment::
 400
 401     def remove_lines(self, inStr, targetList):
 402         inLines = inStr.splitlines()
 403         outLines = []
 404         for line in inLines:
 405             remove = False
 406             for target in targetList:
 407                 if line.find(target) > -1:
 408                     remove = True
 409             if not remove:
 410                 outLines.append(line)
 411         outStr = '\n'.join(outLines)
 412         return outStr
 413
 414 """,
 415
 416 # expected output
 417 latex_head + r"""
 418 %___________________________________________________________________________
 419
 420 \section{1   Block Quote Test\label{block-quote-test}}
 421
 422 This section contains a paragraph which is followed by a block
 423 quote.  The block quote is a simple paragraph that is indented.
 424 \begin{quote}
 425
 426 This is the block quoted paragraph.  It has several sentences.
 427 These sentences have empty content because they are only a
 428 test.  This is a test.  This is a test.  This is a test.  This
 429 is a test.  This is a test.  This is a test.
 430 \end{quote}
 431
 432
 433 %___________________________________________________________________________
 434
 435 \section{2   Python Iteractive Session Test\label{python-iteractive-session-test}}
 436
 437 This section has a Python interactive session.  It is a test.
 438 Here is the example session.
 439 \begin{verbatim}
 440 >>> import sys
 441 >>> print sys.version
 442 2.3 (#1, Jul 31 2003, 15:26:15)
 443 [GCC 3.2.3 20030415 (Debian prerelease)]
 444 >>> a = [11,22,33]
 445 >>> for x in a:
 446 ...   print x
 447 ...
 448 11
 449 22
 450 33
 451 \end{verbatim}
 452
 453
 454 %___________________________________________________________________________
 455
 456 \section{3   Literal Block Test\label{literal-block-test}}
 457
 458 This section has a literal block.  In Python LaTeX it will be
 459 formatted in a verbatim environment:
 460
 461 \begin{verbatim}
 462 def remove_lines(self, inStr, targetList):
 463     inLines = inStr.splitlines()
 464     outLines = []
 465     for line in inLines:
 466         remove = False
 467         for target in targetList:
 468             if line.find(target) > -1:
 469                 remove = True
 470         if not remove:
 471             outLines.append(line)
 472     outStr = '\n'.join(outLines)
 473     return outStr
 474 \end{verbatim}
 475
 476 \end{document}
 477 """],
 478 ]
 479
 480
 481 # ==============================================================
 482
 483 if __name__ == '__main__':
 484     import unittest
 485     unittest.main(defaultTest='suite')
 486
 487
 488
 489
 490