docs: add memory benefit and variable-reuse note to collect() section#1173
Open
k1chik wants to merge 2 commits intoprometheus:masterfrom
Open
docs: add memory benefit and variable-reuse note to collect() section#1173k1chik wants to merge 2 commits intoprometheus:masterfrom
k1chik wants to merge 2 commits intoprometheus:masterfrom
Conversation
Contributor
Author
|
Closing to reopen with a proper description. |
Addresses follow-up feedback on prometheus#1169 from @calestyo: the existing yield explanation mentioned lazy iteration but omitted memory as a secondary benefit and gave no guidance on variable reuse for GC efficiency. Added a paragraph explaining that yielding inline lets Python reclaim the object as soon as the registry advances, while a named variable stays alive until rebound. Also added a short loop example showing how reusing the same variable name across iterations gives the GC the opportunity to reclaim each object before the next is allocated. Signed-off-by: k1chik <107162115+k1chik@users.noreply.github.com>
Signed-off-by: k1chik <107162115+k1chik@users.noreply.github.com>
k1chik
force-pushed
the
fix/yield-explanation-custom-collector
branch
from
4667a37 to
387e948
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes points made from comment section in #1169.
Changes
is a secondary benefit of using `yield`: yielding inline lets Python
reclaim the object as soon as the registry advances, while a named variable
stays alive until it is rebound.
accumulating into a list keeps at most one object alive at a time.
cc @calestyo @csmarchbanks