PageRenderTime 55ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 1ms

/docs/re-module.html

https://github.com/adamldoyle/mixins
HTML | 827 lines | 744 code | 63 blank | 20 comment | 0 complexity | cd9e0b74c96ecfda8ae74c57f21c5727 MD5 | raw file
  1. <?xml version="1.0" encoding="ascii"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3. "DTD/xhtml1-transitional.dtd">
  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5. <head>
  6. <title>re</title>
  7. <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8. <script type="text/javascript" src="epydoc.js"></script>
  9. </head>
  10. <body bgcolor="white" text="black" link="blue" vlink="#204080"
  11. alink="#204080">
  12. <!-- ==================== NAVIGATION BAR ==================== -->
  13. <table class="navbar" border="0" width="100%" cellpadding="0"
  14. bgcolor="#a0c0ff" cellspacing="0">
  15. <tr valign="middle">
  16. <!-- Tree link -->
  17. <th>&nbsp;&nbsp;&nbsp;<a
  18. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  19. <!-- Index link -->
  20. <th>&nbsp;&nbsp;&nbsp;<a
  21. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  22. <!-- Help link -->
  23. <th>&nbsp;&nbsp;&nbsp;<a
  24. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  25. <th class="navbar" width="100%"></th>
  26. </tr>
  27. </table>
  28. <table width="100%" cellpadding="0" cellspacing="0">
  29. <tr valign="top">
  30. <td width="100%">
  31. <span class="breadcrumbs">
  32. Module&nbsp;re
  33. </span>
  34. </td>
  35. <td>
  36. <table cellpadding="0" cellspacing="0">
  37. <!-- hide/show private -->
  38. <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  39. onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  40. <tr><td align="right"><span class="options"
  41. >[<a href="frames.html" target="_top">frames</a
  42. >]&nbsp;|&nbsp;<a href="re-module.html"
  43. target="_top">no&nbsp;frames</a>]</span></td></tr>
  44. </table>
  45. </td>
  46. </tr>
  47. </table>
  48. <!-- ==================== MODULE DESCRIPTION ==================== -->
  49. <h1 class="epydoc">Module re</h1><span class="codelink"><a href="re-pysrc.html">source&nbsp;code</a></span><br /><br />
  50. <pre class="literalblock">
  51. Support for regular expressions (RE).
  52. This module provides regular expression matching operations similar to
  53. those found in Perl. It supports both 8-bit and Unicode strings; both
  54. the pattern and the strings being processed can contain null bytes and
  55. characters outside the US ASCII range.
  56. Regular expressions can contain both special and ordinary characters.
  57. Most ordinary characters, like &quot;A&quot;, &quot;a&quot;, or &quot;0&quot;, are the simplest
  58. regular expressions; they simply match themselves. You can
  59. concatenate ordinary characters, so last matches the string 'last'.
  60. The special characters are:
  61. &quot;.&quot; Matches any character except a newline.
  62. &quot;^&quot; Matches the start of the string.
  63. &quot;$&quot; Matches the end of the string or just before the newline at
  64. the end of the string.
  65. &quot;*&quot; Matches 0 or more (greedy) repetitions of the preceding RE.
  66. Greedy means that it will match as many repetitions as possible.
  67. &quot;+&quot; Matches 1 or more (greedy) repetitions of the preceding RE.
  68. &quot;?&quot; Matches 0 or 1 (greedy) of the preceding RE.
  69. *?,+?,?? Non-greedy versions of the previous three special characters.
  70. {m,n} Matches from m to n repetitions of the preceding RE.
  71. {m,n}? Non-greedy version of the above.
  72. &quot;\\&quot; Either escapes special characters or signals a special sequence.
  73. [] Indicates a set of characters.
  74. A &quot;^&quot; as the first character indicates a complementing set.
  75. &quot;|&quot; A|B, creates an RE that will match either A or B.
  76. (...) Matches the RE inside the parentheses.
  77. The contents can be retrieved or matched later in the string.
  78. (?iLmsux) Set the I, L, M, S, U, or X flag for the RE (see below).
  79. (?:...) Non-grouping version of regular parentheses.
  80. (?P&lt;name&gt;...) The substring matched by the group is accessible by name.
  81. (?P=name) Matches the text matched earlier by the group named name.
  82. (?#...) A comment; ignored.
  83. (?=...) Matches if ... matches next, but doesn't consume the string.
  84. (?!...) Matches if ... doesn't match next.
  85. (?&lt;=...) Matches if preceded by ... (must be fixed length).
  86. (?&lt;!...) Matches if not preceded by ... (must be fixed length).
  87. (?(id/name)yes|no) Matches yes pattern if the group with id/name matched,
  88. the (optional) no pattern otherwise.
  89. The special sequences consist of &quot;\\&quot; and a character from the list
  90. below. If the ordinary character is not on the list, then the
  91. resulting RE will match the second character.
  92. \number Matches the contents of the group of the same number.
  93. \A Matches only at the start of the string.
  94. \Z Matches only at the end of the string.
  95. \b Matches the empty string, but only at the start or end of a word.
  96. \B Matches the empty string, but not at the start or end of a word.
  97. \d Matches any decimal digit; equivalent to the set [0-9].
  98. \D Matches any non-digit character; equivalent to the set [^0-9].
  99. \s Matches any whitespace character; equivalent to [ \t\n\r\f\v].
  100. \S Matches any non-whitespace character; equiv. to [^ \t\n\r\f\v].
  101. \w Matches any alphanumeric character; equivalent to [a-zA-Z0-9_].
  102. With LOCALE, it will match the set [0-9_] plus characters defined
  103. as letters for the current locale.
  104. \W Matches the complement of \w.
  105. \\ Matches a literal backslash.
  106. This module exports the following functions:
  107. match Match a regular expression pattern to the beginning of a string.
  108. search Search a string for the presence of a pattern.
  109. sub Substitute occurrences of a pattern found in a string.
  110. subn Same as sub, but also return the number of substitutions made.
  111. split Split a string by the occurrences of a pattern.
  112. findall Find all occurrences of a pattern in a string.
  113. finditer Return an iterator yielding a match object for each match.
  114. compile Compile a pattern into a RegexObject.
  115. purge Clear the regular expression cache.
  116. escape Backslash all non-alphanumerics in a string.
  117. Some of the functions in this module takes flags as optional parameters:
  118. I IGNORECASE Perform case-insensitive matching.
  119. L LOCALE Make \w, \W, \b, \B, dependent on the current locale.
  120. M MULTILINE &quot;^&quot; matches the beginning of lines (after a newline)
  121. as well as the string.
  122. &quot;$&quot; matches the end of lines (before a newline) as well
  123. as the end of the string.
  124. S DOTALL &quot;.&quot; matches any character at all, including the newline.
  125. X VERBOSE Ignore whitespace and comments for nicer looking RE's.
  126. U UNICODE Make \w, \W, \b, \B, dependent on the Unicode locale.
  127. This module also defines an exception 'error'.
  128. </pre><br /><br />
  129. <hr />
  130. <div class="fields"> <p><strong>Version:</strong>
  131. 2.2.1
  132. </p>
  133. </div><!-- ==================== CLASSES ==================== -->
  134. <a name="section-Classes"></a>
  135. <table class="summary" border="1" cellpadding="3"
  136. cellspacing="0" width="100%" bgcolor="white">
  137. <tr bgcolor="#70b0f0" class="table-header">
  138. <td colspan="2" class="table-header">
  139. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  140. <tr valign="top">
  141. <td align="left"><span class="table-header">Classes</span></td>
  142. <td align="right" valign="top"
  143. ><span class="options">[<a href="#section-Classes"
  144. class="privatelink" onclick="toggle_private();"
  145. >hide private</a>]</span></td>
  146. </tr>
  147. </table>
  148. </td>
  149. </tr>
  150. <tr class="private">
  151. <td width="15%" align="right" valign="top" class="summary">
  152. <span class="summary-type">&nbsp;</span>
  153. </td><td class="summary">
  154. <a href="re.Scanner-class.html" class="summary-name">Scanner</a>
  155. </td>
  156. </tr>
  157. </table>
  158. <!-- ==================== FUNCTIONS ==================== -->
  159. <a name="section-Functions"></a>
  160. <table class="summary" border="1" cellpadding="3"
  161. cellspacing="0" width="100%" bgcolor="white">
  162. <tr bgcolor="#70b0f0" class="table-header">
  163. <td colspan="2" class="table-header">
  164. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  165. <tr valign="top">
  166. <td align="left"><span class="table-header">Functions</span></td>
  167. <td align="right" valign="top"
  168. ><span class="options">[<a href="#section-Functions"
  169. class="privatelink" onclick="toggle_private();"
  170. >hide private</a>]</span></td>
  171. </tr>
  172. </table>
  173. </td>
  174. </tr>
  175. <tr>
  176. <td width="15%" align="right" valign="top" class="summary">
  177. <span class="summary-type">&nbsp;</span>
  178. </td><td class="summary">
  179. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  180. <tr>
  181. <td><span class="summary-sig"><a name="match"></a><span class="summary-sig-name">match</span>(<span class="summary-sig-arg">pattern</span>,
  182. <span class="summary-sig-arg">string</span>,
  183. <span class="summary-sig-arg">flags</span>=<span class="summary-sig-default">0</span>)</span><br />
  184. Try to apply the pattern at the start of the string, returning
  185. a match object, or None if no match was found.</td>
  186. <td align="right" valign="top">
  187. <span class="codelink"><a href="re-pysrc.html#match">source&nbsp;code</a></span>
  188. </td>
  189. </tr>
  190. </table>
  191. </td>
  192. </tr>
  193. <tr>
  194. <td width="15%" align="right" valign="top" class="summary">
  195. <span class="summary-type">&nbsp;</span>
  196. </td><td class="summary">
  197. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  198. <tr>
  199. <td><span class="summary-sig"><a name="search"></a><span class="summary-sig-name">search</span>(<span class="summary-sig-arg">pattern</span>,
  200. <span class="summary-sig-arg">string</span>,
  201. <span class="summary-sig-arg">flags</span>=<span class="summary-sig-default">0</span>)</span><br />
  202. Scan through string looking for a match to the pattern, returning
  203. a match object, or None if no match was found.</td>
  204. <td align="right" valign="top">
  205. <span class="codelink"><a href="re-pysrc.html#search">source&nbsp;code</a></span>
  206. </td>
  207. </tr>
  208. </table>
  209. </td>
  210. </tr>
  211. <tr>
  212. <td width="15%" align="right" valign="top" class="summary">
  213. <span class="summary-type">&nbsp;</span>
  214. </td><td class="summary">
  215. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  216. <tr>
  217. <td><span class="summary-sig"><a href="re-module.html#sub" class="summary-sig-name">sub</a>(<span class="summary-sig-arg">pattern</span>,
  218. <span class="summary-sig-arg">repl</span>,
  219. <span class="summary-sig-arg">string</span>,
  220. <span class="summary-sig-arg">count</span>=<span class="summary-sig-default">0</span>)</span><br />
  221. Return the string obtained by replacing the leftmost
  222. non-overlapping occurrences of the pattern in string by the
  223. replacement repl.</td>
  224. <td align="right" valign="top">
  225. <span class="codelink"><a href="re-pysrc.html#sub">source&nbsp;code</a></span>
  226. </td>
  227. </tr>
  228. </table>
  229. </td>
  230. </tr>
  231. <tr>
  232. <td width="15%" align="right" valign="top" class="summary">
  233. <span class="summary-type">&nbsp;</span>
  234. </td><td class="summary">
  235. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  236. <tr>
  237. <td><span class="summary-sig"><a href="re-module.html#subn" class="summary-sig-name">subn</a>(<span class="summary-sig-arg">pattern</span>,
  238. <span class="summary-sig-arg">repl</span>,
  239. <span class="summary-sig-arg">string</span>,
  240. <span class="summary-sig-arg">count</span>=<span class="summary-sig-default">0</span>)</span><br />
  241. Return a 2-tuple containing (new_string, number).</td>
  242. <td align="right" valign="top">
  243. <span class="codelink"><a href="re-pysrc.html#subn">source&nbsp;code</a></span>
  244. </td>
  245. </tr>
  246. </table>
  247. </td>
  248. </tr>
  249. <tr>
  250. <td width="15%" align="right" valign="top" class="summary">
  251. <span class="summary-type">&nbsp;</span>
  252. </td><td class="summary">
  253. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  254. <tr>
  255. <td><span class="summary-sig"><a name="split"></a><span class="summary-sig-name">split</span>(<span class="summary-sig-arg">pattern</span>,
  256. <span class="summary-sig-arg">string</span>,
  257. <span class="summary-sig-arg">maxsplit</span>=<span class="summary-sig-default">0</span>)</span><br />
  258. Split the source string by the occurrences of the pattern,
  259. returning a list containing the resulting substrings.</td>
  260. <td align="right" valign="top">
  261. <span class="codelink"><a href="re-pysrc.html#split">source&nbsp;code</a></span>
  262. </td>
  263. </tr>
  264. </table>
  265. </td>
  266. </tr>
  267. <tr>
  268. <td width="15%" align="right" valign="top" class="summary">
  269. <span class="summary-type">&nbsp;</span>
  270. </td><td class="summary">
  271. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  272. <tr>
  273. <td><span class="summary-sig"><a href="re-module.html#findall" class="summary-sig-name">findall</a>(<span class="summary-sig-arg">pattern</span>,
  274. <span class="summary-sig-arg">string</span>,
  275. <span class="summary-sig-arg">flags</span>=<span class="summary-sig-default">0</span>)</span><br />
  276. Return a list of all non-overlapping matches in the string.</td>
  277. <td align="right" valign="top">
  278. <span class="codelink"><a href="re-pysrc.html#findall">source&nbsp;code</a></span>
  279. </td>
  280. </tr>
  281. </table>
  282. </td>
  283. </tr>
  284. <tr class="private">
  285. <td width="15%" align="right" valign="top" class="summary">
  286. <span class="summary-type">&nbsp;</span>
  287. </td><td class="summary">
  288. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  289. <tr>
  290. <td><span class="summary-sig"><a href="re-module.html#finditer" class="summary-sig-name">finditer</a>(<span class="summary-sig-arg">pattern</span>,
  291. <span class="summary-sig-arg">string</span>,
  292. <span class="summary-sig-arg">flags</span>=<span class="summary-sig-default">0</span>)</span><br />
  293. Return an iterator over all non-overlapping matches in the
  294. string.</td>
  295. <td align="right" valign="top">
  296. <span class="codelink"><a href="re-pysrc.html#finditer">source&nbsp;code</a></span>
  297. </td>
  298. </tr>
  299. </table>
  300. </td>
  301. </tr>
  302. <tr>
  303. <td width="15%" align="right" valign="top" class="summary">
  304. <span class="summary-type">&nbsp;</span>
  305. </td><td class="summary">
  306. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  307. <tr>
  308. <td><span class="summary-sig"><a name="compile"></a><span class="summary-sig-name">compile</span>(<span class="summary-sig-arg">pattern</span>,
  309. <span class="summary-sig-arg">flags</span>=<span class="summary-sig-default">0</span>)</span><br />
  310. Compile a regular expression pattern, returning a pattern object.</td>
  311. <td align="right" valign="top">
  312. <span class="codelink"><a href="re-pysrc.html#compile">source&nbsp;code</a></span>
  313. </td>
  314. </tr>
  315. </table>
  316. </td>
  317. </tr>
  318. <tr>
  319. <td width="15%" align="right" valign="top" class="summary">
  320. <span class="summary-type">&nbsp;</span>
  321. </td><td class="summary">
  322. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  323. <tr>
  324. <td><span class="summary-sig"><a name="purge"></a><span class="summary-sig-name">purge</span>()</span><br />
  325. Clear the regular expression cache</td>
  326. <td align="right" valign="top">
  327. <span class="codelink"><a href="re-pysrc.html#purge">source&nbsp;code</a></span>
  328. </td>
  329. </tr>
  330. </table>
  331. </td>
  332. </tr>
  333. <tr>
  334. <td width="15%" align="right" valign="top" class="summary">
  335. <span class="summary-type">&nbsp;</span>
  336. </td><td class="summary">
  337. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  338. <tr>
  339. <td><span class="summary-sig"><a name="template"></a><span class="summary-sig-name">template</span>(<span class="summary-sig-arg">pattern</span>,
  340. <span class="summary-sig-arg">flags</span>=<span class="summary-sig-default">0</span>)</span><br />
  341. Compile a template pattern, returning a pattern object</td>
  342. <td align="right" valign="top">
  343. <span class="codelink"><a href="re-pysrc.html#template">source&nbsp;code</a></span>
  344. </td>
  345. </tr>
  346. </table>
  347. </td>
  348. </tr>
  349. <tr>
  350. <td width="15%" align="right" valign="top" class="summary">
  351. <span class="summary-type">&nbsp;</span>
  352. </td><td class="summary">
  353. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  354. <tr>
  355. <td><span class="summary-sig"><a name="escape"></a><span class="summary-sig-name">escape</span>(<span class="summary-sig-arg">pattern</span>)</span><br />
  356. Escape all non-alphanumeric characters in pattern.</td>
  357. <td align="right" valign="top">
  358. <span class="codelink"><a href="re-pysrc.html#escape">source&nbsp;code</a></span>
  359. </td>
  360. </tr>
  361. </table>
  362. </td>
  363. </tr>
  364. <tr class="private">
  365. <td width="15%" align="right" valign="top" class="summary">
  366. <span class="summary-type">&nbsp;</span>
  367. </td><td class="summary">
  368. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  369. <tr>
  370. <td><span class="summary-sig"><a name="_compile"></a><span class="summary-sig-name">_compile</span>(<span class="summary-sig-arg">*key</span>)</span></td>
  371. <td align="right" valign="top">
  372. <span class="codelink"><a href="re-pysrc.html#_compile">source&nbsp;code</a></span>
  373. </td>
  374. </tr>
  375. </table>
  376. </td>
  377. </tr>
  378. <tr class="private">
  379. <td width="15%" align="right" valign="top" class="summary">
  380. <span class="summary-type">&nbsp;</span>
  381. </td><td class="summary">
  382. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  383. <tr>
  384. <td><span class="summary-sig"><a name="_compile_repl"></a><span class="summary-sig-name">_compile_repl</span>(<span class="summary-sig-arg">*key</span>)</span></td>
  385. <td align="right" valign="top">
  386. <span class="codelink"><a href="re-pysrc.html#_compile_repl">source&nbsp;code</a></span>
  387. </td>
  388. </tr>
  389. </table>
  390. </td>
  391. </tr>
  392. <tr class="private">
  393. <td width="15%" align="right" valign="top" class="summary">
  394. <span class="summary-type">&nbsp;</span>
  395. </td><td class="summary">
  396. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  397. <tr>
  398. <td><span class="summary-sig"><a name="_expand"></a><span class="summary-sig-name">_expand</span>(<span class="summary-sig-arg">pattern</span>,
  399. <span class="summary-sig-arg">match</span>,
  400. <span class="summary-sig-arg">template</span>)</span></td>
  401. <td align="right" valign="top">
  402. <span class="codelink"><a href="re-pysrc.html#_expand">source&nbsp;code</a></span>
  403. </td>
  404. </tr>
  405. </table>
  406. </td>
  407. </tr>
  408. <tr class="private">
  409. <td width="15%" align="right" valign="top" class="summary">
  410. <span class="summary-type">&nbsp;</span>
  411. </td><td class="summary">
  412. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  413. <tr>
  414. <td><span class="summary-sig"><a name="_subx"></a><span class="summary-sig-name">_subx</span>(<span class="summary-sig-arg">pattern</span>,
  415. <span class="summary-sig-arg">template</span>)</span></td>
  416. <td align="right" valign="top">
  417. <span class="codelink"><a href="re-pysrc.html#_subx">source&nbsp;code</a></span>
  418. </td>
  419. </tr>
  420. </table>
  421. </td>
  422. </tr>
  423. <tr class="private">
  424. <td width="15%" align="right" valign="top" class="summary">
  425. <span class="summary-type">&nbsp;</span>
  426. </td><td class="summary">
  427. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  428. <tr>
  429. <td><span class="summary-sig"><a name="_pickle"></a><span class="summary-sig-name">_pickle</span>(<span class="summary-sig-arg">p</span>)</span></td>
  430. <td align="right" valign="top">
  431. <span class="codelink"><a href="re-pysrc.html#_pickle">source&nbsp;code</a></span>
  432. </td>
  433. </tr>
  434. </table>
  435. </td>
  436. </tr>
  437. </table>
  438. <!-- ==================== VARIABLES ==================== -->
  439. <a name="section-Variables"></a>
  440. <table class="summary" border="1" cellpadding="3"
  441. cellspacing="0" width="100%" bgcolor="white">
  442. <tr bgcolor="#70b0f0" class="table-header">
  443. <td colspan="2" class="table-header">
  444. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  445. <tr valign="top">
  446. <td align="left"><span class="table-header">Variables</span></td>
  447. <td align="right" valign="top"
  448. ><span class="options">[<a href="#section-Variables"
  449. class="privatelink" onclick="toggle_private();"
  450. >hide private</a>]</span></td>
  451. </tr>
  452. </table>
  453. </td>
  454. </tr>
  455. <tr>
  456. <td width="15%" align="right" valign="top" class="summary">
  457. <span class="summary-type">&nbsp;</span>
  458. </td><td class="summary">
  459. <a name="IGNORECASE"></a><span class="summary-name">IGNORECASE</span> = <code title="sre_compile.SRE_FLAG_IGNORECASE">sre_compile.SRE_FLAG_IGNORECASE</code>
  460. </td>
  461. </tr>
  462. <tr>
  463. <td width="15%" align="right" valign="top" class="summary">
  464. <span class="summary-type">&nbsp;</span>
  465. </td><td class="summary">
  466. <a name="I"></a><span class="summary-name">I</span> = <code title="sre_compile.SRE_FLAG_IGNORECASE">sre_compile.SRE_FLAG_IGNORECASE</code>
  467. </td>
  468. </tr>
  469. <tr>
  470. <td width="15%" align="right" valign="top" class="summary">
  471. <span class="summary-type">&nbsp;</span>
  472. </td><td class="summary">
  473. <a name="LOCALE"></a><span class="summary-name">LOCALE</span> = <code title="sre_compile.SRE_FLAG_LOCALE">sre_compile.SRE_FLAG_LOCALE</code>
  474. </td>
  475. </tr>
  476. <tr>
  477. <td width="15%" align="right" valign="top" class="summary">
  478. <span class="summary-type">&nbsp;</span>
  479. </td><td class="summary">
  480. <a name="L"></a><span class="summary-name">L</span> = <code title="sre_compile.SRE_FLAG_LOCALE">sre_compile.SRE_FLAG_LOCALE</code>
  481. </td>
  482. </tr>
  483. <tr>
  484. <td width="15%" align="right" valign="top" class="summary">
  485. <span class="summary-type">&nbsp;</span>
  486. </td><td class="summary">
  487. <a name="UNICODE"></a><span class="summary-name">UNICODE</span> = <code title="sre_compile.SRE_FLAG_UNICODE">sre_compile.SRE_FLAG_UNICODE</code>
  488. </td>
  489. </tr>
  490. <tr>
  491. <td width="15%" align="right" valign="top" class="summary">
  492. <span class="summary-type">&nbsp;</span>
  493. </td><td class="summary">
  494. <a name="U"></a><span class="summary-name">U</span> = <code title="sre_compile.SRE_FLAG_UNICODE">sre_compile.SRE_FLAG_UNICODE</code>
  495. </td>
  496. </tr>
  497. <tr>
  498. <td width="15%" align="right" valign="top" class="summary">
  499. <span class="summary-type">&nbsp;</span>
  500. </td><td class="summary">
  501. <a name="MULTILINE"></a><span class="summary-name">MULTILINE</span> = <code title="sre_compile.SRE_FLAG_MULTILINE">sre_compile.SRE_FLAG_MULTILINE</code>
  502. </td>
  503. </tr>
  504. <tr>
  505. <td width="15%" align="right" valign="top" class="summary">
  506. <span class="summary-type">&nbsp;</span>
  507. </td><td class="summary">
  508. <a name="M"></a><span class="summary-name">M</span> = <code title="sre_compile.SRE_FLAG_MULTILINE">sre_compile.SRE_FLAG_MULTILINE</code>
  509. </td>
  510. </tr>
  511. <tr>
  512. <td width="15%" align="right" valign="top" class="summary">
  513. <span class="summary-type">&nbsp;</span>
  514. </td><td class="summary">
  515. <a name="DOTALL"></a><span class="summary-name">DOTALL</span> = <code title="sre_compile.SRE_FLAG_DOTALL">sre_compile.SRE_FLAG_DOTALL</code>
  516. </td>
  517. </tr>
  518. <tr>
  519. <td width="15%" align="right" valign="top" class="summary">
  520. <span class="summary-type">&nbsp;</span>
  521. </td><td class="summary">
  522. <a name="S"></a><span class="summary-name">S</span> = <code title="sre_compile.SRE_FLAG_DOTALL">sre_compile.SRE_FLAG_DOTALL</code>
  523. </td>
  524. </tr>
  525. <tr>
  526. <td width="15%" align="right" valign="top" class="summary">
  527. <span class="summary-type">&nbsp;</span>
  528. </td><td class="summary">
  529. <a name="VERBOSE"></a><span class="summary-name">VERBOSE</span> = <code title="sre_compile.SRE_FLAG_VERBOSE">sre_compile.SRE_FLAG_VERBOSE</code>
  530. </td>
  531. </tr>
  532. <tr>
  533. <td width="15%" align="right" valign="top" class="summary">
  534. <span class="summary-type">&nbsp;</span>
  535. </td><td class="summary">
  536. <a name="X"></a><span class="summary-name">X</span> = <code title="sre_compile.SRE_FLAG_VERBOSE">sre_compile.SRE_FLAG_VERBOSE</code>
  537. </td>
  538. </tr>
  539. <tr class="private">
  540. <td width="15%" align="right" valign="top" class="summary">
  541. <span class="summary-type">&nbsp;</span>
  542. </td><td class="summary">
  543. <a name="TEMPLATE"></a><span class="summary-name">TEMPLATE</span> = <code title="sre_compile.SRE_FLAG_TEMPLATE">sre_compile.SRE_FLAG_TEMPLATE</code>
  544. </td>
  545. </tr>
  546. <tr class="private">
  547. <td width="15%" align="right" valign="top" class="summary">
  548. <span class="summary-type">&nbsp;</span>
  549. </td><td class="summary">
  550. <a name="T"></a><span class="summary-name">T</span> = <code title="sre_compile.SRE_FLAG_TEMPLATE">sre_compile.SRE_FLAG_TEMPLATE</code>
  551. </td>
  552. </tr>
  553. <tr class="private">
  554. <td width="15%" align="right" valign="top" class="summary">
  555. <span class="summary-type">&nbsp;</span>
  556. </td><td class="summary">
  557. <a name="DEBUG"></a><span class="summary-name">DEBUG</span> = <code title="sre_compile.SRE_FLAG_DEBUG">sre_compile.SRE_FLAG_DEBUG</code>
  558. </td>
  559. </tr>
  560. <tr>
  561. <td width="15%" align="right" valign="top" class="summary">
  562. <span class="summary-type">&nbsp;</span>
  563. </td><td class="summary">
  564. <a name="error"></a><span class="summary-name">error</span> = <code title="sre_compile.error">sre_compile.error</code>
  565. </td>
  566. </tr>
  567. <tr class="private">
  568. <td width="15%" align="right" valign="top" class="summary">
  569. <span class="summary-type">&nbsp;</span>
  570. </td><td class="summary">
  571. <a name="_alphanum"></a><span class="summary-name">_alphanum</span> = <code title="{}">{}</code>
  572. </td>
  573. </tr>
  574. <tr class="private">
  575. <td width="15%" align="right" valign="top" class="summary">
  576. <span class="summary-type">&nbsp;</span>
  577. </td><td class="summary">
  578. <a name="_cache"></a><span class="summary-name">_cache</span> = <code title="{}">{}</code>
  579. </td>
  580. </tr>
  581. <tr class="private">
  582. <td width="15%" align="right" valign="top" class="summary">
  583. <span class="summary-type">&nbsp;</span>
  584. </td><td class="summary">
  585. <a name="_cache_repl"></a><span class="summary-name">_cache_repl</span> = <code title="{}">{}</code>
  586. </td>
  587. </tr>
  588. <tr class="private">
  589. <td width="15%" align="right" valign="top" class="summary">
  590. <span class="summary-type">&nbsp;</span>
  591. </td><td class="summary">
  592. <a name="_pattern_type"></a><span class="summary-name">_pattern_type</span> = <code title="type(sre_compile.compile(&quot;&quot;, 0))">type(sre_compile.compile(&quot;&quot;, 0))</code>
  593. </td>
  594. </tr>
  595. <tr class="private">
  596. <td width="15%" align="right" valign="top" class="summary">
  597. <span class="summary-type">&nbsp;</span>
  598. </td><td class="summary">
  599. <a name="_MAXCACHE"></a><span class="summary-name">_MAXCACHE</span> = <code title="100">100</code>
  600. </td>
  601. </tr>
  602. </table>
  603. <!-- ==================== FUNCTION DETAILS ==================== -->
  604. <a name="section-FunctionDetails"></a>
  605. <table class="details" border="1" cellpadding="3"
  606. cellspacing="0" width="100%" bgcolor="white">
  607. <tr bgcolor="#70b0f0" class="table-header">
  608. <td colspan="2" class="table-header">
  609. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  610. <tr valign="top">
  611. <td align="left"><span class="table-header">Function Details</span></td>
  612. <td align="right" valign="top"
  613. ><span class="options">[<a href="#section-FunctionDetails"
  614. class="privatelink" onclick="toggle_private();"
  615. >hide private</a>]</span></td>
  616. </tr>
  617. </table>
  618. </td>
  619. </tr>
  620. </table>
  621. <a name="sub"></a>
  622. <div>
  623. <table class="details" border="1" cellpadding="3"
  624. cellspacing="0" width="100%" bgcolor="white">
  625. <tr><td>
  626. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  627. <tr valign="top"><td>
  628. <h3 class="epydoc"><span class="sig"><span class="sig-name">sub</span>(<span class="sig-arg">pattern</span>,
  629. <span class="sig-arg">repl</span>,
  630. <span class="sig-arg">string</span>,
  631. <span class="sig-arg">count</span>=<span class="sig-default">0</span>)</span>
  632. </h3>
  633. </td><td align="right" valign="top"
  634. ><span class="codelink"><a href="re-pysrc.html#sub">source&nbsp;code</a></span>&nbsp;
  635. </td>
  636. </table>
  637. <pre class="literalblock">
  638. Return the string obtained by replacing the leftmost
  639. non-overlapping occurrences of the pattern in string by the
  640. replacement repl. repl can be either a string or a callable;
  641. if a callable, it's passed the match object and must return
  642. a replacement string to be used.
  643. </pre>
  644. <dl class="fields">
  645. </dl>
  646. </td></tr></table>
  647. </div>
  648. <a name="subn"></a>
  649. <div>
  650. <table class="details" border="1" cellpadding="3"
  651. cellspacing="0" width="100%" bgcolor="white">
  652. <tr><td>
  653. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  654. <tr valign="top"><td>
  655. <h3 class="epydoc"><span class="sig"><span class="sig-name">subn</span>(<span class="sig-arg">pattern</span>,
  656. <span class="sig-arg">repl</span>,
  657. <span class="sig-arg">string</span>,
  658. <span class="sig-arg">count</span>=<span class="sig-default">0</span>)</span>
  659. </h3>
  660. </td><td align="right" valign="top"
  661. ><span class="codelink"><a href="re-pysrc.html#subn">source&nbsp;code</a></span>&nbsp;
  662. </td>
  663. </table>
  664. <pre class="literalblock">
  665. Return a 2-tuple containing (new_string, number).
  666. new_string is the string obtained by replacing the leftmost
  667. non-overlapping occurrences of the pattern in the source
  668. string by the replacement repl. number is the number of
  669. substitutions that were made. repl can be either a string or a
  670. callable; if a callable, it's passed the match object and must
  671. return a replacement string to be used.
  672. </pre>
  673. <dl class="fields">
  674. </dl>
  675. </td></tr></table>
  676. </div>
  677. <a name="findall"></a>
  678. <div>
  679. <table class="details" border="1" cellpadding="3"
  680. cellspacing="0" width="100%" bgcolor="white">
  681. <tr><td>
  682. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  683. <tr valign="top"><td>
  684. <h3 class="epydoc"><span class="sig"><span class="sig-name">findall</span>(<span class="sig-arg">pattern</span>,
  685. <span class="sig-arg">string</span>,
  686. <span class="sig-arg">flags</span>=<span class="sig-default">0</span>)</span>
  687. </h3>
  688. </td><td align="right" valign="top"
  689. ><span class="codelink"><a href="re-pysrc.html#findall">source&nbsp;code</a></span>&nbsp;
  690. </td>
  691. </table>
  692. <pre class="literalblock">
  693. Return a list of all non-overlapping matches in the string.
  694. If one or more groups are present in the pattern, return a
  695. list of groups; this will be a list of tuples if the pattern
  696. has more than one group.
  697. Empty matches are included in the result.
  698. </pre>
  699. <dl class="fields">
  700. </dl>
  701. </td></tr></table>
  702. </div>
  703. <a name="finditer"></a>
  704. <div class="private">
  705. <table class="details" border="1" cellpadding="3"
  706. cellspacing="0" width="100%" bgcolor="white">
  707. <tr><td>
  708. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  709. <tr valign="top"><td>
  710. <h3 class="epydoc"><span class="sig"><span class="sig-name">finditer</span>(<span class="sig-arg">pattern</span>,
  711. <span class="sig-arg">string</span>,
  712. <span class="sig-arg">flags</span>=<span class="sig-default">0</span>)</span>
  713. </h3>
  714. </td><td align="right" valign="top"
  715. ><span class="codelink"><a href="re-pysrc.html#finditer">source&nbsp;code</a></span>&nbsp;
  716. </td>
  717. </table>
  718. <pre class="literalblock">
  719. Return an iterator over all non-overlapping matches in the
  720. string. For each match, the iterator returns a match object.
  721. Empty matches are included in the result.
  722. </pre>
  723. <dl class="fields">
  724. </dl>
  725. </td></tr></table>
  726. </div>
  727. <br />
  728. <!-- ==================== NAVIGATION BAR ==================== -->
  729. <table class="navbar" border="0" width="100%" cellpadding="0"
  730. bgcolor="#a0c0ff" cellspacing="0">
  731. <tr valign="middle">
  732. <!-- Tree link -->
  733. <th>&nbsp;&nbsp;&nbsp;<a
  734. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  735. <!-- Index link -->
  736. <th>&nbsp;&nbsp;&nbsp;<a
  737. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  738. <!-- Help link -->
  739. <th>&nbsp;&nbsp;&nbsp;<a
  740. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  741. <th class="navbar" width="100%"></th>
  742. </tr>
  743. </table>
  744. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  745. <tr>
  746. <td align="left" class="footer">
  747. Generated by Epydoc 3.0beta1 on Mon Sep 21 23:21:22 2009
  748. </td>
  749. <td align="right" class="footer">
  750. <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
  751. </td>
  752. </tr>
  753. </table>
  754. <script type="text/javascript">
  755. <!--
  756. // Private objects are initially displayed (because if
  757. // javascript is turned off then we want them to be
  758. // visible); but by default, we want to hide them. So hide
  759. // them unless we have a cookie that says to show them.
  760. checkCookie()
  761. // -->
  762. </script>
  763. </body>
  764. </html>