How to output XML entity references

Question

I am using Python xml.etree.ElementTree to output XML. I want to output it with entity references that will be substituted when the XML is parsed.

ordinarily '&' is escaped as & because '&' is used to declare entity references. However, I really do want to write an entity reference. For example, I want to write an XML file containing the entity reference &manifestName;:

>>> from xml.etree.ElementTree import Element, tostring
>>> manifest = Element('manifest')
>>> manifest.text = '&manifestName;'
>>> tostring(manifest)

Which returns an escaped ampersand:

'<manifest>&amp;manifestName;</manifest>'

The desired XML would be:

'<manifest>&manifestName;</manifest>'

I have tried various escaping tricks, like &, \&, &&, but they do not work. The ampersands they contain are always rendered as &.

See stackoverflow.com/questions/2360598/…

user1026933
– user1026933

2011-11-03 03:44:34 +00:00
Commented Nov 3, 2011 at 3:44 — user1026933
– user1026933, Commented Nov 3, 2011 at 3:44

John McGehee · Accepted Answer · 2011-11-03 19:23:00Z

1

I have decided to go with a relatively palatable hack. In the text, I use && to mean an escaped &. ElementTree converts this to &&. At the end, I simply do a string replacement on it:

>>> from xml.etree.ElementTree import Element, tostring
>>> manifest = Element('manifest')
>>> manifest.text = '&&manifestName;'
>>> tostring(manifest).replace('&amp;&amp;', '&')

The result is the entity reference I want:

'<manifest>&manifestName;</manifest>'

answered Nov 3, 2011 at 19:23

John McGehee

835 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

posfan12 Over a year ago

I am having trouble implementing your solution. Could you check this question? stackoverflow.com/questions/56892938/…

Collectives™ on Stack Overflow

How to output XML entity references

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related