-
-
Notifications
You must be signed in to change notification settings - Fork 757
Truncate large coro repr in retry log output #9197
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.
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
base: main
Are you sure you want to change the base?
Changes from 2 commits
30ddcdc
5cb36b3
82cefd0
40472e5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -229,6 +229,53 @@ async def f(): | |
| assert sleep_calls == [0.0, 1.0, 3.0, 6.0, 6.0] | ||
|
|
||
|
|
||
| def test_retry_truncates_large_coro_repr(cleanup): | ||
| """Test that retry truncates excessively large string representations of coro.""" | ||
|
|
||
| class MyEx(Exception): | ||
| pass | ||
|
|
||
| class LargeReprCallable: | ||
| def __repr__(self): | ||
| return "x" * 500 | ||
|
|
||
| async def __call__(self): | ||
| raise MyEx("fail") | ||
|
|
||
| log_messages = [] | ||
|
|
||
| async def f(): | ||
| return await retry( | ||
| LargeReprCallable(), | ||
| retry_on_exceptions=(MyEx,), | ||
| count=1, | ||
| delay_min=0, | ||
| delay_max=0, | ||
| jitter_fraction=0, | ||
| ) | ||
|
|
||
| import logging | ||
|
|
||
| handler = logging.Handler() | ||
| handler.emit = lambda record: log_messages.append(record.getMessage()) | ||
|
|
||
| logger = logging.getLogger("distributed.utils_comm") | ||
| logger.addHandler(handler) | ||
| try: | ||
| with pytest.raises(MyEx): | ||
| asyncio_run(f(), loop_factory=get_loop_factory()) | ||
| finally: | ||
| logger.removeHandler(handler) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you just use
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yep, switched to caplog — much cleaner. |
||
|
|
||
| assert len(log_messages) == 1 | ||
| # reprlib truncates the 500-char repr to maxother (200) chars | ||
| assert len(log_messages[0]) < 500 | ||
| # reprlib uses "..." to indicate truncation | ||
| assert "..." in log_messages[0] | ||
| # Verify the full 500-char repr is NOT present | ||
| assert "x" * 500 not in log_messages[0] | ||
|
|
||
|
|
||
| def test_unpack_remotedata(): | ||
| def assert_eq(keys1: set[TaskRef], keys2: set[TaskRef]) -> None: | ||
| if len(keys1) != len(keys2): | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -3,6 +3,7 @@ | |||||||||
| import asyncio | ||||||||||
| import logging | ||||||||||
| import random | ||||||||||
| import reprlib | ||||||||||
| from collections import defaultdict | ||||||||||
| from collections.abc import Callable, Collection, Coroutine, Mapping | ||||||||||
| from functools import partial | ||||||||||
|
|
@@ -384,7 +385,10 @@ async def retry( | |||||||||
| try: | ||||||||||
| return await coro() | ||||||||||
| except retry_on_exceptions as ex: | ||||||||||
| operation = operation or str(coro) | ||||||||||
| if not operation: | ||||||||||
| aRepr = reprlib.Repr() | ||||||||||
| aRepr.maxother = 200 | ||||||||||
| operation = aRepr.repr(coro) | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's clean this up into a simple one-liner.
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done — condensed to a one-liner.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. turns out Repr() doesnt accept kwargs per mypy, maxother is an instance attribute. switched to a two-liner that sets it after init. |
||||||||||
| logger.info( | ||||||||||
| f"Retrying {operation} after exception in attempt {i_try}/{count}: {ex}" | ||||||||||
| ) | ||||||||||
|
|
||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you move imports to the top of the file. Claude loves importing stuff randomly in the middle of code for some reason.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
moved to the top, good catch.