/usr/share/doc/python-genshi-doc/html/api/genshi.filters.transform.Transformer-class.html is in python-genshi-doc 0.7-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>genshi.filters.transform.Transformer</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="genshi-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="genshi-module.html">Package genshi</a> ::
<a href="genshi.filters-module.html">Package filters</a> ::
<a href="genshi.filters.transform-module.html">Module transform</a> ::
Class Transformer
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Transformer</h1><p class="nomargin-top"></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">Transformer</strong>
</pre>
<hr />
<p>Stream filter that can apply a variety of different transformations to
a stream.</p>
<p>This is achieved by selecting the events to be transformed using XPath,
then applying the transformations to the events matched by the path
expression. Each marked event is in the form (mark, (kind, data, pos)),
where mark can be any of <a href="genshi.filters.transform-module.html#ENTER" class="link">ENTER</a>, <a href="genshi.filters.transform-module.html#INSIDE" class="link">INSIDE</a>, <a href="genshi.filters.transform-module.html#EXIT" class="link">EXIT</a>, <a href="genshi.filters.transform-module.html#OUTSIDE" class="link">OUTSIDE</a>, or <code class="link">None</code>.</p>
<p>The first three marks match START and END events, and any events
contained <a href="genshi.filters.transform-module.html#INSIDE" class="link">INSIDE</a> any selected XML/HTML element. A non-element match
outside a START/END container (e.g. <tt class="rst-docutils literal">text()</tt>) will yield an <a href="genshi.filters.transform-module.html#OUTSIDE" class="link">OUTSIDE</a>
mark.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)</pre>
<p>Transformations act on selected stream events matching an XPath expression.
Here's an example of removing some markup (the title, in this case)
selected by an expression:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'head/title'</span>).remove())
<span class="py-output"><html><head/><body>Some <em>body</em> text.</body></html></span></pre>
<p>Inserted content can be passed in the form of a string, or a markup event
stream, which includes streams generated programmatically via the
<a href="genshi.builder-module.html" class="link">builder</a> module:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> genshi.builder <span class="py-keyword">import</span> tag
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'body'</span>).prepend(tag.h1(<span class="py-string">'Document Title'</span>)))
<span class="py-output"><html><head><title>Some Title</title></head><body><h1>Document</span>
<span class="py-output">Title</h1>Some <em>body</em> text.</body></html></span></pre>
<p>Each XPath expression determines the set of tags that will be acted upon by
subsequent transformations. In this example we select the <tt class="rst-docutils literal"><title></tt> text,
copy it into a buffer, then select the <tt class="rst-docutils literal"><body></tt> element and paste the
copied text into the body as <tt class="rst-docutils literal"><h1></tt> enclosed text:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>buffer = StreamBuffer()
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'head/title/text()'</span>).copy(buffer)
<span class="py-more">... </span> .end().select(<span class="py-string">'body'</span>).prepend(tag.h1(buffer)))
<span class="py-output"><html><head><title>Some Title</title></head><body><h1>Some Title</h1>Some</span>
<span class="py-output"><em>body</em> text.</body></html></span></pre>
<p>Transformations can also be assigned and reused, although care must be
taken when using buffers, to ensure that buffers are cleared between
transforms:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>emphasis = Transformer(<span class="py-string">'body//em'</span>).attr(<span class="py-string">'class'</span>, <span class="py-string">'emphasis'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | emphasis)
<span class="py-output"><html><head><title>Some Title</title></head><body>Some <em</span>
<span class="py-output">class="emphasis">body</em> text.</body></html></span></pre>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">.</code><code class="variable-quote">'</code></span>)</span><br />
Construct a new transformation filter.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.core.Stream-class.html" class="link">Stream</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">stream</span>,
<span class="summary-sig-arg">keep_marks</span>=<span class="summary-sig-default">False</span>)</span><br />
Apply the transform filter to the marked stream.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#apply" class="summary-sig-name">apply</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">function</span>)</span><br />
Apply a transformation to the stream.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Selection operations</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#select" class="summary-sig-name">select</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">path</span>)</span><br />
Mark events matching the given XPath expression, within the current
selection.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#invert" class="summary-sig-name">invert</a>(<span class="summary-sig-arg">self</span>)</span><br />
Invert selection so that marked events become unmarked, and vice
versa.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#end" class="summary-sig-name">end</a>(<span class="summary-sig-arg">self</span>)</span><br />
End current selection, allowing all events to be selected.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Deletion operations</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#empty" class="summary-sig-name">empty</a>(<span class="summary-sig-arg">self</span>)</span><br />
Empty selected elements of all content.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#remove" class="summary-sig-name">remove</a>(<span class="summary-sig-arg">self</span>)</span><br />
Remove selection from the stream.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Direct element operations</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#unwrap" class="summary-sig-name">unwrap</a>(<span class="summary-sig-arg">self</span>)</span><br />
Remove outermost enclosing elements from selection.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#wrap" class="summary-sig-name">wrap</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">element</span>)</span><br />
Wrap selection in an element.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Content insertion operations</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#replace" class="summary-sig-name">replace</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">content</span>)</span><br />
Replace selection with content.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#before" class="summary-sig-name">before</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">content</span>)</span><br />
Insert content before selection.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#after" class="summary-sig-name">after</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">content</span>)</span><br />
Insert content after selection.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#prepend" class="summary-sig-name">prepend</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">content</span>)</span><br />
Insert content after the ENTER event of the selection.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#append" class="summary-sig-name">append</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">content</span>)</span><br />
Insert content before the END event of the selection.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Attribute manipulation</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#attr" class="summary-sig-name">attr</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Add, replace or delete an attribute on selected elements.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Buffer operations</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#copy" class="summary-sig-name">copy</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">buffer</span>,
<span class="summary-sig-arg">accumulate</span>=<span class="summary-sig-default">False</span>)</span><br />
Copy selection into buffer.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#cut" class="summary-sig-name">cut</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">buffer</span>,
<span class="summary-sig-arg">accumulate</span>=<span class="summary-sig-default">False</span>)</span><br />
Copy selection into buffer and remove the selection from the stream.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#buffer" class="summary-sig-name">buffer</a>(<span class="summary-sig-arg">self</span>)</span><br />
Buffer the entire stream (can consume a considerable amount of
memory).</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Miscellaneous operations</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#filter" class="summary-sig-name">filter</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">filter</span>)</span><br />
Apply a normal stream filter to the selection. The filter is called
once for each contiguous block of marked events.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#map" class="summary-sig-name">map</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">function</span>,
<span class="summary-sig-arg">kind</span>)</span><br />
Applies a function to the <tt class="rst-docutils literal">data</tt> element of events of <tt class="rst-docutils literal">kind</tt> in
the selection.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#substitute" class="summary-sig-name">substitute</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">pattern</span>,
<span class="summary-sig-arg">replace</span>,
<span class="summary-sig-arg">count</span>=<span class="summary-sig-default">1</span>)</span><br />
Replace text matching a regular expression.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="rename"></a><span class="summary-sig-name">rename</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Rename matching elements.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="genshi.filters.transform.Transformer-class.html#trace" class="summary-sig-name">trace</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">fileobj</span>=<span class="summary-sig-default">None</span>)</span><br />
Print events as they pass through the transform.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="transforms"></a><span class="summary-name">transforms</span>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">.</code><code class="variable-quote">'</code></span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
Construct a new transformation filter.
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> - an XPath expression (as string) or a <a href="genshi.path.Path-class.html" class="link">Path</a> instance</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__call__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">stream</span>,
<span class="sig-arg">keep_marks</span>=<span class="sig-default">False</span>)</span>
<br /><em class="fname">(Call operator)</em>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
Apply the transform filter to the marked stream.
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>stream</code></strong> - the marked event stream to filter</li>
<li><strong class="pname"><code>keep_marks</code></strong> - Do not strip transformer selection marks from the
stream. Useful for testing.</li>
</ul></dd>
<dt>Returns: <a href="genshi.core.Stream-class.html" class="link">Stream</a></dt>
<dd>the transformed stream</dd>
</dl>
</td></tr></table>
</div>
<a name="apply"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">apply</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">function</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Apply a transformation to the stream.</p>
<p>Transformations can be chained, similar to stream filters. Any callable
accepting a marked stream can be used as a transform.</p>
<p>As an example, here is a simple TEXT event upper-casing transform:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">def</span> <span class="py-defname">upper</span>(stream):
<span class="py-more">... </span> <span class="py-keyword">for</span> mark, (kind, data, pos) <span class="py-keyword">in</span> stream:
<span class="py-more">... </span> <span class="py-keyword">if</span> mark <span class="py-keyword">and</span> kind <span class="py-keyword">is</span> TEXT:
<span class="py-more">... </span> yield mark, (kind, data.upper(), pos)
<span class="py-more">... </span> <span class="py-keyword">else</span>:
<span class="py-more">... </span> yield mark, (kind, data, pos)
<span class="py-prompt">>>> </span>short_stream = HTML(<span class="py-string">'<body>Some <em>test</em> text</body>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(short_stream | Transformer(<span class="py-string">'.//em/text()'</span>).apply(upper))
<span class="py-output"><body>Some <em>TEST</em> text</body></span></pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="select"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">select</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Mark events matching the given XPath expression, within the current
selection.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<body>Some <em>test</em> text</body>'</span>, encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer().select(<span class="py-string">'.//em'</span>).trace())
<span class="py-output">(None, ('START', (QName('body'), Attrs()), (None, 1, 0)))</span>
<span class="py-output">(None, ('TEXT', u'Some ', (None, 1, 6)))</span>
<span class="py-output">('ENTER', ('START', (QName('em'), Attrs()), (None, 1, 11)))</span>
<span class="py-output">('INSIDE', ('TEXT', u'test', (None, 1, 15)))</span>
<span class="py-output">('EXIT', ('END', QName('em'), (None, 1, 19)))</span>
<span class="py-output">(None, ('TEXT', u' text', (None, 1, 24)))</span>
<span class="py-output">(None, ('END', QName('body'), (None, 1, 29)))</span>
<span class="py-output"><body>Some <em>test</em> text</body></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> - an XPath expression (as string) or a <a href="genshi.path.Path-class.html" class="link">Path</a> instance</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
<dd>the stream augmented by transformation marks</dd>
</dl>
</td></tr></table>
</div>
<a name="invert"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">invert</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Invert selection so that marked events become unmarked, and vice
versa.</p>
<p>Specificaly, all marks are converted to null marks, and all null marks
are converted to OUTSIDE marks.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<body>Some <em>test</em> text</body>'</span>, encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'//em'</span>).invert().trace())
<span class="py-output">('OUTSIDE', ('START', (QName('body'), Attrs()), (None, 1, 0)))</span>
<span class="py-output">('OUTSIDE', ('TEXT', u'Some ', (None, 1, 6)))</span>
<span class="py-output">(None, ('START', (QName('em'), Attrs()), (None, 1, 11)))</span>
<span class="py-output">(None, ('TEXT', u'test', (None, 1, 15)))</span>
<span class="py-output">(None, ('END', QName('em'), (None, 1, 19)))</span>
<span class="py-output">('OUTSIDE', ('TEXT', u' text', (None, 1, 24)))</span>
<span class="py-output">('OUTSIDE', ('END', QName('body'), (None, 1, 29)))</span>
<span class="py-output"><body>Some <em>test</em> text</body></span></pre>
<dl class="fields">
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="end"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">end</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>End current selection, allowing all events to be selected.</p>
<p>Example:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<body>Some <em>test</em> text</body>'</span>, encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'//em'</span>).end().trace())
<span class="py-output">('OUTSIDE', ('START', (QName('body'), Attrs()), (None, 1, 0)))</span>
<span class="py-output">('OUTSIDE', ('TEXT', u'Some ', (None, 1, 6)))</span>
<span class="py-output">('OUTSIDE', ('START', (QName('em'), Attrs()), (None, 1, 11)))</span>
<span class="py-output">('OUTSIDE', ('TEXT', u'test', (None, 1, 15)))</span>
<span class="py-output">('OUTSIDE', ('END', QName('em'), (None, 1, 19)))</span>
<span class="py-output">('OUTSIDE', ('TEXT', u' text', (None, 1, 24)))</span>
<span class="py-output">('OUTSIDE', ('END', QName('body'), (None, 1, 29)))</span>
<span class="py-output"><body>Some <em>test</em> text</body></span></pre>
<dl class="fields">
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
<dd>the stream augmented by transformation marks</dd>
</dl>
</td></tr></table>
</div>
<a name="empty"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">empty</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Empty selected elements of all content.</p>
<p>Example:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'.//em'</span>).empty())
<span class="py-output"><html><head><title>Some Title</title></head><body>Some <em/></span>
<span class="py-output">text.</body></html></span></pre>
<dl class="fields">
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="remove"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">remove</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Remove selection from the stream.</p>
<p>Example:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'.//em'</span>).remove())
<span class="py-output"><html><head><title>Some Title</title></head><body>Some</span>
<span class="py-output">text.</body></html></span></pre>
<dl class="fields">
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="unwrap"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">unwrap</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Remove outermost enclosing elements from selection.</p>
<p>Example:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'.//em'</span>).unwrap())
<span class="py-output"><html><head><title>Some Title</title></head><body>Some body</span>
<span class="py-output">text.</body></html></span></pre>
<dl class="fields">
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="wrap"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">wrap</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">element</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Wrap selection in an element.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'.//em'</span>).wrap(<span class="py-string">'strong'</span>))
<span class="py-output"><html><head><title>Some Title</title></head><body>Some</span>
<span class="py-output"><strong><em>body</em></strong> text.</body></html></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>element</code></strong> - either a tag name (as string) or an <a href="genshi.builder.Element-class.html" class="link">Element</a> object</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="replace"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">replace</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">content</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Replace selection with content.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'.//title/text()'</span>).replace(<span class="py-string">'New Title'</span>))
<span class="py-output"><html><head><title>New Title</title></head><body>Some <em>body</em></span>
<span class="py-output">text.</body></html></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>content</code></strong> - Either a callable, an iterable of events, or a string
to insert.</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="before"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">before</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">content</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Insert content before selection.</p>
<p>In this example we insert the word 'emphasised' before the <em> opening
tag:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'.//em'</span>).before(<span class="py-string">'emphasised '</span>))
<span class="py-output"><html><head><title>Some Title</title></head><body>Some emphasised</span>
<span class="py-output"><em>body</em> text.</body></html></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>content</code></strong> - Either a callable, an iterable of events, or a string
to insert.</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="after"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">after</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">content</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Insert content after selection.</p>
<p>Here, we insert some text after the </em> closing tag:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'.//em'</span>).after(<span class="py-string">' rock'</span>))
<span class="py-output"><html><head><title>Some Title</title></head><body>Some <em>body</em></span>
<span class="py-output">rock text.</body></html></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>content</code></strong> - Either a callable, an iterable of events, or a string
to insert.</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="prepend"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">prepend</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">content</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Insert content after the ENTER event of the selection.</p>
<p>Inserting some new text at the start of the <body>:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'.//body'</span>).prepend(<span class="py-string">'Some new body text. '</span>))
<span class="py-output"><html><head><title>Some Title</title></head><body>Some new body text.</span>
<span class="py-output">Some <em>body</em> text.</body></html></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>content</code></strong> - Either a callable, an iterable of events, or a string
to insert.</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="append"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">append</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">content</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Insert content before the END event of the selection.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'.//body'</span>).append(<span class="py-string">' Some new body text.'</span>))
<span class="py-output"><html><head><title>Some Title</title></head><body>Some <em>body</em></span>
<span class="py-output">text. Some new body text.</body></html></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>content</code></strong> - Either a callable, an iterable of events, or a string
to insert.</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="attr"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">attr</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Add, replace or delete an attribute on selected elements.</p>
<p>If <code class="link">value</code> evaulates to <code class="link">None</code> the attribute will be deleted from the
element:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em class="before">body</em> <em>text</em>.</body>'</span>
<span class="py-more">... </span> <span class="py-string">'</html>'</span>, encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'body/em'</span>).attr(<span class="py-string">'class'</span>, None))
<span class="py-output"><html><head><title>Some Title</title></head><body>Some <em>body</em></span>
<span class="py-output"><em>text</em>.</body></html></span></pre>
<p>Otherwise the attribute will be set to <code class="link">value</code>:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'body/em'</span>).attr(<span class="py-string">'class'</span>, <span class="py-string">'emphasis'</span>))
<span class="py-output"><html><head><title>Some Title</title></head><body>Some <em</span>
<span class="py-output">class="emphasis">body</em> <em class="emphasis">text</em>.</body></html></span></pre>
<p>If <code class="link">value</code> is a callable it will be called with the attribute name and
the START event for the matching element. Its return value will then
be used to set the attribute:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">def</span> <span class="py-defname">print_attr</span>(name, event):
<span class="py-more">... </span> attrs = event[1][1]
<span class="py-more">... </span> <span class="py-keyword">print</span>(attrs)
<span class="py-more">... </span> return attrs.get(name)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'body/em'</span>).attr(<span class="py-string">'class'</span>, print_attr))
<span class="py-output">Attrs([(QName('class'), u'before')])</span>
<span class="py-output">Attrs()</span>
<span class="py-output"><html><head><title>Some Title</title></head><body>Some <em</span>
<span class="py-output">class="before">body</em> <em>text</em>.</body></html></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> - the name of the attribute</li>
<li><strong class="pname"><code>value</code></strong> - the value that should be set for the attribute.</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="copy"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">copy</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">buffer</span>,
<span class="sig-arg">accumulate</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Copy selection into buffer.</p>
<p>The buffer is replaced by each <em>contiguous</em> selection before being passed
to the next transformation. If accumulate=True, further selections will
be appended to the buffer rather than replacing it.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> genshi.builder <span class="py-keyword">import</span> tag
<span class="py-prompt">>>> </span>buffer = StreamBuffer()
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'head/title/text()'</span>).copy(buffer)
<span class="py-more">... </span> .end().select(<span class="py-string">'body'</span>).prepend(tag.h1(buffer)))
<span class="py-output"><html><head><title>Some Title</title></head><body><h1>Some</span>
<span class="py-output">Title</h1>Some <em>body</em> text.</body></html></span></pre>
<p>This example illustrates that only a single contiguous selection will
be buffered:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'head/title/text()'</span>).copy(buffer)
<span class="py-more">... </span> .end().select(<span class="py-string">'body/em'</span>).copy(buffer).end().select(<span class="py-string">'body'</span>)
<span class="py-more">... </span> .prepend(tag.h1(buffer)))
<span class="py-output"><html><head><title>Some Title</title></head><body><h1>Some</span>
<span class="py-output">Title</h1>Some <em>body</em> text.</body></html></span>
<span class="py-output"></span><span class="py-prompt">>>> </span><span class="py-keyword">print</span>(buffer)
<span class="py-output"><em>body</em></span></pre>
<p>Element attributes can also be copied for later use:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body><em>Some</em> <em class="before">body</em>'</span>
<span class="py-more">... </span> <span class="py-string">'<em>text</em>.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span>buffer = StreamBuffer()
<span class="py-prompt">>>> </span><span class="py-keyword">def</span> <span class="py-defname">apply_attr</span>(name, entry):
<span class="py-more">... </span> return list(buffer)[0][1][1].get(<span class="py-string">'class'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'body/em[@class]/@class'</span>).copy(buffer)
<span class="py-more">... </span> .end().buffer().select(<span class="py-string">'body/em[not(@class)]'</span>)
<span class="py-more">... </span> .attr(<span class="py-string">'class'</span>, apply_attr))
<span class="py-output"><html><head><title>Some Title</title></head><body><em</span>
<span class="py-output">class="before">Some</em> <em class="before">body</em><em</span>
<span class="py-output">class="before">text</em>.</body></html></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>buffer</code></strong> - the <a href="genshi.filters.transform.StreamBuffer-class.html" class="link">StreamBuffer</a> in which the selection should be
stored</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
<div class="fields"> <p><strong>Note:</strong>
Copy (and cut) copy each individual selected object into the
buffer before passing to the next transform. For example, the
XPath <tt class="rst-docutils literal">*|text()</tt> will select all elements and text, each
instance of which will be copied to the buffer individually
before passing to the next transform. This has implications for
how <tt class="rst-docutils literal">StreamBuffer</tt> objects can be used, so some
experimentation may be required.
</p>
</div></td></tr></table>
</div>
<a name="cut"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">cut</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">buffer</span>,
<span class="sig-arg">accumulate</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Copy selection into buffer and remove the selection from the stream.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> genshi.builder <span class="py-keyword">import</span> tag
<span class="py-prompt">>>> </span>buffer = StreamBuffer()
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'.//em/text()'</span>).cut(buffer)
<span class="py-more">... </span> .end().select(<span class="py-string">'.//em'</span>).after(tag.h1(buffer)))
<span class="py-output"><html><head><title>Some Title</title></head><body>Some</span>
<span class="py-output"><em/><h1>body</h1> text.</body></html></span></pre>
<p>Specifying accumulate=True, appends all selected intervals onto the
buffer. Combining this with the .buffer() operation allows us operate
on all copied events rather than per-segment. See the documentation on
buffer() for more information.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>buffer</code></strong> - the <a href="genshi.filters.transform.StreamBuffer-class.html" class="link">StreamBuffer</a> in which the selection should be
stored</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
<div class="fields"> <p><strong>Note:</strong>
this transformation will buffer the entire input stream
</p>
</div></td></tr></table>
</div>
<a name="buffer"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">buffer</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Buffer the entire stream (can consume a considerable amount of
memory).</p>
<p>Useful in conjunction with copy(accumulate=True) and
cut(accumulate=True) to ensure that all marked events in the entire
stream are copied to the buffer before further transformations are
applied.</p>
<p>For example, to move all <note> elements inside a <notes> tag at the
top of the document:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>doc = HTML(<span class="py-string">'<doc><notes></notes><body>Some <note>one</note> '</span>
<span class="py-more">... </span> <span class="py-string">'text <note>two</note>.</body></doc>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span>buffer = StreamBuffer()
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(doc | Transformer(<span class="py-string">'body/note'</span>).cut(buffer, accumulate=True)
<span class="py-more">... </span> .end().buffer().select(<span class="py-string">'notes'</span>).prepend(buffer))
<span class="py-output"><doc><notes><note>one</note><note>two</note></notes><body>Some text</span>
<span class="py-output">.</body></doc></span></pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="filter"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">filter</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">filter</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Apply a normal stream filter to the selection. The filter is called
once for each contiguous block of marked events.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> genshi.filters.html <span class="py-keyword">import</span> HTMLSanitizer
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><body>Some text<script>alert(document.cookie)'</span>
<span class="py-more">... </span> <span class="py-string">'</script> and some more text</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'body/*'</span>).filter(HTMLSanitizer()))
<span class="py-output"><html><body>Some text and some more text</body></html></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>filter</code></strong> - The stream filter to apply.</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="map"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">map</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">function</span>,
<span class="sig-arg">kind</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Applies a function to the <tt class="rst-rst-docutils literal rst-docutils literal">data</tt> element of events of <tt class="rst-rst-docutils literal rst-docutils literal">kind</tt> in
the selection.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><head><title>Some Title</title></head>'</span>
<span class="py-more">... </span> <span class="py-string">'<body>Some <em>body</em> text.</body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'head/title'</span>).map(unicode.upper, TEXT))
<span class="py-output"><html><head><title>SOME TITLE</title></head><body>Some <em>body</em></span>
<span class="py-output">text.</body></html></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>function</code></strong> - the function to apply</li>
<li><strong class="pname"><code>kind</code></strong> - the kind of event the function should be applied to</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="substitute"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">substitute</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">pattern</span>,
<span class="sig-arg">replace</span>,
<span class="sig-arg">count</span>=<span class="sig-default">1</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Replace text matching a regular expression.</p>
<p>Refer to the documentation for <tt class="rst-docutils literal">re.sub()</tt> for details.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<html><body>Some text, some more text and '</span>
<span class="py-more">... </span> <span class="py-string">'<b>some bold text</b>\n'</span>
<span class="py-more">... </span> <span class="py-string">'<i>some italicised text</i></body></html>'</span>,
<span class="py-more">... </span> encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'body/b'</span>).substitute(<span class="py-string">'(?i)some'</span>, <span class="py-string">'SOME'</span>))
<span class="py-output"><html><body>Some text, some more text and <b>SOME bold text</b></span>
<span class="py-output"><i>some italicised text</i></body></html></span>
<span class="py-output"></span><span class="py-prompt">>>> </span>tags = tag.html(tag.body(<span class="py-string">'Some text, some more text and\n'</span>,
<span class="py-more">... </span> Markup(<span class="py-string">'<b>some bold text</b>'</span>)))
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(tags.generate() | Transformer(<span class="py-string">'body'</span>).substitute(
<span class="py-more">... </span> <span class="py-string">'(?i)some'</span>, <span class="py-string">'SOME'</span>))
<span class="py-output"><html><body>SOME text, some more text and</span>
<span class="py-output"><b>SOME bold text</b></body></html></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>pattern</code></strong> - A regular expression object or string.</li>
<li><strong class="pname"><code>replace</code></strong> - Replacement pattern.</li>
<li><strong class="pname"><code>count</code></strong> - Number of replacements to make in each text fragment.</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<a name="trace"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">trace</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">prefix</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="sig-arg">fileobj</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Print events as they pass through the transform.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>html = HTML(<span class="py-string">'<body>Some <em>test</em> text</body>'</span>, encoding=<span class="py-string">'utf-8'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">print</span>(html | Transformer(<span class="py-string">'em'</span>).trace())
<span class="py-output">(None, ('START', (QName('body'), Attrs()), (None, 1, 0)))</span>
<span class="py-output">(None, ('TEXT', u'Some ', (None, 1, 6)))</span>
<span class="py-output">('ENTER', ('START', (QName('em'), Attrs()), (None, 1, 11)))</span>
<span class="py-output">('INSIDE', ('TEXT', u'test', (None, 1, 15)))</span>
<span class="py-output">('EXIT', ('END', QName('em'), (None, 1, 19)))</span>
<span class="py-output">(None, ('TEXT', u' text', (None, 1, 24)))</span>
<span class="py-output">(None, ('END', QName('body'), (None, 1, 29)))</span>
<span class="py-output"><body>Some <em>test</em> text</body></span></pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>prefix</code></strong> - a string to prefix each event with in the output</li>
<li><strong class="pname"><code>fileobj</code></strong> - the writable file-like object to write to; defaults to
the standard output stream</li>
</ul></dd>
<dt>Returns: <a href="genshi.filters.transform.Transformer-class.html" class="link">Transformer</a></dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="genshi-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun Jan 27 18:17:20 2013
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|