Caveats and Gotchas

NaN, Integer NA values and NA type promotions

Choice of NA representation

For lack of NA (missing) support from the ground up in NumPy and Python in general, we were given the difficult choice between either

• A masked array solution: an array of data and an array of boolean values indicating whether a value
• Using a special sentinel value, bit pattern, or set of sentinel values to denote NA across the dtypes

For many reasons we chose the latter. After years of production use it has proven, at least in my opinion, to be the best decision given the state of affairs in NumPy and Python in general. The special value NaN (Not-A-Number) is used everywhere as the NA value, and there are API functions isnull and notnull which can be used across the dtypes to detect NA values.

However, it comes with it a couple of trade-offs which I most certainly have not ignored.

Support for integer NA

In the absence of high performance NA support being built into NumPy from the ground up, the primary casualty is the ability to represent NAs in integer arrays. For example:

In [347]: s = Series([1, 2, 3, 4, 5], index=list('abcde'))

In [348]: s
Out[348]: 
a    1
b    2
c    3
d    4
e    5

In [349]: s.dtype
Out[349]: dtype('int64')

In [350]: s2 = s.reindex(['a', 'b', 'c', 'f', 'u'])

In [351]: s2
Out[351]: 
a     1
b     2
c     3
f   NaN
u   NaN

In [352]: s2.dtype
Out[352]: dtype('float64')

This trade-off is made largely for memory and performance reasons, and also so that the resulting Series continues to be “numeric”. One possibility is to use dtype=object arrays instead.

NA type promotions

When introducing NAs into an existing Series or DataFrame via reindex or some other means, boolean and integer types will be promoted to a different dtype in order to store the NAs. These are summarized by this table:

Typeclass	Promotion dtype for storing NAs
floating	no change
object	no change
integer	cast to float64
boolean	cast to object

While this may seem like a heavy trade-off, in practice I have found very few cases where this is an issue in practice. Some explanation for the motivation here in the next section.

Why not make NumPy like R?

Many people have suggested that NumPy should simply emulate the NA support present in the more domain-specific statistical programming langauge R. Part of the reason is the NumPy type hierarchy:

Typeclass	Dtypes
numpy.floating	float16, float32, float64, float128
numpy.integer	int8, int16, int32, int64
numpy.unsignedinteger	uint8, uint16, uint32, uint64
numpy.object_	object_
numpy.bool_	bool_
numpy.character	string_, unicode_

The R language, by contrast, only has a handful of built-in data types: integer, numeric (floating-point), character, and boolean. NA types are implemented by reserving special bit patterns for each type to be used as the missing value. While doing this with the full NumPy type hierarchy would be possible, it would be a more substantial trade-off (especially for the 8- and 16-bit data types) and implementation undertaking.

An alternate approach is that of using masked arrays. A masked array is an array of data with an associated boolean mask denoting whether each value should be considered NA or not. I am personally not in love with this approach as I feel that overall it places a fairly heavy burden on the user and the library implementer. Additionally, it exacts a fairly high performance cost when working with numerical data compared with the simple approach of using NaN. Thus, I have chosen the Pythonic “practicality beats purity” approach and traded integer NA capability for a much simpler approach of using a special value in float and object arrays to denote NA, and promoting integer arrays to floating when NAs must be introduced.

Integer indexing

Label-based slicing conventions

Non-monotonic indexes require exact matches

Endpoints are inclusive

Compared with standard Python sequence slicing in which the slice endpoint is not inclusive, label-based slicing in pandas is inclusive. The primary reason for this is that it is often not possible to easily the “successor” or next element after a particular label in an index. For example, consider the following Series:

In [353]: s = Series(randn(6), index=list('abcdef'))

In [354]: s
Out[354]: 
a    0.483368
b    0.186405
c   -1.439567
d   -0.503782
e    0.890769
f   -0.777798

Suppose we wished to slice from c to e, using integers this would be

In [355]: s[2:5]
Out[355]: 
c   -1.439567
d   -0.503782
e    0.890769

However, if you only had c and e, determining the next element in the index can be somewhat complicated. For example, the following does not work:

s.ix['c':'e'+1]

A very common use case is to limit a time series to start and end at two specific dates. To enable this, we made the design design to make label-based slicing include both endpoints:

In [356]: s.ix['c':'e']
Out[356]: 
c   -1.439567
d   -0.503782
e    0.890769

This is most definitely a “practicality beats purity” sort of thing, but it is something to watch out for is you expect label-based slicing to behave exactly in the way that standard Python integer slicing works.

Miscellaneous indexing gotchas

Reindex versus ix gotchas

Many users will find themselves using the ix indexing capabilities as a concise means of selecting data from a pandas object:

In [357]: df = DataFrame(randn(6, 4), columns=['one', 'two', 'three', 'four'],
   .....:                index=list('abcdef'))

In [358]: df
Out[358]: 
        one       two     three      four
a -0.552820 -1.428744  0.597468 -0.491240
b  1.281674 -0.099685 -1.823043 -0.779213
c -0.949327  0.768043 -0.054860 -1.493561
d  0.106004 -0.903513 -0.719875  0.301945
e  1.112546 -0.542770 -2.695540  0.431284
f -0.431092  1.666631  0.716659 -0.919717

In [359]: df.ix[['b', 'c', 'e']]
Out[359]: 
        one       two     three      four
b  1.281674 -0.099685 -1.823043 -0.779213
c -0.949327  0.768043 -0.054860 -1.493561
e  1.112546 -0.542770 -2.695540  0.431284

This is, of course, completely equivalent in this case to using th reindex method:

In [360]: df.reindex(['b', 'c', 'e'])
Out[360]: 
        one       two     three      four
b  1.281674 -0.099685 -1.823043 -0.779213
c -0.949327  0.768043 -0.054860 -1.493561
e  1.112546 -0.542770 -2.695540  0.431284

Some might conclude that ix and reindex are 100% equivalent based on this. This is indeed true except in the case of integer indexing. For example, the above operation could alternately have been expressed as:

In [361]: df.ix[[1, 2, 4]]
Out[361]: 
        one       two     three      four
b  1.281674 -0.099685 -1.823043 -0.779213
c -0.949327  0.768043 -0.054860 -1.493561
e  1.112546 -0.542770 -2.695540  0.431284

If you pass [1, 2, 4] to reindex you will get another thing entirely:

In [362]: df.reindex([1, 2, 4])
Out[362]: 
   one  two  three  four
1  NaN  NaN    NaN   NaN
2  NaN  NaN    NaN   NaN
4  NaN  NaN    NaN   NaN

So it’s important to remember that reindex is strict label indexing only. This can lead to some potentially surprising results in pathological cases where an index contains, say, both integers and strings:

In [363]: s = Series([1, 2, 3], index=['a', 0, 1])

In [364]: s
Out[364]: 
a    1
0    2
1    3

In [365]: s.ix[[0, 1]]
Out[365]: 
a    1
0    2

In [366]: s.reindex([0, 1])
Out[366]: 
0    2
1    3

Because the index in this case does not contain solely integers, ix falls back on integer indexing. By contrast, reindex only looks for the values passed in the index, thus finding the integers 0 and 1. While it would be possible to insert some logic to check whether a passed sequence is all contained in the index, that logic would exact a very high cost in large data sets.