Skip to content

Commit 8d185c6

Browse files
authored
Mark the Any trick with MaybeNone in third-party stubs (#16627)
- No change for type checkers, `MaybeNone` is an alias for `Any` - `regex`: match groups and `split()` results, matching stdlib `re` - `shapely`: indexed getters, `STRtree.nearest()` and `boundary` - `PyYAML`, `requests`, `pyserial`, `docutils`: attributes that can be `None` - `yt-dlp`: `read_stdin()`, matching `sys.stdin` Closes #12822 Refs #12855
1 parent 350a961 commit 8d185c6

11 files changed

Lines changed: 48 additions & 42 deletions

File tree

‎stubs/PyYAML/yaml/nodes.pyi‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
from _typeshed import Incomplete
2-
from typing import Any, ClassVar
1+
from _typeshed import Incomplete, MaybeNone
2+
from typing import ClassVar
33

44
from yaml.error import Mark
55

@@ -9,19 +9,19 @@ from yaml.error import Mark
99
class Node:
1010
tag: str
1111
value: Incomplete
12-
start_mark: Mark | Any
13-
end_mark: Mark | Any
12+
start_mark: Mark | MaybeNone
13+
end_mark: Mark | MaybeNone
1414
def __init__(self, tag: str, value, start_mark: Mark | None, end_mark: Mark | None) -> None: ...
1515

1616
class ScalarNode(Node):
1717
id: ClassVar[str]
18-
style: str | Any
18+
style: str | MaybeNone
1919
def __init__(
2020
self, tag: str, value, start_mark: Mark | None = None, end_mark: Mark | None = None, style: str | None = None
2121
) -> None: ...
2222

2323
class CollectionNode(Node):
24-
flow_style: bool | Any
24+
flow_style: bool | MaybeNone
2525
def __init__(
2626
self, tag: str, value, start_mark: Mark | None = None, end_mark: Mark | None = None, flow_style: bool | None = None
2727
) -> None: ...

‎stubs/docutils/docutils/nodes.pyi‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import sys
22
import xml.dom.minidom
3-
from _typeshed import Incomplete, StrPath
3+
from _typeshed import Incomplete, MaybeNone, StrPath
44
from abc import abstractmethod
55
from collections import Counter
66
from collections.abc import Callable, Generator, Iterable, Iterator, Mapping, Sequence
@@ -32,7 +32,7 @@ class Node:
3232
# TODO: `parent` is actually `Element | None``, but `None`` only happens rarely,
3333
# i.e. for synthetic nodes (or `document`, where it is overridden).
3434
# See https://github.com/python/typeshed/blob/main/CONTRIBUTING.md#the-any-trick
35-
parent: Element | Any
35+
parent: Element | MaybeNone
3636
source: str | None
3737
line: int | None
3838

‎stubs/pyserial/serial/tools/list_ports_common.pyi‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
from _typeshed import MaybeNone
12
from collections.abc import Collection
2-
from typing import Any
33

44
def numsplit(text: str) -> list[str | int]: ...
55

@@ -11,13 +11,13 @@ class ListPortInfo:
1111
# USB specific data: the vid and pid attributes below are specific to USB devices only and
1212
# should be marked as Optional. Since the majority of the serial devices nowadays are USB
1313
# devices, typing them as Optional will be unnecessarily annoying. We type them with as
14-
# `int | Any` so that obvious typing errors like ListPortInfo.pid + "str" are flagged.
14+
# `int | MaybeNone` so that obvious typing errors like ListPortInfo.pid + "str" are flagged.
1515
# As desired, this will cause a false negative if the value is ever None, but may also cause
1616
# other false negatives from the Any proliferating. The other USB attributes are correctly
1717
# typed as Optional because they may be `None` even for USB devices
1818
# Original discussion at https://github.com/python/typeshed/pull/9347#issuecomment-1358245865.
19-
vid: int | Any
20-
pid: int | Any
19+
vid: int | MaybeNone
20+
pid: int | MaybeNone
2121
serial_number: str | None
2222
location: str | None
2323
manufacturer: str | None

‎stubs/regex/regex/_main.pyi‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from _typeshed import ReadableBuffer, Unused
1+
from _typeshed import MaybeNone, ReadableBuffer, Unused
22
from collections.abc import Callable, Mapping
33
from types import GenericAlias
44
from typing import Any, AnyStr, Generic, Literal, TypeVar, final, overload
@@ -176,7 +176,7 @@ def split(
176176
timeout: float | None = None,
177177
ignore_unused: bool = False,
178178
**kwargs: Any,
179-
) -> list[str | Any]: ...
179+
) -> list[str | MaybeNone]: ...
180180
@overload
181181
def split(
182182
pattern: bytes | Pattern[bytes],
@@ -187,7 +187,7 @@ def split(
187187
timeout: float | None = None,
188188
ignore_unused: bool = False,
189189
**kwargs: Any,
190-
) -> list[bytes | Any]: ...
190+
) -> list[bytes | MaybeNone]: ...
191191

