add typing to aiokafka/record/* #1001
Merged
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
|
Many differences between python and cython implementations. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
There was a problem hiding this comment.
CodeQL found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.
ods
reviewed
Apr 23, 2024
aiokafka/record/_protocols.py
Outdated
There was a problem hiding this comment.
Could you describe the idea with protocols? I'd rather try to avoid them, as they break code navigation
There was a problem hiding this comment.
What alternatives? I did attempt to use Union instead of Protocol (last commit) - it's hard for mypy:
tests/record/test_records.py:70: error: "object" has no attribute "value" [attr-defined]
tests/record/test_records.py:71: error: "object" has no attribute "key" [attr-defined]
tests/record/test_records.py:72: error: "object" has no attribute "timestamp" [attr-defined]
tests/record/test_records.py:73: error: "object" has no attribute "timestamp_type" [attr-defined]
tests/record/test_records.py:74: error: "object" has no attribute "checksum" [attr-defined]
tests/record/test_records.py:75: error: "object" has no attribute "headers" [attr-defined]
tests/record/test_records.py:96: error: "object" has no attribute "value" [attr-defined]
tests/record/test_records.py:97: error: "object" has no attribute "key" [attr-defined]
tests/record/test_records.py:98: error: "object" has no attribute "timestamp" [attr-defined]
tests/record/test_records.py:99: error: "object" has no attribute "timestamp_type" [attr-defined]
tests/record/test_records.py:100: error: "object" has no attribute "checksum" [attr-defined]
tests/record/test_records.py:124: error: "object" has no attribute "value" [attr-defined]
tests/record/test_records.py:125: error: "object" has no attribute "key" [attr-defined]
tests/record/test_records.py:126: error: "object" has no attribute "timestamp" [attr-defined]
tests/record/test_records.py:127: error: "object" has no attribute "timestamp_type" [attr-defined]
tests/record/test_records.py:128: error: "object" has no attribute "checksum" [attr-defined]
tests/record/test_legacy.py:48: error: "object" has no attribute "offset" [attr-defined]
tests/record/test_legacy.py:49: error: "object" has no attribute "timestamp" [attr-defined]
tests/record/test_legacy.py:50: error: "object" has no attribute "timestamp_type" [attr-defined]
tests/record/test_legacy.py:51: error: "object" has no attribute "key" [attr-defined]
tests/record/test_legacy.py:52: error: "object" has no attribute "value" [attr-defined]
tests/record/test_legacy.py:53: error: "object" has no attribute "checksum" [attr-defined]
tests/record/test_legacy.py:91: error: "object" has no attribute "offset" [attr-defined]
tests/record/test_legacy.py:92: error: "object" has no attribute "timestamp" [attr-defined]
tests/record/test_legacy.py:93: error: "object" has no attribute "timestamp_type" [attr-defined]
tests/record/test_legacy.py:94: error: "object" has no attribute "key" [attr-defined]
tests/record/test_legacy.py:95: error: "object" has no attribute "value" [attr-defined]
tests/record/test_legacy.py:96: error: "object" has no attribute "checksum" [attr-defined]
tests/record/test_legacy.py:293: error: "object" has no attribute "offset" [attr-defined]
tests/record/test_legacy.py:294: error: "object" has no attribute "timestamp" [attr-defined]
tests/record/test_legacy.py:295: error: "object" has no attribute "timestamp_type" [attr-defined]
tests/record/test_legacy.py:314: error: "object" has no attribute "offset" [attr-defined]
tests/record/test_legacy.py:315: error: "object" has no attribute "timestamp" [attr-defined]
tests/record/test_legacy.py:316: error: "object" has no attribute "timestamp_type" [attr-defined]
tests/record/test_legacy.py:317: error: "object" has no attribute "key" [attr-defined]
tests/record/test_legacy.py:318: error: "object" has no attribute "value" [attr-defined]
tests/record/test_legacy.py:319: error: "object" has no attribute "checksum" [attr-defined]
tests/record/test_default_records.py:67: error: "object" has no attribute "offset" [attr-defined]
tests/record/test_default_records.py:68: error: "object" has no attribute "timestamp" [attr-defined]
tests/record/test_default_records.py:69: error: "object" has no attribute "key" [attr-defined]
tests/record/test_default_records.py:70: error: "object" has no attribute "value" [attr-defined]
tests/record/test_default_records.py:71: error: "object" has no attribute "headers" [attr-defined]
There was a problem hiding this comment.
Just checked for the first set of errors. Looks like mypy fails to infer type in such a complicated chain. But changing recs = tuple(batch) (which doesn't make sense anyway) to a simple unpack [rec] = batch solves the problem. Not sure this a right way though.
There was a problem hiding this comment.
It's ok for this case but we should use cast in a loop over union type, see python/mypy#8586
This reverts commit 7fa1efa.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1001 +/- ##
==========================================
- Coverage 95.36% 95.04% -0.32%
==========================================
Files 112 114 +2
Lines 16751 16917 +166
Branches 2694 2757 +63
==========================================
+ Hits 15974 16079 +105
- Misses 489 493 +4
- Partials 288 345 +57
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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
Fixes #
Checklist
CHANGESfolder<issue_id>.<type>(e.g.588.bugfix)issue_idchange it to the pr id after creating the PR.feature: Signifying a new feature..bugfix: Signifying a bug fix..doc: Signifying a documentation improvement..removal: Signifying a deprecation or removal of public API..misc: A ticket has been closed, but it is not of interest to users.Fix issue with non-ascii contents in doctest text files.