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
|
<?xml version="1.0" encoding="ascii" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ascii" />
<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
<title>End-to-end Tests for Unicode Encoding</title>
<link rel="stylesheet" href="../custom.css" type="text/css" />
</head>
<body>
<div class="document" id="end-to-end-tests-for-unicode-encoding">
<h1 class="title">End-to-end Tests for Unicode Encoding</h1>
<div class="section" id="test-function">
<h1>Test Function</h1>
<p>The function <cite>testencoding</cite> is used as an end-to-end test for unicode
encodings. It takes a given string, writes it to a python file, and
processes that file's documentation. It then generates HTML output
from the documentation, extracts all docstrings from the generated
HTML output, and displays them. (In order to extract & display all
docstrings, it monkey-patches the HMTLwriter.docstring_to_html()
method.)</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> epydoc.test.util <span class="py-keyword">import</span> testencoding</pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> epydoc.test.util <span class="py-keyword">import</span> print_warnings
<span class="py-prompt">>>> </span>print_warnings()</pre>
</blockquote>
</div>
<div class="section" id="encoding-tests">
<h1>Encoding Tests</h1>
<p>This section tests the output for a variety of different encodings.
Note that some encodings (such as cp424) are not supported, since
the ascii coding directive would result in a syntax error in the
new encoding.</p>
<p>Tests for several Microsoft codepges:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: cp874 -*-</span>
<span class="py-more">... </span><span class="py-string">"""abc ABC 123 \x80 \x85"""</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output"><p>abc ABC 123 &#8364; &#8230;</p></span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: cp1250 -*-</span>
<span class="py-more">... </span><span class="py-string">"""abc ABC 123 \x80 \x82 \x84 \x85 \xff"""</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output"><p>abc ABC 123 &#8364; &#8218; &#8222; &#8230; &#729;</p></span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: cp1251 -*-</span>
<span class="py-more">... </span><span class="py-string">"""abc ABC 123 \x80 \x81 \x82 \xff"""</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output"><p>abc ABC 123 &#1026; &#1027; &#8218; &#1103;</p></span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: cp1252 -*-</span>
<span class="py-more">... </span><span class="py-string">"""abc ABC 123 \x80 \x82 \x83 \xff"""</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output"><p>abc ABC 123 &#8364; &#8218; &#402; &#255;</p></span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: cp1253 -*-</span>
<span class="py-more">... </span><span class="py-string">"""abc ABC 123 \x80 \x82 \x83 \xfe"""</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output"><p>abc ABC 123 &#8364; &#8218; &#402; &#974;</p></span></pre>
</blockquote>
<p>Unicode tests:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>utf8_test =<span class="py-string">'''\</span>
<span class="py-more">... </span><span class="py-string">"""abc ABC 123</span>
<span class="py-more">...</span>
<span class="py-more">... </span><span class="py-string">0x80-0x7ff range:</span>
<span class="py-more">... </span><span class="py-string">\xc2\x80 \xc2\x81 \xdf\xbe \xdf\xbf</span>
<span class="py-more">...</span>
<span class="py-more">... </span><span class="py-string">0x800-0xffff range:</span>
<span class="py-more">... </span><span class="py-string">\xe0\xa0\x80 \xe0\xa0\x81 \xef\xbf\xbe \xef\xbf\xbf</span>
<span class="py-more">...</span>
<span class="py-more">... </span><span class="py-string">0x10000-0x10ffff range:</span>
<span class="py-more">... </span><span class="py-string">\xf0\x90\x80\x80 \xf0\x90\x80\x81</span>
<span class="py-more">... </span><span class="py-string">\xf4\x8f\xbf\xbe \xf4\x8f\xbf\xbf</span>
<span class="py-more">... </span><span class="py-string">"""\n'''</span>
<span class="py-prompt">>>> </span>utf8_bom = <span class="py-string">'\xef\xbb\xbf'</span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-comment"># UTF-8 with a coding directive:</span>
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">"# -*- coding: utf-8 -*-\n"</span>+utf8_test)
<span class="py-output"><p>abc ABC 123</p></span>
<span class="py-output"><p>0x80-0x7ff range: &#128; &#129; &#2046; &#2047;</p></span>
<span class="py-output"><p>0x800-0xffff range: &#2048; &#2049; &#65534; &#65535;</p></span>
<span class="py-output"><p>0x10000-0x10ffff range: &#65536; &#65537; &#1114110; &#1114111;</p></span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-comment"># UTF-8 with a BOM & a coding directive:</span>
<span class="py-prompt">>>> </span>testencoding(utf8_bom+<span class="py-string">"# -*- coding: utf-8 -*-\n"</span>+utf8_test)
<span class="py-output"><p>abc ABC 123</p></span>
<span class="py-output"><p>0x80-0x7ff range: &#128; &#129; &#2046; &#2047;</p></span>
<span class="py-output"><p>0x800-0xffff range: &#2048; &#2049; &#65534; &#65535;</p></span>
<span class="py-output"><p>0x10000-0x10ffff range: &#65536; &#65537; &#1114110; &#1114111;</p></span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-comment"># UTF-8 with a BOM & no coding directive:</span>
<span class="py-prompt">>>> </span>testencoding(utf8_bom+utf8_test)
<span class="py-output"><p>abc ABC 123</p></span>
<span class="py-output"><p>0x80-0x7ff range: &#128; &#129; &#2046; &#2047;</p></span>
<span class="py-output"><p>0x800-0xffff range: &#2048; &#2049; &#65534; &#65535;</p></span>
<span class="py-output"><p>0x10000-0x10ffff range: &#65536; &#65537; &#1114110; &#1114111;</p></span></pre>
</blockquote>
<p>Tests for KOI8-R:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: koi8-r -*-</span>
<span class="py-more">... </span><span class="py-string">"""abc ABC 123 \x80 \x82 \x83 \xff"""</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output"><p>abc ABC 123 &#9472; &#9484; &#9488; &#1066;</p></span></pre>
</blockquote>
<p>Tests for 'coding' directive on the second line:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''\n# -*- coding: cp1252 -*-</span>
<span class="py-more">... </span><span class="py-string">"""abc ABC 123 \x80 \x82 \x83 \xff"""</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output"><p>abc ABC 123 &#8364; &#8218; &#402; &#255;</p></span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# comment on the first line.\n# -*- coding: cp1252 -*-</span>
<span class="py-more">... </span><span class="py-string">"""abc ABC 123 \x80 \x82 \x83 \xff"""</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output"><p>abc ABC 123 &#8364; &#8218; &#402; &#255;</p></span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">"\n# -*- coding: utf-8 -*-\n"</span>+utf8_test)
<span class="py-output"><p>abc ABC 123</p></span>
<span class="py-output"><p>0x80-0x7ff range: &#128; &#129; &#2046; &#2047;</p></span>
<span class="py-output"><p>0x800-0xffff range: &#2048; &#2049; &#65534; &#65535;</p></span>
<span class="py-output"><p>0x10000-0x10ffff range: &#65536; &#65537; &#1114110; &#1114111;</p></span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">"# comment\n# -*- coding: utf-8 -*-\n"</span>+utf8_test)
<span class="py-output"><p>abc ABC 123</p></span>
<span class="py-output"><p>0x80-0x7ff range: &#128; &#129; &#2046; &#2047;</p></span>
<span class="py-output"><p>0x800-0xffff range: &#2048; &#2049; &#65534; &#65535;</p></span>
<span class="py-output"><p>0x10000-0x10ffff range: &#65536; &#65537; &#1114110; &#1114111;</p></span></pre>
</blockquote>
<p>Tests for shift-jis</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: shift_jis -*-</span>
<span class="py-more">... </span><span class="py-string">"""abc ABC 123 \xA1 \xA2 \xA3"""</span>
<span class="py-more">... </span><span class="py-string">'''</span>) <span class="py-comment"># doctest: +PYTHON2.4</span>
<span class="py-output">abc ABC 123 &#65377; &#65378; &#65379;</span></pre>
</blockquote>
</div>
<div class="section" id="str-unicode-test">
<h1>Str/Unicode Test</h1>
<p>Make sure that we use the coding for both str and unicode docstrings.</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: utf-8 -*-</span>
<span class="py-more">... </span><span class="py-string">"""abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80"""</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output"><p>abc ABC 123 &#128; &#2047; &#2048;</p></span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: utf-8 -*-</span>
<span class="py-more">... </span><span class="py-string">u"""abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80"""</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output"><p>abc ABC 123 &#128; &#2047; &#2048;</p></span></pre>
</blockquote>
<p>Under special circumstances, we may not be able to tell what the
proper encoding for a docstring is. This happens if:</p>
<ol class="arabic simple">
<li>the docstring is only available via introspection.</li>
<li>we are unable to determine what module the object that owns
the docstring came from.</li>
<li>the docstring contains non-ascii characters</li>
</ol>
<p>Under these circumstances, we issue a warning, and treat the docstring
as latin-1. An example of this is a non-unicode docstring for
properties:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: utf-8 -*-</span>
<span class="py-more">... </span><span class="py-string">p=property(doc="""\xc2\x80""")</span>
<span class="py-more">... </span><span class="py-string">'''</span>) <span class="py-comment"># doctest: +ELLIPSIS</span>
<span class="py-output"><property object at ...>'s docstring is not a unicode string, but it contains non-ascii data -- treating it as latin-1.</span>
<span class="py-output">&#194;&#128;</span></pre>
</blockquote>
</div>
<div class="section" id="introspection-parsing-tests">
<h1>Introspection/Parsing Tests</h1>
<p>This section checks to make sure that both introspection & parsing are
getting the right results.</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">"# -*- coding: utf-8 -*-\n"</span>+utf8_test, introspect=False)
<span class="py-output"><p>abc ABC 123</p></span>
<span class="py-output"><p>0x80-0x7ff range: &#128; &#129; &#2046; &#2047;</p></span>
<span class="py-output"><p>0x800-0xffff range: &#2048; &#2049; &#65534; &#65535;</p></span>
<span class="py-output"><p>0x10000-0x10ffff range: &#65536; &#65537; &#1114110; &#1114111;</p></span>
<span class="py-output"></span><span class="py-prompt">>>> </span>testencoding(utf8_bom+<span class="py-string">"# -*- coding: utf-8 -*-\n"</span>+utf8_test, introspect=False)
<span class="py-output"><p>abc ABC 123</p></span>
<span class="py-output"><p>0x80-0x7ff range: &#128; &#129; &#2046; &#2047;</p></span>
<span class="py-output"><p>0x800-0xffff range: &#2048; &#2049; &#65534; &#65535;</p></span>
<span class="py-output"><p>0x10000-0x10ffff range: &#65536; &#65537; &#1114110; &#1114111;</p></span>
<span class="py-output"></span><span class="py-prompt">>>> </span>testencoding(utf8_bom+utf8_test, introspect=False)
<span class="py-output"><p>abc ABC 123</p></span>
<span class="py-output"><p>0x80-0x7ff range: &#128; &#129; &#2046; &#2047;</p></span>
<span class="py-output"><p>0x800-0xffff range: &#2048; &#2049; &#65534; &#65535;</p></span>
<span class="py-output"><p>0x10000-0x10ffff range: &#65536; &#65537; &#1114110; &#1114111;</p></span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">"# -*- coding: utf-8 -*-\n"</span>+utf8_test, parse=False)
<span class="py-output"><p>abc ABC 123</p></span>
<span class="py-output"><p>0x80-0x7ff range: &#128; &#129; &#2046; &#2047;</p></span>
<span class="py-output"><p>0x800-0xffff range: &#2048; &#2049; &#65534; &#65535;</p></span>
<span class="py-output"><p>0x10000-0x10ffff range: &#65536; &#65537; &#1114110; &#1114111;</p></span>
<span class="py-output"></span><span class="py-prompt">>>> </span>testencoding(utf8_bom+<span class="py-string">"# -*- coding: utf-8 -*-\n"</span>+utf8_test, parse=False)
<span class="py-output"><p>abc ABC 123</p></span>
<span class="py-output"><p>0x80-0x7ff range: &#128; &#129; &#2046; &#2047;</p></span>
<span class="py-output"><p>0x800-0xffff range: &#2048; &#2049; &#65534; &#65535;</p></span>
<span class="py-output"><p>0x10000-0x10ffff range: &#65536; &#65537; &#1114110; &#1114111;</p></span>
<span class="py-output"></span><span class="py-prompt">>>> </span>testencoding(utf8_bom+utf8_test, parse=False)
<span class="py-output"><p>abc ABC 123</p></span>
<span class="py-output"><p>0x80-0x7ff range: &#128; &#129; &#2046; &#2047;</p></span>
<span class="py-output"><p>0x800-0xffff range: &#2048; &#2049; &#65534; &#65535;</p></span>
<span class="py-output"><p>0x10000-0x10ffff range: &#65536; &#65537; &#1114110; &#1114111;</p></span></pre>
</blockquote>
</div>
<div class="section" id="context-checks">
<h1>Context checks</h1>
<p>Make sure that docstrings are rendered correctly in different contexts.</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: utf-8 -*-</span>
<span class="py-more">... </span><span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string">@var x: abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80</span>
<span class="py-more">... </span><span class="py-string">@group \xc2\x80: x</span>
<span class="py-more">... </span><span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: utf-8 -*-</span>
<span class="py-more">... </span><span class="py-string">def f(x):</span>
<span class="py-more">... </span><span class="py-string"> """</span>
<span class="py-more">... </span><span class="py-string"> abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80</span>
<span class="py-more">... </span><span class="py-string"> @param x: abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80</span>
<span class="py-more">... </span><span class="py-string"> @type x: abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80</span>
<span class="py-more">... </span><span class="py-string"> @return: abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80</span>
<span class="py-more">... </span><span class="py-string"> @rtype: abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80</span>
<span class="py-more">... </span><span class="py-string"> @except X: abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80</span>
<span class="py-more">... </span><span class="py-string"> """</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span>
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span>
<span class="py-output"><p>abc ABC 123 &#128; &#2047; &#2048;</p></span>
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span>
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span>
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span>
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span>
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>testencoding(<span class="py-string">'''# -*- coding: utf-8 -*-</span>
<span class="py-more">... </span><span class="py-string">class A:</span>
<span class="py-more">... </span><span class="py-string"> """</span>
<span class="py-more">... </span><span class="py-string"> abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80</span>
<span class="py-more">... </span><span class="py-string"> @ivar x: abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80</span>
<span class="py-more">... </span><span class="py-string"> @cvar y: abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80</span>
<span class="py-more">... </span><span class="py-string"> @type x: abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80</span>
<span class="py-more">... </span><span class="py-string"> """</span>
<span class="py-more">...</span>
<span class="py-more">... </span><span class="py-string"> z = property(doc=u"abc ABC 123 \xc2\x80 \xdf\xbf \xe0\xa0\x80")</span>
<span class="py-more">... </span><span class="py-string">'''</span>)
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span>
<span class="py-output"><p>abc ABC 123 &#128; &#2047; &#2048;</p></span>
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span>
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span>
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span>
<span class="py-output">abc ABC 123 &#128; &#2047; &#2048;</span></pre>
</blockquote>
</div>
</div>
<table width="100%" class="navbox" cellpadding="1" cellspacing="0">
<tr>
<a class="nav" href="../index.html">
<td align="center" width="20%" class="nav">
<a class="nav" href="../index.html">
Home</a></td></a>
<a class="nav" href="../installing.html">
<td align="center" width="20%" class="nav">
<a class="nav" href="../installing.html">
Installing Epydoc</a></td></a>
<a class="nav" href="../using.html">
<td align="center" width="20%" class="nav">
<a class="nav" href="../using.html">
Using Epydoc</a></td></a>
<a class="nav" href="../epytext.html">
<td align="center" width="20%" class="nav">
<a class="nav" href="../epytext.html">
Epytext</a></td></a>
<td align="center" width="20%" class="nav">
<A href="http://sourceforge.net/projects/epydoc">
<IMG src="../sflogo.png"
width="88" height="26" border="0" alt="SourceForge"
align="top"/></A></td>
</tr>
</table>
</body>
</html>
|