mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-29 13:24:57 +00:00
[ty] typecheck dict methods for TypedDict
(#19874)
Some checks are pending
CI / Determine changes (push) Waiting to run
CI / cargo fmt (push) Waiting to run
CI / cargo clippy (push) Blocked by required conditions
CI / cargo test (linux) (push) Blocked by required conditions
CI / cargo test (linux, release) (push) Blocked by required conditions
CI / cargo test (windows) (push) Blocked by required conditions
CI / cargo test (wasm) (push) Blocked by required conditions
CI / cargo build (release) (push) Waiting to run
CI / cargo build (msrv) (push) Blocked by required conditions
CI / cargo fuzz build (push) Blocked by required conditions
CI / fuzz parser (push) Blocked by required conditions
CI / test scripts (push) Blocked by required conditions
CI / ecosystem (push) Blocked by required conditions
CI / Fuzz for new ty panics (push) Blocked by required conditions
CI / cargo shear (push) Blocked by required conditions
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / mkdocs (push) Waiting to run
CI / formatter instabilities and black similarity (push) Blocked by required conditions
CI / test ruff-lsp (push) Blocked by required conditions
CI / check playground (push) Blocked by required conditions
CI / benchmarks-instrumented (push) Blocked by required conditions
CI / benchmarks-walltime (push) Blocked by required conditions
[ty Playground] Release / publish (push) Waiting to run
Some checks are pending
CI / Determine changes (push) Waiting to run
CI / cargo fmt (push) Waiting to run
CI / cargo clippy (push) Blocked by required conditions
CI / cargo test (linux) (push) Blocked by required conditions
CI / cargo test (linux, release) (push) Blocked by required conditions
CI / cargo test (windows) (push) Blocked by required conditions
CI / cargo test (wasm) (push) Blocked by required conditions
CI / cargo build (release) (push) Waiting to run
CI / cargo build (msrv) (push) Blocked by required conditions
CI / cargo fuzz build (push) Blocked by required conditions
CI / fuzz parser (push) Blocked by required conditions
CI / test scripts (push) Blocked by required conditions
CI / ecosystem (push) Blocked by required conditions
CI / Fuzz for new ty panics (push) Blocked by required conditions
CI / cargo shear (push) Blocked by required conditions
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / mkdocs (push) Waiting to run
CI / formatter instabilities and black similarity (push) Blocked by required conditions
CI / test ruff-lsp (push) Blocked by required conditions
CI / check playground (push) Blocked by required conditions
CI / benchmarks-instrumented (push) Blocked by required conditions
CI / benchmarks-walltime (push) Blocked by required conditions
[ty Playground] Release / publish (push) Waiting to run
## Summary Typecheck `get()`, `setdefault()`, `pop()` for `TypedDict` ```py from typing import TypedDict from typing_extensions import NotRequired class Employee(TypedDict): name: str department: NotRequired[str] emp = Employee(name="Alice", department="Engineering") emp.get("name") emp.get("departmen", "Unknown") emp.pop("department") emp.pop("name") ``` <img width="838" height="529" alt="Screenshot 2025-08-12 at 11 42 12" src="https://github.com/user-attachments/assets/77ce150a-223c-4931-b914-551095d8a3a6" /> part of https://github.com/astral-sh/ty/issues/154 ## Test Plan Updated Markdown tests --------- Co-authored-by: David Peter <mail@david-peter.de>
This commit is contained in:
parent
c2d7c673ca
commit
5a608f7366
6 changed files with 312 additions and 60 deletions
|
@ -450,19 +450,51 @@ class Person(TypedDict, total=False):
|
|||
|
||||
```py
|
||||
from typing import TypedDict
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
class Person(TypedDict):
|
||||
name: str
|
||||
age: int | None
|
||||
extra: NotRequired[str]
|
||||
|
||||
def _(p: Person) -> None:
|
||||
reveal_type(p.keys()) # revealed: dict_keys[str, object]
|
||||
reveal_type(p.values()) # revealed: dict_values[str, object]
|
||||
|
||||
reveal_type(p.setdefault("name", "Alice")) # revealed: @Todo(Support for `TypedDict`)
|
||||
# `get()` returns the field type for required keys (no None union)
|
||||
reveal_type(p.get("name")) # revealed: str
|
||||
reveal_type(p.get("age")) # revealed: int | None
|
||||
|
||||
reveal_type(p.get("name")) # revealed: @Todo(Support for `TypedDict`)
|
||||
reveal_type(p.get("name", "Unknown")) # revealed: @Todo(Support for `TypedDict`)
|
||||
# It doesn't matter if a default is specified:
|
||||
reveal_type(p.get("name", "default")) # revealed: str
|
||||
reveal_type(p.get("age", 999)) # revealed: int | None
|
||||
|
||||
# `get()` can return `None` for non-required keys
|
||||
reveal_type(p.get("extra")) # revealed: str | None
|
||||
reveal_type(p.get("extra", "default")) # revealed: str
|
||||
|
||||
# The type of the default parameter can be anything:
|
||||
reveal_type(p.get("extra", 0)) # revealed: str | Literal[0]
|
||||
|
||||
# We allow access to unknown keys (they could be set for a subtype of Person)
|
||||
reveal_type(p.get("unknown")) # revealed: Unknown | None
|
||||
reveal_type(p.get("unknown", "default")) # revealed: Unknown | Literal["default"]
|
||||
|
||||
# `pop()` only works on non-required fields
|
||||
reveal_type(p.pop("extra")) # revealed: str
|
||||
reveal_type(p.pop("extra", "fallback")) # revealed: str
|
||||
# error: [invalid-argument-type] "Cannot pop required field 'name' from TypedDict `Person`"
|
||||
reveal_type(p.pop("name")) # revealed: Unknown
|
||||
|
||||
# Similar to above, the default parameter can be of any type:
|
||||
reveal_type(p.pop("extra", 0)) # revealed: str | Literal[0]
|
||||
|
||||
# `setdefault()` always returns the field type
|
||||
reveal_type(p.setdefault("name", "Alice")) # revealed: str
|
||||
reveal_type(p.setdefault("extra", "default")) # revealed: str
|
||||
|
||||
# error: [invalid-key] "Invalid key access on TypedDict `Person`: Unknown key "extraz" - did you mean "extra"?"
|
||||
reveal_type(p.setdefault("extraz", "value")) # revealed: Unknown
|
||||
```
|
||||
|
||||
## Unlike normal classes
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue