weakref: Add basic stub function to aid in porting. #529
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dpgeorge
reviewed
May 24, 2024
python-stdlib/weakref/weakref.py
Outdated
| The weakref module allows the Python programmer to create weak references to objects. | ||
| In the following, the term referent means the object which is referred to by a weak reference. | ||
| A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it. | ||
| A primary use for weak references is to implement caches or mappings holding large objects, where it’s desired that a large object not be kept alive solely because it appears in a cache or mapping. |
There was a problem hiding this comment.
Is this copied from CPython? If so I think just remove it, keep only the link to CPython's weakref docs, and the paragraph below about lack of support in MicroPython.
There was a problem hiding this comment.
Yes this text was just from the linked doc, so isn't adding much value. I've removed it now thanks
Signed-off-by: Andrew Leech <andrew@alelec.net>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This just allows most basic usages of weakref in other modules to "work" unless they test for actual cleanup via gc.collect etc.
Docs: https://docs.python.org/3/library/weakref.html#weakref.ref