python / python/mypy

Method overloads ignored when dispatched via protocols

Open
#9,464 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug topic-overloads topic-protocols
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Bug Report

At the moment I'm dealing with a number of numpy functions which, effectively, serve as wrappers
around a set of matching ndarray methods. Taking a simplified version of argmax as example,
a custom SupportsArgmax Protocol is herein used for dispatching the internals of the argmax
function to the ndarray.argmax method.

As it turns out, this works perfectly fine when the ndarray.argmax mods does not contain any
overloads, but when it does then any overloads beyond the first are ignored.

from typing import Protocol, overload, TypeVar

# Step 1: Define the class
class ndarray:
    @overload
    def argmax(self, axis: None) -> int: ...
    @overload
    def argmax(self, axis: int) -> ndarray: ...


# Step 2: Define a Protocol for describing the classes' argmax method
T_contra = TypeVar("T_contra", contravariant=True)
T_co = TypeVar("T_co", covariant=True)

class SupportsArgmax(Protocol[T_contra, T_co]):
    def argmax(self, axis: T_contra) -> T_co: ...


# Step 3: Define a wrapper function around the classes' argmax method
T1 = TypeVar("T1")
T2 = TypeVar("T2")

def argmax(a: SupportsArgmax[T1, T2], axis: T1) -> T2: ...

Now, when an ndarray instance is passed to the argmax function I'd expect the
return type to be int if axis=None and ndarray if axis=int(...), just as is
described in the ndarray.argmax method:

array: ndarray

# note: Revealed type is 'builtins.int*'
reveal_type(argmax(array, axis=None))

# error: Cannot infer type argument 1 of "argmax"
# note: Revealed type is 'Any'
reveal_type(argmax(array, axis=0))

As can be seen above, the expected behavior is indeed observed when passing
through the first ndarray.argmax overload, but the presence of any subsequent
overloads seems to be ignored. Swapping the two overloads in the original
ndarray.argmax method only serves to reverse the issue.

Expected Behavior

Mypy successfully infers the return type, regardless of whether the protocol should
extract it from the methods' first overload or any subsequent ones.

Actual Behavior

Mypy fails for any method overload overload beyond the first.

Your Environment

  • Mypy version used: mypy 0.782
  • Mypy command-line flags: --show-error-codes (including or excluding --strict makes no difference here)
  • Mypy configuration options from mypy.ini (and other config files): n.a.
  • Python version used: Python 3.8.5
  • Operating system and version: macOS 10.15.6

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 reproducing the minimal Protocol and overloaded ndarray.argmax example from the issue with mypy, checking both reveal_type calls and the reported inference error. Trace the type-checking path for protocol method compatibility and overloaded method selection. Done means both axis=None and integer-axis calls infer the return types described in the overloads.

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.