docs: note TypedDict runtime dict behavior in types.py#664
Open
kvr06-ai wants to merge 1 commit intoanthropics:mainfrom
Open
docs: note TypedDict runtime dict behavior in types.py#664kvr06-ai wants to merge 1 commit intoanthropics:mainfrom
kvr06-ai wants to merge 1 commit intoanthropics:mainfrom
Conversation
TypedDict instances are plain dicts at runtime, but the existing docstrings don't warn about this. Adds a module-level note and per-class reminders to prevent AttributeError from dot-access.
Author
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
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.
Summary
Fixes #623
TypedDict classes in
types.pyare plaindictobjects at runtime, but this wasn't documented. Since the same file mixes@dataclassandTypedDict, users (and LLMs writing integration code) naturally tryconfig.budget_tokensinstead ofconfig["budget_tokens"]and hitAttributeError.This PR adds:
ThinkingConfig*,McpStdioServerConfig,McpSSEServerConfig,McpHttpServerConfig,SandboxNetworkConfig,SandboxSettings,AsyncHookJSONOutput,SyncHookJSONOutput)Changes
src/claude_agent_sdk/types.py: Expanded module docstring, added/updated docstrings on 10 TypedDict classesTesting
ruff checkpasses.