Skip to content

bpo-44310: added docs to functools to warn for memory leaks #26528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wouterdb wants to merge 2 commits into from
Closed

bpo-44310: added docs to functools to warn for memory leaks #26528

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2bc0e0
added docs to functools
wouterdb Jun 4, 2021
2f5f006
Update Doc/library/functools.rst
pablogsal Jun 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Doc/library/functools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,11 @@ The :mod:`functools` module defines the following functions:
functions with side-effects, functions that need to create distinct mutable
objects on each call, or impure functions such as time() or random().

The LRU cache takes string references to the arguments provided in the decorated callable
Copy link
Author

@wouterdb wouterdb Jun 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The LRU cache takes string references to the arguments provided in the decorated callable
The LRU cache takes strong references to the arguments provided in the decorated callable

as well as the return value. Notice that this means that if a class method is decorated, the cache
will keep strong references to all arguments provided, including the instance itself (provided as the
Copy link
Author

@wouterdb wouterdb Jun 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
will keep strong references to all arguments provided, including the instance itself (provided as the
will keep strong references to all arguments provided, including the instance itself (provided as first the

argument of the method, normally called ``self``). This has the consequence that calling the cached
method will keep the instances alive until they are discarded by the cache or manually removed.
Example of an LRU cache for static web content::

@lru_cache(maxsize=32)
Expand Down