How to use overload from the typing package within a higher-order function in Python?

Returning an overloaded function from a higher-order callable does not produce expected results with respect to type hints: namely, the resulting function behaves as if it was unannotated at all.

Here a minimal example:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>from typing import Optional, overload
def get_f(b: int):
@overload
def f(x: int) -> str: ...
@overload
def f(x: int, c: bool) -> int: ...
def f(x: int, c: Optional[bool] = None) -> int | str:
return 2 * x * b if c is not None else "s"
return f
d = get_f(2)
a = d(2)
b = a ** 2
</code>
<code>from typing import Optional, overload def get_f(b: int): @overload def f(x: int) -> str: ... @overload def f(x: int, c: bool) -> int: ... def f(x: int, c: Optional[bool] = None) -> int | str: return 2 * x * b if c is not None else "s" return f d = get_f(2) a = d(2) b = a ** 2 </code>
from typing import Optional, overload


def get_f(b: int):
    @overload
    def f(x: int) -> str: ...

    @overload
    def f(x: int, c: bool) -> int: ...

    def f(x: int, c: Optional[bool] = None) -> int | str:
        return 2 * x * b if c is not None else "s"

    return f


d = get_f(2)
a = d(2)
b = a ** 2

Here mypy does not realize that b = a**2 leads to an TypeError. How to remedy this?

4

You can create a type denoting an overloaded callable using typing.Protocol (read the PEP to learn more about structural subtyping):

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>from typing import Optional, Protocol, overload
class FProtocol(Protocol):
@overload
def __call__(self, x: int) -> str: ...
@overload
def __call__(self, x: int, c: bool) -> int: ...
def get_f(b: int) -> FProtocol:
@overload
def f(x: int) -> str: ...
@overload
def f(x: int, c: bool) -> int: ...
def f(x: int, c: Optional[bool] = None) -> int | str:
return 2 * x * b if c is not None else "s"
return f
d = get_f(2)
a = d(2)
b = a ** 2 # E: Unsupported operand types for ** ("str" and "int") [operator]
</code>
<code>from typing import Optional, Protocol, overload class FProtocol(Protocol): @overload def __call__(self, x: int) -> str: ... @overload def __call__(self, x: int, c: bool) -> int: ... def get_f(b: int) -> FProtocol: @overload def f(x: int) -> str: ... @overload def f(x: int, c: bool) -> int: ... def f(x: int, c: Optional[bool] = None) -> int | str: return 2 * x * b if c is not None else "s" return f d = get_f(2) a = d(2) b = a ** 2 # E: Unsupported operand types for ** ("str" and "int") [operator] </code>
from typing import Optional, Protocol, overload


class FProtocol(Protocol):
    @overload
    def __call__(self, x: int) -> str: ...
    @overload
    def __call__(self, x: int, c: bool) -> int: ...
    

def get_f(b: int) -> FProtocol:
    @overload
    def f(x: int) -> str: ...

    @overload
    def f(x: int, c: bool) -> int: ...

    def f(x: int, c: Optional[bool] = None) -> int | str:
        return 2 * x * b if c is not None else "s"

    return f


d = get_f(2)
a = d(2)
b = a ** 2  # E: Unsupported operand types for ** ("str" and "int")  [operator]

mypy playground pyright playground

Using protocol is the only way to specify an overloaded callable, as far as I know.

When you leave the return type unspecified, it defaults to Any, as PEP484 mandates:

For a checked function, the default annotation for arguments and for the return type is Any

Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa Dịch vụ tổ chức sự kiện 5 sao Thông tin về chúng tôi Dịch vụ sinh nhật bé trai Dịch vụ sinh nhật bé gái Sự kiện trọn gói Các tiết mục giải trí Dịch vụ bổ trợ Tiệc cưới sang trọng Dịch vụ khai trương Tư vấn tổ chức sự kiện Hình ảnh sự kiện Cập nhật tin tức Liên hệ ngay Thuê chú hề chuyên nghiệp Tiệc tất niên cho công ty Trang trí tiệc cuối năm Tiệc tất niên độc đáo Sinh nhật bé Hải Đăng Sinh nhật đáng yêu bé Khánh Vân Sinh nhật sang trọng Bích Ngân Tiệc sinh nhật bé Thanh Trang Dịch vụ ông già Noel Xiếc thú vui nhộn Biểu diễn xiếc quay đĩa Dịch vụ tổ chức tiệc uy tín Khám phá dịch vụ của chúng tôi Tiệc sinh nhật cho bé trai Trang trí tiệc cho bé gái Gói sự kiện chuyên nghiệp Chương trình giải trí hấp dẫn Dịch vụ hỗ trợ sự kiện Trang trí tiệc cưới đẹp Khởi đầu thành công với khai trương Chuyên gia tư vấn sự kiện Xem ảnh các sự kiện đẹp Tin mới về sự kiện Kết nối với đội ngũ chuyên gia Chú hề vui nhộn cho tiệc sinh nhật Ý tưởng tiệc cuối năm Tất niên độc đáo Trang trí tiệc hiện đại Tổ chức sinh nhật cho Hải Đăng Sinh nhật độc quyền Khánh Vân Phong cách tiệc Bích Ngân Trang trí tiệc bé Thanh Trang Thuê dịch vụ ông già Noel chuyên nghiệp Xem xiếc khỉ đặc sắc Xiếc quay đĩa thú vị
Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa
Thiết kế website Thiết kế website Thiết kế website Cách kháng tài khoản quảng cáo Mua bán Fanpage Facebook Dịch vụ SEO Tổ chức sinh nhật