Skip to content

Docs: Qualify the lru_cache scalar example with typed=True #158424

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

Open
esadomer wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: Qualify the lru_cache scalar example with typed=True #158424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions Doc/library/functools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,12 @@ The :mod:`!functools` module defines the following functions:
types such as *str* and *int* may be cached separately even when *typed*
is false.)

Note, type specificity applies only to the function's immediate arguments
rather than their contents. The scalar arguments, ``Decimal(42)`` and
``Fraction(42)`` are treated as distinct calls with distinct results.
In contrast, the tuple arguments ``('answer', Decimal(42))`` and
``('answer', Fraction(42))`` are treated as equivalent.
If *typed* is true, type specificity applies only to the function's
immediate arguments rather than their contents. The scalar arguments,
``Decimal(42)`` and ``Fraction(42)`` are treated as distinct calls with
distinct results. In contrast, the tuple arguments
``('answer', Decimal(42))`` and ``('answer', Fraction(42))`` are treated
as equivalent.

The wrapped function is instrumented with a :func:`!cache_parameters`
function that returns a new :class:`dict` showing the values for *maxsize*
Expand Down
Loading