192192
@overload
193193
def splititer(
@@ -480,15 +480,15 @@ class Pattern(Generic[AnyStr]):
480480
@overload
481481
def split(
482482
self: Pattern[str], string: str, maxsplit: int = 0, concurrent: bool | None = None, timeout: float | None = None
483-
) -> list[str | Any]: ...
483+
) -> list[str | MaybeNone]: ...
484484
@overload
485485
def split(
486486
self: Pattern[bytes],
487487
string: ReadableBuffer,
488488
maxsplit: int = 0,
489489
concurrent: bool | None = None,
490490
timeout: float | None = None,
491-
) -> list[bytes | Any]: ...
491+
) -> list[bytes | MaybeNone]: ...
492492

493493
@overload
494494
def splititer(
@@ -692,17 +692,17 @@ class Match(Generic[AnyStr]):
692692
@overload
693693
def group(self, group: Literal[0] = 0, /) -> AnyStr: ...
694694
@overload
695-
def group(self, group: int | str = ..., /) -> AnyStr | Any: ...
695+
def group(self, group: int | str = ..., /) -> AnyStr | MaybeNone: ...
696696
@overload
697-
def group(self, group1: int | str, group2: int | str, /, *groups: int | str) -> tuple[AnyStr | Any, ...]: ...
697+
def group(self, group1: int | str, group2: int | str, /, *groups: int | str) -> tuple[AnyStr | MaybeNone, ...]: ...
698698

699699
@overload
700-
def groups(self, default: None = None) -> tuple[AnyStr | Any, ...]: ...
700+
def groups(self, default: None = None) -> tuple[AnyStr | MaybeNone, ...]: ...
701701
@overload
702702
def groups(self, default: _T) -> tuple[AnyStr | _T, ...]: ...
703703

704704
@overload
705-
def groupdict(self, default: None = None) -> dict[str, AnyStr | Any]: ...
705+
def groupdict(self, default: None = None) -> dict[str, AnyStr | MaybeNone]: ...
706706
@overload
707707
def groupdict(self, default: _T) -> dict[str, AnyStr | _T]: ...
708708

@@ -752,7 +752,7 @@ class Match(Generic[AnyStr]):
752752
@overload
753753
def __getitem__(self, key: Literal[0], /) -> AnyStr: ...
754754
@overload
755-
def __getitem__(self, key: int | str, /) -> AnyStr | Any: ...
755+
def __getitem__(self, key: int | str, /) -> AnyStr | MaybeNone: ...
756756

757757
def __copy__(self) -> Self: ...
758758
def __deepcopy__(self, memo: Unused, /) -> Self: ...

‎stubs/regex/regex/_regex.pyi‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
# For example: `Pattern` and `Match` are not exported
44
# and are redefined in `regex.regex module.
55

6-
from typing import Any, AnyStr, Generic, final
6+
from _typeshed import MaybeNone
7+
from typing import AnyStr, Generic, final
78
from typing_extensions import Self
89

910
from ._main import Match, Pattern
@@ -13,8 +14,8 @@ class Splitter(Generic[AnyStr]):
1314
@property
1415
def pattern(self) -> Pattern[AnyStr]: ...
1516
def __iter__(self) -> Self: ...
16-
def __next__(self) -> AnyStr | Any: ...
17-
def split(self) -> AnyStr | Any: ...
17+
def __next__(self) -> AnyStr | MaybeNone: ...
18+
def split(self) -> AnyStr | MaybeNone: ...
1819

1920
@final
2021
class Scanner(Generic[AnyStr]):

‎stubs/requests/requests/exceptions.pyi‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from typing import Any
1+
from _typeshed import MaybeNone
22

33
from urllib3.exceptions import HTTPError as BaseHTTPError
44

@@ -17,8 +17,8 @@ class InvalidJSONError(RequestException): ...
1717
class JSONDecodeError(InvalidJSONError, CompatJSONDecodeError): ...
1818

1919
class HTTPError(RequestException):
20-
request: Request | PreparedRequest | Any
21-
response: Response | Any
20+
request: Request | PreparedRequest | MaybeNone
21+
response: Response | MaybeNone
2222

2323
class ConnectionError(RequestException): ...
2424
class ProxyError(ConnectionError): ...

‎stubs/shapely/shapely/_geometry.pyi‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
from _typeshed import MaybeNone
12
from enum import IntEnum
2-
from typing import Any, Literal, SupportsIndex, TypeAlias, overload
3+
from typing import Literal, SupportsIndex, TypeAlias, overload
34

45
import numpy as np
56
from numpy.typing import NDArray
@@ -103,7 +104,7 @@ def get_m(point: Geometry | None, **kwargs) -> np.float64: ...
103104
def get_m(point: OptGeoArrayLikeSeq, **kwargs) -> NDArray[np.float64]: ...
104105

105106
@overload
106-
def get_point(geometry: LineString, index: SupportsIndex, **kwargs) -> Point | Any: ...
107+
def get_point(geometry: LineString, index: SupportsIndex, **kwargs) -> Point | MaybeNone: ...
107108
@overload
108109
def get_point(geometry: Point | Polygon | BaseMultipartGeometry | None, index: SupportsIndex, **kwargs) -> None: ...
109110
@overload
@@ -128,7 +129,7 @@ def get_exterior_ring(geometry: Geometry, **kwargs) -> LinearRing | None: ...
128129
def get_exterior_ring(geometry: OptGeoArrayLikeSeq, **kwargs) -> GeoArray: ...
129130

130131
@overload
131-
def get_interior_ring(geometry: Polygon, index: SupportsIndex, **kwargs) -> LinearRing | Any: ...
132+
def get_interior_ring(geometry: Polygon, index: SupportsIndex, **kwargs) -> LinearRing | MaybeNone: ...
132133
@overload
133134
def get_interior_ring(geometry: Point | LineString | BaseMultipartGeometry | None, index: SupportsIndex, **kwargs) -> None: ...
134135
@overload
@@ -144,13 +145,13 @@ def get_num_interior_rings(geometry: Geometry | None, **kwargs) -> np.int32: ...
144145
def get_num_interior_rings(geometry: OptGeoArrayLikeSeq, **kwargs) -> NDArray[np.int32]: ...
145146

146147
@overload
147-
def get_geometry(geometry: MultiPoint, index: SupportsIndex, **kwargs) -> Point | Any: ...
148+
def get_geometry(geometry: MultiPoint, index: SupportsIndex, **kwargs) -> Point | MaybeNone: ...
148149
@overload
149-
def get_geometry(geometry: MultiLineString, index: SupportsIndex, **kwargs) -> LineString | Any: ...
150+
def get_geometry(geometry: MultiLineString, index: SupportsIndex, **kwargs) -> LineString | MaybeNone: ...
150151
@overload
151-
def get_geometry(geometry: MultiPolygon, index: SupportsIndex, **kwargs) -> Polygon | Any: ...
152+
def get_geometry(geometry: MultiPolygon, index: SupportsIndex, **kwargs) -> Polygon | MaybeNone: ...
152153
@overload
153-
def get_geometry(geometry: BaseMultipartGeometry, index: SupportsIndex, **kwargs) -> BaseGeometry | Any: ...
154+
def get_geometry(geometry: BaseMultipartGeometry, index: SupportsIndex, **kwargs) -> BaseGeometry | MaybeNone: ...
154155
@overload
155156
def get_geometry(geometry: None, index: SupportsIndex, **kwargs) -> None: ...
156157
@overload

‎stubs/shapely/shapely/constructive.pyi‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
from _typeshed import MaybeNone
12
from collections.abc import Sequence
2-
from typing import Any, Literal, SupportsIndex, overload
3+
from typing import Literal, SupportsIndex, overload
34
from typing_extensions import Unpack
45

56
from ._enum import ParamEnum
@@ -62,7 +63,7 @@ def boundary(geometry: Polygon | MultiPolygon, **kwargs: Unpack[UFuncKwargs]) ->
6263
@overload
6364
def boundary(geometry: GeometryCollection | None, **kwargs: Unpack[UFuncKwargs]) -> None: ...
6465
@overload
65-
def boundary(geometry: Geometry, **kwargs: Unpack[UFuncKwargs]) -> BaseMultipartGeometry | Any: ...
66+
def boundary(geometry: Geometry, **kwargs: Unpack[UFuncKwargs]) -> BaseMultipartGeometry | MaybeNone: ...
6667
@overload
6768
def boundary(geometry: OptGeoArrayLikeSeq, **kwargs: Unpack[UFuncKwargs]) -> GeoArray: ...
6869

‎stubs/shapely/shapely/geometry/base.pyi‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
from _typeshed import MaybeNone
12
from array import array
23
from collections.abc import Iterator
34
from typing import Any, Generic, Literal, overload
@@ -111,7 +112,7 @@ class BaseGeometry(Geometry):
111112
@property
112113
def minimum_clearance(self) -> float: ...
113114
@property
114-
def boundary(self) -> BaseMultipartGeometry | Any: ... # is None for GeometryCollection
115+
def boundary(self) -> BaseMultipartGeometry | MaybeNone: ... # is None for GeometryCollection
115116
@property
116117
def bounds(self) -> tuple[float, float, float, float]: ...
117118
@property

‎stubs/shapely/shapely/strtree.pyi‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
from typing import Any, Literal, SupportsIndex, TypeAlias, overload
1+
from _typeshed import MaybeNone
2+
from typing import Literal, SupportsIndex, TypeAlias, overload
23

34
import numpy as np
45
from numpy.typing import NDArray
@@ -41,9 +42,9 @@ class STRtree:
4142

4243
# nearest may return `None` if the tree is empty, use the "Any trick"
4344
@overload
44-
def nearest(self, geometry: Geometry) -> np.int64 | Any: ...
45+
def nearest(self, geometry: Geometry) -> np.int64 | MaybeNone: ...
4546
@overload
46-
def nearest(self, geometry: GeoArrayLikeSeq) -> NDArray[np.int64] | Any: ...
47+
def nearest(self, geometry: GeoArrayLikeSeq) -> NDArray[np.int64] | MaybeNone: ...
4748

4849
@overload # return_distance=False
4950
def query_nearest(

0 commit comments

Comments
 (0)