Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions Doc/library/xml.etree.elementtree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -702,6 +702,9 @@ Functions
attributes. *extra* contains additional attributes, given as keyword
arguments. Returns an element instance.

.. versionchanged:: next
*attrib* can now be a :class:`frozendict`.


.. function:: tostring(element, encoding="us-ascii", method="xml", *, \
xml_declaration=None, default_namespace=None, \
Expand Down Expand Up @@ -887,6 +890,9 @@ Element Objects
an optional dictionary, containing element attributes. *extra* contains
additional attributes, given as keyword arguments.

.. versionchanged:: next
*attrib* can now be a :class:`frozendict`.


.. attribute:: tag

Expand Down
3 changes: 2 additions & 1 deletion Include/internal/pycore_dict.h
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,8 @@ extern void _PyDict_Clear_LockHeld(PyObject *op);
PyAPI_FUNC(void) _PyDict_EnsureSharedOnRead(PyDictObject *mp);
#endif

extern PyObject* _PyDict_CopyAsDict(PyObject *op);
// Export for '_elementtree' shared extension
PyAPI_FUNC(PyObject*) _PyDict_CopyAsDict(PyObject *op);

#define DKIX_EMPTY (-1)
#define DKIX_DUMMY (-2) /* Used internally */
Expand Down
11 changes: 9 additions & 2 deletions Lib/test/test_xml_etree.py
Original file line number Diff line number Diff line change
Expand Up @@ -4472,17 +4472,24 @@ def test_issue14818(self):
ET.Element('a', dict(href="#"), id="foo"),
ET.Element('a', href="#", id="foo"),
ET.Element('a', dict(href="#", id="foo"), href="#", id="foo"),
ET.Element('a', frozendict(href="#", id="foo")),
ET.Element('a', frozendict(href="#"), id="foo"),
ET.Element('a', attrib=frozendict(href="#", id="foo")),
]
for e in elements:
self.assertEqual(e.tag, 'a')
self.assertEqual(e.attrib, dict(href="#", id="foo"))

e2 = ET.SubElement(elements[0], 'foobar', attrib={'key1': 'value1'})
self.assertEqual(e2.attrib['key1'], 'value1')
e3 = ET.SubElement(elements[0], 'foobar',
attrib=frozendict({'key1': 'value1'}))
self.assertEqual(e3.attrib['key1'], 'value1')

with self.assertRaisesRegex(TypeError, 'must be dict, not str'):
errmsg = 'must be dict or frozendict, not str'
with self.assertRaisesRegex(TypeError, errmsg):
ET.Element('a', "I'm not a dict")
with self.assertRaisesRegex(TypeError, 'must be dict, not str'):
with self.assertRaisesRegex(TypeError, errmsg):
ET.Element('a', attrib="I'm not a dict")

# --------------------------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions Lib/xml/etree/ElementTree.py
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,8 @@ class Element:
"""

def __init__(self, tag, attrib={}, **extra):
if not isinstance(attrib, dict):
raise TypeError("attrib must be dict, not %s" % (
if not isinstance(attrib, (dict, frozendict)):
raise TypeError("attrib must be dict or frozendict, not %s" % (
attrib.__class__.__name__,))
self.tag = tag
self.attrib = {**attrib, **extra}
Expand Down
26 changes: 17 additions & 9 deletions Modules/_elementtree.c
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
#endif

#include "Python.h"
#include "pycore_dict.h" // _PyDict_CopyAsDict()
#include "pycore_pyhash.h" // _Py_HashSecret
#include "pycore_weakref.h" // FT_CLEAR_WEAKREFS()

Expand Down Expand Up @@ -382,13 +383,14 @@ get_attrib_from_keywords(PyObject *kwds)
/* If attrib was found in kwds, copy its value and remove it from
* kwds
*/
if (!PyDict_Check(attrib)) {
PyErr_Format(PyExc_TypeError, "attrib must be dict, not %.100s",
Py_TYPE(attrib)->tp_name);
if (!PyAnyDict_Check(attrib)) {
PyErr_Format(PyExc_TypeError,
"attrib must be dict or frozendict, not %T",
attrib);
Py_DECREF(attrib);
return NULL;
}
Py_SETREF(attrib, PyDict_Copy(attrib));
Py_SETREF(attrib, _PyDict_CopyAsDict(attrib));
}
else {
attrib = PyDict_New();
Expand Down Expand Up @@ -416,12 +418,18 @@ element_init(PyObject *self, PyObject *args, PyObject *kwds)
PyObject *attrib = NULL;
ElementObject *self_elem;

if (!PyArg_ParseTuple(args, "O|O!:Element", &tag, &PyDict_Type, &attrib))
if (!PyArg_ParseTuple(args, "O|O:Element", &tag, &attrib))
return -1;
if (attrib != NULL && !PyAnyDict_Check(attrib)) {
PyErr_Format(PyExc_TypeError,
"Element() argument 2 must be dict or frozendict, not %T",
attrib);
return -1;
}

if (attrib) {
/* attrib passed as positional arg */
attrib = PyDict_Copy(attrib);
attrib = _PyDict_CopyAsDict(attrib);
if (!attrib)
return -1;
if (kwds) {
Expand Down Expand Up @@ -2111,10 +2119,10 @@ static int
element_attrib_setter(PyObject *op, PyObject *value, void *closure)
{
_VALIDATE_ATTR_VALUE(value);
if (!PyDict_Check(value)) {
if (!PyAnyDict_Check(value)) {
PyErr_Format(PyExc_TypeError,
"attrib must be dict, not %.200s",
Py_TYPE(value)->tp_name);
"attrib must be dict or frozendict, not %T",
value);
return -1;
}
ElementObject *self = _Element_CAST(op);
Expand Down
Loading