ref(taskbroker): Clarify docstring & class name #103893
Merged
Conversation
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
Changes included: * A Markdown table is added to the docstring describing how to call the `retry` decorator. * It renames `RetryError` to `RetryTaskError` to help search the codebase.
github-actions
bot
added
the
Scope: Backend
![sentry[bot]](https://avatars.githubusercontent.com/u/1396951?s=60&v=4){kind=small}
armenzg
commented
Nov 24, 2025
| The first set of parameters define how different exceptions are handled. | ||
| Raising an error will still report a Sentry event. | ||
| | Parameter | Retry | Report | Raise | Description | |
Member
Author
There was a problem hiding this comment.
As reference, this renders like this within my IDE:
| @functools.wraps(func) | ||
| def wrapped(*args, **kwargs): | ||
| task_state = current_task() | ||
| no_retries_remaining = task_state and not task_state.retries_remaining |
Member
Author
There was a problem hiding this comment.
Putting these variables here is to simplify a follow-up PR I have.
| from sentry.taskworker.constants import CompressionType | ||
| from sentry.taskworker.registry import TaskNamespace | ||
| from sentry.taskworker.retry import Retry, RetryError, retry_task | ||
| from sentry.taskworker.retry import Retry, RetryTaskError, retry_task |
Member
Author
There was a problem hiding this comment.
Renaming the variable name makes it easier to search for this.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
❌ 1 Tests Failed:
View the top 1 failed test(s) by shortest run time
To view more test analytics, go to the Test Analytics Dashboard |
armenzg
commented
Nov 24, 2025
armenzg
commented
Nov 24, 2025
Member
Author
There was a problem hiding this comment.
From here on, there's only renaming of the variable across the codebase.
markstory
approved these changes
Nov 24, 2025
Member
markstory
left a comment
markstory
left a comment
There was a problem hiding this comment.
Looks good. I'm not sure that going back to stack grouping for retry errors is the right choice though.
Member
Author
I have addressed your feedback and I'm retracting it. |
markstory
approved these changes
Nov 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes included:
retrydecorator.RetryErrortoRetryTaskErrorto help search the codebase.