How to annotate python function with different return type based on parameters?

There are some cases when a function will return different type based on the parameter input.

A simple example could be

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>from typing import Union
def func(is_str: bool) -> Union[str, int]:
if is_str:
return "string"
else:
return 42
a:int = func(is_str=False)
</code>
<code>from typing import Union def func(is_str: bool) -> Union[str, int]: if is_str: return "string" else: return 42 a:int = func(is_str=False) </code>
from typing import Union

def func(is_str: bool) -> Union[str, int]:
    if is_str:
        return "string"
    else:
        return 42


a:int = func(is_str=False)

For pylint, it will raise a warning:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>Type "str | int" is not assignable to declared type "int".
</code>
<code>Type "str | int" is not assignable to declared type "int". </code>
Type "str | int" is not assignable to declared type "int".

I wonder what is the best practice for circumstances like this.


What I tried

One suggested way is to rewrite the function with decorator @overload, but this scenario also happens for some package dependencies, when the function body is relative long (e.g. a function handling network request, and decide whether to return a json type(response.json()) or a string(response.text).)


Another way for this is

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>from typing import TypeVar
T = TypeVar('T')
def func(return_type:T = str) -> T:
if return_type is str:
return "string"
else:
return 42
</code>
<code>from typing import TypeVar T = TypeVar('T') def func(return_type:T = str) -> T: if return_type is str: return "string" else: return 42 </code>
from typing import TypeVar

T = TypeVar('T')

def func(return_type:T = str) -> T:
    if return_type is str:
        return "string"
    else:
        return 42

That would also raise some warnings.

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>Type "Literal[string]" is not assignable to type "T@func"
Type "Literal[42]" is not assignable to type "T@func"
</code>
<code>Type "Literal[string]" is not assignable to type "T@func" Type "Literal[42]" is not assignable to type "T@func" </code>
Type "Literal[string]" is not assignable to type "T@func"
Type "Literal[42]" is not assignable to type "T@func"

Is is possible to avoid the warning without modification the function?


Another approach for solving this would be:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code>from typing import Union
def func(is_str: bool) -> Union[str, int]:
if is_str:
return "string"
else:
return 42
a:Union[str, int] = func(is_str=False)
if isinstance(a, str):
raise TypeError('parameter a should be an integer.')
</code>
<code>from typing import Union def func(is_str: bool) -> Union[str, int]: if is_str: return "string" else: return 42 a:Union[str, int] = func(is_str=False) if isinstance(a, str): raise TypeError('parameter a should be an integer.') </code>
from typing import Union

def func(is_str: bool) -> Union[str, int]:
    if is_str:
        return "string"
    else:
        return 42

a:Union[str, int] = func(is_str=False)

if isinstance(a, str):
    raise TypeError('parameter a should be an integer.')

So that variable a will be considered an integer for pylint in later code.

this practice is needed when the code is long, but for short code cases, it is just obvious, and write the checking can be tiring especially when calling the function multiple times.

New contributor

YLEE is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.

3

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