refactor: reorganize message handling for better type safety and clarity #239
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
dsp-ant
force-pushed
the
davidsp/raw-request
branch
from
2e3388b to
0d651d5
Compare
dsp-ant
requested review from
jerome3o-anthropic,
jspahrsummers and
bhosmer-ant
and removed request for
jerome3o-anthropic
bhosmer-ant
previously approved these changes
Mar 4, 2025
| RawT = TypeVar("RawT") | ||
|
|
||
|
|
||
| class MessageFrame(BaseModel, Generic[RawT]): |
There was a problem hiding this comment.
Don't know how fastidious we are about this in general, but fwiw the other classes here are docstringed up pretty thoroughly (and the point of raw in particular might be worth noting here)
Move memory stream type definitions to models.py and use them throughout the codebase for better type safety and maintainability. GitHub-Issue:#201
Updates test files to work with the ParsedMessage stream type aliases and fixes a line length issue in test_201_client_hangs_on_logging.py. Github-Issue:#201
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
…ation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Modified the websocket client to work with the new MessageFrame type, preserving raw message text and properly extracting the root JSON-RPC message when sending. Github-Issue:#204
🤖 Generated with [Claude Code](https://claude.ai/code)
dsp-ant
force-pushed
the
davidsp/raw-request
branch
from
1d57efa to
1c53fc2
Compare
|
This broke a lot types 😢 |
Kludex
reviewed
Mar 14, 2025
Comment on lines
+32
to
+35
| ReadStream = MemoryObjectReceiveStream[MessageFrame | Exception] | ||
| ReadStreamWriter = MemoryObjectSendStream[MessageFrame | Exception] | ||
| WriteStream = MemoryObjectSendStream[MessageFrame] | ||
| WriteStreamReader = MemoryObjectReceiveStream[MessageFrame] |
There was a problem hiding this comment.
You can't do this if MessageFrame is a generic. It means that all those new types have unkown parameters to the generic type.
Kludex
reviewed
Mar 14, 2025
Comment on lines
+211
to
+223
| def model_dump(self, *args, **kwargs): | ||
| """ | ||
| Dumps the model to a dictionary, delegating to the root JSONRPCMessage. | ||
| This method allows for consistent serialization of the parsed message. | ||
| """ | ||
| return self.message.model_dump(*args, **kwargs) | ||
|
|
||
| def model_dump_json(self, *args, **kwargs): | ||
| """ | ||
| Dumps the model to a JSON string, delegating to the root JSONRPCMessage. | ||
| This method provides a convenient way to serialize the parsed message to JSON. | ||
| """ | ||
| return self.message.model_dump_json(*args, **kwargs) |
There was a problem hiding this comment.
This is not type safe. You are hiding the parameters with args and kwargs.
|
What's this |
This was referenced Mar 14, 2025
Kludex
reviewed
Mar 14, 2025
| read_stream: MemoryObjectReceiveStream[types.JSONRPCMessage | Exception], | ||
| write_stream: MemoryObjectSendStream[types.JSONRPCMessage], | ||
| read_stream: ReadStream, | ||
| write_stream: WriteStream, |
There was a problem hiding this comment.
This is not really the end type, since ReadStream and WriteStream are generics, something is missing here.
I believe it's easier to understand the code if we don't hide that those streams are anyio objects. Makes it easier to go around the code.
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.
Summary
Test plan
GitHub-Issue:#201