How to check for NaN values
Asked Answered
P

19

1641

float('nan') represents NaN (not a number). But how do I check for it?

Pillowcase answered 3/6, 2009 at 13:19 Comment(2)
For some history of NaN in Python, see PEP 754. python.org/dev/peps/pep-0754Peculiar
just for fun, NaN is a Number: isinstance(float("nan"), Number) ;-PKliber
A
2097

Use math.isnan:

>>> import math
>>> x = float('nan')
>>> math.isnan(x)
True
Aldora answered 3/6, 2009 at 13:24 Comment(15)
Note that this works equally well with float("nan") as it does with numpy.core.numeric.NaN, while comparing the two with is does not work. Hence this might be the preferrable solution in (legacy?) code possibly containing both definitions, if I'm not mistaken?Mide
I got an error with the above code. Is it because of python 3? However, numpy.isnan(float('nan')) did work. Why would I use math instead of numpy?Rationale
@charlie-parker : In Python3, math.isnan is still a part of the math module. docs.python.org/3/library/math.html#math.isnan . Use numpy.isnan if you wish, this answer is just a suggestion.Aldora
@ SittingBull See docs.python.org/3/library/functions.html#float "If the argument is a string, it should contain a decimal number", or "Infinity" "inf" "nan"Aldora
Note: Only works with float; throws a TypeError when x is a str.Octahedrite
is math.isnan preferred to np.isnan() ?Fogbound
@Fogbound possibly... import numpy takes around 15 MB of RAM, whereas import math takes some 0,2 MBDansby
@Joel: Strings aren't numbers. You shouldn't be passing a string to this check at all. This is a check for floating-point NaN values. Also, isdigit is not a check for numbers. For example, '1.0'.isdigit() produces False.Frap
@TMWP: If you're using NumPy, numpy.isnan is a superior choice, as it handles NumPy arrays. If you're not using NumPy, there's no benefit to taking a NumPy dependency and spending the time to load NumPy just for a NaN check (but if you're writing the kind of code that does NaN checks, it's likely you should be using NumPy).Frap
@jungwook That actually doesn't work. Your expression is always false. That is, float('nan') == float('nan') returns False — which is a strange convention, but basically part of the definition of a NaN. The approach you want is actually the one posted by Chris Jester-Young, below.Paige
math.isnan seems to be faster than np.isnan (about 20 times on my machine)Timpani
@kotrfa: Only if you call it on an individual scalar, and if you're doing that a lot in NumPy, you're using NumPy wrong. Using NumPy effectively is all about doing whole-array operations. Calling numpy.isnan on a large array is faster than using math.isnan by a factor of over 200.Frap
@Fogbound no need to import the whole module one can just do from numpy import isnanNegotiation
why NaN == NaN returns False?Fayina
@ORHANERDAY Because by definition, NaN != x for every x. Which means you can do x=float('nan'); if x != x: print("it's not a number")Gifford
G
599

The usual way to test for a NaN is to see if it's equal to itself:

def isNaN(num):
    return num != num
