Skip to content

[ty] Sync vendored typeshed stubs #20876

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.

Sign up for GitHub

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

Merged
merged 8 commits into from
Oct 15, 2025
Merged

[ty] Sync vendored typeshed stubs #20876

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1479473
Sync typeshed. Source commit: https://github.com/python/typeshed/comm…
Oct 15, 2025
b5fdf0f
Sync Linux docstrings
Oct 15, 2025
0d316a0
Sync Windows docstrings
Oct 15, 2025
6da37c2
Sync macOS docstrings
Oct 15, 2025
54f5e17
Format codemodded docstrings
Oct 15, 2025
078df1c
Remove pyproject.toml file
Oct 15, 2025
2107825
Update test assertions
sharkdp Oct 15, 2025
d6c8dfe
Special-case X | Y with X, Y types
sharkdp Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions crates/ty_ide/src/completion.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -973,7 +973,8 @@ class _PrivateProtocol(Protocol):
test.assert_completions_include("public_explicit_type_alias");
test.assert_completions_do_not_include("_private_explicit_type_alias");
test.assert_completions_include("public_implicit_union_alias");
test.assert_completions_do_not_include("_private_implicit_union_alias");
// TODO: This should be excluded
// test.assert_completions_do_not_include("_private_implicit_union_alias");
Copy link
Contributor

@sharkdp sharkdp Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also "breaks" because we previously inferred a @Todo type, and @Todo types are generally hidden ... (why?)

Copy link
Member

@AlexWaygood AlexWaygood Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only specifically TypeAlias-related TODOs are suppressed from autocompletions:

ruff/crates/ty_python_semantic/src/types/ide_support.rs

Line 272 in 4fc7dd3

Type::Dynamic(DynamicType::TodoTypeAlias) => continue,

We never want private type aliases appearing in autocompletions. The special Todo variant was the best way I could think of doing this without PEP-613 support

Copy link
Member

@AlexWaygood AlexWaygood Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instances of UnionType are also suppressed, because they're almost certainly implicit type aliases, and we don't support them yet either, but we never want private type aliases from stubs appearing in autocompletions because they don't exist at runtime:

ruff/crates/ty_python_semantic/src/types/ide_support.rs

Line 262 in 4fc7dd3

| KnownClass::UnionType

Copy link
Contributor

@sharkdp sharkdp Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instances of UnionType are also suppressed

This is why it breaks, because now it's UnionType | <class 'int'>.

