gh-153357: Add object-oriented MinHeap and MaxHeap classes to heapq

[facundobatista]

Add heapq.MinHeap and heapq.MaxHeap, an object-oriented interface to the existing heapq functions.

Both classes wrap a list and expose the heap operations as methods, so you no longer have to pass the list around to the module-level functions:

>>> from heapq import MinHeap
>>> heap = MinHeap([3, 1, 2])
>>> heap.push(0)
>>> heap.pop()
0
>>> len(heap)
3

The classes provide push, pop, pushpop, replace, nsmallest and nlargest, plus __len__, __bool__ and __repr__. MaxHeap behaves as a max-heap, using the *_max variants under the hood.

The implementation is pure Python and delegates to the C-accelerated module functions, so there is no performance regression.

Includes documentation, a What's New entry and tests.

• Issue: Add MinHeap and MaxHeap classes to heapq (object-oriented interface) #153357

[read-the-docs-community]

Documentation build overview

📚 cpython-previews | 🛠️ Build #33624913 | 📁 Comparing 4d1581a against main (f62050d)

  🔍 Preview build  

3 files changed

± library/datatypes.html
± library/heapq.html
± whatsnew/3.16.html

[picnixz]

I thought we decieed not to do it? the linked issue is also the wrong one

[facundobatista]

@picnixz yes, sorry, I converted the PR to draft; I just proposed it so it serves as reference in the conversation, as some people is pushing for having this.

Also fixed the issue number. Thanks!