summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorShantanu <hauntsaninja@users.noreply.github.com>2020-06-08 14:11:44 (GMT)
committerGitHub <noreply@github.com>2020-06-08 14:11:44 (GMT)
commit301f0d4ff9b6bd60599eea0612904f65a92e6dd9 (patch)
tree10017d7998202152bbf417edea69eda661376558
parent63fc55b2eab0331465605a49bfd28a1bcb997f92 (diff)
downloadcpython-301f0d4ff9b6bd60599eea0612904f65a92e6dd9.zip
cpython-301f0d4ff9b6bd60599eea0612904f65a92e6dd9.tar.gz
cpython-301f0d4ff9b6bd60599eea0612904f65a92e6dd9.tar.bz2
bpo-33187: Document 3.9 changes to xml.etree.ElementInclude.include (GH-20438)
Looks like the merging of bpo-33187 and bpo-20928 was racy, resulting in this change going undocumented.
-rw-r--r--Doc/library/xml.etree.elementtree.rst13
1 files changed, 11 insertions, 2 deletions
diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst
index 658bc3a..2085a85 100644
--- a/Doc/library/xml.etree.elementtree.rst
+++ b/Doc/library/xml.etree.elementtree.rst
@@ -816,16 +816,25 @@ Functions
loader fails, it can return None or raise an exception.
-.. function:: xml.etree.ElementInclude.include( elem, loader=None)
+.. function:: xml.etree.ElementInclude.include( elem, loader=None, base_url=None, \
+ max_depth=6)
This function expands XInclude directives. *elem* is the root element. *loader* is
an optional resource loader. If omitted, it defaults to :func:`default_loader`.
If given, it should be a callable that implements the same interface as
- :func:`default_loader`. Returns the expanded resource. If the parse mode is
+ :func:`default_loader`. *base_url* is base URL of the original file, to resolve
+ relative include file references. *max_depth* is the maximum number of recursive
+ inclusions. Limited to reduce the risk of malicious content explosion. Pass a
+ negative value to disable the limitation.
+
+ Returns the expanded resource. If the parse mode is
``"xml"``, this is an ElementTree instance. If the parse mode is "text",
this is a Unicode string. If the loader fails, it can return None or
raise an exception.
+ .. versionadded:: 3.9
+ The *base_url* and *max_depth* parameters.
+
.. _elementtree-element-objects: