1berry/cpython
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Issue #16089: Allow ElementTree.TreeBuilder to work again with a non-Element element_factory (fixes a regression in SimpleTAL).

Browse Source
This commit is contained in:
Antoine Pitrou 2012-10-04 19:54:53 +02:00
commit 997adb5819
4 changed files with 127 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
Lib/test/test_xml_etree.py
View File

@ -1893,10 +1893,23 @@ class TreeBuilderTest(unittest.TestCase):
sample1 = ('<!DOCTYPE html PUBLIC' sample1 = ('<!DOCTYPE html PUBLIC'
' "-//W3C//DTD XHTML 1.0 Transitional//EN"' ' "-//W3C//DTD XHTML 1.0 Transitional//EN"'
' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">' ' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
'<html>text</html>') '<html>text<div>subtext</div>tail</html>')
sample2 = '''<toplevel>sometext</toplevel>''' sample2 = '''<toplevel>sometext</toplevel>'''
def _check_sample1_element(self, e):
self.assertEqual(e.tag, 'html')
self.assertEqual(e.text, 'text')
self.assertEqual(e.tail, None)
self.assertEqual(e.attrib, {})
children = list(e)
self.assertEqual(len(children), 1)
child = children[0]
self.assertEqual(child.tag, 'div')
self.assertEqual(child.text, 'subtext')
self.assertEqual(child.tail, 'tail')
self.assertEqual(child.attrib, {})
def test_dummy_builder(self): def test_dummy_builder(self):
class BaseDummyBuilder: class BaseDummyBuilder:
def close(self): def close(self):
@ -1929,7 +1942,7 @@ class TreeBuilderTest(unittest.TestCase):
parser.feed(self.sample1) parser.feed(self.sample1)
e = parser.close() e = parser.close()
self.assertEqual(e.tag, 'html') self._check_sample1_element(e)
def test_element_factory(self): def test_element_factory(self):
lst = [] lst = []
@ -1945,6 +1958,33 @@ class TreeBuilderTest(unittest.TestCase):
self.assertEqual(lst, ['toplevel']) self.assertEqual(lst, ['toplevel'])
def _check_element_factory_class(self, cls):
tb = ET.TreeBuilder(element_factory=cls)
parser = ET.XMLParser(target=tb)
parser.feed(self.sample1)
e = parser.close()
self.assertIsInstance(e, cls)
self._check_sample1_element(e)
def test_element_factory_subclass(self):
class MyElement(ET.Element):
pass
self._check_element_factory_class(MyElement)
def test_element_factory_pure_python_subclass(self):
# Mimick SimpleTAL's behaviour (issue #16089): both versions of
# TreeBuilder should be able to cope with a subclass of the
# pure Python Element class.
base = ET._Element
# Not from a C extension
self.assertEqual(base.__module__, 'xml.etree.ElementTree')
# Force some multiple inheritance with a C class to make things
# more interesting.
class MyElement(base, ValueError):
pass
self._check_element_factory_class(MyElement)
def test_doctype(self): def test_doctype(self):
class DoctypeParser: class DoctypeParser:
_doctype = None _doctype = None

4
Lib/xml/etree/ElementTree.py
View File

@ -303,7 +303,9 @@ class Element:
self._children.insert(index, element) self._children.insert(index, element)
def _assert_is_element(self, e): def _assert_is_element(self, e):
if not isinstance(e, Element): # Need to refer to the actual Python implementation, not the
# shadowing C implementation.
if not isinstance(e, _Element):
raise TypeError('expected an Element, not %s' % type(e).__name__) raise TypeError('expected an Element, not %s' % type(e).__name__)
## ##

3
Misc/NEWS
View File

@ -39,6 +39,9 @@ Core and Builtins
Library Library
------- -------
- Issue #16089: Allow ElementTree.TreeBuilder to work again with a non-Element
element_factory (fixes a regression in SimpleTAL).
- Issue #9650: List commonly used format codes in time.strftime and - Issue #9650: List commonly used format codes in time.strftime and
time.strptime docsttings. Original patch by Mike Hoy. time.strptime docsttings. Original patch by Mike Hoy.

107
Modules/_elementtree.c
View File

