python / python/mypy

hinting method decorators with protocols fails to remove the self attribute when binding

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

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Bug Report

When hinting a decorator used on methods using Callable, the unbound method and bound method types differ by the first/self parameter as I expect. When I replace the Callable with a Protocol providing .__call__() instead, the unbound and bound cases are the same.

To Reproduce

https://mypy-play.net/?mypy=latest&python=3.11&gist=1046c1e56c21fd17cda1ecab5e9e131b

import typing


def d(f: typing.Callable[[C, int], str]) -> typing.Callable[[C, int], str]:
    def inner(self, x: int) -> str:
        return f(self, x)
    
    return inner

class C:
    @d
    def m(self, x: int) -> str:
        return ""

reveal_type(C.m)
reveal_type(C().m)


class P(typing.Protocol):
    def __call__(protocol_self, self: CP, x: int) -> str:
        ...

def dp(f: P) -> P:
    def inner(self, x: int) -> str:
        return f(self, x)
    
    return inner

class CP:
    @dp
    def m(self, x: int) -> str:
        return ""

reveal_type(CP.m)
reveal_type(CP().m)

Expected Behavior

I don't know the details around 'modifying' protocols such as would be required here but I would expect that unbound and bound would not be the same.

Actual Behavior

Unbound and bound methods decorated with a decorator hinted with protocols have the same type.

main.py:15: note: Revealed type is "def (__main__.C, builtins.int) -> builtins.str"
main.py:16: note: Revealed type is "def (builtins.int) -> builtins.str"
main.py:34: note: Revealed type is "__main__.P"
main.py:35: note: Revealed type is "__main__.P"
Success: no issues found in 1 source file

Your Environment

  • Mypy version used: 1.5.1, master
  • Mypy command-line flags: mypy-play defaults
  • Mypy configuration options from mypy.ini (and other config files): none
  • Python version used: 3.11

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 with the linked mypy-play reproducer and the reveal_type output in main.py, comparing the Callable and Protocol cases. Trace the method-binding handling for protocol call types and add a regression test covering unbound and bound methods. Done means the bound Protocol-decorated method omits self, matching the Callable behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.