Goebbels answered 3/6, 2009 at 13:22 Comment(15)
Word of warning: quoting Bear's comment below "For people stuck with python <= 2.5. Nan != Nan did not work reliably. Used numpy instead." Having said that, I've not actually ever seen it fail.Antevert
I'm sure that, given operator overloading, there are lots of ways I could confuse this function. go with math.isnan()Carbrey
It says in the 754 spec mentioned above that NaN==NaN should always be false, although it is not always implemented as such. Isn't is possible this is how math and/or numpy check this under the hood anyway?Untruthful
Thanks . this is also 15-20x times faster than using np.isnan if doing operation on a scalarGrape
Even though this works and, to a degree makes sense, I'm a human with principles and I hereby declare this as prohibited witchcraft. Please use math.isnan instead.Skepticism
@Carbrey Is there any other drawback to confusion? math.isnan() can't check string values, so this solution seems more robust.Hispid
math.isnan(x) requires x to be a real number, incurring the overhead of verifying the type of x (and possibly converting x to a real number) before you can even check for NaN. x != x is succinct and robust -- bravo!Trough
If your input includes strings this is the correct answer. (@williamtorkington) np.isnan and math.isnan will both break in this case.Terzas
This answer is awful; it relies on nan being the only thing in the universe not equal to itself. AT THE VERY LEAST it should be return isinstance(num, float) and num != num. The overhead of verifying the type is better than the possibility of actually being wrong, which this can be.Yeomanry
@Trough This is more succinct but it's hardly robust. Type checking is necessary to be accurate, and if someone is so concerned about the minimal overhead of checking the type (no conversion is necessary) than they shouldn't be using Python.Yeomanry
This solution is the fastest. It beats numpy, pandas and math libraries.Denni
This solution violates #2 in PEP-20: Explicit is better than implicit. It will fail if __eq__ is defined as constant False for some abstract type and of course should have a type check. Otherwise I would say that "some string" is also Not A Number (and even doesn't have NaN or not-NaN semantics at all).Wohlen
I'm guessing this fails to produce a value for signaling NaN's.Kieger
That is not always true. ``` In [1]: class LOL: ...: def __eq__(self, other): ...: return False ...: In [2]: x = LOL() In [3]: x == x Out[3]: False ```Bigamy
If you define __eq__ to produce nonsense this function will indeed produce nonsense but that is not the fault of this function. And NaN refers to certain values in float, a string or anything non-float should never be considered NaN even though it is "not a number" in some sense. That being said I would still prefer np or math for this problem.Wheelbase
A
289

numpy.isnan(number) tells you if it's NaN or not.

Antevert answered 3/6, 2009 at 13:28 Comment(10)
Works in python version 2.7 too.Rainout
numpy.all(numpy.isnan(data_list)) is also useful if you need to determine if all elements in the list are nanPlanimeter
No need for NumPy: all(map(math.isnan, [float("nan")]*5))Toback
When this answer was written 6 years ago, Python 2.5 was still in common use - and math.isnan was not part of the standard library. Now days I'm really hoping that's not the case in many places!Antevert
This is also useful if you're using numpy and don't want to import math.Heterogeneous
note that np.isnan() doesn't handle decimal.Decimal type (as many numpy's function). math.isnan() does handle.Boyfriend
I prefer this to the accepted answer, because numpy.isnan can handle arrays while math.isnan throws: TypeError: only size-1 arrays can be converted to Python scalars.Hyland
@comte: If you're using Decimal, you should use d.is_nan() instead of math.isnan(d). Feeding Decimal instances to math functions is a bad habit to get into, because most math functions will convert the input to float and defeat the point of using Decimal in the first place.Frap
np.isnan('foo') causes a TypeError exception because it can't handle strings. Use pd.isna() instead, if you need to handle strings, and are already using Pandas . That can handle float('nan') as well as strings.Analytic
This should be the accepted answer since numpy is much more common than math lib.Fasciation
S
243

Here are three ways where you can test a variable is "NaN" or not.

import pandas as pd
import numpy as np
import math

# For single variable all three libraries return single boolean
x1 = float("nan")

print(f"It's pd.isna: {pd.isna(x1)}")
print(f"It's np.isnan: {np.isnan(x1)}}")
print(f"It's math.isnan: {math.isnan(x1)}}")

Output:

It's pd.isna: True
It's np.isnan: True
It's math.isnan: True
Shindig answered 3/3, 2019 at 8:38 Comment(7)
pd.isna(value) saved a lot of troubles! working like a charm!Manipulate
pd.isnan() or pd.isna()? That is the question :DWorkingwoman
version 3 of this answer was correct and well formatted. this one (now 7) is wrong again. rolled back as "dont want your edit" while the edits improved the answer, wtf.Chishima
side note I have found if not np.isnan(x): to be quite useful.Venturous
pd.isna('foo') is also the only one that can handle strings. np.isnan('foo') and math.isnan('foo') will result in TypeError exception.Analytic
parse to int or float before calling functionShindig
Careful, Pandas "NA" isn't just NaN. E.g. pd.isna(None) is also True.Erepsin
E
61

It seems that checking if it's equal to itself (x != x) is the fastest.

import pandas as pd 
import numpy as np 
import math 

x = float('nan')

%timeit x != x
44.8 ns ± 0.152 ns per loop (mean ± std. dev. of 7 runs, 10000000 loops each)

%timeit math.isnan(x)
94.2 ns ± 0.955 ns per loop (mean ± std. dev. of 7 runs, 10000000 loops each)

