From 88db6f402e4f1187cb80f005dd74820a5f6d3662 Mon Sep 17 00:00:00 2001 From: Florent Xicluna Date: Sun, 14 Mar 2010 01:22:09 +0000 Subject: [PATCH] Minor documentation updates for xml.etree. --- Doc/library/xml.etree.elementtree.rst | 26 ++++++++++++++------------ Lib/test/test_xml_etree.py | 4 ++-- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index ae4044ed51e..def46696908 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -72,8 +72,8 @@ Functions .. function:: fromstring(text) - Parses an XML section from a string constant. Same as XML. *text* is a - string containing XML data. Returns an :class:`Element` instance. + Parses an XML section from a string constant. Same as :func:`XML`. *text* + is a string containing XML data. Returns an :class:`Element` instance. .. function:: fromstringlist(sequence, parser=None) @@ -139,7 +139,7 @@ Functions .. versionadded:: 2.7 -.. function:: SubElement(parent, tag, attrib={}, **extra) +.. function:: SubElement(parent, tag, attrib={}, **extra) Subelement factory. This function creates an element instance, and appends it to an existing element. @@ -151,22 +151,24 @@ Functions arguments. Returns an element instance. -.. function:: tostring(element, encoding=None, method=None) +.. function:: tostring(element, encoding="us-ascii", method="xml") Generates a string representation of an XML element, including all - subelements. *element* is an :class:`Element` instance. *encoding* is the - output encoding (default is US-ASCII). *method* is either ``"xml"``, + subelements. *element* is an :class:`Element` instance. *encoding* [1]_ is + the output encoding (default is US-ASCII). *method* is either ``"xml"``, ``"html"`` or ``"text"`` (default is ``"xml"``). Returns an encoded string containing the XML data. -.. function:: tostringlist(element, encoding=None, method=None) +.. function:: tostringlist(element, encoding="us-ascii", method="xml") Generates a string representation of an XML element, including all - subelements. *element* is an :class:`Element` instance. *encoding* is the - output encoding (default is US-ASCII). *method* is either ``"xml"``, - ``"html"`` or ``"text"`` (default is ``"xml"``). Returns a sequence object - containing the XML data. + subelements. *element* is an :class:`Element` instance. *encoding* [1]_ is + the output encoding (default is US-ASCII). *method* is either ``"xml"``, + ``"html"`` or ``"text"`` (default is ``"xml"``). Returns a list of encoded + strings containing the XML data. It does not guarantee any specific + sequence, except that ``"".join(tostringlist(element)) == + tostring(element)``. .. versionadded:: 2.7 @@ -459,7 +461,7 @@ ElementTree Objects root element. - .. method:: write(file, encoding=None, xml_declaration=None, method=None) + .. method:: write(file, encoding="us-ascii", xml_declaration=None, method="xml") Writes the element tree to a file, as XML. *file* is a file name, or a file object opened for writing. *encoding* [1]_ is the output encoding diff --git a/Lib/test/test_xml_etree.py b/Lib/test/test_xml_etree.py index cdb9fdfbef0..7fbc78c60d8 100644 --- a/Lib/test/test_xml_etree.py +++ b/Lib/test/test_xml_etree.py @@ -617,7 +617,7 @@ def parsefile(): """ def parseliteral(): - r""" + """ >>> element = ET.XML("text") >>> ET.ElementTree(element).write(sys.stdout) text @@ -631,7 +631,7 @@ def parseliteral(): >>> print "".join(ET.tostringlist(element)) text >>> ET.tostring(element, "ascii") - "\ntext" + "\\ntext" >>> _, ids = ET.XMLID("text") >>> len(ids) 0