@ -1997,8 +1997,8 @@ typedef struct {
PyObject *root; /* root node (first created node) */ PyObject *root; /* root node (first created node) */
ElementObject *this; /* current node */ PyObject *this; /* current node */
ElementObject *last; /* most recently created node */ PyObject *last; /* most recently created node */
PyObject *data; /* data collector (string or list), or NULL */ PyObject *data; /* data collector (string or list), or NULL */
@ -2030,9 +2030,9 @@ treebuilder_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
t->root = NULL; t->root = NULL;
Py_INCREF(Py_None); Py_INCREF(Py_None);
t->this = (ElementObject *)Py_None; t->this = Py_None;
Py_INCREF(Py_None); Py_INCREF(Py_None);
t->last = (ElementObject *)Py_None; t->last = Py_None;
t->data = NULL; t->data = NULL;
t->element_factory = NULL; t->element_factory = NULL;
@ -2112,6 +2112,64 @@ treebuilder_dealloc(TreeBuilderObject *self)
Py_TYPE(self)->tp_free((PyObject *)self); Py_TYPE(self)->tp_free((PyObject *)self);
} }
/* -------------------------------------------------------------------- */
/* helpers for handling of arbitrary element-like objects */
static int
treebuilder_set_element_text_or_tail(PyObject *element, PyObject *data,
PyObject **dest, _Py_Identifier *name)
{
if (Element_CheckExact(element)) {
Py_DECREF(JOIN_OBJ(*dest));
*dest = JOIN_SET(data, PyList_CheckExact(data));
return 0;
}
else {
PyObject *joined = list_join(data);
int r;
if (joined == NULL)
return -1;
r = _PyObject_SetAttrId(element, name, joined);
Py_DECREF(joined);
return r;
}
}
/* These two functions steal a reference to data */
static int
treebuilder_set_element_text(PyObject *element, PyObject *data)
{
_Py_IDENTIFIER(text);
return treebuilder_set_element_text_or_tail(
element, data, &((ElementObject *) element)->text, &PyId_text);
}
static int
treebuilder_set_element_tail(PyObject *element, PyObject *data)
{
_Py_IDENTIFIER(tail);
return treebuilder_set_element_text_or_tail(
element, data, &((ElementObject *) element)->tail, &PyId_tail);
}
static int
treebuilder_add_subelement(PyObject *element, PyObject *child)
{
_Py_IDENTIFIER(append);
if (Element_CheckExact(element)) {
ElementObject *elem = (ElementObject *) element;
return element_add_subelement(elem, child);
}
else {
PyObject *res;
res = _PyObject_CallMethodId(element, &PyId_append, "O", child);
if (res == NULL)
return -1;
Py_DECREF(res);
return 0;
}
}
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/* handlers */ /* handlers */
@ -2124,15 +2182,12 @@ treebuilder_handle_start(TreeBuilderObject* self, PyObject* tag,
if (self->data) { if (self->data) {
if (self->this == self->last) { if (self->this == self->last) {
Py_DECREF(JOIN_OBJ(self->last->text)); if (treebuilder_set_element_text(self->last, self->data))
self->last->text = JOIN_SET( return NULL;
self->data, PyList_CheckExact(self->data) }
); else {
} else { if (treebuilder_set_element_tail(self->last, self->data))
Py_DECREF(JOIN_OBJ(self->last->tail)); return NULL;
self->last->tail = JOIN_SET(
self->data, PyList_CheckExact(self->data)
);
} }
self->data = NULL; self->data = NULL;
} }
@ -2146,10 +2201,10 @@ treebuilder_handle_start(TreeBuilderObject* self, PyObject* tag,
return NULL; return NULL;
} }
this = (PyObject*) self->this; this = self->this;
if (this != Py_None) { if (this != Py_None) {
if (element_add_subelement((ElementObject*) this, node) < 0) if (treebuilder_add_subelement(this, node) < 0)
goto error; goto error;
} else { } else {
if (self->root) { if (self->root) {
@ -2175,11 +2230,11 @@ treebuilder_handle_start(TreeBuilderObject* self, PyObject* tag,
Py_DECREF(this); Py_DECREF(this);
Py_INCREF(node); Py_INCREF(node);
self->this = (ElementObject*) node; self->this = node;
Py_DECREF(self->last); Py_DECREF(self->last);
Py_INCREF(node); Py_INCREF(node);
self->last = (ElementObject*) node; self->last = node;
if (self->start_event_obj) { if (self->start_event_obj) {
PyObject* res; PyObject* res;
@ -2203,7 +2258,7 @@ LOCAL(PyObject*)
treebuilder_handle_data(TreeBuilderObject* self, PyObject* data) treebuilder_handle_data(TreeBuilderObject* self, PyObject* data)
{ {
if (!self->data) { if (!self->data) {
if (self->last == (ElementObject*) Py_None) { if (self->last == Py_None) {
/* ignore calls to data before the first call to start */ /* ignore calls to data before the first call to start */
Py_RETURN_NONE; Py_RETURN_NONE;
} }
@ -2243,15 +2298,11 @@ treebuilder_handle_end(TreeBuilderObject* self, PyObject* tag)
if (self->data) { if (self->data) {
if (self->this == self->last) { if (self->this == self->last) {
Py_DECREF(JOIN_OBJ(self->last->text)); if (treebuilder_set_element_text(self->last, self->data))
self->last->text = JOIN_SET( return NULL;
self->data, PyList_CheckExact(self->data)
);
} else { } else {
Py_DECREF(JOIN_OBJ(self->last->tail)); if (treebuilder_set_element_tail(self->last, self->data))
self->last->tail = JOIN_SET( return NULL;
self->data, PyList_CheckExact(self->data)
);
} }
self->data = NULL; self->data = NULL;
} }
@ -2271,8 +2322,8 @@ treebuilder_handle_end(TreeBuilderObject* self, PyObject* tag)
Py_DECREF(self->last); Py_DECREF(self->last);
self->last = (ElementObject*) self->this; self->last = self->this;
self->this = (ElementObject*) item; self->this = item;
if (self->end_event_obj) { if (self->end_event_obj) {
PyObject* res; PyObject* res;