python / python/mypy

Support TypedDict unpacking in ParamSpec specifications

Open
#16,120 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature topic-paramspec topic-typed-dict
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Feature

Related to

  • #16083

TypedDict unpacking in ParamSpec would work just like it works now in Callables.

P = ParamSpec("P")
class C(Generic[P]):
    def __init__(self, f: Callable[P, None]): ...

class Args(TypedDict):
    x: int
    y: str

def f(*, x: int, y: str) -> None: ...
c: C[[Unpack[Args]]] = C(f)  # OK
d: C[[int, str]] =  = C(f)  # error because `f` expects keyword arguments

Pitch

In order to express a callable type with keyword arguments, you can use a call protocol, but this doesn't work for other classes that are generic in ParamSpec. For example, in pytorch, network layers have to inherit from Module which should be typed approximately like this (using Python 3.12 generic syntax):

class Module[T, **P]:
    @abstractmethod
    def forward(self, *args: P.args, **kwargs: P.kwargs) -> T: ...

    def __call__(self, *args: P.args, **kwargs: P.kwargs) -> T:
        # do other stuff
        return self.forward(*args, **kwargs)

But what to do if I want to override forward with an optional argument?

class Dense(Module[Tensor, [Tensor, bool]]):
    def forward(self, x: Tensor, *, with_dropout: bool = False):
        # my implementation
        return x

With TypedDict unpacking in ParamSpec:

class ExtraArgs(TypedDict):
    with_dropout: bool

class Dense(Module[Tensor, [Tensor, Unpack[ExtraArgs]]]):
    def forward(self, x: Tensor, *, with_dropout: bool = False):
        # my implementation
        return x

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing Callable support for TypedDict unpacking and the ParamSpec examples in this issue, then review related issue #16083. Done should include support for Unpack[TypedDict] in ParamSpec specifications, including the accepted and rejected assignments illustrated here.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.