%timeit pd.isna(x)
281 ns ± 5.48 ns per loop (mean ± std. dev. of 7 runs, 1000000 loops each)

%timeit np.isnan(x)
1.38 µs ± 15.7 ns per loop (mean ± std. dev. of 7 runs, 1000000 loops each)
Exequies answered 3/6, 2020 at 11:40 Comment(5)
It's worthwhile noting that this works even if infinities are in question. That is, if z = float('inf'), z != z evaluates to false.Ostracon
in my computer z=float('inf') and then z==z give True. x=float('nan') and then x==x give False.Ketonuria
In most (if not all) cases, these speed differences will only be relevant, if repeated numerous times. Then you'll be using numpy or another tensor library, anyway.Alicaalicante
This is a bad comparison. At this scale (nanoseconds) name and attribute lookup time are significant. If you use only local names, the difference between x != x and math.isnan(x) disappears; they're both about 35 ns on my system. You can use %timeit in cell mode to check: 1) %%timeit x = float('nan') <newline> x != x 2) %%timeit x = float('nan'); from math import isnan <newline> isnan(x)Erepsin
Careful: These timings only represent checking a pre-existing variable and do not generalise well. A function such as math.isnan will compete very differently when a function is actually required and x != x would need wrapping in a lambda. A numpy functionality such as numpy.isnan will compete very differently when applied to a numpy array where x != x would require iteration.Overmantel
B
49

here is an answer working with:

  • NaN implementations respecting IEEE 754 standard
    • ie: python's NaN: float('nan'), numpy.nan...
  • any other objects: string or whatever (does not raise exceptions if encountered)

A NaN implemented following the standard, is the only value for which the inequality comparison with itself should return True:

def is_nan(x):
    return (x != x)

And some examples:

import numpy as np
values = [float('nan'), np.nan, 55, "string", lambda x : x]
for value in values:
    print(f"{repr(value):<8} : {is_nan(value)}")

Output:

nan      : True
nan      : True
55       : False
'string' : False
<function <lambda> at 0x000000000927BF28> : False
Batfish answered 24/5, 2017 at 9:40 Comment(8)
The series I'm checking is strings with missing values are 'nans' (???) so this solution works where others failed.Fabrikoid
numpy.nan is a regular Python float object, just like the kind returned by float('nan'). Most NaNs you encounter in NumPy will not be the numpy.nan object.Frap
numpy.nan defines its NaN value on its own in the underlying library in C. It does not wrap python's NaN. But now, they both comply with IEEE 754 standard as they rely on C99 API.Batfish
@user2357112supportsMonica: Python and numpy NaN actually don't behave the same way: float('nan') is float('nan') (non-unique) and np.nan is np.nan (unique)Batfish
@x0s: That has nothing to do with NumPy. np.nan is a specific object, while each float('nan') call produces a new object. If you did nan = float('nan'), then you'd get nan is nan too. If you constructed an actual NumPy NaN with something like np.float64('nan'), then you'd get np.float64('nan') is not np.float64('nan') too.Frap
@x0s: Those macros you're looking at in the source are a completely unrelated C-level thing. They're used in NumPy C code to get C-level NaNs, which are completely different from regular Python NaNs or NumPy array scalar NaNs.Frap
It's important to understand that you cannot assume all NumPy NaNs are numpy.nan. Even numpy.array([numpy.nan])[0] is not numpy.nan.Frap
@user2357112supportsMonica: Thanks for your insights and supporting examples. I'll update the answer.Batfish
A
33

I actually just ran into this, but for me it was checking for nan, -inf, or inf. I just used

if float('-inf') < float(num) < float('inf'):

This is true for numbers, false for nan and both inf, and will raise an exception for things like strings or other types (which is probably a good thing). Also this does not require importing any libraries like math or numpy (numpy is so damn big it doubles the size of any compiled application).

Afterward answered 25/9, 2012 at 18:22 Comment(2)
math.isfinite was not introduced until Python 3.2, so given the answer from @Afterward was posted in 2012 it was not exactly "reinvent[ing] the wheel" - solution still stands for those working with Python 2.Selfoperating
This can be useful for people who need to check for NaN in a pd.eval expression. For example pd.eval(float('-inf') < float('nan') < float('inf')) will return FalseOriana
E
28

