Skip to content

Use more precise context for TypedDict plugin errors #18293

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
Dec 14, 2024
Merged

Use more precise context for TypedDict plugin errors #18293

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
30 changes: 17 additions & 13 deletions mypy/plugins/default.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,25 +304,26 @@ def typed_dict_pop_callback(ctx: MethodContext) -> Type:
and len(ctx.arg_types) >= 1
and len(ctx.arg_types[0]) == 1
):
keys = try_getting_str_literals(ctx.args[0][0], ctx.arg_types[0][0])
key_expr = ctx.args[0][0]
keys = try_getting_str_literals(key_expr, ctx.arg_types[0][0])
if keys is None:
ctx.api.fail(
message_registry.TYPEDDICT_KEY_MUST_BE_STRING_LITERAL,
ctx.context,
key_expr,
code=codes.LITERAL_REQ,
)
return AnyType(TypeOfAny.from_error)

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

value_type = ctx.type.items.get(key)
if value_type:
value_types.append(value_type)
else:
ctx.api.msg.typeddict_key_not_found(ctx.type, key, ctx.context)
ctx.api.msg.typeddict_key_not_found(ctx.type, key, key_expr)
return AnyType(TypeOfAny.from_error)

if len(ctx.args[1]) == 0:
Expand Down Expand Up @@ -363,27 +364,29 @@ def typed_dict_setdefault_callback(ctx: MethodContext) -> Type:
and len(ctx.arg_types[0]) == 1
and len(ctx.arg_types[1]) == 1
):
keys = try_getting_str_literals(ctx.args[0][0], ctx.arg_types[0][0])
key_expr = ctx.args[0][0]
keys = try_getting_str_literals(key_expr, ctx.arg_types[0][0])
if keys is None:
ctx.api.fail(
message_registry.TYPEDDICT_KEY_MUST_BE_STRING_LITERAL,
ctx.context,
key_expr,
code=codes.LITERAL_REQ,
)
return AnyType(TypeOfAny.from_error)

assigned_readonly_keys = ctx.type.readonly_keys & set(keys)
if assigned_readonly_keys:
ctx.api.msg.readonly_keys_mutated(assigned_readonly_keys, context=ctx.context)
ctx.api.msg.readonly_keys_mutated(assigned_readonly_keys, context=key_expr)

default_type = ctx.arg_types[1][0]
default_expr = ctx.args[1][0]

value_types = []
for key in keys:
value_type = ctx.type.items.get(key)

if value_type is None:
ctx.api.msg.typeddict_key_not_found(ctx.type, key, ctx.context)
ctx.api.msg.typeddict_key_not_found(ctx.type, key, key_expr)
return AnyType(TypeOfAny.from_error)

# The signature_callback above can't always infer the right signature
Expand All @@ -392,7 +395,7 @@ def typed_dict_setdefault_callback(ctx: MethodContext) -> Type:
# default can be assigned to all key-value pairs we're updating.
if not is_subtype(default_type, value_type):
ctx.api.msg.typeddict_setdefault_arguments_inconsistent(
default_type, value_type, ctx.context
default_type, value_type, default_expr
)
return AnyType(TypeOfAny.from_error)

Expand All @@ -409,20 +412,21 @@ def typed_dict_delitem_callback(ctx: MethodContext) -> Type:
and len(ctx.arg_types) == 1
and len(ctx.arg_types[0]) == 1
):
keys = try_getting_str_literals(ctx.args[0][0], ctx.arg_types[0][0])
key_expr = ctx.args[0][0]
keys = try_getting_str_literals(key_expr, ctx.arg_types[0][0])
if keys is None:
ctx.api.fail(
message_registry.TYPEDDICT_KEY_MUST_BE_STRING_LITERAL,
ctx.context,
key_expr,
code=codes.LITERAL_REQ,
)
return AnyType(TypeOfAny.from_error)

