allow object type in dict.get and dict.pop

Author: randolf-scholz

stdlib/@tests/test_cases/builtins/check_dict.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import os
-from typing import Any, Dict, Generic, Iterable, Mapping, TypeVar, Union
+from typing import Any, Dict, Generic, Iterable, Literal, Mapping, TypeVar, Union
 from typing_extensions import Self, assert_type
 
 ###################################################################
@@ -103,6 +103,16 @@ def test_iterable_tuple_overload(x: Iterable[tuple[int, str]]) -> dict[int, str]
 result = d_str.get("key", int_value)  # type: ignore[arg-type]
 
 
+def test_dict_signature_overlapping_type(d: dict[Literal["foo", "bar"], int], key: str) -> None:
+    # Note: annotations also allow using keys of a disjoint type (e.g., int),
+    #   linters / type checkers are free to issue warnings in such cases.
+    #   statically, a .get(arg) is superfluous if the intersection of the
+    #   dict key type and the argument type is empty.
+    #   So we only test a case with non-empty intersection here.
+    d.get(key)
+    d.pop(key)
+
+
 # Return values also make things weird
 
 # Pyright doesn't have a version of no-any-return,

stdlib/builtins.pyi

@@ -1220,17 +1220,19 @@ class dict(MutableMapping[_KT, _VT]):
     def fromkeys(cls, iterable: Iterable[_T], value: _S, /) -> dict[_T, _S]: ...
     # Positional-only in dict, but not in MutableMapping
     @overload  # type: ignore[override]
-    def get(self, key: _KT, default: None = None, /) -> _VT | None: ...
+    def get(self, key: object, default: None = None, /) -> _VT | None: ...
     @overload
-    def get(self, key: _KT, default: _VT, /) -> _VT: ...
+    def get(self, key: object, default: _VT, /) -> _VT: ...
     @overload
-    def get(self, key: _KT, default: _T, /) -> _VT | _T: ...
+    def get(self, key: object, default: _T, /) -> _VT | _T: ...
+    # dict.pop allows arbitrary types, which matches runtime semantics.
+    # linters may choose to warn if the given type does not overlap with the key type
     @overload
-    def pop(self, key: _KT, /) -> _VT: ...
+    def pop(self, key: object, /) -> _VT: ...
     @overload
-    def pop(self, key: _KT, default: _VT, /) -> _VT: ...
+    def pop(self, key: object, default: _VT, /) -> _VT: ...
     @overload
-    def pop(self, key: _KT, default: _T, /) -> _VT | _T: ...
+    def pop(self, key: object, default: _T, /) -> _VT | _T: ...
     def __len__(self) -> int: ...
     def __getitem__(self, key: _KT, /) -> _VT: ...
     def __setitem__(self, key: _KT, value: _VT, /) -> None: ...

stdlib/collections/__init__.pyi

@@ -382,11 +382,11 @@ class OrderedDict(dict[_KT, _VT]):
     def setdefault(self, key: _KT, default: _VT) -> _VT: ...
     # Same as dict.pop, but accepts keyword arguments
     @overload
-    def pop(self, key: _KT) -> _VT: ...
+    def pop(self, key: object) -> _VT: ...
     @overload
-    def pop(self, key: _KT, default: _VT) -> _VT: ...
+    def pop(self, key: object, default: _VT) -> _VT: ...
     @overload
-    def pop(self, key: _KT, default: _T) -> _VT | _T: ...
+    def pop(self, key: object, default: _T) -> _VT | _T: ...
     def __eq__(self, value: object, /) -> bool: ...
     @overload
     def __or__(self, value: dict[_KT, _VT], /) -> Self: ...

stdlib/mailbox.pyi

@@ -88,7 +88,7 @@ class Mailbox(Generic[_MessageT]):
     def __len__(self) -> int: ...
     def clear(self) -> None: ...
     @overload
-    def pop(self, key: str, default: None = None) -> _MessageT | None: ...
+    def pop(self, key: str) -> _MessageT | None: ...
     @overload
     def pop(self, key: str, default: _T) -> _MessageT | _T: ...
     def popitem(self) -> tuple[str, _MessageT]: ...

stubs/boltons/boltons/cacheutils.pyi

@@ -31,9 +31,9 @@ class LRI(dict[_KT, _VT]):
     def get(self, key: _KT, default: _T) -> _T | _VT: ...
     def __delitem__(self, key: _KT) -> None: ...
     @overload
-    def pop(self, key: _KT) -> _VT: ...
+    def pop(self, key: object) -> _VT: ...
     @overload
-    def pop(self, key: _KT, default: _T) -> _T | _VT: ...
+    def pop(self, key: object, default: _T) -> _T | _VT: ...
     def popitem(self) -> tuple[_KT, _VT]: ...
     def clear(self) -> None: ...
     def copy(self) -> Self: ...

stubs/boltons/boltons/dictutils.pyi

@@ -55,7 +55,7 @@ class OneToOne(dict[_KT, _VT]):
     inv: OneToOne[_VT, _KT]
     def clear(self) -> None: ...
     def copy(self) -> Self: ...
-    def pop(self, key: _KT, default: _VT | _T = ...) -> _VT | _T: ...
+    def pop(self, key: object, default: _VT | _T = ...) -> _VT | _T: ...
     def popitem(self) -> tuple[_KT, _VT]: ...
     def setdefault(self, key: _KT, default: _VT | None = None) -> _VT: ...
     @classmethod

stubs/yt-dlp/yt_dlp/utils/networking.pyi

@@ -21,11 +21,11 @@ class HTTPHeaderDict(dict[str, str]):
     @overload
     def get(self, key: str, /, default: type[NO_DEFAULT] | _T = ...) -> str | _T | type[NO_DEFAULT]: ...
     @overload
-    def pop(self, key: str, /) -> str: ...
+    def pop(self, key: object, /) -> str: ...
     @overload
-    def pop(self, key: str, /, default: _T) -> str | _T: ...
+    def pop(self, key: object, /, default: _T) -> str | _T: ...
     @overload
-    def pop(self, key: str, /, default: type[NO_DEFAULT] | _T | str = ...) -> str | _T | type[NO_DEFAULT]: ...
+    def pop(self, key: object, /, default: type[NO_DEFAULT] | _T | str = ...) -> str | _T | type[NO_DEFAULT]: ...
     @overload
     def setdefault(self, key: str, /) -> str: ...
     @overload