math.isnan()

or compare the number to itself. NaN is always != NaN, otherwise (e.g. if it is a number) the comparison should succeed.

Elmore answered 3/6, 2009 at 13:24 Comment(1)
For people stuck with python <= 2.5. Nan != Nan did not work reliably. Used numpy instead.Companionable
D
27

Well I entered this post, because i've had some issues with the function:

math.isnan()

There are problem when you run this code:

a = "hello"
math.isnan(a)

It raises exception. My solution for that is to make another check:

def is_nan(x):
    return isinstance(x, float) and math.isnan(x)
Destefano answered 4/7, 2012 at 20:15 Comment(5)
It was probably downvoted because isnan() takes a float, not a string. There's nothing wrong with the function, and the problems are only in his attempted use of it. (For that particular use case his solution is valid, but it's not an answer to this question.)Hydrostatics
Be careful with checking for types in this way. This will not work e.g. for numpy.float32 NaN's. Better to use a try/except construction: def is_nan(x): try: return math.isnan(x) except: return FalseInoculation
NaN does not mean that a value is not a valid number. It is part of IEEE floating point representation to specify that a particular result is undefined. e.g. 0 / 0. Therefore asking if "hello" is nan is meaningless.Ulita
this is better because NaN can land in any list of strings,ints or floats, so useful checkAmimia
I had to implement exactly this for handling string columns in pandas.Jardiniere
E
17

Another method if you're stuck on <2.6, you don't have numpy, and you don't have IEEE 754 support:

def isNaN(x):
    return str(x) == str(1e400*0)
Egomania answered 26/1, 2010 at 9:10 Comment(0)
H
10

With python < 2.6 I ended up with

def isNaN(x):
    return str(float(x)).lower() == 'nan'

This works for me with python 2.5.1 on a Solaris 5.9 box and with python 2.6.5 on Ubuntu 10

Hyperaesthesia answered 17/6, 2010 at 8:35 Comment(1)
This isn't too portable, as Windows sometimes calls this -1.#INDFolacin
A
9

Comparison pd.isna, math.isnan and np.isnan and their flexibility dealing with different type of objects.

The table below shows if the type of object can be checked with the given method:


+------------+-----+---------+------+--------+------+
|   Method   | NaN | numeric | None | string | list |
+------------+-----+---------+------+--------+------+
| pd.isna    | yes | yes     | yes  | yes    | yes  |
| math.isnan | yes | yes     | no   | no     | no   |
| np.isnan   | yes | yes     | no   | no     | yes  | <-- # will error on mixed type list
+------------+-----+---------+------+--------+------+

pd.isna

The most flexible method to check for different types of missing values.


None of the answers cover the flexibility of pd.isna. While math.isnan and np.isnan will return True for NaN values, you cannot check for different type of objects like None or strings. Both methods will return an error, so checking a list with mixed types will be cumbersom. This while pd.isna is flexible and will return the correct boolean for different kind of types:

In [1]: import pandas as pd

In [2]: import numpy as np

In [3]: missing_values = [3, None, np.NaN, pd.NA, pd.NaT, '10']

In [4]: pd.isna(missing_values)
Out[4]: array([False,  True,  True,  True,  True, False])
Anetteaneurin answered 28/6, 2021 at 19:13 Comment(1)
This!!!! I came here trying to figure out how to check for both NaN and None, which depending on user input excel sheets I could get either. If it weren't for those pesky users this would be easy!Telpherage
R
7

I am receiving the data from a web-service that sends NaN as a string 'Nan'. But there could be other sorts of string in my data as well, so a simple float(value) could throw an exception. I used the following variant of the accepted answer:

def isnan(value):
  try:
      import math
      return math.isnan(float(value))
  except:
      return False

Requirement:

isnan('hello') == False
isnan('NaN') == True
isnan(100) == False
isnan(float('nan')) = True
Remotion answered 23/6, 2016 at 8:22 Comment(5)
or try: int(value)Fridafriday
@Fridafriday so what does your suggestion tell about value being NaN or not?Remotion
Well, being "not a number", anything that can not be casted to an int I guess is in fact not a number, and the try statement will fail? Try, return true, except return false.Fridafriday
@Fridafriday Well, taking "not a number" literally, you are right, but that's not the point here. In fact, I am looking exactly for what the semantics of NaN is (like in python what you could get from float('inf') * 0), and thus although the string 'Hello' is not a number, but it is also not NaN because NaN is still a numeric value!Remotion
@chwi: You are correct, if exception handling is for specific exception. But in this answer, generic exception have been handled. So no need to check int(value) For all exception, False will be written.Cid
B
4

All the methods to tell if the variable is NaN or None:

None type

In [1]: from numpy import math

In [2]: a = None
In [3]: not a
Out[3]: True

In [4]: len(a or ()) == 0
Out[4]: True

In [5]: a == None
Out[5]: True

In [6]: a is None
Out[6]: True

In [7]: a != a
Out[7]: False

In [9]: math.isnan(a)
Traceback (most recent call last):
  File "<ipython-input-9-6d4d8c26d370>", line 1, in <module>
    math.isnan(a)
TypeError: a float is required

In [10]: len(a) == 0
Traceback (most recent call last):
  File "<ipython-input-10-65b72372873e>", line 1, in <module>
    len(a) == 0
TypeError: object of type 'NoneType' has no len()

NaN type

In [11]: b = float('nan')
In [12]: b
Out[12]: nan

In [13]: not b
Out[13]: False

In [14]: b != b
Out[14]: True

In [15]: math.isnan(b)
Out[15]: True
Bostwick answered 7/12, 2016 at 6:49 Comment(0)
T
4

How to remove NaN (float) item(s) from a list of mixed data types

If you have mixed types in an iterable, here is a solution that does not use numpy:

from math import isnan

Z = ['a','b', float('NaN'), 'd', float('1.1024')]

[x for x in Z if not (
                      type(x) == float # let's drop all float values…
                      and isnan(x) # … but only if they are nan
                      )]
['a', 'b', 'd', 1.1024]

Short-circuit evaluation means that isnan will not be called on values that are not of type 'float', as False and (…) quickly evaluates to False without having to evaluate the right-hand side.

Toback answered 28/1, 2019 at 6:53 Comment(0)
S
4

In Python 3.6 checking on a string value x math.isnan(x) and np.isnan(x) raises an error. So I can't check if the given value is NaN or not if I don't know beforehand it's a number. The following seems to solve this issue

if str(x)=='nan' and type(x)!='str':
    print ('NaN')
else:
    print ('non NaN')
Scathe answered 13/1, 2020 at 19:2 Comment(0)
G
1

For nan of type float

>>> import pandas as pd
>>> value = float(nan)
>>> type(value)
>>> <class 'float'>
>>> pd.isnull(value)
True
>>>
>>> value = 'nan'
>>> type(value)
>>> <class 'str'>
>>> pd.isnull(value)
False
Gladysglagolitic answered 17/7, 2018 at 4:57 Comment(0)
T
0

If you want to check for values that are not NaN, then negate whatever is used to flag NaNs; pandas has its own dedicated function for flagging non-NaN values.

lst = [1, 2, float('nan')]

m1 = [e == e for e in lst]              # [True, True, False]

m2 = [not math.isnan(e) for e in lst]   # [True, True, False]

m3 = ~np.isnan(lst)                     # array([ True,  True, False])

m4 = pd.notna(lst)                      # array([ True,  True, False])

This is especially useful if you want to filter values that are not NaN. For ndarray/Series objects, == is vectorized, so it can be used as well.

s = pd.Series(lst)
arr = np.array(lst)

x = s[s.notna()]
y = s[s==s]                             # `==` is vectorized
z = arr[~np.isnan(arr)]                 # array([1., 2.])

assert (x == y).all() and (x == z).all()
Tinfoil answered 13/7, 2023 at 23:29 Comment(0)
P
-5

for strings in panda take pd.isnull:

if not pd.isnull(atext):
  for word in nltk.word_tokenize(atext):

the function as feature extraction for NLTK

def act_features(atext):
features = {}
if not pd.isnull(atext):
  for word in nltk.word_tokenize(atext):
    if word not in default_stopwords:
      features['cont({})'.format(word.lower())]=True
return features
Physician answered 17/7, 2018 at 13:3 Comment(2)
What for this reduction?Physician
isnull returns true for not just NaN values.Eraeradiate

© 2022 - 2024 — McMap. All rights reserved.