for key in 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, ctx.context)
ctx.api.msg.typeddict_key_cannot_be_deleted(ctx.type, key, key_expr)
elif key not in ctx.type.items:
ctx.api.msg.typeddict_key_not_found(ctx.type, key, ctx.context)
ctx.api.msg.typeddict_key_not_found(ctx.type, key, key_expr)
return ctx.default_return_type


Expand Down
12 changes: 11 additions & 1 deletion test-data/unit/check-columns.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,9 +227,19 @@ class D(TypedDict):
x: int
t: D = {'x':
'y'} # E:5: Incompatible types (expression has type "str", TypedDict item "x" has type "int")
s: str

if int():
del t['y'] # E:5: TypedDict "D" has no key "y"
del t[s] # E:11: Expected TypedDict key to be string literal
del t["x"] # E:11: Key "x" of TypedDict "D" cannot be deleted
del t["y"] # E:11: TypedDict "D" has no key "y"

t.pop(s) # E:7: Expected TypedDict key to be string literal
t.pop("y") # E:7: TypedDict "D" has no key "y"

t.setdefault(s, 123) # E:14: Expected TypedDict key to be string literal
t.setdefault("x", "a") # E:19: Argument 2 to "setdefault" of "TypedDict" has incompatible type "str"; expected "int"
t.setdefault("y", 123) # E:14: TypedDict "D" has no key "y"
[builtins fixtures/dict.pyi]
[typing fixtures/typing-typeddict.pyi]

Expand Down
5 changes: 3 additions & 2 deletions test-data/unit/check-literal.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1909,8 +1909,9 @@ reveal_type(d.get(a_key, u)) # N: Revealed type is "Union[builtins.int, __main_
reveal_type(d.get(b_key, u)) # N: Revealed type is "Union[builtins.str, __main__.Unrelated]"
reveal_type(d.get(c_key, u)) # N: Revealed type is "builtins.object"

reveal_type(d.pop(a_key)) # E: Key "a" of TypedDict "Outer" cannot be deleted \
# N: Revealed type is "builtins.int"
reveal_type(d.pop(a_key)) # N: Revealed type is "builtins.int" \
# E: Key "a" of TypedDict "Outer" cannot be deleted

reveal_type(d.pop(b_key)) # N: Revealed type is "builtins.str"
d.pop(c_key) # E: TypedDict "Outer" has no key "c"

Expand Down
15 changes: 9 additions & 6 deletions test-data/unit/check-typeddict.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1747,8 +1747,9 @@ td: Union[TDA, TDB]

reveal_type(td.pop('a')) # N: Revealed type is "builtins.int"
reveal_type(td.pop('b')) # N: Revealed type is "Union[builtins.str, builtins.int]"
reveal_type(td.pop('c')) # E: TypedDict "TDA" has no key "c" \
# N: Revealed type is "Union[Any, builtins.int]"
reveal_type(td.pop('c')) # N: Revealed type is "Union[Any, builtins.int]" \
# E: TypedDict "TDA" has no key "c"

[builtins fixtures/dict.pyi]
[typing fixtures/typing-typeddict.pyi]

Expand Down Expand Up @@ -2614,8 +2615,9 @@ def func(foo: Union[Foo1, Foo2]):

del foo["missing"] # E: TypedDict "Foo1" has no key "missing" \
# E: TypedDict "Foo2" has no key "missing"
del foo[1] # E: Expected TypedDict key to be string literal \
# E: Argument 1 to "__delitem__" has incompatible type "int"; expected "str"
del foo[1] # E: Argument 1 to "__delitem__" has incompatible type "int"; expected "str" \
# E: Expected TypedDict key to be string literal

[builtins fixtures/dict.pyi]
[typing fixtures/typing-typeddict.pyi]

Expand Down Expand Up @@ -3726,8 +3728,9 @@ class TP(TypedDict):
mutable: bool

x: TP
reveal_type(x.pop("key")) # E: Key "key" of TypedDict "TP" cannot be deleted \
# N: Revealed type is "builtins.str"
reveal_type(x.pop("key")) # N: Revealed type is "builtins.str" \
# E: Key "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
Expand Down
Loading