Skip to content

Forbid .pop of Readonly NotRequired TypedDict items #19133

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 1 commit into from
May 23, 2025
Merged

Forbid .pop of Readonly NotRequired TypedDict items #19133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion mypy/plugins/default.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ def typed_dict_pop_callback(ctx: MethodContext) -> Type:

value_types = []
for key in keys:
if key in ctx.type.required_keys:
if key in ctx.type.required_keys or key in ctx.type.readonly_keys:
ctx.api.msg.typeddict_key_cannot_be_deleted(ctx.type, key, key_expr)

value_type = ctx.type.items.get(key)
Expand Down
6 changes: 5 additions & 1 deletion test-data/unit/check-typeddict.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3760,20 +3760,24 @@ del x["optional_key"] # E: Key "optional_key" of TypedDict "TP" cannot be delet
[typing fixtures/typing-typeddict.pyi]

[case testTypedDictReadOnlyMutateMethods]
from typing import ReadOnly, TypedDict
from typing import ReadOnly, NotRequired, TypedDict

class TP(TypedDict):
key: ReadOnly[str]
optional_key: ReadOnly[NotRequired[str]]
other: ReadOnly[int]
mutable: bool

x: TP
reveal_type(x.pop("key")) # N: Revealed type is "builtins.str" \
# E: Key "key" of TypedDict "TP" cannot be deleted
reveal_type(x.pop("optional_key")) # N: Revealed type is "builtins.str" \
# E: Key "optional_key" of TypedDict "TP" cannot be deleted


x.update({"key": "abc", "other": 1, "mutable": True}) # E: ReadOnly TypedDict keys ("key", "other") TypedDict are mutated
x.setdefault("key", "abc") # E: ReadOnly TypedDict key "key" TypedDict is mutated
x.setdefault("optional_key", "foo") # E: ReadOnly TypedDict key "optional_key" TypedDict is mutated
x.setdefault("other", 1) # E: ReadOnly TypedDict key "other" TypedDict is mutated
x.setdefault("mutable", False) # ok
[builtins fixtures/dict.pyi]
Expand Down