-
Notifications
You must be signed in to change notification settings - Fork 3.2k
chore: enforce type annotations on all functions via ruff ANN rules #2339
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
maxisbey
wants to merge
5
commits into
main
Choose a base branch
from
enforce-type-annotations
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
5697d68
chore: enforce type annotations on all functions via ruff ANN rules
maxisbey 8b7399c
chore: use AsyncIterator for lifespan annotations, sync README snippets
maxisbey cfde91d
chore: exempt tests from ANN, enable mypy-init-return
maxisbey 91a983f
chore: ignore ANN204 to allow __init__ without return type
maxisbey a9cf2fa
test: ignore ANN in README code example linting
maxisbey File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟣 Pre-existing:
from typing import Self(line 18) causesImportErroron Python 3.10, butpyproject.tomlrequires>=3.10.typing.Selfwas added in Python 3.11. This PR adds a new-> Selfreturn annotation onfrom_content(), deepening the dependency on the broken import. Fix: importSelffromtyping_extensionsinstead, matching the pattern used in SDK source (e.g.,src/mcp/shared/session.py).Extended reasoning...
What the bug is
The example file
examples/mcpserver/memory.pyimportsSelffromtypingon line 18:However,
typing.Selfwas only introduced in Python 3.11 (PEP 673). The project declaresrequires-python = ">=3.10"inpyproject.toml, meaning this file will raiseImportErrorwhen run on Python 3.10.The specific code path
Any attempt to import or run
examples/mcpserver/memory.pyon Python 3.10 will fail immediately at line 18 with:Selfis used in two places in the file: as a parameter type annotation inmerge_with(self, other: Self, deps: Deps)(line 132), and as a return type annotation infrom_content(cls, content: str, deps: Deps) -> Self(line 93). Themerge_withusage existed before this PR; the-> Selfreturn annotation onfrom_content()was added by this PR.Why existing code doesn't prevent it
The SDK source files correctly import
Selffromtyping_extensions(e.g.,src/mcp/shared/session.py:12andsrc/mcp/client/session_group.py:19), which backportsSelfto Python 3.10+. However, this example file does not follow the same pattern. Since this is a standalone example with PEP 723 script dependencies (not part of the pyright include paths), it was not caught by type checking.Step-by-step proof
pyproject.tomlline 6:requires-python = ">=3.10"— the project supports Python 3.10.examples/mcpserver/memory.pyline 18:from typing import Annotated, Self, TypeVar— importsSelffromtyping.typingmodule does not exportSelf(added in 3.11).python3.10 examples/mcpserver/memory.pyproducesImportError: cannot import name 'Self' from 'typing'.async def from_content(cls, content: str, deps: Deps):toasync def from_content(cls, content: str, deps: Deps) -> Self:, adding a new usage of the broken import.Impact
This is an example file, not part of the SDK's core library. The practical impact is limited — users running this example on Python 3.10 would hit an immediate import error. The example also has heavy external dependencies (pydantic-ai, asyncpg, numpy, pgvector) that may themselves require Python 3.11+. Nevertheless, the fix is trivial and would bring the example in line with SDK conventions.
Fix
Change the import on line 18 from:
to:
This matches the pattern used throughout the SDK source code.