docs: Python sync client zero-copy buffers for mget - #288
Open
Aryex wants to merge 1 commit into
Open
Conversation
Aryex
added
AI Generated
documentation
Aryex
force-pushed
the
alexl/agent/python-mget-zero-copy-buffers
branch
from
July 26, 2026 21:27
6c61b11 to
e60a6fe
Compare
Aryex
force-pushed
the
alexl/agent/python-mget-zero-copy-buffers
branch
from
July 27, 2026 14:47
e60a6fe to
d38be75
Compare
Aryex
marked this pull request as ready for review
July 27, 2026 14:47
xShinnRyuu
force-pushed
the
alexl/agent/python-mget-zero-copy-buffers
branch
2 times, most recently
from
July 29, 2026 18:27
9f0a15b to
d38be75
Compare
xShinnRyuu
approved these changes
Jul 29, 2026
Add a Zero-Copy Buffers section to the Synchronous Client how-to page covering the buffers parameter on mget() and the sibling buffer parameter on get(). Documents both patterns with complete examples, describes the byte-count return semantics, lists buffer requirements (writable memoryview, C-contiguous, correct length), and covers the error cases (RequestError for oversized values, ValueError for length mismatch, TypeError for invalid buffers). Includes a complete mset/mget workflow example and a retry-on-overflow error handling snippet. Signed-off-by: Thomas Zhou <thomaszhou64@gmail.com>
xShinnRyuu
force-pushed
the
alexl/agent/python-mget-zero-copy-buffers
branch
from
July 29, 2026 21:55
ddbf2bb to
70c5a04
Compare
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 free
to 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.
Summary
Document the new
buffersparameter on the Python sync client'smget()method, which enables zero-copy reads directly into caller-owned buffers.Source Commits
e2c088d— feat(python-sync): add zero-copy buffers to mget (#6367)Changes
how-to/synchronous-connection.mdx)get(key, buffer=...)and multi-keymget(keys, buffers=...)patternsContext
PR #6367 adds an optional
buffersargument to the sync Python client'smgetso values are read straight into caller-owned buffers with no intermediate allocation. This is a performance optimization for large multi-key reads (KV-cache blobs, embeddings). The feature is sync-client only and opt-in — existingmget(keys)behavior is unchanged.cc @ksmotiv8
This PR was generated by the automated documentation pipeline.