mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-13 07:26:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Issue #9458: clarify the documentation of ElementTree.write with regards to the type of the stream expected for a given encoding

Browse source
This commit is contained in:
Eli Bendersky 2012-07-15 06:19:44 +03:00
parent 00f402bfcb
commit f96cf911a0
1 changed files with 17 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

24
Doc/library/xml.etree.elementtree.rst
View file

@ -650,15 +650,25 @@ ElementTree Objects
section root element. section root element.
.. method:: write(file, encoding="us-ascii", xml_declaration=None, method="xml") .. 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 Writes the element tree to a file, as XML. *file* is a file name, or a
:term:`file object` opened for writing. *encoding* [1]_ is the output encoding :term:`file object` opened for writing. *encoding* [1]_ is the output
(default is US-ASCII). Use ``encoding="unicode"`` to write a Unicode string. encoding (default is US-ASCII).
*xml_declaration* controls if an XML declaration *xml_declaration* controls if an XML declaration should be added to the
should be added to the file. Use False for never, True for always, None file. Use ``False`` for never, ``True`` for always, ``None``
for only if not US-ASCII or UTF-8 or Unicode (default is None). *method* is for only if not US-ASCII or UTF-8 or Unicode (default is ``None``).
either ``"xml"``, ``"html"`` or ``"text"`` (default is ``"xml"``). *method* is either ``"xml"``, ``"html"`` or ``"text"`` (default is
``"xml"``).
The output is either a string (:class:`str`) or binary (:class:`bytes`).
This is controlled by the *encoding* argument. If *encoding* is
``"unicode"``, the output is a string; otherwise, it's binary. Note that
this may conflict with the type of *file* if it's an open
:term:`file object`; make sure you do not try to write a string to a
binary stream and vice versa.
This is the XML file that is going to be manipulated:: This is the XML file that is going to be manipulated::