Suggest use of "hasattr" with checking for 3.13 Expat API availability

hartwork · Mar 3, 2024 · 28b1c91 · 28b1c91
1 parent 4d3ee77
commit 28b1c91
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/Doc/library/pyexpat.rst b/Doc/library/pyexpat.rst
@@ -217,6 +217,12 @@ XMLParser Objects
    Calling ``SetReparseDeferralEnabled(True)`` allows re-enabling reparse
    deferral.
 
+   Note that :meth:`SetReparseDeferralEnabled` has been backported to prior
+   releases of CPython, so it is recommended to check for availability of
+   :meth:`SetReparseDeferralEnabled` using :func:`hasattr`
+   (rather than inspecting :const:`!pyexpat.version_info`),
+   at runtime.
+
    .. versionadded:: 3.13
 
 .. method:: xmlparser.GetReparseDeferralEnabled()

diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst
@@ -1402,6 +1402,12 @@ XMLParser Objects
       Disabling reparse deferral has security consequences; please see
       :meth:`xml.parsers.expat.xmlparser.SetReparseDeferralEnabled` for details.
 
+      Note that :meth:`flush` has been backported to prior releases of CPython,
+      so it is recommended to check for availability of :meth:`flush`
+      using :func:`hasattr`
+      (rather than inspecting :const:`!pyexpat.version_info`),
+      at runtime.
+
       .. versionadded:: 3.13
 
 
@@ -1475,6 +1481,12 @@ XMLPullParser Objects
       Disabling reparse deferral has security consequences; please see
       :meth:`xml.parsers.expat.xmlparser.SetReparseDeferralEnabled` for details.
 
+      Note that :meth:`flush` has been backported to prior releases of CPython,
+      so it is recommended to check for availability of :meth:`flush`
+      using :func:`hasattr`
+      (rather than inspecting :const:`!pyexpat.version_info`),
+      at runtime.
+
       .. versionadded:: 3.13
 
    .. method:: close()

diff --git a/Misc/NEWS.d/next/Documentation/2024-03-03-17-04-30.gh-issue-115398.FQICYA.rst b/Misc/NEWS.d/next/Documentation/2024-03-03-17-04-30.gh-issue-115398.FQICYA.rst
@@ -0,0 +1,2 @@
+Suggest use of :func:`hasattr` when checking for availability of Expat reparse
+deferral security API.