/python-gzipstream-1.7.1/html/gzipstream._StreamBuf-class.html

# · HTML · 729 lines · 648 code · 59 blank · 22 comment · 0 complexity · 63fd6e4200db557c6ed0bba64b7f591a MD5 · raw file 

    

  1. <?xml version="1.0" encoding="ascii"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.           "DTD/xhtml1-transitional.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.   <title>gzipstream._StreamBuf</title>
    7. 

  7.   <link rel="stylesheet" href="epydoc.css" type="text/css" />
    8. 

  8.   <script type="text/javascript" src="epydoc.js"></script>
    9. 

  9. </head>
    10. 

  10. 

  11. <body bgcolor="white" text="black" link="blue" vlink="#204080"
    12. 

  12.       alink="#204080">
    13. 

  13. <!-- ==================== NAVIGATION BAR ==================== -->
    14. 

  14. <table class="navbar" border="0" width="100%" cellpadding="0"
    15. 

  15.        bgcolor="#a0c0ff" cellspacing="0">
    16. 

  16.   <tr valign="middle">
    17. 

  17.   <!-- Home link -->
    18. 

  18.       <th>&nbsp;&nbsp;&nbsp;<a
    19. 

  19.         href="gzipstream-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    20. 

  20. 

  21.   <!-- Tree link -->
    22. 

  22.       <th>&nbsp;&nbsp;&nbsp;<a
    23. 

  23.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    24. 

  24. 

  25.   <!-- Index link -->
    26. 

  26.       <th>&nbsp;&nbsp;&nbsp;<a
    27. 

  27.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    28. 

  28. 

  29.   <!-- Help link -->
    30. 

  30.       <th>&nbsp;&nbsp;&nbsp;<a
    31. 

  31.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    32. 

  32. 

  33.       <th class="navbar" width="100%"></th>
    34. 

  34.   </tr>
    35. 

  35. </table>
    36. 

  36. <table width="100%" cellpadding="0" cellspacing="0">
    37. 

  37.   <tr valign="top">
    38. 

  38.     <td width="100%">
    39. 

  39.       <span class="breadcrumbs">
    40. 

  40.         <a href="gzipstream-module.html">Module&nbsp;gzipstream</a> ::
    41. 

  41.         Class&nbsp;_StreamBuf
    42. 

  42.       </span>
    43. 

  43.     </td>
    44. 

  44.     <td>
    45. 

  45.       <table cellpadding="0" cellspacing="0">
    46. 

  46.         <!-- hide/show private -->
    47. 

  47.         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    48. 

  48.     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
    49. 

  49.         <tr><td align="right"><span class="options"
    50. 

  50.             >[<a href="frames.html" target="_top">frames</a
    51. 

  51.             >]&nbsp;|&nbsp;<a href="gzipstream._StreamBuf-class.html"
    52. 

  52.             target="_top">no&nbsp;frames</a>]</span></td></tr>
    53. 

  53.       </table>
    54. 

  54.     </td>
    55. 

  55.   </tr>
    56. 

  56. </table>
    57. 

  57. <!-- ==================== CLASS DESCRIPTION ==================== -->
    58. 

  58. <h1 class="epydoc">Class _StreamBuf</h1><p class="nomargin-top"><span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf">source&nbsp;code</a></span></p>
    59. 

  59. <p>Stream buffer for file-like objects.</p>
    60. 

  60.   <p>Allow seeks on socket-like objects. Enables non-seekable file-like 
    61. 

  61.   objects some flexibility as regards to seeking. It does this via a 
    62. 

  62.   buffer, a StringIO object. Note, because it is assumed that a socket 
    63. 

  63.   stream is being manipulated, once the buffer &quot;window&quot; has 
    64. 

  64.   passed over a data segment, seeking prior to that is not allowed. XXX: 
    65. 

  65.   probably reinventing the wheel.</p>
    66. 

  66. 

  67. <!-- ==================== INSTANCE METHODS ==================== -->
    68. 

  68. <a name="section-InstanceMethods"></a>
    69. 

  69. <table class="summary" border="1" cellpadding="3"
    70. 

  70.        cellspacing="0" width="100%" bgcolor="white">
    71. 

  71. <tr bgcolor="#70b0f0" class="table-header">
    72. 

  72.   <td colspan="2" class="table-header">
    73. 

  73.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    74. 

  74.       <tr valign="top">
    75. 

  75.         <td align="left"><span class="table-header">Instance Methods</span></td>
    76. 

  76.         <td align="right" valign="top"
    77. 

  77.          ><span class="options">[<a href="#section-InstanceMethods"
    78. 

  78.          class="privatelink" onclick="toggle_private();"
    79. 

  79.          >hide private</a>]</span></td>
    80. 

  80.       </tr>
    81. 

  81.     </table>
    82. 

  82.   </td>
    83. 

  83. </tr>
    84. 

  84. <tr>
    85. 

  85.     <td width="15%" align="right" valign="top" class="summary">
    86. 

  86.       <span class="summary-type">&nbsp;</span>
    87. 

  87.     </td><td class="summary">
    88. 

  88.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    89. 

  89.         <tr>
    90. 

  90.           <td><span class="summary-sig"><a href="gzipstream._StreamBuf-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
    91. 

  91.         <span class="summary-sig-arg">stream</span>=<span class="summary-sig-default">None</span>,
    92. 

  92.         <span class="summary-sig-arg">mode</span>=<span class="summary-sig-default">None</span>)</span><br />
    93. 

  93.       Constructor.</td>
    94. 

  94.           <td align="right" valign="top">
    95. 

  95.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.__init__">source&nbsp;code</a></span>
    96. 

  96.             
    97. 

  97.           </td>
    98. 

  98.         </tr>
    99. 

  99.       </table>
    100. 

  100.       
    101. 

  101.     </td>
    102. 

  102.   </tr>
    103. 

  103. <tr>
    104. 

  104.     <td width="15%" align="right" valign="top" class="summary">
    105. 

  105.       <span class="summary-type">&nbsp;</span>
    106. 

  106.     </td><td class="summary">
    107. 

  107.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    108. 

  108.         <tr>
    109. 

  109.           <td><span class="summary-sig"><a name="__del__"></a><span class="summary-sig-name">__del__</span>(<span class="summary-sig-arg">self</span>)</span><br />
    110. 

  110.       Destructor</td>
    111. 

  111.           <td align="right" valign="top">
    112. 

  112.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.__del__">source&nbsp;code</a></span>
    113. 

  113.             
    114. 

  114.           </td>
    115. 

  115.         </tr>
    116. 

  116.       </table>
    117. 

  117.       
    118. 

  118.     </td>
    119. 

  119.   </tr>
    120. 

  120. <tr>
    121. 

  121.     <td width="15%" align="right" valign="top" class="summary">
    122. 

  122.       <span class="summary-type">&nbsp;</span>
    123. 

  123.     </td><td class="summary">
    124. 

  124.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    125. 

  125.         <tr>
    126. 

  126.           <td><span class="summary-sig"><a name="isatty"></a><span class="summary-sig-name">isatty</span>(<span class="summary-sig-arg">self</span>)</span></td>
    127. 

  127.           <td align="right" valign="top">
    128. 

  128.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.isatty">source&nbsp;code</a></span>
    129. 

  129.             
    130. 

  130.           </td>
    131. 

  131.         </tr>
    132. 

  132.       </table>
    133. 

  133.       
    134. 

  134.     </td>
    135. 

  135.   </tr>
    136. 

  136. <tr class="private">
    137. 

  137.     <td width="15%" align="right" valign="top" class="summary">
    138. 

  138.       <span class="summary-type">&nbsp;</span>
    139. 

  139.     </td><td class="summary">
    140. 

  140.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    141. 

  141.         <tr>
    142. 

  142.           <td><span class="summary-sig"><a name="_read"></a><span class="summary-sig-name">_read</span>(<span class="summary-sig-arg">self</span>,
    143. 

  143.         <span class="summary-sig-arg">size</span>)</span><br />
    144. 

  144.       A buffered read --- refactored.</td>
    145. 

  145.           <td align="right" valign="top">
    146. 

  146.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf._read">source&nbsp;code</a></span>
    147. 

  147.             
    148. 

  148.           </td>
    149. 

  149.         </tr>
    150. 

  150.       </table>
    151. 

  151.       
    152. 

  152.     </td>
    153. 

  153.   </tr>
    154. 

  154. <tr>
    155. 

  155.     <td width="15%" align="right" valign="top" class="summary">
    156. 

  156.       <span class="summary-type">&nbsp;</span>
    157. 

  157.     </td><td class="summary">
    158. 

  158.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    159. 

  159.         <tr>
    160. 

  160.           <td><span class="summary-sig"><a name="read"></a><span class="summary-sig-name">read</span>(<span class="summary-sig-arg">self</span>,
    161. 

  161.         <span class="summary-sig-arg">size</span>=<span class="summary-sig-default">None</span>)</span><br />
    162. 

  162.       A buffered read.</td>
    163. 

  163.           <td align="right" valign="top">
    164. 

  164.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.read">source&nbsp;code</a></span>
    165. 

  165.             
    166. 

  166.           </td>
    167. 

  167.         </tr>
    168. 

  168.       </table>
    169. 

  169.       
    170. 

  170.     </td>
    171. 

  171.   </tr>
    172. 

  172. <tr>
    173. 

  173.     <td width="15%" align="right" valign="top" class="summary">
    174. 

  174.       <span class="summary-type">&nbsp;</span>
    175. 

  175.     </td><td class="summary">
    176. 

  176.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    177. 

  177.         <tr>
    178. 

  178.           <td><span class="summary-sig"><a name="readline"></a><span class="summary-sig-name">readline</span>(<span class="summary-sig-arg">self</span>)</span><br />
    179. 

  179.       Return one line of text: a string ending in a ' ' or EOF.</td>
    180. 

  180.           <td align="right" valign="top">
    181. 

  181.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.readline">source&nbsp;code</a></span>
    182. 

  182.             
    183. 

  183.           </td>
    184. 

  184.         </tr>
    185. 

  185.       </table>
    186. 

  186.       
    187. 

  187.     </td>
    188. 

  188.   </tr>
    189. 

  189. <tr>
    190. 

  190.     <td width="15%" align="right" valign="top" class="summary">
    191. 

  191.       <span class="summary-type">&nbsp;</span>
    192. 

  192.     </td><td class="summary">
    193. 

  193.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    194. 

  194.         <tr>
    195. 

  195.           <td><span class="summary-sig"><a name="readlines"></a><span class="summary-sig-name">readlines</span>(<span class="summary-sig-arg">self</span>)</span><br />
    196. 

  196.       Read entire file into memory! And return a list of lines of text.</td>
    197. 

  197.           <td align="right" valign="top">
    198. 

  198.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.readlines">source&nbsp;code</a></span>
    199. 

  199.             
    200. 

  200.           </td>
    201. 

  201.         </tr>
    202. 

  202.       </table>
    203. 

  203.       
    204. 

  204.     </td>
    205. 

  205.   </tr>
    206. 

  206. <tr class="private">
    207. 

  207.     <td width="15%" align="right" valign="top" class="summary">
    208. 

  208.       <span class="summary-type">&nbsp;</span>
    209. 

  209.     </td><td class="summary">
    210. 

  210.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    211. 

  211.         <tr>
    212. 

  212.           <td><span class="summary-sig"><a name="_refactorBufIO"></a><span class="summary-sig-name">_refactorBufIO</span>(<span class="summary-sig-arg">self</span>,
    213. 

  213.         <span class="summary-sig-arg">writeFlushYN</span>=<span class="summary-sig-default">0</span>)</span><br />
    214. 

  214.       Keep the buffer window within __{MAX,ABS_MAX}_BUF_SIZE before the 
    215. 

  215.       current self._bufIO.tell() position.</td>
    216. 

  216.           <td align="right" valign="top">
    217. 

  217.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf._refactorBufIO">source&nbsp;code</a></span>
    218. 

  218.             
    219. 

  219.           </td>
    220. 

  220.         </tr>
    221. 

  221.       </table>
    222. 

  222.       
    223. 

  223.     </td>
    224. 

  224.   </tr>
    225. 

  225. <tr class="private">
    226. 

  226.     <td width="15%" align="right" valign="top" class="summary">
    227. 

  227.       <span class="summary-type">&nbsp;</span>
    228. 

  228.     </td><td class="summary">
    229. 

  229.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    230. 

  230.         <tr>
    231. 

  231.           <td><span class="summary-sig"><a name="_dumpValues"></a><span class="summary-sig-name">_dumpValues</span>(<span class="summary-sig-arg">self</span>)</span><br />
    232. 

  232.       Debug code.</td>
    233. 

  233.           <td align="right" valign="top">
    234. 

  234.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf._dumpValues">source&nbsp;code</a></span>
    235. 

  235.             
    236. 

  236.           </td>
    237. 

  237.         </tr>
    238. 

  238.       </table>
    239. 

  239.       
    240. 

  240.     </td>
    241. 

  241.   </tr>
    242. 

  242. <tr>
    243. 

  243.     <td width="15%" align="right" valign="top" class="summary">
    244. 

  244.       <span class="summary-type">&nbsp;</span>
    245. 

  245.     </td><td class="summary">
    246. 

  246.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    247. 

  247.         <tr>
    248. 

  248.           <td><span class="summary-sig"><a name="write"></a><span class="summary-sig-name">write</span>(<span class="summary-sig-arg">self</span>,
    249. 

  249.         <span class="summary-sig-arg">s</span>)</span><br />
    250. 

  250.       Write string to stream.</td>
    251. 

  251.           <td align="right" valign="top">
    252. 

  252.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.write">source&nbsp;code</a></span>
    253. 

  253.             
    254. 

  254.           </td>
    255. 

  255.         </tr>
    256. 

  256.       </table>
    257. 

  257.       
    258. 

  258.     </td>
    259. 

  259.   </tr>
    260. 

  260. <tr>
    261. 

  261.     <td width="15%" align="right" valign="top" class="summary">
    262. 

  262.       <span class="summary-type">&nbsp;</span>
    263. 

  263.     </td><td class="summary">
    264. 

  264.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    265. 

  265.         <tr>
    266. 

  266.           <td><span class="summary-sig"><a name="writelines"></a><span class="summary-sig-name">writelines</span>(<span class="summary-sig-arg">self</span>,
    267. 

  267.         <span class="summary-sig-arg">l</span>)</span><br />
    268. 

  268.       Given list, concatenate and write.</td>
    269. 

  269.           <td align="right" valign="top">
    270. 

  270.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.writelines">source&nbsp;code</a></span>
    271. 

  271.             
    272. 

  272.           </td>
    273. 

  273.         </tr>
    274. 

  274.       </table>
    275. 

  275.       
    276. 

  276.     </td>
    277. 

  277.   </tr>
    278. 

  278. <tr>
    279. 

  279.     <td width="15%" align="right" valign="top" class="summary">
    280. 

  280.       <span class="summary-type">&nbsp;</span>
    281. 

  281.     </td><td class="summary">
    282. 

  282.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    283. 

  283.         <tr>
    284. 

  284.           <td><span class="summary-sig"><a href="gzipstream._StreamBuf-class.html#seek" class="summary-sig-name">seek</a>(<span class="summary-sig-arg">self</span>,
    285. 

  285.         <span class="summary-sig-arg">offset</span>,
    286. 

  286.         <span class="summary-sig-arg">where</span>=<span class="summary-sig-default">0</span>)</span><br />
    287. 

  287.       A limited seek method.</td>
    288. 

  288.           <td align="right" valign="top">
    289. 

  289.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.seek">source&nbsp;code</a></span>
    290. 

  290.             
    291. 

  291.           </td>
    292. 

  292.         </tr>
    293. 

  293.       </table>
    294. 

  294.       
    295. 

  295.     </td>
    296. 

  296.   </tr>
    297. 

  297. <tr>
    298. 

  298.     <td width="15%" align="right" valign="top" class="summary">
    299. 

  299.       <span class="summary-type">&nbsp;</span>
    300. 

  300.     </td><td class="summary">
    301. 

  301.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    302. 

  302.         <tr>
    303. 

  303.           <td><span class="summary-sig"><a name="tell"></a><span class="summary-sig-name">tell</span>(<span class="summary-sig-arg">self</span>)</span><br />
    304. 

  304.       Return current position in the file-like object.</td>
    305. 

  305.           <td align="right" valign="top">
    306. 

  306.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.tell">source&nbsp;code</a></span>
    307. 

  307.             
    308. 

  308.           </td>
    309. 

  309.         </tr>
    310. 

  310.       </table>
    311. 

  311.       
    312. 

  312.     </td>
    313. 

  313.   </tr>
    314. 

  314. <tr>
    315. 

  315.     <td width="15%" align="right" valign="top" class="summary">
    316. 

  316.       <span class="summary-type">&nbsp;</span>
    317. 

  317.     </td><td class="summary">
    318. 

  318.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    319. 

  319.         <tr>
    320. 

  320.           <td><span class="summary-sig"><a href="gzipstream._StreamBuf-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>)</span><br />
    321. 

  321.       Flush the buffer.</td>
    322. 

  322.           <td align="right" valign="top">
    323. 

  323.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.close">source&nbsp;code</a></span>
    324. 

  324.             
    325. 

  325.           </td>
    326. 

  326.         </tr>
    327. 

  327.       </table>
    328. 

  328.       
    329. 

  329.     </td>
    330. 

  330.   </tr>
    331. 

  331. <tr>
    332. 

  332.     <td width="15%" align="right" valign="top" class="summary">
    333. 

  333.       <span class="summary-type">&nbsp;</span>
    334. 

  334.     </td><td class="summary">
    335. 

  335.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    336. 

  336.         <tr>
    337. 

  337.           <td><span class="summary-sig"><a name="flush"></a><span class="summary-sig-name">flush</span>(<span class="summary-sig-arg">self</span>)</span><br />
    338. 

  338.       Flush the buffer.</td>
    339. 

  339.           <td align="right" valign="top">
    340. 

  340.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.flush">source&nbsp;code</a></span>
    341. 

  341.             
    342. 

  342.           </td>
    343. 

  343.         </tr>
    344. 

  344.       </table>
    345. 

  345.       
    346. 

  346.     </td>
    347. 

  347.   </tr>
    348. 

  348. <tr>
    349. 

  349.     <td width="15%" align="right" valign="top" class="summary">
    350. 

  350.       <span class="summary-type">&nbsp;</span>
    351. 

  351.     </td><td class="summary">
    352. 

  352.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    353. 

  353.         <tr>
    354. 

  354.           <td><span class="summary-sig"><a name="__repr__"></a><span class="summary-sig-name">__repr__</span>(<span class="summary-sig-arg">self</span>)</span></td>
    355. 

  355.           <td align="right" valign="top">
    356. 

  356.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.__repr__">source&nbsp;code</a></span>
    357. 

  357.             
    358. 

  358.           </td>
    359. 

  359.         </tr>
    360. 

  360.       </table>
    361. 

  361.       
    362. 

  362.     </td>
    363. 

  363.   </tr>
    364. 

  364. <tr class="private">
    365. 

  365.     <td width="15%" align="right" valign="top" class="summary">
    366. 

  366.       <span class="summary-type">&nbsp;</span>
    367. 

  367.     </td><td class="summary">
    368. 

  368.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    369. 

  369.         <tr>
    370. 

  370.           <td><span class="summary-sig"><a href="gzipstream._StreamBuf-class.html#__checkInt" class="summary-sig-name" onclick="show_private();">__checkInt</a>(<span class="summary-sig-arg">self</span>,
    371. 

  371.         <span class="summary-sig-arg">i</span>)</span><br />
    372. 

  372.       Might be faster just to declare them longs.</td>
    373. 

  373.           <td align="right" valign="top">
    374. 

  374.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.__checkInt">source&nbsp;code</a></span>
    375. 

  375.             
    376. 

  376.           </td>
    377. 

  377.         </tr>
    378. 

  378.       </table>
    379. 

  379.       
    380. 

  380.     </td>
    381. 

  381.   </tr>
    382. 

  382. <tr class="private">
    383. 

  383.     <td width="15%" align="right" valign="top" class="summary">
    384. 

  384.       <span class="summary-type">&nbsp;</span>
    385. 

  385.     </td><td class="summary">
    386. 

  386.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    387. 

  387.         <tr>
    388. 

  388.           <td><span class="summary-sig"><a href="gzipstream._StreamBuf-class.html#__debugThread" class="summary-sig-name" onclick="show_private();">__debugThread</a>(<span class="summary-sig-arg">self</span>)</span><br />
    389. 

  389.       XXX: Only used for debugging.</td>
    390. 

  390.           <td align="right" valign="top">
    391. 

  391.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.__debugThread">source&nbsp;code</a></span>
    392. 

  392.             
    393. 

  393.           </td>
    394. 

  394.         </tr>
    395. 

  395.       </table>
    396. 

  396.       
    397. 

  397.     </td>
    398. 

  398.   </tr>
    399. 

  399. <tr class="private">
    400. 

  400.     <td width="15%" align="right" valign="top" class="summary">
    401. 

  401.       <span class="summary-type">&nbsp;</span>
    402. 

  402.     </td><td class="summary">
    403. 

  403.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    404. 

  404.         <tr>
    405. 

  405.           <td><span class="summary-sig"><a href="gzipstream._StreamBuf-class.html#_StreamBuf__checkInt" class="summary-sig-name" onclick="show_private();">_StreamBuf__checkInt</a>(<span class="summary-sig-arg">self</span>,
    406. 

  406.         <span class="summary-sig-arg">i</span>)</span><br />
    407. 

  407.       Might be faster just to declare them longs.</td>
    408. 

  408.           <td align="right" valign="top">
    409. 

  409.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf._StreamBuf__checkInt">source&nbsp;code</a></span>
    410. 

  410.             
    411. 

  411.           </td>
    412. 

  412.         </tr>
    413. 

  413.       </table>
    414. 

  414.       
    415. 

  415.     </td>
    416. 

  416.   </tr>
    417. 

  417. <tr class="private">
    418. 

  418.     <td width="15%" align="right" valign="top" class="summary">
    419. 

  419.       <span class="summary-type">&nbsp;</span>
    420. 

  420.     </td><td class="summary">
    421. 

  421.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    422. 

  422.         <tr>
    423. 

  423.           <td><span class="summary-sig"><a href="gzipstream._StreamBuf-class.html#_StreamBuf__debugThread" class="summary-sig-name" onclick="show_private();">_StreamBuf__debugThread</a>(<span class="summary-sig-arg">self</span>)</span><br />
    424. 

  424.       XXX: Only used for debugging.</td>
    425. 

  425.           <td align="right" valign="top">
    426. 

  426.             <span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf._StreamBuf__debugThread">source&nbsp;code</a></span>
    427. 

  427.             
    428. 

  428.           </td>
    429. 

  429.         </tr>
    430. 

  430.       </table>
    431. 

  431.       
    432. 

  432.     </td>
    433. 

  433.   </tr>
    434. 

  434. </table>
    435. 

  435. <!-- ==================== CLASS VARIABLES ==================== -->
    436. 

  436. <a name="section-ClassVariables"></a>
    437. 

  437. <table class="summary" border="1" cellpadding="3"
    438. 

  438.        cellspacing="0" width="100%" bgcolor="white">
    439. 

  439. <tr bgcolor="#70b0f0" class="table-header">
    440. 

  440.   <td colspan="2" class="table-header">
    441. 

  441.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    442. 

  442.       <tr valign="top">
    443. 

  443.         <td align="left"><span class="table-header">Class Variables</span></td>
    444. 

  444.         <td align="right" valign="top"
    445. 

  445.          ><span class="options">[<a href="#section-ClassVariables"
    446. 

  446.          class="privatelink" onclick="toggle_private();"
    447. 

  447.          >hide private</a>]</span></td>
    448. 

  448.       </tr>
    449. 

  449.     </table>
    450. 

  450.   </td>
    451. 

  451. </tr>
    452. 

  452. <tr class="private">
    453. 

  453.     <td width="15%" align="right" valign="top" class="summary">
    454. 

  454.       <span class="summary-type">&nbsp;</span>
    455. 

  455.     </td><td class="summary">
    456. 

  456.         <a name="__MIN_READ_SIZE"></a><span class="summary-name">__MIN_READ_SIZE</span> = <code title="1024* 2">1024* 2</code>
    457. 

  457.     </td>
    458. 

  458.   </tr>
    459. 

  459. <tr class="private">
    460. 

  460.     <td width="15%" align="right" valign="top" class="summary">
    461. 

  461.       <span class="summary-type">&nbsp;</span>
    462. 

  462.     </td><td class="summary">
    463. 

  463.         <a name="__MAX_BUFIO_SIZE"></a><span class="summary-name">__MAX_BUFIO_SIZE</span> = <code title="__MIN_READ_SIZE* 10">__MIN_READ_SIZE* 10</code>
    464. 

  464.     </td>
    465. 

  465.   </tr>
    466. 

  466. <tr class="private">
    467. 

  467.     <td width="15%" align="right" valign="top" class="summary">
    468. 

  468.       <span class="summary-type">&nbsp;</span>
    469. 

  469.     </td><td class="summary">
    470. 

  470.         <a name="__ABS_MAX_BUFIO_SIZE"></a><span class="summary-name">__ABS_MAX_BUFIO_SIZE</span> = <code title="__MAX_BUFIO_SIZE* 2">__MAX_BUFIO_SIZE* 2</code>
    471. 

  471.     </td>
    472. 

  472.   </tr>
    473. 

  473. <tr class="private">
    474. 

  474.     <td width="15%" align="right" valign="top" class="summary">
    475. 

  475.       <span class="summary-type">&nbsp;</span>
    476. 

  476.     </td><td class="summary">
    477. 

  477.         <a name="__INT_CHECK_SIZE"></a><span class="summary-name">__INT_CHECK_SIZE</span> = <code title="sys.maxint-__ABS_MAX_BUFIO_SIZE-2">sys.maxint-__ABS_MAX_BUFIO_SIZE-2</code>
    478. 

  478.     </td>
    479. 

  479.   </tr>
    480. 

  480. <tr>
    481. 

  481.     <td width="15%" align="right" valign="top" class="summary">
    482. 

  482.       <span class="summary-type">&nbsp;</span>
    483. 

  483.     </td><td class="summary">
    484. 

  484.         <a name="VERSION"></a><span class="summary-name">VERSION</span> = <code title="2">2</code>
    485. 

  485.     </td>
    486. 

  486.   </tr>
    487. 

  487. <tr class="private">
    488. 

  488.     <td width="15%" align="right" valign="top" class="summary">
    489. 

  489.       <span class="summary-type">&nbsp;</span>
    490. 

  490.     </td><td class="summary">
    491. 

  491.         <a name="_StreamBuf__ABS_MAX_BUFIO_SIZE"></a><span class="summary-name">_StreamBuf__ABS_MAX_BUFIO_SIZE</span> = <code title="40960">40960</code>
    492. 

  492.     </td>
    493. 

  493.   </tr>
    494. 

  494. <tr class="private">
    495. 

  495.     <td width="15%" align="right" valign="top" class="summary">
    496. 

  496.       <span class="summary-type">&nbsp;</span>
    497. 

  497.     </td><td class="summary">
    498. 

  498.         <a name="_StreamBuf__INT_CHECK_SIZE"></a><span class="summary-name">_StreamBuf__INT_CHECK_SIZE</span> = <code title="9223372036854734845">9223372036854734845</code>
    499. 

  499.     </td>
    500. 

  500.   </tr>
    501. 

  501. <tr class="private">
    502. 

  502.     <td width="15%" align="right" valign="top" class="summary">
    503. 

  503.       <span class="summary-type">&nbsp;</span>
    504. 

  504.     </td><td class="summary">
    505. 

  505.         <a name="_StreamBuf__MAX_BUFIO_SIZE"></a><span class="summary-name">_StreamBuf__MAX_BUFIO_SIZE</span> = <code title="20480">20480</code>
    506. 

  506.     </td>
    507. 

  507.   </tr>
    508. 

  508. <tr class="private">
    509. 

  509.     <td width="15%" align="right" valign="top" class="summary">
    510. 

  510.       <span class="summary-type">&nbsp;</span>
    511. 

  511.     </td><td class="summary">
    512. 

  512.         <a name="_StreamBuf__MIN_READ_SIZE"></a><span class="summary-name">_StreamBuf__MIN_READ_SIZE</span> = <code title="2048">2048</code>
    513. 

  513.     </td>
    514. 

  514.   </tr>
    515. 

  515. </table>
    516. 

  516. <!-- ==================== METHOD DETAILS ==================== -->
    517. 

  517. <a name="section-MethodDetails"></a>
    518. 

  518. <table class="details" border="1" cellpadding="3"
    519. 

  519.        cellspacing="0" width="100%" bgcolor="white">
    520. 

  520. <tr bgcolor="#70b0f0" class="table-header">
    521. 

  521.   <td colspan="2" class="table-header">
    522. 

  522.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    523. 

  523.       <tr valign="top">
    524. 

  524.         <td align="left"><span class="table-header">Method Details</span></td>
    525. 

  525.         <td align="right" valign="top"
    526. 

  526.          ><span class="options">[<a href="#section-MethodDetails"
    527. 

  527.          class="privatelink" onclick="toggle_private();"
    528. 

  528.          >hide private</a>]</span></td>
    529. 

  529.       </tr>
    530. 

  530.     </table>
    531. 

  531.   </td>
    532. 

  532. </tr>
    533. 

  533. </table>
    534. 

  534. <a name="__init__"></a>
    535. 

  535. <div>
    536. 

  536. <table class="details" border="1" cellpadding="3"
    537. 

  537.        cellspacing="0" width="100%" bgcolor="white">
    538. 

  538. <tr><td>
    539. 

  539.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    540. 

  540.   <tr valign="top"><td>
    541. 

  541.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
    542. 

  542.         <span class="sig-arg">stream</span>=<span class="sig-default">None</span>,
    543. 

  543.         <span class="sig-arg">mode</span>=<span class="sig-default">None</span>)</span>
    544. 

  544.     <br /><em class="fname">(Constructor)</em>
    545. 

  545.   </h3>
    546. 

  546.   </td><td align="right" valign="top"
    547. 

  547.     ><span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.__init__">source&nbsp;code</a></span>&nbsp;
    548. 

  548.     </td>
    549. 

  549.   </tr></table>
    550. 

  550.   
    551. 

  551.   <p>Constructor. stream: an open file-like object.</p>
    552. 

  552.   <dl class="fields">
    553. 

  553.   </dl>
    554. 

  554. </td></tr></table>
    555. 

  555. </div>
    556. 

  556. <a name="seek"></a>
    557. 

  557. <div>
    558. 

  558. <table class="details" border="1" cellpadding="3"
    559. 

  559.        cellspacing="0" width="100%" bgcolor="white">
    560. 

  560. <tr><td>
    561. 

  561.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    562. 

  562.   <tr valign="top"><td>
    563. 

  563.   <h3 class="epydoc"><span class="sig"><span class="sig-name">seek</span>(<span class="sig-arg">self</span>,
    564. 

  564.         <span class="sig-arg">offset</span>,
    565. 

  565.         <span class="sig-arg">where</span>=<span class="sig-default">0</span>)</span>
    566. 

  566.   </h3>
    567. 

  567.   </td><td align="right" valign="top"
    568. 

  568.     ><span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.seek">source&nbsp;code</a></span>&nbsp;
    569. 

  569.     </td>
    570. 

  570.   </tr></table>
    571. 

  571.   
    572. 

  572.   <p>A limited seek method. See class __doc__ for more details.</p>
    573. 

  573.   <dl class="fields">
    574. 

  574.   </dl>
    575. 

  575. </td></tr></table>
    576. 

  576. </div>
    577. 

  577. <a name="close"></a>
    578. 

  578. <div>
    579. 

  579. <table class="details" border="1" cellpadding="3"
    580. 

  580.        cellspacing="0" width="100%" bgcolor="white">
    581. 

  581. <tr><td>
    582. 

  582.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    583. 

  583.   <tr valign="top"><td>
    584. 

  584.   <h3 class="epydoc"><span class="sig"><span class="sig-name">close</span>(<span class="sig-arg">self</span>)</span>
    585. 

  585.   </h3>
    586. 

  586.   </td><td align="right" valign="top"
    587. 

  587.     ><span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.close">source&nbsp;code</a></span>&nbsp;
    588. 

  588.     </td>
    589. 

  589.   </tr></table>
    590. 

  590.   
    591. 

  591.   <pre class="literalblock">
    592. 

  592. Flush the buffer.
    593. 

  593. NOTE: fileobject is NOT closed, just flushed. Mapping as closely as
    594. 

  594.       possible to GzipFile.
    595. 

  595. 

  596. </pre>
    597. 

  597.   <dl class="fields">
    598. 

  598.   </dl>
    599. 

  599. </td></tr></table>
    600. 

  600. </div>
    601. 

  601. <a name="__checkInt"></a>
    602. 

  602. <div class="private">
    603. 

  603. <table class="details" border="1" cellpadding="3"
    604. 

  604.        cellspacing="0" width="100%" bgcolor="white">
    605. 

  605. <tr><td>
    606. 

  606.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    607. 

  607.   <tr valign="top"><td>
    608. 

  608.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__checkInt</span>(<span class="sig-arg">self</span>,
    609. 

  609.         <span class="sig-arg">i</span>)</span>
    610. 

  610.   </h3>
    611. 

  611.   </td><td align="right" valign="top"
    612. 

  612.     ><span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.__checkInt">source&nbsp;code</a></span>&nbsp;
    613. 

  613.     </td>
    614. 

  614.   </tr></table>
    615. 

  615.   
    616. 

  616.   <p>Might be faster just to declare them longs. Python versions 1.5.2 
    617. 

  617.   &amp; 2.1.* ONLY!</p>
    618. 

  618.   <dl class="fields">
    619. 

  619.   </dl>
    620. 

  620. </td></tr></table>
    621. 

  621. </div>
    622. 

  622. <a name="__debugThread"></a>
    623. 

  623. <div class="private">
    624. 

  624. <table class="details" border="1" cellpadding="3"
    625. 

  625.        cellspacing="0" width="100%" bgcolor="white">
    626. 

  626. <tr><td>
    627. 

  627.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    628. 

  628.   <tr valign="top"><td>
    629. 

  629.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__debugThread</span>(<span class="sig-arg">self</span>)</span>
    630. 

  630.   </h3>
    631. 

  631.   </td><td align="right" valign="top"
    632. 

  632.     ><span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf.__debugThread">source&nbsp;code</a></span>&nbsp;
    633. 

  633.     </td>
    634. 

  634.   </tr></table>
    635. 

  635.   
    636. 

  636.   <p>XXX: Only used for debugging. Runs a thread that watches some 
    637. 

  637.   tell-tale warning flags that something bad is happening.</p>
    638. 

  638.   <dl class="fields">
    639. 

  639.   </dl>
    640. 

  640. </td></tr></table>
    641. 

  641. </div>
    642. 

  642. <a name="_StreamBuf__checkInt"></a>
    643. 

  643. <div class="private">
    644. 

  644. <table class="details" border="1" cellpadding="3"
    645. 

  645.        cellspacing="0" width="100%" bgcolor="white">
    646. 

  646. <tr><td>
    647. 

  647.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    648. 

  648.   <tr valign="top"><td>
    649. 

  649.   <h3 class="epydoc"><span class="sig"><span class="sig-name">_StreamBuf__checkInt</span>(<span class="sig-arg">self</span>,
    650. 

  650.         <span class="sig-arg">i</span>)</span>
    651. 

  651.   </h3>
    652. 

  652.   </td><td align="right" valign="top"
    653. 

  653.     ><span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf._StreamBuf__checkInt">source&nbsp;code</a></span>&nbsp;
    654. 

  654.     </td>
    655. 

  655.   </tr></table>
    656. 

  656.   
    657. 

  657.   <p>Might be faster just to declare them longs. Python versions 1.5.2 
    658. 

  658.   &amp; 2.1.* ONLY!</p>
    659. 

  659.   <dl class="fields">
    660. 

  660.   </dl>
    661. 

  661. </td></tr></table>
    662. 

  662. </div>
    663. 

  663. <a name="_StreamBuf__debugThread"></a>
    664. 

  664. <div class="private">
    665. 

  665. <table class="details" border="1" cellpadding="3"
    666. 

  666.        cellspacing="0" width="100%" bgcolor="white">
    667. 

  667. <tr><td>
    668. 

  668.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    669. 

  669.   <tr valign="top"><td>
    670. 

  670.   <h3 class="epydoc"><span class="sig"><span class="sig-name">_StreamBuf__debugThread</span>(<span class="sig-arg">self</span>)</span>
    671. 

  671.   </h3>
    672. 

  672.   </td><td align="right" valign="top"
    673. 

  673.     ><span class="codelink"><a href="gzipstream-pysrc.html#_StreamBuf._StreamBuf__debugThread">source&nbsp;code</a></span>&nbsp;
    674. 

  674.     </td>
    675. 

  675.   </tr></table>
    676. 

  676.   
    677. 

  677.   <p>XXX: Only used for debugging. Runs a thread that watches some 
    678. 

  678.   tell-tale warning flags that something bad is happening.</p>
    679. 

  679.   <dl class="fields">
    680. 

  680.   </dl>
    681. 

  681. </td></tr></table>
    682. 

  682. </div>
    683. 

  683. <br />
    684. 

  684. <!-- ==================== NAVIGATION BAR ==================== -->
    685. 

  685. <table class="navbar" border="0" width="100%" cellpadding="0"
    686. 

  686.        bgcolor="#a0c0ff" cellspacing="0">
    687. 

  687.   <tr valign="middle">
    688. 

  688.   <!-- Home link -->
    689. 

  689.       <th>&nbsp;&nbsp;&nbsp;<a
    690. 

  690.         href="gzipstream-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    691. 

  691. 

  692.   <!-- Tree link -->
    693. 

  693.       <th>&nbsp;&nbsp;&nbsp;<a
    694. 

  694.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    695. 

  695. 

  696.   <!-- Index link -->
    697. 

  697.       <th>&nbsp;&nbsp;&nbsp;<a
    698. 

  698.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    699. 

  699. 

  700.   <!-- Help link -->
    701. 

  701.       <th>&nbsp;&nbsp;&nbsp;<a
    702. 

  702.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    703. 

  703. 

  704.       <th class="navbar" width="100%"></th>
    705. 

  705.   </tr>
    706. 

  706. </table>
    707. 

  707. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    708. 

  708.   <tr>
    709. 

  709.     <td align="left" class="footer">
    710. 

  710.     Generated by Epydoc 3.0.1 on Mon Oct 31 00:54:47 2011
    711. 

  711.     </td>
    712. 

  712.     <td align="right" class="footer">
    713. 

  713.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    714. 

  714.         >http://epydoc.sourceforge.net</a>
    715. 

  715.     </td>
    716. 

  716.   </tr>
    717. 

  717. </table>
    718. 

  718. 

  719. <script type="text/javascript">
    720. 

  720.   <!--
    721. 

  721.   // Private objects are initially displayed (because if
    722. 

  722.   // javascript is turned off then we want them to be
    723. 

  723.   // visible); but by default, we want to hide them.  So hide
    724. 

  724.   // them unless we have a cookie that says to show them.
    725. 

  725.   checkCookie();
    726. 

  726.   // -->
    727. 

  727. </script>
    728. 

  728. </body>
    729. 

  729. </html>
    730.