Skip to content

gh-107421: Clarify OrderedDict Examples and Recipes #107613

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

Merged
merged 11 commits into from
Aug 11, 2023
Merged

gh-107421: Clarify OrderedDict Examples and Recipes #107613

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
affd885
Use explicit `last=False` argument for `.popitem` method
shailshouryya Aug 4, 2023
2c24cbc
Remove unnecessary default argument for `self.requests.pop` call in `…
shailshouryya Aug 4, 2023
e2232f1
Add comments to `__call__` method `MultiHitLRUCache` for clarity
shailshouryya Aug 4, 2023
ff22bac
Maintain invariant of `maxsize` items in `cache` attribute in `MultiH…
shailshouryya Aug 4, 2023
ecbb79a
Remove comments that restate what the code does
shailshouryya Aug 4, 2023
77f10b2
Move useful comment to separate lines before the relevant code
shailshouryya Aug 4, 2023
a03483d
Keep `pop(args, None)` for simplicity in multi-threaded environments
shailshouryya Aug 4, 2023
26f9f90
Revert "Maintain invariant of `maxsize` items in `cache` attribute in…
shailshouryya Aug 4, 2023
12a42e5
Remove backticks from code comment to avoid linter error
shailshouryya Aug 4, 2023
9d2e3c1
Remove backticks from other code comment to avoid linter error
shailshouryya Aug 4, 2023
aae218b
Remove all comments
shailshouryya Aug 10, 2023
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
6 changes: 3 additions & 3 deletions Doc/library/collections.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1224,7 +1224,7 @@ variants of :func:`functools.lru_cache`:
result = self.func(*args)
self.cache[args] = time(), result
if len(self.cache) > self.maxsize:
self.cache.popitem(0)
self.cache.popitem(last=False)
return result


Expand Down Expand Up @@ -1256,12 +1256,12 @@ variants of :func:`functools.lru_cache`:
if self.requests[args] <= self.cache_after:
self.requests.move_to_end(args)
if len(self.requests) > self.maxrequests:
self.requests.popitem(0)
self.requests.popitem(last=False)
else:
self.requests.pop(args, None)
self.cache[args] = result
if len(self.cache) > self.maxsize:
self.cache.popitem(0)
self.cache.popitem(last=False)
return result

.. doctest::
Expand Down