From 9bd2c4eb38e9f0fdb0bdb384b4512d89f6730377 Mon Sep 17 00:00:00 2001 From: Tomas R Date: Mon, 17 Feb 2025 16:48:29 +0100 Subject: [PATCH] gh-125756: Document Pickler.clear_memo() (GH-125762) (cherry picked from commit 25422561de40075bd10c37b182a0d60008809770) Co-authored-by: Tomas R. --- Doc/library/pickle.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst index 57fbe5b6ece6b6..1c8eecd28f5fea 100644 --- a/Doc/library/pickle.rst +++ b/Doc/library/pickle.rst @@ -394,6 +394,15 @@ The :mod:`pickle` module exports three classes, :class:`Pickler`, Use :func:`pickletools.optimize` if you need more compact pickles. + .. method:: clear_memo() + + Clears the pickler's "memo". + + The memo is the data structure that remembers which objects the + pickler has already seen, so that shared or recursive objects + are pickled by reference and not by value. This method is + useful when re-using picklers. + .. class:: Unpickler(file, *, fix_imports=True, encoding="ASCII", errors="strict", buffers=None)