Uh oh!
There was an error while loading. Please reload this page.
feat: return a useful value from CodecPipeline.read() - #3828
Merged
Conversation
This type is a typeddict that stores information about a completed attempt to fetch a stored resource, e.g. a chunk. Currently, `GetResult` only stores whether the resource was present or missing. We can add more capacity to this type in the future.
maxrjones
approved these changes
Mar 25, 2026
Uh oh!
There was an error while loading. Please reload this page.
This was referenced Jul 17, 2026
Closed
Closed
Closed
Closed
Closed
Closed
Closed
This was referenced Jul 24, 2026
Closed
Closed
Closed
Closed
This was referenced Jul 27, 2026
Closed
Closed
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
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 PR adds
GetResult, aTypedDict, tozarr.abc.codec.GetResulthas 1 field:status, which can be either"present"or"missing".CodecPipeline.readreturn a tuple ofGetResultobjects, one per chunk.In its current form, this allows a caller of
CodecPipeline.read()to know which chunks where present, and which were missing, which will be useful for #3748, where this idea emerged. More broadly, returning useful information about IO is something we should do more, which is whyGetResultis a simple, extensibleTypedDictclass which we can build on later.