test.assert_completions_include("PublicProtocol");
test.assert_completions_do_not_include("_PrivateProtocol");
}
Expand Down Expand Up @@ -1759,13 +1760,13 @@ C.<CURSOR>
__name__ :: str
__ne__ :: def __ne__(self, value: object, /) -> bool
__new__ :: def __new__(cls) -> Self@__new__
__or__ :: bound method <class 'C'>.__or__(value: Any, /) -> UnionType
__or__ :: bound method <class 'C'>.__or__[Self](value: Any, /) -> UnionType | Self@__or__
__prepare__ :: bound method <class 'Meta'>.__prepare__(name: str, bases: tuple[type, ...], /, **kwds: Any) -> MutableMapping[str, object]
__qualname__ :: str
__reduce__ :: def __reduce__(self) -> str | tuple[Any, ...]
__reduce_ex__ :: def __reduce_ex__(self, protocol: SupportsIndex, /) -> str | tuple[Any, ...]
__repr__ :: def __repr__(self) -> str
__ror__ :: bound method <class 'C'>.__ror__(value: Any, /) -> UnionType
__ror__ :: bound method <class 'C'>.__ror__[Self](value: Any, /) -> UnionType | Self@__ror__
__setattr__ :: def __setattr__(self, name: str, value: Any, /) -> None
__sizeof__ :: def __sizeof__(self) -> int
__str__ :: def __str__(self) -> str
Expand Down Expand Up @@ -1827,13 +1828,13 @@ Meta.<CURSOR>
__mro__ :: tuple[<class 'Meta'>, <class 'type'>, <class 'object'>]
__name__ :: str
__ne__ :: def __ne__(self, value: object, /) -> bool
__or__ :: def __or__(self, value: Any, /) -> UnionType
__or__ :: def __or__[Self](self: Self@__or__, value: Any, /) -> UnionType | Self@__or__
__prepare__ :: bound method <class 'Meta'>.__prepare__(name: str, bases: tuple[type, ...], /, **kwds: Any) -> MutableMapping[str, object]
__qualname__ :: str
__reduce__ :: def __reduce__(self) -> str | tuple[Any, ...]
__reduce_ex__ :: def __reduce_ex__(self, protocol: SupportsIndex, /) -> str | tuple[Any, ...]
__repr__ :: def __repr__(self) -> str
__ror__ :: def __ror__(self, value: Any, /) -> UnionType
__ror__ :: def __ror__[Self](self: Self@__ror__, value: Any, /) -> UnionType | Self@__ror__
__setattr__ :: def __setattr__(self, name: str, value: Any, /) -> None
__sizeof__ :: def __sizeof__(self) -> int
__str__ :: def __str__(self) -> str
Expand Down Expand Up @@ -1936,13 +1937,13 @@ Quux.<CURSOR>
__name__ :: str
__ne__ :: def __ne__(self, value: object, /) -> bool
__new__ :: def __new__(cls) -> Self@__new__
__or__ :: bound method <class 'Quux'>.__or__(value: Any, /) -> UnionType
__or__ :: bound method <class 'Quux'>.__or__[Self](value: Any, /) -> UnionType | Self@__or__
__prepare__ :: bound method <class 'type'>.__prepare__(name: str, bases: tuple[type, ...], /, **kwds: Any) -> MutableMapping[str, object]
__qualname__ :: str
__reduce__ :: def __reduce__(self) -> str | tuple[Any, ...]
__reduce_ex__ :: def __reduce_ex__(self, protocol: SupportsIndex, /) -> str | tuple[Any, ...]
__repr__ :: def __repr__(self) -> str
__ror__ :: bound method <class 'Quux'>.__ror__(value: Any, /) -> UnionType
__ror__ :: bound method <class 'Quux'>.__ror__[Self](value: Any, /) -> UnionType | Self@__ror__
__setattr__ :: def __setattr__(self, name: str, value: Any, /) -> None
__sizeof__ :: def __sizeof__(self) -> int
__str__ :: def __str__(self) -> str
Expand Down Expand Up @@ -2013,14 +2014,14 @@ Answer.<CURSOR>
__name__ :: str
__ne__ :: def __ne__(self, value: object, /) -> bool
__new__ :: def __new__(cls, value: object) -> Self@__new__
__or__ :: bound method <class 'Answer'>.__or__(value: Any, /) -> UnionType
__or__ :: bound method <class 'Answer'>.__or__[Self](value: Any, /) -> UnionType | Self@__or__
__order__ :: str
__prepare__ :: bound method <class 'EnumMeta'>.__prepare__(cls: str, bases: tuple[type, ...], **kwds: Any) -> _EnumDict
__qualname__ :: str
__reduce__ :: def __reduce__(self) -> str | tuple[Any, ...]
__repr__ :: def __repr__(self) -> str
__reversed__ :: bound method <class 'Answer'>.__reversed__[_EnumMemberT]() -> Iterator[_EnumMemberT@__reversed__]
__ror__ :: bound method <class 'Answer'>.__ror__(value: Any, /) -> UnionType
__ror__ :: bound method <class 'Answer'>.__ror__[Self](value: Any, /) -> UnionType | Self@__ror__
__setattr__ :: def __setattr__(self, name: str, value: Any, /) -> None
__sizeof__ :: def __sizeof__(self) -> int
__str__ :: def __str__(self) -> str
Expand Down
80 changes: 40 additions & 40 deletions crates/ty_ide/src/goto_type_definition.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,13 +199,13 @@ mod tests {

assert_snapshot!(test.goto_type_definition(), @r#"
info[goto-type-definition]: Type definition
--> stdlib/builtins.pyi:911:7
--> stdlib/builtins.pyi:913:7
|
910 | @disjoint_base
911 | class str(Sequence[str]):
912 | @disjoint_base
913 | class str(Sequence[str]):
| ^^^
912 | """str(object='') -> str
913 | str(bytes_or_buffer[, encoding[, errors]]) -> str
914 | """str(object='') -> str
915 | str(bytes_or_buffer[, encoding[, errors]]) -> str
|
info: Source
--> main.py:4:1
Expand All @@ -227,13 +227,13 @@ mod tests {

assert_snapshot!(test.goto_type_definition(), @r#"
info[goto-type-definition]: Type definition
--> stdlib/builtins.pyi:911:7
--> stdlib/builtins.pyi:913:7
|
910 | @disjoint_base
911 | class str(Sequence[str]):
912 | @disjoint_base
913 | class str(Sequence[str]):
| ^^^
912 | """str(object='') -> str
913 | str(bytes_or_buffer[, encoding[, errors]]) -> str
914 | """str(object='') -> str
915 | str(bytes_or_buffer[, encoding[, errors]]) -> str
|
info: Source
--> main.py:2:10
Expand Down Expand Up @@ -324,13 +324,13 @@ mod tests {

assert_snapshot!(test.goto_type_definition(), @r#"
info[goto-type-definition]: Type definition
--> stdlib/builtins.pyi:911:7
--> stdlib/builtins.pyi:913:7
|
910 | @disjoint_base
911 | class str(Sequence[str]):
912 | @disjoint_base
913 | class str(Sequence[str]):
| ^^^
912 | """str(object='') -> str
913 | str(bytes_or_buffer[, encoding[, errors]]) -> str
914 | """str(object='') -> str
915 | str(bytes_or_buffer[, encoding[, errors]]) -> str
|
info: Source
--> main.py:4:6
Expand Down Expand Up @@ -358,13 +358,13 @@ mod tests {
// is an int. Navigating to `str` would match pyright's behavior.
assert_snapshot!(test.goto_type_definition(), @r#"
info[goto-type-definition]: Type definition
--> stdlib/builtins.pyi:344:7
--> stdlib/builtins.pyi:346:7
|
343 | @disjoint_base
344 | class int:
345 | @disjoint_base
346 | class int:
| ^^^
345 | """int([x]) -> integer
346 | int(x, base=10) -> integer
347 | """int([x]) -> integer
348 | int(x, base=10) -> integer
|
info: Source
--> main.py:4:6
Expand All @@ -391,13 +391,13 @@ f(**kwargs<CURSOR>)

assert_snapshot!(test.goto_type_definition(), @r#"
info[goto-type-definition]: Type definition
--> stdlib/builtins.pyi:2916:7
--> stdlib/builtins.pyi:2918:7
|
2915 | @disjoint_base
2916 | class dict(MutableMapping[_KT, _VT]):
2917 | @disjoint_base
2918 | class dict(MutableMapping[_KT, _VT]):
| ^^^^
2917 | """dict() -> new empty dictionary
2918 | dict(mapping) -> new dictionary initialized from a mapping object's
2919 | """dict() -> new empty dictionary
2920 | dict(mapping) -> new dictionary initialized from a mapping object's
|
info: Source
--> main.py:6:5
Expand All @@ -421,13 +421,13 @@ f(**kwargs<CURSOR>)

assert_snapshot!(test.goto_type_definition(), @r#"
info[goto-type-definition]: Type definition
--> stdlib/builtins.pyi:911:7
--> stdlib/builtins.pyi:913:7
|
910 | @disjoint_base
911 | class str(Sequence[str]):
912 | @disjoint_base
913 | class str(Sequence[str]):
| ^^^
912 | """str(object='') -> str
913 | str(bytes_or_buffer[, encoding[, errors]]) -> str
914 | """str(object='') -> str
915 | str(bytes_or_buffer[, encoding[, errors]]) -> str
|
info: Source
--> main.py:3:5
Expand Down Expand Up @@ -513,13 +513,13 @@ f(**kwargs<CURSOR>)

assert_snapshot!(test.goto_type_definition(), @r#"
info[goto-type-definition]: Type definition
--> stdlib/builtins.pyi:911:7
--> stdlib/builtins.pyi:913:7
|
910 | @disjoint_base
911 | class str(Sequence[str]):
912 | @disjoint_base
913 | class str(Sequence[str]):
| ^^^
912 | """str(object='') -> str
913 | str(bytes_or_buffer[, encoding[, errors]]) -> str
914 | """str(object='') -> str
915 | str(bytes_or_buffer[, encoding[, errors]]) -> str
|
info: Source
--> main.py:4:15
Expand Down Expand Up @@ -560,13 +560,13 @@ f(**kwargs<CURSOR>)
|

info[goto-type-definition]: Type definition
--> stdlib/builtins.pyi:911:7
--> stdlib/builtins.pyi:913:7
|
910 | @disjoint_base
911 | class str(Sequence[str]):
912 | @disjoint_base
913 | class str(Sequence[str]):
| ^^^
912 | """str(object='') -> str
913 | str(bytes_or_buffer[, encoding[, errors]]) -> str
914 | """str(object='') -> str
915 | str(bytes_or_buffer[, encoding[, errors]]) -> str
|
info: Source
--> main.py:3:5
Expand Down
2 changes: 1 addition & 1 deletion crates/ty_python_semantic/resources/mdtest/annotations/union.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,5 @@ python-version = "3.10"
X = int | str

def f(y: X):
reveal_type(y) # revealed: @Todo(Support for `types.UnionType` instances in type expressions)
reveal_type(y) # revealed: @Todo(Support for `types.UnionType` instances in type expressions) | int
Copy link
Contributor

@sharkdp sharkdp Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is due to python/typeshed#14813. It's not technically incorrect, but breaks in cases that previously relied on the @Todo type to shadow false positives. We may need to special-case type.__or__'s return type (for now)?

Copy link
Member

@AlexWaygood AlexWaygood Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may need to special-case type.__or__'s return type (for now)?

That sounds reasonable. Sorry I didn't give any warning that this was coming — completely forgot about all the special casing we have for PEP-604 unions and type aliases when I merged that typeshed PR :-(

It might be easiest to work in the special case at a higher level, in inference of | operations in infer/builder.rs

Copy link
Contributor

@sharkdp sharkdp Oct 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I didn't give any warning that this was coming — completely forgot about all the special casing we have for PEP-604 unions and type aliases when I merged that typeshed PR :-(

We certainly didn't expect you to. This also looks innocent enough 😃

```
2 changes: 1 addition & 1 deletion crates/ty_python_semantic/resources/mdtest/attributes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2189,7 +2189,7 @@ All attribute access on literal `bytes` types is currently delegated to `builtin
```py
# revealed: bound method Literal[b"foo"].join(iterable_of_bytes: Iterable[@Todo(Support for `typing.TypeAlias`)], /) -> bytes
reveal_type(b"foo".join)
# revealed: bound method Literal[b"foo"].endswith(suffix: @Todo(Support for `typing.TypeAlias`) | tuple[@Todo(Support for `typing.TypeAlias`), ...], start: SupportsIndex | None = EllipsisType, end: SupportsIndex | None = EllipsisType, /) -> bool
# revealed: bound method Literal[b"foo"].endswith(suffix: @Todo(Support for `typing.TypeAlias`) | tuple[@Todo(Support for `typing.TypeAlias`), ...], start: SupportsIndex | None = None, end: SupportsIndex | None = None, /) -> bool
reveal_type(b"foo".endswith)
```

Expand Down
2 changes: 1 addition & 1 deletion crates/ty_python_semantic/resources/mdtest/binary/classes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ python-version = "3.10"
class A: ...
class B: ...

reveal_type(A | B) # revealed: UnionType
reveal_type(A | B) # revealed: UnionType | <class 'A'>
```

## Union of two classes (prior to 3.10)
Expand Down
6 changes: 3 additions & 3 deletions crates/ty_python_semantic/resources/mdtest/call/methods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,7 +651,7 @@ static_assert(is_assignable_to(TypeOf[property.__set__], Callable))
reveal_type(MyClass.my_property.__set__)
static_assert(is_assignable_to(TypeOf[MyClass.my_property.__set__], Callable))

# revealed: def startswith(self, prefix: str | tuple[str, ...], start: SupportsIndex | None = EllipsisType, end: SupportsIndex | None = EllipsisType, /) -> bool
# revealed: def startswith(self, prefix: str | tuple[str, ...], start: SupportsIndex | None = None, end: SupportsIndex | None = None, /) -> bool
reveal_type(str.startswith)
static_assert(is_assignable_to(TypeOf[str.startswith], Callable))

Expand Down Expand Up @@ -689,7 +689,7 @@ def _(
# revealed: (obj: type) -> None
reveal_type(e)

# revealed: (fget: ((Any, /) -> Any) | None = EllipsisType, fset: ((Any, Any, /) -> None) | None = EllipsisType, fdel: ((Any, /) -> None) | None = EllipsisType, doc: str | None = EllipsisType) -> property
# revealed: (fget: ((Any, /) -> Any) | None = None, fset: ((Any, Any, /) -> None) | None = None, fdel: ((Any, /) -> None) | None = None, doc: str | None = None) -> property
reveal_type(f)

# revealed: Overload[(self: property, instance: None, owner: type, /) -> Unknown, (self: property, instance: object, owner: type | None = None, /) -> Unknown]
Expand All @@ -707,7 +707,7 @@ def _(
# revealed: (instance: object, value: object, /) -> Unknown
reveal_type(j)

# revealed: (self, prefix: str | tuple[str, ...], start: SupportsIndex | None = EllipsisType, end: SupportsIndex | None = EllipsisType, /) -> bool
# revealed: (self, prefix: str | tuple[str, ...], start: SupportsIndex | None = None, end: SupportsIndex | None = None, /) -> bool
reveal_type(k)

# revealed: (prefix: str | tuple[str, ...], start: SupportsIndex | None = None, end: SupportsIndex | None = None, /) -> bool
Expand Down
10 changes: 5 additions & 5 deletions ...mdtest/snapshots/invalid_await.md_-_Invalid_await_diagno…_-_Basic_(f15db7dc447d0795).snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ error[invalid-await]: `Literal[1]` is not awaitable
2 | await 1 # error: [invalid-await]
| ^
|
::: stdlib/builtins.pyi:344:7
::: stdlib/builtins.pyi:346:7
|
343 | @disjoint_base
344 | class int:
345 | @disjoint_base
346 | class int:
| --- type defined here
345 | """int([x]) -> integer
346 | int(x, base=10) -> integer
347 | """int([x]) -> integer
348 | int(x, base=10) -> integer
|
info: `__await__` is missing
info: rule `invalid-await` is enabled by default
Expand Down
2 changes: 1 addition & 1 deletion crates/ty_vendored/vendor/typeshed/source_commit.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
91055c730ffcda6311654cf32d663858ece69bad
d6f4a0f7102b1400a21742cf9b7ea93614e2b6ec
7 changes: 4 additions & 3 deletions crates/ty_vendored/vendor/typeshed/stdlib/_csv.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ else:
def writerows(self, rows: Iterable[Iterable[Any]]) -> None: ...

def writer(
csvfile: SupportsWrite[str],
fileobj: SupportsWrite[str],
/,
dialect: _DialectLike = "excel",
*,
Expand Down Expand Up @@ -164,7 +164,7 @@ def writer(
"""

def reader(
csvfile: Iterable[str],
iterable: Iterable[str],
/,
dialect: _DialectLike = "excel",
*,
Expand Down Expand Up @@ -194,7 +194,8 @@ def reader(

def register_dialect(
name: str,
dialect: type[Dialect | csv.Dialect] = ...,
/,
dialect: type[Dialect | csv.Dialect] | str = "excel",
*,
delimiter: str = ",",
quotechar: str | None = '"',
Expand Down
10 changes: 5 additions & 5 deletions crates/ty_vendored/vendor/typeshed/stdlib/_frozen_importlib_external.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ class SourceLoader(_LoaderBasics):
"""

def source_to_code(
self, data: ReadableBuffer | str | _ast.Module | _ast.Expression | _ast.Interactive, path: ReadableBuffer | StrPath
self, data: ReadableBuffer | str | _ast.Module | _ast.Expression | _ast.Interactive, path: bytes | StrPath
) -> types.CodeType:
"""Return the code object compiled from source.

Expand Down Expand Up @@ -281,10 +281,10 @@ class FileLoader:
def get_data(self, path: str) -> bytes:
"""Return the data from path as raw bytes."""

def get_filename(self, name: str | None = None) -> str:
def get_filename(self, fullname: str | None = None) -> str:
"""Return the path to the source file as found by the finder."""

def load_module(self, name: str | None = None) -> types.ModuleType:
def load_module(self, fullname: str | None = None) -> types.ModuleType:
"""Load a module from a file.

This method is deprecated. Use exec_module() instead.
Expand All @@ -311,7 +311,7 @@ class SourceFileLoader(importlib.abc.FileLoader, FileLoader, importlib.abc.Sourc
def source_to_code( # type: ignore[override] # incompatible with InspectLoader.source_to_code
self,
data: ReadableBuffer | str | _ast.Module | _ast.Expression | _ast.Interactive,
path: ReadableBuffer | StrPath,
path: bytes | StrPath,
*,
_optimize: int = -1,
) -> types.CodeType:
Expand All @@ -335,7 +335,7 @@ class ExtensionFileLoader(FileLoader, _LoaderBasics, importlib.abc.ExecutionLoad
"""

def __init__(self, name: str, path: str) -> None: ...
def get_filename(self, name: str | None = None) -> str:
def get_filename(self, fullname: str | None = None) -> str:
"""Return the path to the source file as found by the finder."""

def get_source(self, fullname: str) -> None:
Expand Down
3 changes: 3 additions & 0 deletions crates/ty_vendored/vendor/typeshed/stdlib/_typeshed/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,9 @@ class SupportsIter(Protocol[_T_co]):
class SupportsAiter(Protocol[_T_co]):
def __aiter__(self) -> _T_co: ...

class SupportsLen(Protocol):
def __len__(self) -> int: ...

class SupportsLenAndGetItem(Protocol[_T_co]):
def __len__(self) -> int: ...
def __getitem__(self, k: int, /) -> _T_co: ...
Expand Down
Loading
Loading