Update documentation now that canonicalize() supports file paths as i…

…nput.
python · scoder · May 1, 2019 · Apr 20, 2019 · Apr 20, 2019 · Apr 20, 2019
commit a94b07d7d13a3591c5482451533c28ee4672cb95
diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst
@@ -475,11 +475,12 @@ Functions
    representation.  The main restrictions regard the placement of namespace
    declarations, the ordering of attributes, and ignorable whitespace.
 
-   This function takes an XML data string (*xml_data*) or a file-like object
-   (*from_file*) as input, converts it to the canonical form, and writes it
-   out using the *out* file(-like) object, if provided, or returns it as a
-   text string if not.  The output file receives text, not bytes.  It should
-   therefore be opened in text mode with ``utf-8`` encoding.
+   This function takes an XML data string (*xml_data*) or a file path or
+   file-like object (*from_file*) as input, converts it to the canonical
+   form, and writes it out using the *out* file(-like) object, if provided,
+   or returns it as a text string if not.  The output file receives text,
+   not bytes.  It should therefore be opened in text mode with ``utf-8``
+   encoding.
 
    Typical uses::
 
@@ -489,6 +490,9 @@ Functions
       with open("c14n_output.xml", mode='w', encoding='utf-8') as out_file:
           canonicalize(xml_data, out=out_file)
 
+      with open("c14n_output.xml", mode='w', encoding='utf-8') as out_file:
+          canonicalize(from_file="inputfile.xml", out=out_file)
+
    The configuration *options* are as follows:
 
    - *with_comments*: set to true to include comments (default: false)

diff --git a/Lib/xml/etree/ElementTree.py b/Lib/xml/etree/ElementTree.py
@@ -1723,8 +1723,8 @@ def canonicalize(xml_data=None, *, out=None, from_file=None, **options):
     method.  To write to a file, open it in text mode with encoding "utf-8".
     If *out* is not provided, this function returns the output as text string.
 
-    Either *xml_data* (an XML string) or *from_file* (a file-like object)
-    must be provided as input.
+    Either *xml_data* (an XML string) or *from_file* (a file path or
+    file-like object) must be provided as input.
 
     The configuration options are the same as for the ``C14NWriterTarget``.
     """