feat: add name parameter to Retrying for meaningful log output#597
Merged
mergify[bot] merged 1 commit intomainfrom Feb 20, 2026
Conversation
When using `Retrying` or `AsyncRetrying` as a context manager, log
callbacks showed '<unknown>' as the function name since no `fn` is
set. A new `name` parameter allows users to provide a meaningful
identifier:
for attempt in Retrying(name='ws_listener', before_sleep=before_sleep_log(...)):
with attempt:
...
`RetryCallState.get_fn_name()` is introduced as the single source of
truth for resolving the display name: it returns the decorated
function's qualified name when used as a decorator, falls back to
`str(retry_object)` in context manager mode. `BaseRetrying.__str__`
returns `name` if set, else '<unknown>'. The three log helpers
(before_log, after_log, before_sleep_log) all use `get_fn_name()`
instead of the repeated `fn is None` boilerplate.
Closes #273, closes #333
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Change-Id: I717d4d3977028b499612cecb567d0ebc49b5f539
jd
force-pushed
the
devs/jd/feat/retrying-name/I717d4d3977028b499612cecb567d0ebc49b5f539
branch
from
ff377e7 to
31ffdea
Compare
mergify
Bot
deleted the
devs/jd/feat/retrying-name/I717d4d3977028b499612cecb567d0ebc49b5f539
branch
Contributor
Merge Queue StatusRule:
This pull request spent 28 seconds in the queue, including 4 seconds running CI. Required conditions to merge |
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.
When using
RetryingorAsyncRetryingas a context manager, logcallbacks showed '' as the function name since no
fnisset. A new
nameparameter allows users to provide a meaningfulidentifier:
RetryCallState.get_fn_name()is introduced as the single source oftruth for resolving the display name: it returns the decorated
function's qualified name when used as a decorator, falls back to
str(retry_object)in context manager mode.BaseRetrying.__str__returns
nameif set, else ''. The three log helpers(before_log, after_log, before_sleep_log) all use
get_fn_name()instead of the repeated
fn is Noneboilerplate.Closes #273, closes #333
Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com