Provide annotations for kombu/utils/encoding.py
#2208
+43
−13
Conversation
This file contains 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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2208 +/- ##
==========================================
- Coverage 81.54% 81.52% -0.03%
==========================================
Files 77 77
Lines 9517 9527 +10
Branches 1154 1158 +4
==========================================
+ Hits 7761 7767 +6
Misses 1564 1564
- Partials 192 196 +4 ☔ View full report in Codecov by Sentry. |
The initial annotations provided aim to annotate the current implementation opposed to potentially refactoring to narrow down the original intention of the provided implementations.
for more information, see https://pre-commit.ci
Nusnus
force-pushed
the
annotate-utils-encoding
branch
from
4f51694 to
2a911cd
Compare
Nusnus
reviewed
Feb 19, 2025
| def _safe_str( | ||
| s: object, | ||
| errors: str = 'replace', | ||
| file: Any = None |
There was a problem hiding this comment.
Some places say Any and some object.
Is there any specific reason for not using the same annotation all over?
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.
Linked Issue: #1511
For this PR, I aimed to annotate the existing implementation of the encoding functions, regardless of what I thought the function's intention is.
There are some functions e.g.
str_to_bytes,bytes_to_str, orsafe_strwhich I think may have potentially misleading implementations. I'm not sure whether this is under the scope of this PR, input on this would be appreciated :).