/usr/lib/python2.7/dist-packages/meld3/__init__.py is in python-meld3 1.0.0-1.
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 | import email
import re
import sys
from xml.etree.ElementTree import Comment
from xml.etree.ElementTree import ElementPath
from xml.etree.ElementTree import ProcessingInstruction
from xml.etree.ElementTree import TreeBuilder
from xml.etree.ElementTree import XMLParser
from xml.etree.ElementTree import parse as et_parse
from ._compat import PY3
from ._compat import htmlentitydefs
from ._compat import HTMLParser
from ._compat import StringIO
from ._compat import bytes
from ._compat import unichr
from ._compat import _u
from ._compat import _b
from ._compat import _raise_serialization_error
from ._compat import _encode_entity
from ._compat import fixtag
AUTOCLOSE = "p", "li", "tr", "th", "td", "head", "body"
IGNOREEND = "img", "hr", "meta", "link", "br"
_BLANK = _b('')
_SPACE = _b(' ')
_EQUAL = _b('=')
_QUOTE = _b('"')
_OPEN_TAG_START = _b("<")
_CLOSE_TAG_START = _b("</")
_OPEN_TAG_END = _CLOSE_TAG_END = _b(">")
_SELF_CLOSE = _b(" />")
_OMITTED_TEXT = _b(' [...]\n')
_COMMENT_START = _b('<!-- ')
_COMMENT_END = _b(' -->')
_PI_START = _b('<?')
_PI_END = _b('?>')
_AMPER_ESCAPED = _b('&')
_LT = _b('<')
_LT_ESCAPED = _b('<')
_QUOTE_ESCAPED = _b(""")
_XML_PROLOG_BEGIN = _b('<?xml version="1.0"')
_ENCODING = _b('encoding')
_XML_PROLOG_END = _b('?>\n')
_DOCTYPE_BEGIN = _b('<!DOCTYPE')
_PUBLIC = _b('PUBLIC')
_DOCTYPE_END = _b('>\n')
if PY3:
def encode(text, encoding):
if not isinstance(text, bytes):
text = text.encode(encoding)
return text
else:
def encode(text, encoding):
return text.encode(encoding)
# replace element factory
def Replace(text, structure=False):
element = _MeldElementInterface(Replace, {})
element.text = text
element.structure = structure
return element
class PyHelper:
def findmeld(self, node, name, default=None):
iterator = self.getiterator(node)
for element in iterator:
val = element.attrib.get(_MELD_ID)
if val == name:
return element
return default
def clone(self, node, parent=None):
element = _MeldElementInterface(node.tag, node.attrib.copy())
element.text = node.text
element.tail = node.tail
element.structure = node.structure
if parent is not None:
# avoid calling self.append to reduce function call overhead
parent._children.append(element)
element.parent = parent
for child in node._children:
self.clone(child, element)
return element
def _bfclone(self, nodes, parent):
L = []
for node in nodes:
element = _MeldElementInterface(node.tag, node.attrib.copy())
element.parent = parent
element.text = node.text
element.tail = node.tail
element.structure = node.structure
if node._children:
self._bfclone(node._children, element)
L.append(element)
parent._children = L
def bfclone(self, node, parent=None):
element = _MeldElementInterface(node.tag, node.attrib.copy())
element.text = node.text
element.tail = node.tail
element.structure = node.structure
element.parent = parent
if parent is not None:
parent._children.append(element)
if node._children:
self._bfclone(node._children, element)
return element
def getiterator(self, node, tag=None):
nodes = []
if tag == "*":
tag = None
if tag is None or node.tag == tag:
nodes.append(node)
for element in node._children:
nodes.extend(self.getiterator(element, tag))
return nodes
def content(self, node, text, structure=False):
node.text = None
replacenode = Replace(text, structure)
replacenode.parent = node
replacenode.text = text
replacenode.structure = structure
node._children = [replacenode]
helper = PyHelper()
_MELD_NS_URL = 'http://www.plope.com/software/meld3'
_MELD_PREFIX = '{%s}' % _MELD_NS_URL
_MELD_LOCAL = 'id'
_MELD_ID = '%s%s' % (_MELD_PREFIX, _MELD_LOCAL)
_MELD_SHORT_ID = 'meld:%s' % _MELD_LOCAL
_XHTML_NS_URL = 'http://www.w3.org/1999/xhtml'
_XHTML_PREFIX = '{%s}' % _XHTML_NS_URL
_XHTML_PREFIX_LEN = len(_XHTML_PREFIX)
_marker = []
class doctype:
# lookup table for ease of use in external code
html_strict = ('HTML', '-//W3C//DTD HTML 4.01//EN',
'http://www.w3.org/TR/html4/strict.dtd')
html = ('HTML', '-//W3C//DTD HTML 4.01 Transitional//EN',
'http://www.w3.org/TR/html4/loose.dtd')
xhtml_strict = ('html', '-//W3C//DTD XHTML 1.0 Strict//EN',
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd')
xhtml = ('html', '-//W3C//DTD XHTML 1.0 Transitional//EN',
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd')
class _MeldElementInterface:
parent = None
attrib = None
text = None
tail = None
structure = None
# overrides to reduce MRU lookups
def __init__(self, tag, attrib):
self.tag = tag
self.attrib = attrib
self._children = []
def __repr__(self):
return "<MeldElement %s at %x>" % (self.tag, id(self))
def __len__(self):
return len(self._children)
def __getitem__(self, index):
return self._children[index]
def __getslice__(self, start, stop):
return self._children[start:stop]
def getchildren(self):
return self._children
def find(self, path):
return ElementPath.find(self, path)
def findtext(self, path, default=None):
return ElementPath.findtext(self, path, default)
def findall(self, path):
return ElementPath.findall(self, path)
def clear(self):
self.attrib.clear()
self._children = []
self.text = self.tail = None
def get(self, key, default=None):
return self.attrib.get(key, default)
def set(self, key, value):
self.attrib[key] = value
def keys(self):
return list(self.attrib.keys())
def items(self):
return list(self.attrib.items())
def getiterator(self, *ignored_args, **ignored_kw):
# we ignore any tag= passed in to us, originally because it was too
# painfail to support in the old C extension, now for b/w compat
return helper.getiterator(self)
# overrides to support parent pointers and factories
def __setitem__(self, index, element):
if isinstance(index, slice):
for e in element:
e.parent = self
else:
element.parent = self
self._children[index] = element
# TODO: Can __setslice__ be removed now?
def __setslice__(self, start, stop, elements):
for element in elements:
element.parent = self
self._children[start:stop] = list(elements)
def append(self, element):
self._children.append(element)
element.parent = self
def insert(self, index, element):
self._children.insert(index, element)
element.parent = self
def __delitem__(self, index):
if isinstance(index, slice):
for ob in self._children[index]:
ob.parent = None
else:
self._children[index].parent = None
ob = self._children[index]
del self._children[index]
# TODO: Can __delslice__ be removed now?
def __delslice__(self, start, stop):
obs = self._children[start:stop]
for ob in obs:
ob.parent = None
del self._children[start:stop]
def remove(self, element):
self._children.remove(element)
element.parent = None
def makeelement(self, tag, attrib):
return self.__class__(tag, attrib)
# meld-specific
def __mod__(self, other):
""" Fill in the text values of meld nodes in tree; only
support dictionarylike operand (sequence operand doesn't seem
to make sense here)"""
return self.fillmelds(**other)
def fillmelds(self, **kw):
""" Fill in the text values of meld nodes in tree using the
keyword arguments passed in; use the keyword keys as meld ids
and the keyword values as text that should fill in the node
text on which that meld id is found. Return a list of keys
from **kw that were not able to be found anywhere in the tree.
Never raises an exception. """
unfilled = []
for k in kw:
node = self.findmeld(k)
if node is None:
unfilled.append(k)
else:
node.text = kw[k]
return unfilled
def fillmeldhtmlform(self, **kw):
""" Perform magic to 'fill in' HTML form element values from a
dictionary. Unlike 'fillmelds', the type of element being
'filled' is taken into consideration.
Perform a 'findmeld' on each key in the dictionary and use the
value that corresponds to the key to perform mutation of the
tree, changing data in what is presumed to be one or more HTML
form elements according to the following rules::
If the found element is an 'input group' (its meld id ends
with the string ':inputgroup'), set the 'checked' attribute
on the appropriate subelement which has a 'value' attribute
which matches the dictionary value. Also remove the
'checked' attribute from every other 'input' subelement of
the input group. If no input subelement's value matches the
dictionary value, this key is treated as 'unfilled'.
If the found element is an 'input type=text', 'input
type=hidden', 'input type=submit', 'input type=password',
'input type=reset' or 'input type=file' element, replace its
'value' attribute with the value.
If the found element is an 'input type=checkbox' or 'input
type='radio' element, set its 'checked' attribute to true if
the dict value is true, or remove its 'checked' attribute if
the dict value is false.
If the found element is a 'select' element and the value
exists in the 'value=' attribute of one of its 'option'
subelements, change that option's 'selected' attribute to
true and mark all other option elements as unselected. If
the select element does not contain an option with a value
that matches the dictionary value, do nothing and return
this key as unfilled.
If the found element is a 'textarea' or any other kind of
element, replace its text with the value.
If the element corresponding to the key is not found,
do nothing and treat the key as 'unfilled'.
Return a list of 'unfilled' keys, representing meld ids
present in the dictionary but not present in the element tree
or meld ids which could not be filled due to the lack of any
matching subelements for 'select' nodes or 'inputgroup' nodes.
"""
unfilled = []
for k in kw:
node = self.findmeld(k)
if node is None:
unfilled.append(k)
continue
val = kw[k]
if k.endswith(':inputgroup'):
# an input group is a list of input type="checkbox" or
# input type="radio" elements that can be treated as a group
# because they attempt to specify the same value
found = []
unfound = []
for child in node.findall('input'):
input_type = child.attrib.get('type', '').lower()
if input_type not in ('checkbox', 'radio'):
continue
input_val = child.attrib.get('value', '')
if val == input_val:
found.append(child)
else:
unfound.append(child)
if not found:
unfilled.append(k)
else:
for option in found:
option.attrib['checked'] = 'checked'
for option in unfound:
try:
del option.attrib['checked']
except KeyError:
pass
else:
tag = node.tag.lower()
if tag == 'input':
input_type = node.attrib.get('type', 'text').lower()
# fill in value attrib for most input types
if input_type in ('hidden', 'submit', 'text',
'password', 'reset', 'file'):
node.attrib['value'] = val
# unless it's a checkbox or radio attribute, then we
# fill in its checked attribute
elif input_type in ('checkbox', 'radio'):
if val:
node.attrib['checked'] = 'checked'
else:
try:
del node.attrib['checked']
except KeyError:
pass
else:
unfilled.append(k)
elif tag == 'select':
# if the node is a select node, we want to select
# the value matching val, otherwise it's unfilled
found = []
unfound = []
for option in node.findall('option'):
if option.attrib.get('value', '') == val:
found.append(option)
else:
unfound.append(option)
if not found:
unfilled.append(k)
else:
for option in found:
option.attrib['selected'] = 'selected'
for option in unfound:
try:
del option.attrib['selected']
except KeyError:
pass
else:
node.text = kw[k]
return unfilled
def findmeld(self, name, default=None):
""" Find a node in the tree that has a 'meld id' corresponding
to 'name'. Iterate over all subnodes recursively looking for a
node which matches. If we can't find the node, return None."""
# this could be faster if we indexed all the meld nodes in the
# tree; we just walk the whole hierarchy now.
result = helper.findmeld(self, name)
if result is None:
return default
return result
def findmelds(self):
""" Find all nodes that have a meld id attribute and return
the found nodes in a list"""
return self.findwithattrib(_MELD_ID)
def findwithattrib(self, attrib, value=None):
""" Find all nodes that have an attribute named 'attrib'. If
'value' is not None, omit nodes on which the attribute value
does not compare equally to 'value'. Return the found nodes in
a list."""
iterator = helper.getiterator(self)
elements = []
for element in iterator:
attribval = element.attrib.get(attrib)
if attribval is not None:
if value is None:
elements.append(element)
else:
if value == attribval:
elements.append(element)
return elements
# ZPT-alike methods
def repeat(self, iterable, childname=None):
"""repeats an element with values from an iterable. If
'childname' is not None, repeat the element on which the
repeat is called, otherwise find the child element with a
'meld:id' matching 'childname' and repeat that. The element
is repeated within its parent element (nodes that are created
as a result of a repeat share the same parent). This method
returns an iterable; the value of each iteration is a
two-sequence in the form (newelement, data). 'newelement' is
a clone of the template element (including clones of its
children) which has already been seated in its parent element
in the template. 'data' is a value from the passed in
iterable. Changing 'newelement' (typically based on values
from 'data') mutates the element 'in place'."""
if childname:
element = self.findmeld(childname)
else:
element = self
parent = element.parent
# creating a list is faster than yielding a generator (py 2.4)
L = []
first = True
for thing in iterable:
if first is True:
clone = element
else:
clone = helper.bfclone(element, parent)
L.append((clone, thing))
first = False
return L
def replace(self, text, structure=False):
""" Replace this element with a Replace node in our parent with
the text 'text' and return the index of our position in
our parent. If we have no parent, do nothing, and return None.
Pass the 'structure' flag to the replace node so it can do the right
thing at render time. """
parent = self.parent
i = self.deparent()
if i is not None:
# reduce function call overhead by not calliing self.insert
node = Replace(text, structure)
parent._children.insert(i, node)
node.parent = parent
return i
def content(self, text, structure=False):
""" Delete this node's children and append a Replace node that
contains text. Always return None. Pass the 'structure' flag
to the replace node so it can do the right thing at render
time."""
helper.content(self, text, structure)
def attributes(self, **kw):
""" Set attributes on this node. """
for k, v in kw.items():
# prevent this from getting to the parser if possible
if not isinstance(k, str):
raise ValueError('do not set non-stringtype as key: %s' % k)
if not isinstance(v, str):
raise ValueError('do not set non-stringtype as val: %s' % v)
self.attrib[k] = kw[k]
# output methods
def write_xmlstring(self, encoding=None, doctype=None, fragment=False,
declaration=True, pipeline=False):
data = []
write = data.append
if not fragment:
if declaration:
_write_declaration(write, encoding)
if doctype:
_write_doctype(write, doctype)
_write_xml(write, self, encoding, {}, pipeline)
return _BLANK.join(data)
def write_xml(self, file, encoding=None, doctype=None,
fragment=False, declaration=True, pipeline=False):
""" Write XML to 'file' (which can be a filename or filelike object)
encoding - encoding string (if None, 'utf-8' encoding is assumed)
Must be a recognizable Python encoding type.
doctype - 3-tuple indicating name, pubid, system of doctype.
The default is to prevent a doctype from being emitted.
fragment - True if a 'fragment' should be emitted for this node (no
declaration, no doctype). This causes both the
'declaration' and 'doctype' parameters to become ignored
if provided.
declaration - emit an xml declaration header (including an encoding
if it's not None). The default is to emit the
doctype.
pipeline - preserve 'meld' namespace identifiers in output
for use in pipelining
"""
if not hasattr(file, "write"):
file = open(file, "wb")
data = self.write_xmlstring(encoding, doctype, fragment, declaration,
pipeline)
file.write(data)
def write_htmlstring(self, encoding=None, doctype=doctype.html,
fragment=False):
data = []
write = data.append
if encoding is None:
encoding = 'utf8'
if not fragment:
if doctype:
_write_doctype(write, doctype)
_write_html(write, self, encoding, {})
joined = _BLANK.join(data)
return joined
def write_html(self, file, encoding=None, doctype=doctype.html,
fragment=False):
""" Write HTML to 'file' (which can be a filename or filelike object)
encoding - encoding string (if None, 'utf-8' encoding is assumed).
Unlike XML output, this is not used in a declaration,
but it is used to do actual character encoding during
output. Must be a recognizable Python encoding type.
doctype - 3-tuple indicating name, pubid, system of doctype.
The default is the value of doctype.html (HTML 4.0
'loose')
fragment - True if a "fragment" should be omitted (no doctype).
This overrides any provided "doctype" parameter if
provided.
Namespace'd elements and attributes have their namespaces removed
during output when writing HTML, so pipelining cannot be performed.
HTML is not valid XML, so an XML declaration header is never emitted.
"""
if not hasattr(file, "write"):
file = open(file, "wb")
page = self.write_htmlstring(encoding, doctype, fragment)
file.write(page)
def write_xhtmlstring(self, encoding=None, doctype=doctype.xhtml,
fragment=False, declaration=False, pipeline=False):
data = []
write = data.append
if not fragment:
if declaration:
_write_declaration(write, encoding)
if doctype:
_write_doctype(write, doctype)
_write_xml(write, self, encoding, {}, pipeline, xhtml=True)
return _BLANK.join(data)
def write_xhtml(self, file, encoding=None, doctype=doctype.xhtml,
fragment=False, declaration=False, pipeline=False):
""" Write XHTML to 'file' (which can be a filename or filelike object)
encoding - encoding string (if None, 'utf-8' encoding is assumed)
Must be a recognizable Python encoding type.
doctype - 3-tuple indicating name, pubid, system of doctype.
The default is the value of doctype.xhtml (XHTML
'loose').
fragment - True if a 'fragment' should be emitted for this node (no
declaration, no doctype). This causes both the
'declaration' and 'doctype' parameters to be ignored.
declaration - emit an xml declaration header (including an encoding
string if 'encoding' is not None)
pipeline - preserve 'meld' namespace identifiers in output
for use in pipelining
"""
if not hasattr(file, "write"):
file = open(file, "wb")
page = self.write_xhtmlstring(encoding, doctype, fragment, declaration,
pipeline)
file.write(page)
def clone(self, parent=None):
""" Create a clone of an element. If parent is not None,
append the element to the parent. Recurse as necessary to create
a deep clone of the element. """
return helper.bfclone(self, parent)
def deparent(self):
""" Remove ourselves from our parent node (de-parent) and return
the index of the parent which was deleted. """
i = self.parentindex()
if i is not None:
del self.parent[i]
return i
def parentindex(self):
""" Return the parent node index in which we live """
parent = self.parent
if parent is not None:
return parent._children.index(self)
def shortrepr(self, encoding=None):
data = []
_write_html(data.append, self, encoding, {}, maxdepth=2)
return _BLANK.join(data)
def diffmeld(self, other):
""" Compute the meld element differences from this node (the
source) to 'other' (the target). Return a dictionary of
sequences in the form {'unreduced:
{'added':[], 'removed':[], 'moved':[]},
'reduced':
{'added':[], 'removed':[], 'moved':[]},}
"""
srcelements = self.findmelds()
tgtelements = other.findmelds()
srcids = [ x.meldid() for x in srcelements ]
tgtids = [ x.meldid() for x in tgtelements ]
removed = []
for srcelement in srcelements:
if srcelement.meldid() not in tgtids:
removed.append(srcelement)
added = []
for tgtelement in tgtelements:
if tgtelement.meldid() not in srcids:
added.append(tgtelement)
moved = []
for srcelement in srcelements:
srcid = srcelement.meldid()
if srcid in tgtids:
i = tgtids.index(srcid)
tgtelement = tgtelements[i]
if not sharedlineage(srcelement, tgtelement):
moved.append(tgtelement)
unreduced = {'added':added, 'removed':removed, 'moved':moved}
moved_reduced = diffreduce(moved)
added_reduced = diffreduce(added)
removed_reduced = diffreduce(removed)
reduced = {'moved':moved_reduced, 'added':added_reduced,
'removed':removed_reduced}
return {'unreduced':unreduced,
'reduced':reduced}
def meldid(self):
return self.attrib.get(_MELD_ID)
def lineage(self):
L = []
parent = self
while parent is not None:
L.append(parent)
parent = parent.parent
return L
class MeldTreeBuilder(TreeBuilder):
def __init__(self):
TreeBuilder.__init__(self, element_factory=_MeldElementInterface)
self.meldids = {}
def start(self, tag, attrs):
elem = TreeBuilder.start(self, tag, attrs)
for key, value in attrs.items():
if key == _MELD_ID:
if value in self.meldids:
raise ValueError('Repeated meld id "%s" in source' %
value)
self.meldids[value] = 1
break
return elem
def comment(self, data):
self.start(Comment, {})
self.data(data)
self.end(Comment)
def doctype(self, name, pubid, system):
pass
if sys.version_info < (2, 7):
class MeldParser(XMLParser):
""" Based on Fredrik's PIParser[1]
Blithely ignores the case of a comment existing outside the root
element, and ignores processing instructions entirely.
[1] http://effbot.org/zone/element-pi.htm.
"""
def __init__(self, html=0, target=None):
XMLParser.__init__(self, html, target)
self._parser.CommentHandler = self.handle_comment
def handle_comment(self, data):
self._target.start(Comment, {})
self._target.data(data)
self._target.end(Comment)
else:
#just use the stock one
MeldParser = XMLParser
class HTMLMeldParser(HTMLParser):
""" A mostly-cut-and-paste of ElementTree's HTMLTreeBuilder that
does special meld3 things (like preserve comments and munge meld
ids). Subclassing is not possible due to private attributes. :-("""
def __init__(self, builder=None, encoding=None):
self.__stack = []
if builder is None:
builder = MeldTreeBuilder()
self.builder = builder
self.encoding = encoding or "iso-8859-1"
try:
# ``convert_charrefs`` was added in Python 3.4. Set it to avoid
# "DeprecationWarning: The value of convert_charrefs will become
# True in 3.5. You are encouraged to set the value explicitly."
HTMLParser.__init__(self, convert_charrefs=False)
except TypeError:
HTMLParser.__init__(self)
self.meldids = {}
def close(self):
HTMLParser.close(self)
self.meldids = {}
return self.builder.close()
def handle_starttag(self, tag, attrs):
if tag == "meta":
# look for encoding directives
http_equiv = content = None
for k, v in attrs:
if k == "http-equiv":
http_equiv = v.lower()
elif k == "content":
content = v
if http_equiv == "content-type" and content:
# use email to parse the http header
msg = email.message_from_string(
"%s: %s\n\n" % (http_equiv, content)
)
encoding = msg.get_param("charset")
if encoding:
self.encoding = encoding
if tag in AUTOCLOSE:
if self.__stack and self.__stack[-1] == tag:
self.handle_endtag(tag)
self.__stack.append(tag)
attrib = {}
if attrs:
for k, v in attrs:
if k == _MELD_SHORT_ID:
k = _MELD_ID
if self.meldids.get(v):
raise ValueError('Repeated meld id "%s" in source' %
v)
self.meldids[v] = 1
else:
k = k.lower()
attrib[k] = v
self.builder.start(tag, attrib)
if tag in IGNOREEND:
self.__stack.pop()
self.builder.end(tag)
def handle_endtag(self, tag):
if tag in IGNOREEND:
return
lasttag = self.__stack.pop()
if tag != lasttag and lasttag in AUTOCLOSE:
self.handle_endtag(lasttag)
self.builder.end(tag)
def handle_charref(self, char):
if char[:1] == "x":
char = int(char[1:], 16)
else:
char = int(char)
self.builder.data(unichr(char))
def handle_entityref(self, name):
entity = htmlentitydefs.entitydefs.get(name)
if entity:
if len(entity) == 1:
entity = ord(entity)
else:
entity = int(entity[2:-1])
self.builder.data(unichr(entity))
else:
self.unknown_entityref(name)
def handle_data(self, data):
if isinstance(data, bytes):
data = _u(data, self.encoding)
self.builder.data(data)
def unknown_entityref(self, name):
pass # ignore by default; override if necessary
def handle_comment(self, data):
self.builder.start(Comment, {})
self.builder.data(data)
self.builder.end(Comment)
def do_parse(source, parser):
root = et_parse(source, parser=parser).getroot()
iterator = root.getiterator()
for p in iterator:
for c in p:
c.parent = p
return root
def parse_xml(source):
""" Parse source (a filelike object) into an element tree. If
html is true, use a parser that can resolve somewhat ambiguous
HTML into XHTML. Otherwise use a 'normal' parser only."""
builder = MeldTreeBuilder()
parser = MeldParser(target=builder)
return do_parse(source, parser)
def parse_html(source, encoding=None):
builder = MeldTreeBuilder()
parser = HTMLMeldParser(builder, encoding)
return do_parse(source, parser)
def parse_xmlstring(text):
source = StringIO(text)
return parse_xml(source)
def parse_htmlstring(text, encoding=None):
source = StringIO(text)
return parse_html(source, encoding)
attrib_needs_escaping = re.compile(r'[&"<]').search
cdata_needs_escaping = re.compile(r'[&<]').search
def _both_case(mapping):
# Add equivalent upper-case keys to mapping.
lc_keys = list(mapping.keys())
for k in lc_keys:
mapping[k.upper()] = mapping[k]
_HTMLTAGS_UNBALANCED = {'area':1, 'base':1, 'basefont':1, 'br':1, 'col':1,
'frame':1, 'hr':1, 'img':1, 'input':1, 'isindex':1,
'link':1, 'meta':1, 'param':1}
_both_case(_HTMLTAGS_UNBALANCED)
_HTMLTAGS_NOESCAPE = {'script':1, 'style':1}
_both_case(_HTMLTAGS_NOESCAPE)
_HTMLATTRS_BOOLEAN = {'selected':1, 'checked':1, 'compact':1, 'declare':1,
'defer':1, 'disabled':1, 'ismap':1, 'multiple':1,
'nohref':1, 'noresize':1, 'noshade':1, 'nowrap':1}
_both_case(_HTMLATTRS_BOOLEAN)
def _write_html(write, node, encoding, namespaces, depth=-1, maxdepth=None):
""" Walk 'node', calling 'write' with bytes(?).
"""
if encoding is None:
encoding = 'utf-8'
tag = node.tag
tail = node.tail
text = node.text
tail = node.tail
to_write = _BLANK
if tag is Replace:
if not node.structure:
if cdata_needs_escaping(text):
text = _escape_cdata(text)
write(encode(text, encoding))
elif tag is Comment:
if cdata_needs_escaping(text):
text = _escape_cdata(text)
write(encode('<!-- ' + text + ' -->', encoding))
elif tag is ProcessingInstruction:
if cdata_needs_escaping(text):
text = _escape_cdata(text)
write(encode('<!-- ' + text + ' -->', encoding))
else:
xmlns_items = [] # new namespaces in this scope
try:
if tag[:1] == "{":
if tag[:_XHTML_PREFIX_LEN] == _XHTML_PREFIX:
tag = tag[_XHTML_PREFIX_LEN:]
else:
tag, xmlns = fixtag(tag, namespaces)
if xmlns:
xmlns_items.append(xmlns)
except TypeError:
_raise_serialization_error(tag)
to_write += _OPEN_TAG_START + encode(tag, encoding)
attrib = node.attrib
if attrib is not None:
if len(attrib) > 1:
attrib_keys = list(attrib.keys())
attrib_keys.sort()
else:
attrib_keys = attrib
for k in attrib_keys:
try:
if k[:1] == "{":
continue
except TypeError:
_raise_serialization_error(k)
if k in _HTMLATTRS_BOOLEAN:
to_write += _SPACE + encode(k, encoding)
else:
v = attrib[k]
to_write += _encode_attrib(k, v, encoding)
for k, v in xmlns_items:
to_write += _encode_attrib(k, v, encoding)
to_write += _OPEN_TAG_END
if text is not None and text:
if tag in _HTMLTAGS_NOESCAPE:
to_write += encode(text, encoding)
elif cdata_needs_escaping(text):
to_write += _escape_cdata(text)
else:
to_write += encode(text,encoding)
write(to_write)
for child in node._children:
if maxdepth is not None:
depth = depth + 1
if depth < maxdepth:
_write_html(write, child, encoding, namespaces, depth,
maxdepth)
elif depth == maxdepth and text:
write(_OMITTED_TEXT)
else:
_write_html(write, child, encoding, namespaces, depth, maxdepth)
if text or node._children or tag not in _HTMLTAGS_UNBALANCED:
write(_CLOSE_TAG_START + encode(tag, encoding) + _CLOSE_TAG_END)
if tail:
if cdata_needs_escaping(tail):
write(_escape_cdata(tail))
else:
write(encode(tail,encoding))
def _write_xml(write, node, encoding, namespaces, pipeline, xhtml=False):
""" Write XML to a file """
if encoding is None:
encoding = 'utf-8'
tag = node.tag
if tag is Comment:
write(_COMMENT_START +
_escape_cdata(node.text, encoding) +
_COMMENT_END)
elif tag is ProcessingInstruction:
write(_PI_START +
_escape_cdata(node.text, encoding) +
_PI_END)
elif tag is Replace:
if node.structure:
# this may produce invalid xml
write(encode(node.text, encoding))
else:
write(_escape_cdata(node.text, encoding))
else:
if xhtml:
if tag[:_XHTML_PREFIX_LEN] == _XHTML_PREFIX:
tag = tag[_XHTML_PREFIX_LEN:]
if node.attrib:
items = list(node.attrib.items())
else:
items = [] # must always be sortable.
xmlns_items = [] # new namespaces in this scope
try:
if tag[:1] == "{":
tag, xmlns = fixtag(tag, namespaces)
if xmlns:
xmlns_items.append(xmlns)
except TypeError:
_raise_serialization_error(tag)
write(_OPEN_TAG_START + encode(tag, encoding))
if items or xmlns_items:
items.sort() # lexical order
for k, v in items:
try:
if k[:1] == "{":
if not pipeline:
if k == _MELD_ID:
continue
k, xmlns = fixtag(k, namespaces)
if xmlns: xmlns_items.append(xmlns)
if not pipeline:
# special-case for HTML input
if k == 'xmlns:meld':
continue
except TypeError:
_raise_serialization_error(k)
write(_encode_attrib(k, v, encoding))
for k, v in xmlns_items:
write(_encode_attrib(k, v, encoding))
if node.text or node._children:
write(_OPEN_TAG_END)
if node.text:
write(_escape_cdata(node.text, encoding))
for n in node._children:
_write_xml(write, n, encoding, namespaces, pipeline, xhtml)
write(_CLOSE_TAG_START + encode(tag, encoding) + _CLOSE_TAG_END)
else:
write(_SELF_CLOSE)
for k, v in xmlns_items:
del namespaces[v]
if node.tail:
write(_escape_cdata(node.tail, encoding))
def _encode_attrib(k, v, encoding):
return _BLANK.join((_SPACE,
encode(k, encoding),
_EQUAL,
_QUOTE,
_escape_attrib(v, encoding),
_QUOTE,
))
# overrides to elementtree to increase speed and get entity quoting correct.
_NONENTITY_RE = re.compile(_b('&(?!([#\w]*;))')) # negative lookahead assertion
def _escape_cdata(text, encoding=None):
# Return escaped character data as bytes.
try:
if encoding:
try:
encoded = encode(text, encoding)
except UnicodeError:
return _encode_entity(text)
else:
encoded = _b(text)
encoded = _NONENTITY_RE.sub(_AMPER_ESCAPED, encoded)
encoded = encoded.replace(_LT, _LT_ESCAPED)
return encoded
except (TypeError, AttributeError):
_raise_serialization_error(text)
def _escape_attrib(text, encoding):
# Return escaped attribute value as bytes.
try:
if encoding:
try:
encoded = encode(text, encoding)
except UnicodeError:
return _encode_entity(text)
else:
encoded = _b(text)
# don't requote properly-quoted entities
encoded = _NONENTITY_RE.sub(_AMPER_ESCAPED, encoded)
encoded = encoded.replace(_LT, _LT_ESCAPED)
encoded = encoded.replace(_QUOTE, _QUOTE_ESCAPED)
return encoded
except (TypeError, AttributeError):
_raise_serialization_error(text)
# utility functions
def _write_declaration(write, encoding):
# Write as bytes.
if not encoding:
write(_XML_PROLOG_BEGIN + _XML_PROLOG_END)
else:
write(_XML_PROLOG_BEGIN +
_SPACE +
_ENCODING +
_EQUAL +
_QUOTE +
_b(encoding) +
_QUOTE +
_XML_PROLOG_END)
def _write_doctype(write, doctype):
# Write as bytes.
try:
name, pubid, system = doctype
except (ValueError, TypeError):
raise ValueError("doctype must be supplied as a 3-tuple in the form "
"(name, pubid, system) e.g. '%s'" % doctype.xhtml)
write(_DOCTYPE_BEGIN + _SPACE + _b(name) + _SPACE + _PUBLIC + _SPACE +
_QUOTE + _b(pubid) + _QUOTE + _SPACE +
_QUOTE + _b(system) + _QUOTE +
_DOCTYPE_END)
_XML_DECL_RE = re.compile(r'<\?xml .*?\?>')
_BEGIN_TAG_RE = re.compile(r'<[^/?!]?\w+')
def insert_doctype(data, doctype=doctype.xhtml):
# jam an html doctype declaration into 'data' if it
# doesn't already contain a doctype declaration
match = _XML_DECL_RE.search(data)
dt_string = '<!DOCTYPE %s PUBLIC "%s" "%s">' % doctype
if match is not None:
start, end = match.span(0)
before = data[:start]
tag = data[start:end]
after = data[end:]
return before + tag + dt_string + after
else:
return dt_string + data
def insert_meld_ns_decl(data):
match = _BEGIN_TAG_RE.search(data)
if match is not None:
start, end = match.span(0)
before = data[:start]
tag = data[start:end] + ' xmlns:meld="%s"' % _MELD_NS_URL
after = data[end:]
data = before + tag + after
return data
def prefeed(data, doctype=doctype.xhtml):
if data.find('<!DOCTYPE') == -1:
data = insert_doctype(data, doctype)
if data.find('xmlns:meld') == -1:
data = insert_meld_ns_decl(data)
return data
def sharedlineage(srcelement, tgtelement):
srcparent = srcelement.parent
tgtparent = tgtelement.parent
srcparenttag = getattr(srcparent, 'tag', None)
tgtparenttag = getattr(tgtparent, 'tag', None)
if srcparenttag != tgtparenttag:
return False
elif tgtparenttag is None and srcparenttag is None:
return True
elif tgtparent and srcparent:
return sharedlineage(srcparent, tgtparent)
return False
def diffreduce(elements):
# each element in 'elements' should all have non-None meldids, and should
# be preordered in depth-first traversal order
reduced = []
for element in elements:
parent = element.parent
if parent is None:
reduced.append(element)
continue
if parent in reduced:
continue
reduced.append(element)
return reduced
def intersection(S1, S2):
L = []
for element in S1:
if element in S2:
L.append(element)
return L
def melditerator(element, meldid=None, _MELD_ID=_MELD_ID):
nodeid = element.attrib.get(_MELD_ID)
if nodeid is not None:
if meldid is None or nodeid == meldid:
yield element
for child in element._children:
for el2 in melditerator(child, meldid):
nodeid = el2.attrib.get(_MELD_ID)
if nodeid is not None:
if meldid is None or nodeid == meldid:
yield el2
|