Describe the default_namespace parameter of ElemetTree.write.

This commit is contained in:
Serhiy Storchaka 2013-01-13 21:57:14 +02:00
parent 8c9047149b
commit 3d4a02ab8c
2 changed files with 7 additions and 4 deletions

View File

@ -767,13 +767,15 @@ ElementTree Objects
root element. root element.
.. method:: write(file, encoding="us-ascii", xml_declaration=None, method="xml") .. method:: write(file, encoding="us-ascii", xml_declaration=None, \
default_namespace=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
file object opened for writing. *encoding* [1]_ is the output encoding file object opened for writing. *encoding* [1]_ is the output encoding
(default is US-ASCII). *xml_declaration* controls if an XML declaration (default is US-ASCII). *xml_declaration* controls if an XML declaration
should be added to the file. Use False for never, True for always, None should be added to the file. Use False for never, True for always, None
for only if not US-ASCII or UTF-8 (default is None). *method* is either for only if not US-ASCII or UTF-8 (default is None). *default_namespace*
sets the default XML namespace (for "xmlns"). *method* is either
``"xml"``, ``"html"`` or ``"text"`` (default is ``"xml"``). Returns an ``"xml"``, ``"html"`` or ``"text"`` (default is ``"xml"``). Returns an
encoded string. encoded string.

View File

@ -779,11 +779,12 @@ class ElementTree(object):
# @param file A file name, or a file object opened for writing. # @param file A file name, or a file object opened for writing.
# @param **options Options, given as keyword arguments. # @param **options Options, given as keyword arguments.
# @keyparam encoding Optional output encoding (default is US-ASCII). # @keyparam encoding Optional output encoding (default is US-ASCII).
# @keyparam method Optional output method ("xml", "html", "text" or
# "c14n"; default is "xml").
# @keyparam xml_declaration Controls if an XML declaration should # @keyparam xml_declaration Controls if an XML declaration should
# be added to the file. Use False for never, True for always, # be added to the file. Use False for never, True for always,
# None for only if not US-ASCII or UTF-8. None is default. # None for only if not US-ASCII or UTF-8. None is default.
# @keyparam default_namespace Sets the default XML namespace (for "xmlns").
# @keyparam method Optional output method ("xml", "html", "text" or
# "c14n"; default is "xml").
def write(self, file_or_filename, def write(self, file_or_filename,
# keyword arguments # keyword arguments