Refactor Codec interface #3632
Draft
Refactor Codec interface #3632
+249
−114
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
github-actions
bot
added
the
needs release notes
This refactors the interface of `Codec.read` and `Codec.write` to move from an `Iterable[tuple[...]` to an `Iterable[BatchInfo]`. Two things motivate this change 1. Readability: I struggle to remember what the 4th member of these complex tuples. Having the name `info.out_selection` to remind me is helpful. 2. Possible future-proofing: right now, any change to the interface is a hard break since the number of elements in the tuple will change. There may be a class of changes to the interface where we can add additional information to `BatchInfo` without breaking backwards compatibility. I don't want to oversell motivaiton 2 though. If something is important enough to add to the interface, then presumably we expectd implementations to, you know, use it.
TomAugspurger
force-pushed
the
tom/codec-pipeline-interface
branch
from
a1ceba5 to
5fbad19
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3632 +/- ##
==========================================
- Coverage 60.90% 60.82% -0.08%
==========================================
Files 86 86
Lines 10174 10198 +24
==========================================
+ Hits 6196 6203 +7
- Misses 3978 3995 +17
🚀 New features to boost your workflow:
|
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.
This refactors the interface of
Codec.readandCodec.writeto move from anIterable[tuple[...]to anIterable[BatchInfo].Two things motivate this change
info.out_selectionto remind me is helpful.BatchInfowithout breaking backwards compatibility.I don't want to oversell motivation 2 though. If something is important enough to add to the interface, then presumably we expected implementations to, you know, use it.