You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The bug function below has a bug: the else branch will execute both when x is None and when it is empty, and the latter is unexpected. The programmer was hoping "" would be handled by the if branch.
It'd be handy if Mypy could (optionally) flag this sort of mistake, to help reminder the programmer that they probably should write something like fixed, i.e. take optional values like None | str as expressing intent that "" should behave differently to None.
defbug(x: None|str):
ifx: # error: None and strprint(f"the str value is {x}")
else:
print("the value is None")
deffixed(x: None|int):
ifxisnotNone: # no errorprint(f"the int value is {x}")
else:
print("the value is None")
This also applies to:
built-ins like bool, float, int, list, dict, set (etc)
any "truthy" types, that implement __bool__ or __len__
arguably, type variables that could be substituted with any of those types (e.g. def bug[T](x: None | T) called like bug(""))
Pitch
It's very easy to write if x: out of habit when handling strings, lists and any other type with falsey values. When None is involved, this can lead to unexpected behaviour, where the falsey values like [], 0, "", {} are handled like None.
Mypy is very well positioned to catch this mistake given it has full type info (and indeed linters without full type info cannot do so).
This is likely to have some false-positives, and so should be optional. It feels conceptually similar, to me, to truthy-bool.
I've sketched an incomplete implementation in #17893, that I can complete with agreement/guidance.
The text was updated successfully, but these errors were encountered:
Seems related to #16734, "Enforce [that] conditional values are booleans" ; although the idea of that issue is that every x in if x should actually have the type of bool, whereas your idea is (basically) that it's fine to use truthiness, just not if the type of x is a union with none (ie, an optional). Both ideas make sense to me as checks one might reasonably want to have.
Feature
The
bug
function below has a bug: theelse
branch will execute both whenx
is None and when it is empty, and the latter is unexpected. The programmer was hoping""
would be handled by theif
branch.It'd be handy if Mypy could (optionally) flag this sort of mistake, to help reminder the programmer that they probably should write something like
fixed
, i.e. take optional values likeNone | str
as expressing intent that""
should behave differently toNone
.This also applies to:
bool
,float
,int
,list
,dict
,set
(etc)__bool__
or__len__
def bug[T](x: None | T)
called likebug("")
)Pitch
It's very easy to write
if x:
out of habit when handling strings, lists and any other type with falsey values. WhenNone
is involved, this can lead to unexpected behaviour, where the falsey values like[]
,0
,""
,{}
are handled likeNone
.Mypy is very well positioned to catch this mistake given it has full type info (and indeed linters without full type info cannot do so).
This is likely to have some false-positives, and so should be optional. It feels conceptually similar, to me, to
truthy-bool
.I've sketched an incomplete implementation in #17893, that I can complete with agreement/guidance.
The text was updated successfully, but these errors were encountered: