Benedikts Suggestions

Author: StanFromIreland

Doc/library/heapq.rst

@@ -84,7 +84,7 @@ The following functions are provided:
    on the heap.
 
 
-For max-heaps, the reverse of a heap, the following functions are provided:
+For max-heaps, the following functions are provided:
 
 
 .. function:: heapify_max(x)
@@ -103,7 +103,7 @@ For max-heaps, the reverse of a heap, the following functions are provided:
 
 .. function:: heappop_max(heap)
 
-   Pop and return the largest item from the max-*heap*, maintaining the heap
+   Pop and return the largest item from the max-heap *heap*, maintaining the heap
    invariant.  If the max-heap is empty, :exc:`IndexError` is raised.  To access the
    largest item without popping it, use ``heap[0]``.
 
@@ -112,7 +112,7 @@ For max-heaps, the reverse of a heap, the following functions are provided:
 
 .. function:: heappushpop_max(heap, item)
 
-   Push *item* on the max-heap, then pop and return the largest item from *heap*.
+   Push *item* on the max-heap *heap*, then pop and return the largest item from *heap*.
    The combined action runs more efficiently than :func:`heappush_max`
    followed by a separate call to :func:`heappop_max`.
 

Doc/whatsnew/3.14.rst

@@ -563,6 +563,23 @@ getopt
 * Add support for returning intermixed options and non-option arguments in order.
   (Contributed by Serhiy Storchaka in :gh:`126390`.)
 
+
+heapq
+-----
+
+* Make :mod:`heapq` max-heap functions
+
+  * :func:`heapify_max`,
+  * :func:`heappush_max`,
+  * :func:`heappop_max`,
+  * :func:`heapreplace_max`
+
+  public. And add the missing :func:`heappushpop_max` to
+  both the C and Python implementation.
+
+  Previous underscored naming is kept for backwards compatibility.
+
+
 http
 ----
 

Lib/test/test_heapq.py

@@ -69,10 +69,11 @@ def test_push_pop(self):
 
         self.assertRaises(TypeError, self.module.heappush, [])
 
-        exc_types = (AttributeError, TypeError)
-        self.assertRaises(exc_types, self.module.heappush, None, None)
-        self.assertRaises(exc_types, self.module.heappop, None)
-
+        try:
+            self.assertRaises(TypeError, self.module.heappush, None, None)
+            self.assertRaises(TypeError, self.module.heappop, None)
+        except AttributeError:
+            pass
 
     def test_max_push_pop(self):
         # 1) Push 256 random numbers and pop them off, verifying all's OK.
@@ -97,11 +98,10 @@ def test_max_push_pop(self):
         self.check_max_invariant(results)
 
         self.assertRaises(TypeError, self.module.heappush_max, [])
-        try:
-            self.assertRaises(TypeError, self.module.heappush_max, None, None)
-            self.assertRaises(TypeError, self.module.heappop_max, None)
-        except AttributeError:
-            pass
+
+        exc_types = (AttributeError, TypeError)
+        self.assertRaises(exc_types, self.module.heappush_max, None, None)
+        self.assertRaises(exc_types, self.module.heappop_max, None)
 
     def check_invariant(self, heap):
         # Check the heap invariant.

Misc/NEWS.d/next/Library/2025-03-01-15-00-00.gh-issue-110067.1ad3as.rst

@@ -1 +1,11 @@
-Make max heap functions public.
+Make :mod:`heapq` max-heap functions
+
+* :func:`heapify_max`,
+* :func:`heappush_max`,
+* :func:`heappop_max`,
+* :func:`heapreplace_max`
+
+public. And add the missing :func:`heappushpop_max` to
+both the C and Python implementation.
+
+Previous underscored naming is kept for backwards compatibility.