Essential Basic Functionality¶

Here we discuss a lot of the essential functionality common to the pandas data structures. Here’s how to create some of the objects used in the examples from the previous section:

In [1]: index = date_range('1/1/2000', periods=8)

In [2]: s = Series(randn(5), index=['a', 'b', 'c', 'd', 'e'])

In [3]: df = DataFrame(randn(8, 3), index=index,
   ...:                columns=['A', 'B', 'C'])
   ...: 

In [4]: wp = Panel(randn(2, 5, 4), items=['Item1', 'Item2'],
   ...:            major_axis=date_range('1/1/2000', periods=5),
   ...:            minor_axis=['A', 'B', 'C', 'D'])
   ...: 

Head and Tail¶

To view a small sample of a Series or DataFrame object, use the head and tail methods. The default number of elements to display is five, but you may pass a custom number.

In [5]: long_series = Series(randn(1000))

In [6]: long_series.head()

0   -0.199038
1    1.095864
2   -0.200875
3    0.162291
4   -0.430489
dtype: float64

In [7]: long_series.tail(3)

997   -1.198693
998    1.238029
999   -1.344716
dtype: float64

Attributes and the raw ndarray(s)¶

pandas objects have a number of attributes enabling you to access the metadata

shape: gives the axis dimensions of the object, consistent with ndarray

Axis labels

Series: index (only axis)

DataFrame: index (rows) and columns

Panel: items, major_axis, and minor_axis

Note, these attributes can be safely assigned to!

In [8]: df[:2]

                   A         B         C
2000-01-01  0.232465 -0.789552 -0.364308
2000-01-02 -0.534541  0.822239 -0.443109
[2 rows x 3 columns]

In [9]: df.columns = [x.lower() for x in df.columns]

In [10]: df

                   a         b         c
2000-01-01  0.232465 -0.789552 -0.364308
2000-01-02 -0.534541  0.822239 -0.443109
2000-01-03 -2.119990 -0.460149  1.813962
2000-01-04 -1.053571  0.009412 -0.165966
2000-01-05 -0.848662 -0.495553 -0.176421
2000-01-06 -0.423595 -1.035433 -1.035374
2000-01-07 -2.369079  0.524408 -0.871120
2000-01-08  1.585433  0.039501  2.274101
[8 rows x 3 columns]

To get the actual data inside a data structure, one need only access the values property:

In [11]: s.values
array([ 1.1292,  0.2313, -0.1847, -0.1386, -0.9243])

In [12]: df.values

array([[ 0.2325, -0.7896, -0.3643],
       [-0.5345,  0.8222, -0.4431],
       [-2.12  , -0.4601,  1.814 ],
       [-1.0536,  0.0094, -0.166 ],
       [-0.8487, -0.4956, -0.1764],
       [-0.4236, -1.0354, -1.0354],
       [-2.3691,  0.5244, -0.8711],
       [ 1.5854,  0.0395,  2.2741]])

In [13]: wp.values

array([[[-1.1181,  0.4313,  0.5547, -1.3336],
        [-0.3322, -0.4859,  1.7259,  1.7993],
        [-0.9689, -0.7795, -2.0007, -1.8666],
        [-1.1013,  1.9575,  0.0589,  0.7581],
        [ 0.0766, -0.5485, -0.1605, -0.3778]],
       [[ 0.2499, -0.3413, -0.2726, -0.2774],
        [-1.1029,  0.1003, -1.6028,  0.9201],
        [-0.6439,  0.0603, -0.4349, -0.4943],
        [ 0.738 ,  0.4516,  0.3341, -0.7871],
        [ 0.6514, -0.7419,  1.1939, -2.3958]]])

If a DataFrame or Panel contains homogeneously-typed data, the ndarray can actually be modified in-place, and the changes will be reflected in the data structure. For heterogeneous data (e.g. some of the DataFrame’s columns are not all the same dtype), this will not be the case. The values attribute itself, unlike the axis labels, cannot be assigned to.

Note

When working with heterogeneous data, the dtype of the resulting ndarray will be chosen to accommodate all of the data involved. For example, if strings are involved, the result will be of object dtype. If there are only floats and integers, the resulting array will be of float dtype.

Accelerated operations¶

Pandas has support for accelerating certain types of binary numerical and boolean operations using the numexpr library (starting in 0.11.0) and the bottleneck libraries.

These libraries are especially useful when dealing with large data sets, and provide large speedups. numexpr uses smart chunking, caching, and multiple cores. bottleneck is a set of specialized cython routines that are especially fast when dealing with arrays that have nans.

Here is a sample (using 100 column x 100,000 row DataFrames):

Operation	0.11.0 (ms)	Prior Vern (ms)	Ratio to Prior
`df1 > df2`	13.32	125.35	0.1063
`df1 * df2`	21.71	36.63	0.5928
`df1 + df2`	22.04	36.50	0.6039

You are highly encouraged to install both libraries. See the section Recommended Dependencies for more installation info.

Flexible binary operations¶

With binary operations between pandas data structures, there are two key points of interest:

Broadcasting behavior between higher- (e.g. DataFrame) and lower-dimensional (e.g. Series) objects.

Missing data in computations

We will demonstrate how to manage these issues independently, though they can be handled simultaneously.

Matching / broadcasting behavior¶

DataFrame has the methods add, sub, mul, div and related functions radd, rsub, ... for carrying out binary operations. For broadcasting behavior, Series input is of primary interest. Using these functions, you can use to either match on the index or columns via the axis keyword:

In [14]: d = {'one' : Series(randn(3), index=['a', 'b', 'c']),
   ....:      'two' : Series(randn(4), index=['a', 'b', 'c', 'd']),
   ....:      'three' : Series(randn(3), index=['b', 'c', 'd'])}
   ....: 

In [15]: df = df_orig = DataFrame(d)

In [16]: df

        one     three       two
a -0.701368       NaN -0.087103
b  0.109333 -0.354359  0.637674
c -0.231617 -0.148387 -0.002666
d       NaN -0.167407  0.104044
[4 rows x 3 columns]

In [17]: row = df.ix[1]

In [18]: column = df['two']

In [19]: df.sub(row, axis='columns')

        one     three       two
a -0.810701       NaN -0.724777
b  0.000000  0.000000  0.000000
c -0.340950  0.205973 -0.640340
d       NaN  0.186952 -0.533630
[4 rows x 3 columns]

In [20]: df.sub(row, axis=1)

        one     three       two
a -0.810701       NaN -0.724777
b  0.000000  0.000000  0.000000
c -0.340950  0.205973 -0.640340
d       NaN  0.186952 -0.533630
[4 rows x 3 columns]

In [21]: df.sub(column, axis='index')

        one     three  two
a -0.614265       NaN    0
b -0.528341 -0.992033    0
c -0.228950 -0.145720    0
d       NaN -0.271451    0
[4 rows x 3 columns]

In [22]: df.sub(column, axis=0)

        one     three  two
a -0.614265       NaN    0
b -0.528341 -0.992033    0
c -0.228950 -0.145720    0
d       NaN -0.271451    0
[4 rows x 3 columns]

With Panel, describing the matching behavior is a bit more difficult, so the arithmetic methods instead (and perhaps confusingly?) give you the option to specify the broadcast axis. For example, suppose we wished to demean the data over a particular axis. This can be accomplished by taking the mean over an axis and broadcasting over the same axis:

In [23]: major_mean = wp.mean(axis='major')

In [24]: major_mean

      Item1     Item2
A -0.688773 -0.021497
B  0.114982 -0.094183
C  0.035674 -0.156470
D -0.204142 -0.606887
[4 rows x 2 columns]

In [25]: wp.sub(major_mean, axis='major')

<class 'pandas.core.panel.Panel'>
Dimensions: 2 (items) x 5 (major_axis) x 4 (minor_axis)
Items axis: Item1 to Item2
Major_axis axis: 2000-01-01 00:00:00 to 2000-01-05 00:00:00
Minor_axis axis: A to D

And similarly for axis="items" and axis="minor".

Note

I could be convinced to make the axis argument in the DataFrame methods match the broadcasting behavior of Panel. Though it would require a transition period so users can change their code...

Missing data / operations with fill values¶

In Series and DataFrame (though not yet in Panel), the arithmetic functions have the option of inputting a fill_value, namely a value to substitute when at most one of the values at a location are missing. For example, when adding two DataFrame objects, you may wish to treat NaN as 0 unless both DataFrames are missing that value, in which case the result will be NaN (you can later replace NaN with some other value using fillna if you wish).

In [26]: df

        one     three       two
a -0.701368       NaN -0.087103
b  0.109333 -0.354359  0.637674
c -0.231617 -0.148387 -0.002666
d       NaN -0.167407  0.104044
[4 rows x 3 columns]

In [27]: df2

        one     three       two
a -0.701368  1.000000 -0.087103
b  0.109333 -0.354359  0.637674
c -0.231617 -0.148387 -0.002666
d       NaN -0.167407  0.104044
[4 rows x 3 columns]

In [28]: df + df2

        one     three       two
a -1.402736       NaN -0.174206
b  0.218666 -0.708719  1.275347
c -0.463233 -0.296773 -0.005333
d       NaN -0.334814  0.208088
[4 rows x 3 columns]

In [29]: df.add(df2, fill_value=0)

        one     three       two
a -1.402736  1.000000 -0.174206
b  0.218666 -0.708719  1.275347
c -0.463233 -0.296773 -0.005333
d       NaN -0.334814  0.208088
[4 rows x 3 columns]

Flexible Comparisons¶

Starting in v0.8, pandas introduced binary comparison methods eq, ne, lt, gt, le, and ge to Series and DataFrame whose behavior is analogous to the binary arithmetic operations described above:

In [30]: df.gt(df2)

     one  three    two
a  False  False  False
b  False  False  False
c  False  False  False
d  False  False  False
[4 rows x 3 columns]

In [31]: df2.ne(df)

     one  three    two
a  False   True  False
b  False  False  False
c  False  False  False
d   True  False  False
[4 rows x 3 columns]

These operations produce a pandas object the same type as the left-hand-side input that if of dtype bool. These boolean objects can be used in indexing operations, see here

Boolean Reductions¶

You can apply the reductions: empty, any(), all(), and bool() to provide a way to summarize a boolean result.

In [32]: (df>0).all()

one      False
three    False
two      False
dtype: bool

In [33]: (df>0).any()

one       True
three    False
two       True
dtype: bool

You can reduce to a final boolean value.

In [34]: (df>0).any().any()
True

You can test if a pandas object is empty, via the empty property.

In [35]: df.empty
False

In [36]: DataFrame(columns=list('ABC')).empty
True

To evaluate single-element pandas objects in a boolean context, use the method .bool():

In [37]: Series([True]).bool()
True

In [38]: Series([False]).bool()
False

In [39]: DataFrame([[True]]).bool()
True

In [40]: DataFrame([[False]]).bool()
False

Warning

You might be tempted to do the following:

>>>if df:
     ...

Or

>>> df and df2

These both will raise as you are trying to compare multiple values.

ValueError: The truth value of an array is ambiguous. Use a.empty, a.any() or a.all().

See gotchas for a more detailed discussion.

Combining overlapping data sets¶

A problem occasionally arising is the combination of two similar data sets where values in one are preferred over the other. An example would be two data series representing a particular economic indicator where one is considered to be of “higher quality”. However, the lower quality series might extend further back in history or have more complete data coverage. As such, we would like to combine two DataFrame objects where missing values in one DataFrame are conditionally filled with like-labeled values from the other DataFrame. The function implementing this operation is combine_first, which we illustrate:

In [41]: df1 = DataFrame({'A' : [1., np.nan, 3., 5., np.nan],
   ....:                  'B' : [np.nan, 2., 3., np.nan, 6.]})
   ....: 

In [42]: df2 = DataFrame({'A' : [5., 2., 4., np.nan, 3., 7.],
   ....:                  'B' : [np.nan, np.nan, 3., 4., 6., 8.]})
   ....: 

In [43]: df1

    A   B
0   1 NaN
1 NaN   2
2   3   3
3   5 NaN
4 NaN   6
[5 rows x 2 columns]

In [44]: df2

    A   B
0   5 NaN
1   2 NaN
2   4   3
3 NaN   4
4   3   6
5   7   8
[6 rows x 2 columns]

In [45]: df1.combine_first(df2)

   A   B
0  1 NaN
1  2   2
2  3   3
3  5   4
4  3   6
5  7   8
[6 rows x 2 columns]

General DataFrame Combine¶

The combine_first method above calls the more general DataFrame method combine. This method takes another DataFrame and a combiner function, aligns the input DataFrame and then passes the combiner function pairs of Series (ie, columns whose names are the same).

So, for instance, to reproduce combine_first as above:

In [46]: combiner = lambda x, y: np.where(isnull(x), y, x)

In [47]: df1.combine(df2, combiner)

   A   B
0  1 NaN
1  2   2
2  3   3
3  5   4
4  3   6
5  7   8
[6 rows x 2 columns]

Descriptive statistics¶

A large number of methods for computing descriptive statistics and other related operations on Series, DataFrame, and Panel. Most of these are aggregations (hence producing a lower-dimensional result) like sum, mean, and quantile, but some of them, like cumsum and cumprod, produce an object of the same size. Generally speaking, these methods take an axis argument, just like ndarray.{sum, std, ...}, but the axis can be specified by name or integer:

Series: no axis argument needed

DataFrame: “index” (axis=0, default), “columns” (axis=1)

Panel: “items” (axis=0), “major” (axis=1, default), “minor” (axis=2)

For example:

In [48]: df

        one     three       two
a -0.701368       NaN -0.087103
b  0.109333 -0.354359  0.637674
c -0.231617 -0.148387 -0.002666
d       NaN -0.167407  0.104044
[4 rows x 3 columns]

In [49]: df.mean(0)

one     -0.274551
three   -0.223384
two      0.162987
dtype: float64

In [50]: df.mean(1)

a   -0.394235
b    0.130882
c   -0.127557
d   -0.031682
dtype: float64

All such methods have a skipna option signaling whether to exclude missing data (True by default):

In [51]: df.sum(0, skipna=False)

one           NaN
three         NaN
two      0.651948
dtype: float64

In [52]: df.sum(axis=1, skipna=True)

a   -0.788471
b    0.392647
c   -0.382670
d   -0.063363
dtype: float64

Combined with the broadcasting / arithmetic behavior, one can describe various statistical procedures, like standardization (rendering data zero mean and standard deviation 1), very concisely:

In [53]: ts_stand = (df - df.mean()) / df.std()

In [54]: ts_stand.std()

one      1
three    1
two      1
dtype: float64

In [55]: xs_stand = df.sub(df.mean(1), axis=0).div(df.std(1), axis=0)

In [56]: xs_stand.std(1)

a    1
b    1
c    1
d    1
dtype: float64

Note that methods like cumsum and cumprod preserve the location of NA values:

In [57]: df.cumsum()

        one     three       two
a -0.701368       NaN -0.087103
b -0.592035 -0.354359  0.550570
c -0.823652 -0.502746  0.547904
d       NaN -0.670153  0.651948
[4 rows x 3 columns]

Here is a quick reference summary table of common functions. Each also takes an optional level parameter which applies only if the object has a hierarchical index.

Function	Description
`count`	Number of non-null observations
`sum`	Sum of values
`mean`	Mean of values
`mad`	Mean absolute deviation
`median`	Arithmetic median of values
`min`	Minimum
`max`	Maximum
`mode`	Mode
`abs`	Absolute Value
`prod`	Product of values
`std`	Unbiased standard deviation
`var`	Unbiased variance
`skew`	Unbiased skewness (3rd moment)
`kurt`	Unbiased kurtosis (4th moment)
`quantile`	Sample quantile (value at %)
`cumsum`	Cumulative sum
`cumprod`	Cumulative product
`cummax`	Cumulative maximum
`cummin`	Cumulative minimum

Note that by chance some NumPy methods, like mean, std, and sum, will exclude NAs on Series input by default:

In [58]: np.mean(df['one'])
-0.27455055654271204

In [59]: np.mean(df['one'].values)
nan

Series also has a method nunique which will return the number of unique non-null values:

In [60]: series = Series(randn(500))

In [61]: series[20:500] = np.nan

In [62]: series[10:20]  = 5

In [63]: series.nunique()
11

Summarizing data: describe¶

There is a convenient describe function which computes a variety of summary statistics about a Series or the columns of a DataFrame (excluding NAs of course):

In [64]: series = Series(randn(1000))

In [65]: series[::2] = np.nan

In [66]: series.describe()

count    500.000000
mean      -0.019898
std        1.019180
min       -2.628792
25%       -0.649795
50%       -0.059405
75%        0.651932
max        3.240991
dtype: float64

In [67]: frame = DataFrame(randn(1000, 5), columns=['a', 'b', 'c', 'd', 'e'])

In [68]: frame.ix[::2] = np.nan

In [69]: frame.describe()

                a           b           c           d           e
count  500.000000  500.000000  500.000000  500.000000  500.000000
mean     0.051388    0.053476   -0.035612    0.015388    0.057804
std      0.989217    0.995961    0.977047    0.968385    1.022528
min     -3.224136   -2.606460   -2.762875   -2.961757   -2.829100
25%     -0.657420   -0.597123   -0.688961   -0.695019   -0.738097
50%      0.042928    0.018837   -0.071830   -0.011326    0.073287
75%      0.702445    0.693542    0.600454    0.680924    0.807670
max      3.034008    3.104512    2.812028    2.623914    3.542846
[8 rows x 5 columns]

For a non-numerical Series object, describe will give a simple summary of the number of unique values and most frequently occurring values:

In [70]: s = Series(['a', 'a', 'b', 'b', 'a', 'a', np.nan, 'c', 'd', 'a'])

In [71]: s.describe()

count     9
unique    4
top       a
freq      5
dtype: object

There also is a utility function, value_range which takes a DataFrame and returns a series with the minimum/maximum values in the DataFrame.

Index of Min/Max Values¶

The idxmin and idxmax functions on Series and DataFrame compute the index labels with the minimum and maximum corresponding values:

In [72]: s1 = Series(randn(5))

In [73]: s1

0   -0.574018
1    0.668292
2    0.303418
3   -1.190271
4    0.138399
dtype: float64

In [74]: s1.idxmin(), s1.idxmax()
(3, 1)

In [75]: df1 = DataFrame(randn(5,3), columns=['A','B','C'])

In [76]: df1

          A         B         C
0 -0.184355 -1.054354 -1.613138
1 -0.050807 -2.130168 -1.852271
2  0.455674  2.571061 -1.152538
3 -1.638940 -0.364831 -0.348520
4  0.202856  0.777088 -0.358316
[5 rows x 3 columns]

In [77]: df1.idxmin(axis=0)

A    3
B    1
C    1
dtype: int64

In [78]: df1.idxmax(axis=1)

0    A
1    A
2    B
3    C
4    B
dtype: object

When there are multiple rows (or columns) matching the minimum or maximum value, idxmin and idxmax return the first matching index:

In [79]: df3 = DataFrame([2, 1, 1, 3, np.nan], columns=['A'], index=list('edcba'))

In [80]: df3

    A
e   2
d   1
c   1
b   3
a NaN
[5 rows x 1 columns]

In [81]: df3['A'].idxmin()
'd'

Note

idxmin and idxmax are called argmin and argmax in NumPy.

Value counts (histogramming) / Mode¶

The value_counts Series method and top-level function computes a histogram of a 1D array of values. It can also be used as a function on regular arrays:

In [82]: data = np.random.randint(0, 7, size=50)

In [83]: data

array([4, 6, 6, 1, 2, 1, 0, 5, 3, 2, 4, 3, 1, 3, 5, 3, 0, 0, 4, 4, 6, 1, 0,
       4, 3, 2, 1, 3, 1, 5, 6, 3, 1, 2, 4, 4, 3, 3, 2, 2, 2, 3, 2, 3, 0, 1,
       2, 4, 5, 5])

In [84]: s = Series(data)

In [85]: s.value_counts()

3    11
2     9
4     8
1     8
5     5
0     5
6     4
dtype: int64

In [86]: value_counts(data)

3    11
2     9
4     8
1     8
5     5
0     5
6     4
dtype: int64

Similarly, you can get the most frequently occuring value(s) (the mode) of the values in a Series or DataFrame:

In [87]: s5 = Series([1, 1, 3, 3, 3, 5, 5, 7, 7, 7])

In [88]: s5.mode()

0    3
1    7
dtype: int64

In [89]: df5 = DataFrame({"A": np.random.randint(0, 7, size=50),
   ....:                  "B": np.random.randint(-10, 15, size=50)})
   ....: 

In [90]: df5.mode()

   A   B
0  5  -4
1  6 NaN
[2 rows x 2 columns]

Discretization and quantiling¶

Continuous values can be discretized using the cut (bins based on values) and qcut (bins based on sample quantiles) functions:

In [91]: arr = np.random.randn(20)

In [92]: factor = cut(arr, 4)

In [93]: factor

 (-0.886, -0.0912]
 (-0.886, -0.0912]
 (-0.886, -0.0912]
    (1.493, 2.285]
    (0.701, 1.493]
...
  (-0.0912, 0.701]
 (-0.886, -0.0912]
    (0.701, 1.493]
    (0.701, 1.493]
  (-0.0912, 0.701]
    (1.493, 2.285]
Levels (4): Index(['(-0.886, -0.0912]', '(-0.0912, 0.701]',
                   '(0.701, 1.493]', '(1.493, 2.285]'], dtype=object)
Length: 20

In [94]: factor = cut(arr, [-5, -1, 0, 1, 5])

In [95]: factor

 (-1, 0]
 (-1, 0]
 (-1, 0]
  (1, 5]
  (1, 5]
...
  (0, 1]
 (-1, 0]
  (0, 1]
  (0, 1]
  (0, 1]
  (1, 5]
Levels (4): Index(['(-5, -1]', '(-1, 0]', '(0, 1]', '(1, 5]'], dtype=object)
Length: 20

qcut computes sample quantiles. For example, we could slice up some normally distributed data into equal-size quartiles like so:

In [96]: arr = np.random.randn(30)

In [97]: factor = qcut(arr, [0, .25, .5, .75, 1])

In [98]: factor

 [-1.861, -0.487]
  (0.0554, 0.658]
   (0.658, 2.259]
 [-1.861, -0.487]
   (0.658, 2.259]
...
  (0.0554, 0.658]
  (0.0554, 0.658]
   (0.658, 2.259]
 [-1.861, -0.487]
  (0.0554, 0.658]
 (-0.487, 0.0554]
Levels (4): Index(['[-1.861, -0.487]', '(-0.487, 0.0554]',
                   '(0.0554, 0.658]', '(0.658, 2.259]'], dtype=object)
Length: 30

In [99]: value_counts(factor)

(0.658, 2.259]      8
[-1.861, -0.487]    8
(0.0554, 0.658]     7
(-0.487, 0.0554]    7
dtype: int64

We can also pass infinite values to define the bins:

In [100]: arr = np.random.randn(20)

In [101]: factor = cut(arr, [-np.inf, 0, np.inf])

In [102]: factor

  (0, inf]
  (0, inf]
 (-inf, 0]
  (0, inf]
 (-inf, 0]
...
 (-inf, 0]
  (0, inf]
  (0, inf]
 (-inf, 0]
  (0, inf]
 (-inf, 0]
Levels (2): Index(['(-inf, 0]', '(0, inf]'], dtype=object)
Length: 20

Function application¶

Arbitrary functions can be applied along the axes of a DataFrame or Panel using the apply method, which, like the descriptive statistics methods, take an optional axis argument:

In [103]: df.apply(np.mean)

one           NaN
three         NaN
two      0.162987
dtype: float64

In [104]: df.apply(np.mean, axis=1)

a   -0.394235
b    0.130882
c   -0.127557
d   -0.031682
dtype: float64

In [105]: df.apply(lambda x: x.max() - x.min())

one           NaN
three         NaN
two      0.724777
dtype: float64

In [106]: df.apply(np.cumsum)

        one     three       two
a -0.701368       NaN -0.087103
b -0.592035 -0.354359  0.550570
c -0.823652 -0.502746  0.547904
d       NaN -0.670153  0.651948
[4 rows x 3 columns]

In [107]: df.apply(np.exp)

        one     three       two
a  0.495907       NaN  0.916583
b  1.115534  0.701623  1.892074
c  0.793250  0.862098  0.997337
d       NaN  0.845855  1.109649
[4 rows x 3 columns]

Depending on the return type of the function passed to apply, the result will either be of lower dimension or the same dimension.

apply combined with some cleverness can be used to answer many questions about a data set. For example, suppose we wanted to extract the date where the maximum value for each column occurred:

In [108]: tsdf = DataFrame(randn(1000, 3), columns=['A', 'B', 'C'],
   .....:                  index=date_range('1/1/2000', periods=1000))
   .....: 

In [109]: tsdf.apply(lambda x: x.idxmax())

A   2002-08-19 00:00:00
B   2000-11-30 00:00:00
C   2002-01-10 00:00:00
dtype: datetime64[ns]

You may also pass additional arguments and keyword arguments to the apply method. For instance, consider the following function you would like to apply:

def subtract_and_divide(x, sub, divide=1):
    return (x - sub) / divide

You may then apply this function as follows:

df.apply(subtract_and_divide, args=(5,), divide=3)

Another useful feature is the ability to pass Series methods to carry out some Series operation on each column or row:

In [110]: tsdf

                   A         B         C
2000-01-01 -1.226159  0.173875 -0.798063
2000-01-02  0.127076  0.141070 -2.186743
2000-01-03 -1.804229  0.879800  0.465165
2000-01-04       NaN       NaN       NaN
2000-01-05       NaN       NaN       NaN
2000-01-06       NaN       NaN       NaN
2000-01-07       NaN       NaN       NaN
2000-01-08  1.542261  0.524780  1.445690
2000-01-09 -1.104998 -0.470200  0.336180
2000-01-10 -0.947692 -0.262122 -0.423769
[10 rows x 3 columns]

In [111]: tsdf.apply(Series.interpolate)

                   A         B         C
2000-01-01 -1.226159  0.173875 -0.798063
2000-01-02  0.127076  0.141070 -2.186743
2000-01-03 -1.804229  0.879800  0.465165
2000-01-04 -1.134931  0.808796  0.661270
2000-01-05 -0.465633  0.737792  0.857375
2000-01-06  0.203665  0.666788  1.053480
2000-01-07  0.872963  0.595784  1.249585
2000-01-08  1.542261  0.524780  1.445690
2000-01-09 -1.104998 -0.470200  0.336180
2000-01-10 -0.947692 -0.262122 -0.423769
[10 rows x 3 columns]

Finally, apply takes an argument raw which is False by default, which converts each row or column into a Series before applying the function. When set to True, the passed function will instead receive an ndarray object, which has positive performance implications if you do not need the indexing functionality.

Applying elementwise Python functions¶

Since not all functions can be vectorized (accept NumPy arrays and return another array or value), the methods applymap on DataFrame and analogously map on Series accept any Python function taking a single value and returning a single value. For example:

In [112]: df4

        one     three       two
a -0.701368       NaN -0.087103
b  0.109333 -0.354359  0.637674
c -0.231617 -0.148387 -0.002666
d       NaN -0.167407  0.104044
[4 rows x 3 columns]

In [113]: f = lambda x: len(str(x))

In [114]: df4['one'].map(f)

a    15
b    14
c    15
d     3
Name: one, dtype: int64

In [115]: df4.applymap(f)

   one  three  two
a   15      3   16
b   14     15   14
c   15     15   17
d    3     15   14
[4 rows x 3 columns]

Series.map has an additional feature which is that it can be used to easily “link” or “map” values defined by a secondary series. This is closely related to merging/joining functionality:

In [116]: s = Series(['six', 'seven', 'six', 'seven', 'six'],
   .....:            index=['a', 'b', 'c', 'd', 'e'])
   .....: 

In [117]: t = Series({'six' : 6., 'seven' : 7.})

In [118]: s

a      six
b    seven
c      six
d    seven
e      six
dtype: object

In [119]: s.map(t)

a    6
b    7
c    6
d    7
e    6
dtype: float64

Reindexing and altering labels¶

reindex is the fundamental data alignment method in pandas. It is used to implement nearly all other features relying on label-alignment functionality. To reindex means to conform the data to match a given set of labels along a particular axis. This accomplishes several things:

Reorders the existing data to match a new set of labels

Inserts missing value (NA) markers in label locations where no data for that label existed

If specified, fill data for missing labels using logic (highly relevant to working with time series data)

Here is a simple example:

In [120]: s = Series(randn(5), index=['a', 'b', 'c', 'd', 'e'])

In [121]: s

a    0.166882
b   -1.759496
c    0.901336
d   -0.317478
e   -0.681335
dtype: float64

In [122]: s.reindex(['e', 'b', 'f', 'd'])

e   -0.681335
b   -1.759496
f         NaN
d   -0.317478
dtype: float64

Here, the f label was not contained in the Series and hence appears as NaN in the result.

With a DataFrame, you can simultaneously reindex the index and columns:

In [123]: df

        one     three       two
a -0.701368       NaN -0.087103
b  0.109333 -0.354359  0.637674
c -0.231617 -0.148387 -0.002666
d       NaN -0.167407  0.104044
[4 rows x 3 columns]

In [124]: df.reindex(index=['c', 'f', 'b'], columns=['three', 'two', 'one'])

      three       two       one
c -0.148387 -0.002666 -0.231617
f       NaN       NaN       NaN
b -0.354359  0.637674  0.109333
[3 rows x 3 columns]

For convenience, you may utilize the reindex_axis method, which takes the labels and a keyword axis parameter.

Note that the Index objects containing the actual axis labels can be shared between objects. So if we have a Series and a DataFrame, the following can be done:

In [125]: rs = s.reindex(df.index)

In [126]: rs

a    0.166882
b   -1.759496
c    0.901336
d   -0.317478
dtype: float64

In [127]: rs.index is df.index
True

This means that the reindexed Series’s index is the same Python object as the DataFrame’s index.

Reindexing to align with another object¶

You may wish to take an object and reindex its axes to be labeled the same as another object. While the syntax for this is straightforward albeit verbose, it is a common enough operation that the reindex_like method is available to make this simpler:

In [128]: df2

        one       two
a -0.701368 -0.087103
b  0.109333  0.637674
c -0.231617 -0.002666
[3 rows x 2 columns]

In [129]: df3

        one       two
a -0.426817 -0.269738
b  0.383883  0.455039
c  0.042934 -0.185301
[3 rows x 2 columns]

In [130]: df.reindex_like(df2)

        one       two
a -0.701368 -0.087103
b  0.109333  0.637674
c -0.231617 -0.002666
[3 rows x 2 columns]

Reindexing with `reindex_axis`¶

Aligning objects with each other with `align`¶

The align method is the fastest way to simultaneously align two objects. It supports a join argument (related to joining and merging):

join='outer': take the union of the indexes

join='left': use the calling object’s index

join='right': use the passed object’s index

join='inner': intersect the indexes

It returns a tuple with both of the reindexed Series:

In [131]: s = Series(randn(5), index=['a', 'b', 'c', 'd', 'e'])

In [132]: s1 = s[:4]

In [133]: s2 = s[1:]

In [134]: s1.align(s2)

(a   -0.597361
b   -1.514940
c   -1.640398
d   -1.130643
e         NaN
dtype: float64,
 a         NaN
b   -1.514940
c   -1.640398
d   -1.130643
e   -0.245890
dtype: float64)

In [135]: s1.align(s2, join='inner')

(b   -1.514940
c   -1.640398
d   -1.130643
dtype: float64,
 b   -1.514940
c   -1.640398
d   -1.130643
dtype: float64)

In [136]: s1.align(s2, join='left')

(a   -0.597361
b   -1.514940
c   -1.640398
d   -1.130643
dtype: float64,
 a         NaN
b   -1.514940
c   -1.640398
d   -1.130643
dtype: float64)

For DataFrames, the join method will be applied to both the index and the columns by default:

In [137]: df.align(df2, join='inner')

(        one       two
a -0.701368 -0.087103
b  0.109333  0.637674
c -0.231617 -0.002666
[3 rows x 2 columns],
         one       two
a -0.701368 -0.087103
b  0.109333  0.637674
c -0.231617 -0.002666
[3 rows x 2 columns])

You can also pass an axis option to only align on the specified axis:

In [138]: df.align(df2, join='inner', axis=0)

(        one     three       two
a -0.701368       NaN -0.087103
b  0.109333 -0.354359  0.637674
c -0.231617 -0.148387 -0.002666
[3 rows x 3 columns],
         one       two
a -0.701368 -0.087103
b  0.109333  0.637674
c -0.231617 -0.002666
[3 rows x 2 columns])

If you pass a Series to DataFrame.align, you can choose to align both objects either on the DataFrame’s index or columns using the axis argument:

In [139]: df.align(df2.ix[0], axis=1)

(        one     three       two
a -0.701368       NaN -0.087103
b  0.109333 -0.354359  0.637674
c -0.231617 -0.148387 -0.002666
d       NaN -0.167407  0.104044
[4 rows x 3 columns],
 one     -0.701368
three         NaN
two     -0.087103
Name: a, dtype: float64)

Filling while reindexing¶

reindex takes an optional parameter method which is a filling method chosen from the following table:

Method	Action
pad / ffill	Fill values forward
bfill / backfill	Fill values backward

Other fill methods could be added, of course, but these are the two most commonly used for time series data. In a way they only make sense for time series or otherwise ordered data, but you may have an application on non-time series data where this sort of “interpolation” logic is the correct thing to do. More sophisticated interpolation of missing values would be an obvious extension.

We illustrate these fill methods on a simple TimeSeries:

In [140]: rng = date_range('1/3/2000', periods=8)

In [141]: ts = Series(randn(8), index=rng)

In [142]: ts2 = ts[[0, 3, 6]]

In [143]: ts

2000-01-03   -1.200639
2000-01-04   -1.872993
2000-01-05    0.825210
2000-01-06   -0.392715
2000-01-07   -1.994150
2000-01-08    0.174260
2000-01-09   -0.581163
2000-01-10    0.087916
Freq: D, dtype: float64

In [144]: ts2

2000-01-03   -1.200639
2000-01-06   -0.392715
2000-01-09   -0.581163
dtype: float64

In [145]: ts2.reindex(ts.index)

2000-01-03   -1.200639
2000-01-04         NaN
2000-01-05         NaN
2000-01-06   -0.392715
2000-01-07         NaN
2000-01-08         NaN
2000-01-09   -0.581163
2000-01-10         NaN
Freq: D, dtype: float64

In [146]: ts2.reindex(ts.index, method='ffill')

2000-01-03   -1.200639
2000-01-04   -1.200639
2000-01-05   -1.200639
2000-01-06   -0.392715
2000-01-07   -0.392715
2000-01-08   -0.392715
2000-01-09   -0.581163
2000-01-10   -0.581163
Freq: D, dtype: float64

In [147]: ts2.reindex(ts.index, method='bfill')

2000-01-03   -1.200639
2000-01-04   -0.392715
2000-01-05   -0.392715
2000-01-06   -0.392715
2000-01-07   -0.581163
2000-01-08   -0.581163
2000-01-09   -0.581163
2000-01-10         NaN
Freq: D, dtype: float64

Note these methods require that the indexes are order increasing.

Note the same result could have been achieved using fillna:

In [148]: ts2.reindex(ts.index).fillna(method='ffill')

2000-01-03   -1.200639
2000-01-04   -1.200639
2000-01-05   -1.200639
2000-01-06   -0.392715
2000-01-07   -0.392715
2000-01-08   -0.392715
2000-01-09   -0.581163
2000-01-10   -0.581163
Freq: D, dtype: float64

Note that reindex will raise a ValueError if the index is not monotonic. fillna will not make any checks on the order of the index.

Dropping labels from an axis¶

A method closely related to reindex is the drop function. It removes a set of labels from an axis:

In [149]: df

        one     three       two
a -0.701368       NaN -0.087103
b  0.109333 -0.354359  0.637674
c -0.231617 -0.148387 -0.002666
d       NaN -0.167407  0.104044
[4 rows x 3 columns]

In [150]: df.drop(['a', 'd'], axis=0)

        one     three       two
b  0.109333 -0.354359  0.637674
c -0.231617 -0.148387 -0.002666
[2 rows x 3 columns]

In [151]: df.drop(['one'], axis=1)

      three       two
a       NaN -0.087103
b -0.354359  0.637674
c -0.148387 -0.002666
d -0.167407  0.104044
[4 rows x 2 columns]

Note that the following also works, but is a bit less obvious / clean:

In [152]: df.reindex(df.index - ['a', 'd'])

        one     three       two
b  0.109333 -0.354359  0.637674
c -0.231617 -0.148387 -0.002666
[2 rows x 3 columns]

Renaming / mapping labels¶

The rename method allows you to relabel an axis based on some mapping (a dict or Series) or an arbitrary function.

In [153]: s

a   -0.597361
b   -1.514940
c   -1.640398
d   -1.130643
e   -0.245890
dtype: float64

In [154]: s.rename(str.upper)

A   -0.597361
B   -1.514940
C   -1.640398
D   -1.130643
E   -0.245890
dtype: float64

If you pass a function, it must return a value when called with any of the labels (and must produce a set of unique values). But if you pass a dict or Series, it need only contain a subset of the labels as keys:

In [155]: df.rename(columns={'one' : 'foo', 'two' : 'bar'},
   .....:           index={'a' : 'apple', 'b' : 'banana', 'd' : 'durian'})
   .....: 

             foo     three       bar
apple  -0.701368       NaN -0.087103
banana  0.109333 -0.354359  0.637674
c      -0.231617 -0.148387 -0.002666
durian       NaN -0.167407  0.104044
[4 rows x 3 columns]

The rename method also provides an inplace named parameter that is by default False and copies the underlying data. Pass inplace=True to rename the data in place.

The Panel class has a related rename_axis class which can rename any of its three axes.

Iteration¶

Because Series is array-like, basic iteration produces the values. Other data structures follow the dict-like convention of iterating over the “keys” of the objects. In short:

Series: values

DataFrame: column labels

Panel: item labels

Thus, for example:

In [156]: for col in df:
   .....:     print(col)
   .....: 
one
three
two

iteritems¶

Consistent with the dict-like interface, iteritems iterates through key-value pairs:

Series: (index, scalar value) pairs

DataFrame: (column, Series) pairs

Panel: (item, DataFrame) pairs

For example:

In [157]: for item, frame in wp.iteritems():
   .....:     print(item)
   .....:     print(frame)
   .....: 
Item1
                   A         B         C         D
2000-01-01 -1.118121  0.431279  0.554724 -1.333649
2000-01-02 -0.332174 -0.485882  1.725945  1.799276
2000-01-03 -0.968916 -0.779465 -2.000701 -1.866630
2000-01-04 -1.101268  1.957478  0.058889  0.758071
2000-01-05  0.076612 -0.548502 -0.160485 -0.377780
[5 rows x 4 columns]
Item2
                   A         B         C         D
2000-01-01  0.249911 -0.341270 -0.272599 -0.277446
2000-01-02 -1.102896  0.100307 -1.602814  0.920139
2000-01-03 -0.643870  0.060336 -0.434942 -0.494305
2000-01-04  0.737973  0.451632  0.334124 -0.787062
2000-01-05  0.651396 -0.741919  1.193881 -2.395763
[5 rows x 4 columns]

iterrows¶

New in v0.7 is the ability to iterate efficiently through rows of a DataFrame. It returns an iterator yielding each index value along with a Series containing the data in each row:

In [158]: for row_index, row in df2.iterrows():
   .....:     print('%s\n%s' % (row_index, row))
   .....: 
a
one   -0.701368
two   -0.087103
Name: a, dtype: float64
b
one    0.109333
two    0.637674
Name: b, dtype: float64
c
one   -0.231617
two   -0.002666
Name: c, dtype: float64

For instance, a contrived way to transpose the dataframe would be:

In [159]: df2 = DataFrame({'x': [1, 2, 3], 'y': [4, 5, 6]})

In [160]: print(df2)
   x  y
0  1  4
1  2  5
2  3  6
[3 rows x 2 columns]

In [161]: print(df2.T)
   0  1  2
x  1  2  3
y  4  5  6
[2 rows x 3 columns]

In [162]: df2_t = DataFrame(dict((idx,values) for idx, values in df2.iterrows()))

In [163]: print(df2_t)
   0  1  2
x  1  2  3
y  4  5  6
[2 rows x 3 columns]

Note

iterrows does not preserve dtypes across the rows (dtypes are preserved across columns for DataFrames). For example,

In [164]: df_iter = DataFrame([[1, 1.0]], columns=['x', 'y'])

In [165]: row = next(df_iter.iterrows())[1]

In [166]: print(row['x'].dtype)
float64

In [167]: print(df_iter['x'].dtype)
int64

itertuples¶

This method will return an iterator yielding a tuple for each row in the DataFrame. The first element of the tuple will be the row’s corresponding index value, while the remaining values are the row values proper.

For instance,

In [168]: for r in df2.itertuples():
   .....:     print(r)
   .....: 
(0, 1, 4)
(1, 2, 5)
(2, 3, 6)

Vectorized string methods¶

Series is equipped (as of pandas 0.8.1) with a set of string processing methods that make it easy to operate on each element of the array. Perhaps most importantly, these methods exclude missing/NA values automatically. These are accessed via the Series’s str attribute and generally have names matching the equivalent (scalar) build-in string methods:

Splitting and Replacing Strings¶

In [169]: s = Series(['A', 'B', 'C', 'Aaba', 'Baca', np.nan, 'CABA', 'dog', 'cat'])

In [170]: s.str.lower()

     a
     b
     c
  aaba
  baca
   NaN
  caba
   dog
   cat
dtype: object

In [171]: s.str.upper()

     A
     B
     C
  AABA
  BACA
   NaN
  CABA
   DOG
   CAT
dtype: object

In [172]: s.str.len()

   1
   1
   1
   4
   4
 NaN
   4
   3
   3
dtype: float64

Methods like split return a Series of lists:

In [173]: s2 = Series(['a_b_c', 'c_d_e', np.nan, 'f_g_h'])

In [174]: s2.str.split('_')

0    [a, b, c]
1    [c, d, e]
2          NaN
3    [f, g, h]
dtype: object

Elements in the split lists can be accessed using get or [] notation:

In [175]: s2.str.split('_').str.get(1)

0      b
1      d
2    NaN
3      g
dtype: object

In [176]: s2.str.split('_').str[1]

0      b
1      d
2    NaN
3      g
dtype: object

Methods like replace and findall take regular expressions, too:

In [177]: s3 = Series(['A', 'B', 'C', 'Aaba', 'Baca',
   .....:             '', np.nan, 'CABA', 'dog', 'cat'])
   .....: 

In [178]: s3

     A
     B
     C
  Aaba
  Baca
      
   NaN
  CABA
   dog
   cat
dtype: object

In [179]: s3.str.replace('^.a|dog', 'XX-XX ', case=False)

         A
         B
         C
  XX-XX ba
  XX-XX ca
          
       NaN
  XX-XX BA
    XX-XX 
   XX-XX t
dtype: object

Extracting Substrings¶

The method extract (introduced in version 0.13) accepts regular expressions with match groups. Extracting a regular expression with one group returns a Series of strings.

In [180]: Series(['a1', 'b2', 'c3']).str.extract('[ab](\d)')

0      1
1      2
2    NaN
dtype: object

Elements that do not match return NaN. Extracting a regular expression with more than one group returns a DataFrame with one column per group.

In [181]: Series(['a1', 'b2', 'c3']).str.extract('([ab])(\d)')

     0    1
0    a    1
1    b    2
2  NaN  NaN
[3 rows x 2 columns]

Elements that do not match return a row of NaN``s. Thus, a Series of messy strings can be "converted" into a like-indexed Series or DataFrame of cleaned-up or more useful strings, without necessitating ``get() to access tuples or re.match objects.

Named groups like

In [182]: Series(['a1', 'b2', 'c3']).str.extract('(?P<letter>[ab])(?P<digit>\d)')

  letter digit
0      a     1
1      b     2
2    NaN   NaN
[3 rows x 2 columns]

and optional groups like

In [183]: Series(['a1', 'b2', '3']).str.extract('(?P<letter>[ab])?(?P<digit>\d)')

  letter digit
0      a     1
1      b     2
2    NaN     3
[3 rows x 2 columns]

can also be used.

Testing for Strings that Match or Contain a Pattern¶

In previous versions, extracting match groups was accomplished by match, which returned a not-so-convenient Series of tuples. Starting in version 0.14, the default behavior of match will change. It will return a boolean indexer, analagous to the method contains.

The distinction between match and contains is strictness: match relies on strict re.match while contains relies on re.search.

In version 0.13, match performs its old, deprecated behavior by default, but the new behavior is availabe through the keyword argument as_indexer=True.

Methods like match, contains, startswith, and endswith take: an extra na arguement so missing values can be considered True or False:

In [184]: s4 = Series(['A', 'B', 'C', 'Aaba', 'Baca', np.nan, 'CABA', 'dog', 'cat'])

In [185]: s4.str.contains('A', na=False)

   True
  False
  False
   True
  False
  False
   True
  False
  False
dtype: bool

Method	Description
`cat`	Concatenate strings
`split`	Split strings on delimiter
`get`	Index into each element (retrieve i-th element)
`join`	Join strings in each element of the Series with passed separator
`contains`	Return boolean array if each string contains pattern/regex
`replace`	Replace occurrences of pattern/regex with some other string
`repeat`	Duplicate values (`s.str.repeat(3)` equivalent to `x * 3`)
`pad`	Add whitespace to left, right, or both sides of strings
`center`	Equivalent to `pad(side='both')`
`slice`	Slice each string in the Series
`slice_replace`	Replace slice in each string with passed value
`count`	Count occurrences of pattern
`startswith`	Equivalent to `str.startswith(pat)` for each element
`endswidth`	Equivalent to `str.endswith(pat)` for each element
`findall`	Compute list of all occurrences of pattern/regex for each string
`match`	Call `re.match` on each element, returning matched groups as list
`extract`	Call `re.match` on each element, as `match` does, but return matched groups as strings for convenience.
`len`	Compute string lengths
`strip`	Equivalent to `str.strip`
`rstrip`	Equivalent to `str.rstrip`
`lstrip`	Equivalent to `str.lstrip`
`lower`	Equivalent to `str.lower`
`upper`	Equivalent to `str.upper`

Sorting by index and value¶

There are two obvious kinds of sorting that you may be interested in: sorting by label and sorting by actual values. The primary method for sorting axis labels (indexes) across data structures is the sort_index method.

In [186]: unsorted_df = df.reindex(index=['a', 'd', 'c', 'b'],
   .....:                          columns=['three', 'two', 'one'])
   .....: 

In [187]: unsorted_df.sort_index()

      three       two       one
a       NaN -0.087103 -0.701368
b -0.354359  0.637674  0.109333
c -0.148387 -0.002666 -0.231617
d -0.167407  0.104044       NaN
[4 rows x 3 columns]

In [188]: unsorted_df.sort_index(ascending=False)

      three       two       one
d -0.167407  0.104044       NaN
c -0.148387 -0.002666 -0.231617
b -0.354359  0.637674  0.109333
a       NaN -0.087103 -0.701368
[4 rows x 3 columns]

In [189]: unsorted_df.sort_index(axis=1)

        one     three       two
a -0.701368       NaN -0.087103
d       NaN -0.167407  0.104044
c -0.231617 -0.148387 -0.002666
b  0.109333 -0.354359  0.637674
[4 rows x 3 columns]

DataFrame.sort_index can accept an optional by argument for axis=0 which will use an arbitrary vector or a column name of the DataFrame to determine the sort order:

In [190]: df1 = DataFrame({'one':[2,1,1,1],'two':[1,3,2,4],'three':[5,4,3,2]})

In [191]: df1.sort_index(by='two')

   one  three  two
0    2      5    1
2    1      3    2
1    1      4    3
3    1      2    4
[4 rows x 3 columns]

The by argument can take a list of column names, e.g.:

In [192]: df1[['one', 'two', 'three']].sort_index(by=['one','two'])

   one  two  three
2    1    2      3
1    1    3      4
3    1    4      2
0    2    1      5
[4 rows x 3 columns]

Series has the method order (analogous to R’s order function) which sorts by value, with special treatment of NA values via the na_last argument:

In [193]: s[2] = np.nan

In [194]: s.order()

     A
  Aaba
     B
  Baca
  CABA
   cat
   dog
   NaN
   NaN
dtype: object

In [195]: s.order(na_last=False)

   NaN
   NaN
     A
  Aaba
     B
  Baca
  CABA
   cat
   dog
dtype: object

Some other sorting notes / nuances:

Series.sort sorts a Series by value in-place. This is to provide compatibility with NumPy methods which expect the ndarray.sort behavior.

DataFrame.sort takes a column argument instead of by. This method will likely be deprecated in a future release in favor of just using sort_index.

Copying¶

The copy method on pandas objects copies the underlying data (though not the axis indexes, since they are immutable) and returns a new object. Note that it is seldom necessary to copy objects. For example, there are only a handful of ways to alter a DataFrame in-place:

Inserting, deleting, or modifying a column

Assigning to the index or columns attributes

For homogeneous data, directly modifying the values via the values attribute or advanced indexing

To be clear, no pandas methods have the side effect of modifying your data; almost all methods return new objects, leaving the original object untouched. If data is modified, it is because you did so explicitly.

dtypes¶

The main types stored in pandas objects are float, int, bool, datetime64[ns], timedelta[ns], and object. In addition these dtypes have item sizes, e.g. int64 and int32. A convenient dtypes attribute for DataFrames returns a Series with the data type of each column.

In [196]: dft = DataFrame(dict( A = np.random.rand(3),
   .....:                       B = 1,
   .....:                       C = 'foo',
   .....:                       D = Timestamp('20010102'),
   .....:                       E = Series([1.0]*3).astype('float32'),
   .....:                       F = False,
   .....:                       G = Series([1]*3,dtype='int8')))
   .....: 

In [197]: dft

          A  B    C                   D  E      F  G
0  0.254252  1  foo 2001-01-02 00:00:00  1  False  1
1  0.615858  1  foo 2001-01-02 00:00:00  1  False  1
2  0.410404  1  foo 2001-01-02 00:00:00  1  False  1
[3 rows x 7 columns]

In [198]: dft.dtypes

A           float64
B             int64
C            object
D    datetime64[ns]
E           float32
F              bool
G              int8
dtype: object

On a Series use the dtype method.

In [199]: dft['A'].dtype
dtype('float64')

If a pandas object contains data multiple dtypes IN A SINGLE COLUMN, the dtype of the column will be chosen to accommodate all of the data types (object is the most general).

# these ints are coerced to floats
In [200]: Series([1, 2, 3, 4, 5, 6.])

0    1
1    2
2    3
3    4
4    5
5    6
dtype: float64

# string data forces an ``object`` dtype
In [201]: Series([1, 2, 3, 6., 'foo'])

0      1
1      2
2      3
3      6
4    foo
dtype: object

The method get_dtype_counts will return the number of columns of each type in a DataFrame:

In [202]: dft.get_dtype_counts()

bool              1
datetime64[ns]    1
float32           1
float64           1
int64             1
int8              1
object            1
dtype: int64

Numeric dtypes will propagate and can coexist in DataFrames (starting in v0.11.0). If a dtype is passed (either directly via the dtype keyword, a passed ndarray, or a passed Series, then it will be preserved in DataFrame operations. Furthermore, different numeric dtypes will NOT be combined. The following example will give you a taste.

In [203]: df1 = DataFrame(randn(8, 1), columns = ['A'], dtype = 'float32')

In [204]: df1

          A
0  0.416971
1  0.635240
2  1.500829
3  0.990323
4  1.090392
5 -1.349864
6 -0.235045
7 -0.719088
[8 rows x 1 columns]

In [205]: df1.dtypes

A    float32
dtype: object

In [206]: df2 = DataFrame(dict( A = Series(randn(8),dtype='float16'),
   .....:                       B = Series(randn(8)),
   .....:                       C = Series(np.array(randn(8),dtype='uint8')) ))
   .....: 

In [207]: df2

          A         B    C
0 -0.603516 -0.592695    0
1  1.252930  0.325837    1
2 -0.797852  0.510273    0
3 -0.179565  0.337502  255
4  0.701660 -0.670413    0
5 -0.204956  0.291389    0
6 -0.971191  0.437209    1
7 -1.087891 -0.351341    0
[8 rows x 3 columns]

In [208]: df2.dtypes

A    float16
B    float64
C      uint8
dtype: object

defaults¶

By default integer types are int64 and float types are float64, REGARDLESS of platform (32-bit or 64-bit). The following will all result in int64 dtypes.

In [209]: DataFrame([1, 2], columns=['a']).dtypes

a    int64
dtype: object

In [210]: DataFrame({'a': [1, 2]}).dtypes

a    int64
dtype: object

In [211]: DataFrame({'a': 1 }, index=list(range(2))).dtypes

a    int64
dtype: object

Numpy, however will choose platform-dependent types when creating arrays. The following WILL result in int32 on 32-bit platform.

In [212]: frame = DataFrame(np.array([1, 2]))

upcasting¶

Types can potentially be upcasted when combined with other types, meaning they are promoted from the current type (say int to float)

In [213]: df3 = df1.reindex_like(df2).fillna(value=0.0) + df2

In [214]: df3

          A         B    C
0 -0.186544 -0.592695    0
1  1.888170  0.325837    1
2  0.702977  0.510273    0
3  0.810758  0.337502  255
4  1.792053 -0.670413    0
5 -1.554820  0.291389    0
6 -1.206237  0.437209    1
7 -1.806979 -0.351341    0
[8 rows x 3 columns]

In [215]: df3.dtypes

A    float32
B    float64
C    float64
dtype: object

The values attribute on a DataFrame return the lower-common-denominator of the dtypes, meaning the dtype that can accomodate ALL of the types in the resulting homogenous dtyped numpy array. This can force some upcasting.

In [216]: df3.values.dtype
dtype('float64')

astype¶

You can use the astype method to explicity convert dtypes from one to another. These will by default return a copy, even if the dtype was unchanged (pass copy=False to change this behavior). In addition, they will raise an exception if the astype operation is invalid.

Upcasting is always according to the numpy rules. If two different dtypes are involved in an operation, then the more general one will be used as the result of the operation.

In [217]: df3

          A         B    C
0 -0.186544 -0.592695    0
1  1.888170  0.325837    1
2  0.702977  0.510273    0
3  0.810758  0.337502  255
4  1.792053 -0.670413    0
5 -1.554820  0.291389    0
6 -1.206237  0.437209    1
7 -1.806979 -0.351341    0
[8 rows x 3 columns]

In [218]: df3.dtypes

A    float32
B    float64
C    float64
dtype: object

# conversion of dtypes
In [219]: df3.astype('float32').dtypes

A    float32
B    float32
C    float32
dtype: object

object conversion¶

convert_objects is a method to try to force conversion of types from the object dtype to other types. To force conversion of specific types that are number like, e.g. could be a string that represents a number, pass convert_numeric=True. This will force strings and numbers alike to be numbers if possible, otherwise they will be set to np.nan.

In [220]: df3['D'] = '1.'

In [221]: df3['E'] = '1'

In [222]: df3.convert_objects(convert_numeric=True).dtypes

A    float32
B    float64
C    float64
D    float64
E      int64
dtype: object

# same, but specific dtype conversion
In [223]: df3['D'] = df3['D'].astype('float16')

In [224]: df3['E'] = df3['E'].astype('int32')

In [225]: df3.dtypes

A    float32
B    float64
C    float64
D    float16
E      int32
dtype: object

To force conversion to datetime64[ns], pass convert_dates='coerce'. This will convert any datetimelike object to dates, forcing other values to NaT. This might be useful if you are reading in data which is mostly dates, but occasionally has non-dates intermixed and you want to represent as missing.

In [226]: s = Series([datetime(2001,1,1,0,0),
   .....:            'foo', 1.0, 1, Timestamp('20010104'),
   .....:            '20010105'],dtype='O')
   .....: 

In [227]: s

0    2001-01-01 00:00:00
1                    foo
2                      1
3                      1
4    2001-01-04 00:00:00
5               20010105
dtype: object

In [228]: s.convert_objects(convert_dates='coerce')

0   2001-01-01 00:00:00
1                   NaT
2                   NaT
3                   NaT
4   2001-01-04 00:00:00
5   2001-01-05 00:00:00
dtype: datetime64[ns]

In addition, convert_objects will attempt the soft conversion of any object dtypes, meaning that if all the objects in a Series are of the same type, the Series will have that dtype.

gotchas¶

Performing selection operations on integer type data can easily upcast the data to floating. The dtype of the input data will be preserved in cases where nans are not introduced (starting in 0.11.0) See also integer na gotchas

In [229]: dfi = df3.astype('int32')

In [230]: dfi['E'] = 1

In [231]: dfi

   A  B    C  D  E
0  0  0    0  1  1
1  1  0    1  1  1
2  0  0    0  1  1
3  0  0  255  1  1
4  1  0    0  1  1
5 -1  0    0  1  1
6 -1  0    1  1  1
7 -1  0    0  1  1
[8 rows x 5 columns]

In [232]: dfi.dtypes

A    int32
B    int32
C    int32
D    int32
E    int64
dtype: object

In [233]: casted = dfi[dfi>0]

In [234]: casted

    A   B    C  D  E
0 NaN NaN  NaN  1  1
1   1 NaN    1  1  1
2 NaN NaN  NaN  1  1
3 NaN NaN  255  1  1
4   1 NaN  NaN  1  1
5 NaN NaN  NaN  1  1
6 NaN NaN    1  1  1
7 NaN NaN  NaN  1  1
[8 rows x 5 columns]

In [235]: casted.dtypes

A    float64
B    float64
C    float64
D      int32
E      int64
dtype: object

While float dtypes are unchanged.

In [236]: dfa = df3.copy()

In [237]: dfa['A'] = dfa['A'].astype('float32')

In [238]: dfa.dtypes

A    float32
B    float64
C    float64
D    float16
E      int32
dtype: object

In [239]: casted = dfa[df2>0]

In [240]: casted

          A         B    C   D   E
0       NaN       NaN  NaN NaN NaN
1  1.888170  0.325837    1 NaN NaN
2       NaN  0.510273  NaN NaN NaN
3       NaN  0.337502  255 NaN NaN
4  1.792053       NaN  NaN NaN NaN
5       NaN  0.291389  NaN NaN NaN
6       NaN  0.437209    1 NaN NaN
7       NaN       NaN  NaN NaN NaN
[8 rows x 5 columns]

In [241]: casted.dtypes

A    float32
B    float64
C    float64
D    float16
E    float64
dtype: object

Working with package options¶

New in version 0.10.1.

Pandas has an options system that let’s you customize some aspects of it’s behaviour, display-related options being those the user is must likely to adjust.

Options have a full “dotted-style”, case-insensitive name (e.g. display.max_rows), You can get/set options directly as attributes of the top-level options attribute:

In [242]: import pandas as pd

In [243]: pd.options.display.max_rows
15

In [244]: pd.options.display.max_rows = 999

In [245]: pd.options.display.max_rows
999

There is also an API composed of 4 relevant functions, available directly from the pandas namespace, and they are:

get_option / set_option - get/set the value of a single option.
reset_option - reset one or more options to their default value.
describe_option - print the descriptions of one or more options.

Note: developers can check out pandas/core/config.py for more info.

All of the functions above accept a regexp pattern (re.search style) as an argument, and so passing in a substring will work - as long as it is unambiguous :

In [246]: get_option("display.max_rows")
999

In [247]: set_option("display.max_rows",101)

In [248]: get_option("display.max_rows")
101

In [249]: set_option("max_r",102)

In [250]: get_option("display.max_rows")
102

The following will not work because it matches multiple option names, e.g. display.max_colwidth, display.max_rows, display.max_columns:

In [251]: try:
   .....:     get_option("display.max_")
   .....: except KeyError as e:
   .....:     print(e)
   .....: 
'Pattern matched multiple keys'

Note: Using this form of shorthand may cause your code to break if new options with similar names are added in future versions.

You can get a list of available options and their descriptions with describe_option. When called with no argument describe_option will print out the descriptions for all available options.

In [252]: describe_option()
display.chop_threshold: [default: None] [currently: None]
: float or None
        if set to a float value, all float values smaller then the given threshold
        will be displayed as exactly 0 by repr and friends.
display.colheader_justify: [default: right] [currently: right]
: 'left'/'right'
        Controls the justification of column headers. used by DataFrameFormatter.
display.column_space: [default: 12] [currently: 12]No description available.
display.date_dayfirst: [default: False] [currently: False]
: boolean
        When True, prints and parses dates with the day first, eg 20/01/2005
display.date_yearfirst: [default: False] [currently: False]
: boolean
        When True, prints and parses dates with the year first, eg 2005/01/20
display.encoding: [default: UTF-8] [currently: UTF-8]
: str/unicode
        Defaults to the detected encoding of the console.
        Specifies the encoding to be used for strings returned by to_string,
        these are generally strings meant to be displayed on the console.
display.expand_frame_repr: [default: True] [currently: True]
: boolean
        Whether to print out the full DataFrame repr for wide DataFrames across
        multiple lines, `max_columns` is still respected, but the output will
        wrap-around across multiple "pages" if it's width exceeds `display.width`.
display.float_format: [default: None] [currently: None]
: callable
        The callable should accept a floating point number and return
        a string with the desired format of the number. This is used
        in some places like SeriesFormatter.
        See core.format.EngFormatter for an example.
display.height: [default: 60] [currently: 60]
: int
        Deprecated.
	(Deprecated, use `display.max_rows` instead.)
display.large_repr: [default: truncate] [currently: truncate]
: 'truncate'/'info'
    
        For DataFrames exceeding max_rows/max_cols, the repr (and HTML repr) can
        show a truncated table (the default from 0.13), or switch to the view from
        df.info() (the behaviour in earlier versions of pandas).
display.line_width: [default: 80] [currently: 80]
: int
        Deprecated.
	(Deprecated, use `display.width` instead.)
display.max_columns: [default: 20] [currently: 20]
: int
        max_rows and max_columns are used in __repr__() methods to decide if
        to_string() or info() is used to render an object to a string.  In case
        python/IPython is running in a terminal this can be set to 0 and pandas
        will correctly auto-detect the width the terminal and swap to a smaller
        format in case all columns would not fit vertically. The IPython notebook,
        IPython qtconsole, or IDLE do not run in a terminal and hence it is not
        possible to do correct auto-detection.
        'None' value means unlimited.
display.max_colwidth: [default: 50] [currently: 50]
: int
        The maximum width in characters of a column in the repr of
        a pandas data structure. When the column overflows, a "..."
        placeholder is embedded in the output.
display.max_info_columns: [default: 100] [currently: 100]
: int
        max_info_columns is used in DataFrame.info method to decide if
        per column information will be printed.
display.max_info_rows: [default: 1690785] [currently: 1690785]
: int or None
        Deprecated.
	(Deprecated)
display.max_rows: [default: 60] [currently: 60]
: int
        This sets the maximum number of rows pandas should output when printing
        out various output. For example, this value determines whether the repr()
        for a dataframe prints out fully or just a summary repr.
        'None' value means unlimited.
display.max_seq_items: [default: 100] [currently: 100]
: int or None
    
        when pretty-printing a long sequence, no more then `max_seq_items`
        will be printed. If items are omitted, they will be denoted by the
        addition of "..." to the resulting string.
    
        If set to None, the number of items to be printed is unlimited.
display.mpl_style: [default: None] [currently: None]
: bool
    
        Setting this to 'default' will modify the rcParams used by matplotlib
        to give plots a more pleasing visual style by default.
        Setting this to None/False restores the values to their initial value.
display.multi_sparse: [default: True] [currently: True]
: boolean
        "sparsify" MultiIndex display (don't display repeated
        elements in outer levels within groups)
display.notebook_repr_html: [default: True] [currently: True]
: boolean
        When True, IPython notebook will use html representation for
        pandas objects (if it is available).
display.pprint_nest_depth: [default: 3] [currently: 3]
: int
        Controls the number of nested levels to process when pretty-printing
display.precision: [default: 7] [currently: 7]
: int
        Floating point output precision (number of significant digits). This is
        only a suggestion
display.width: [default: 80] [currently: 80]
: int
        Width of the display in characters. In case python/IPython is running in
        a terminal this can be set to None and pandas will correctly auto-detect
        the width.
        Note that the IPython notebook, IPython qtconsole, or IDLE do not run in a
        terminal and hence it is not possible to correctly detect the width.
io.excel.xls.writer: [default: xlwt] [currently: xlwt]
: string
        The default Excel writer engine for 'xls' files. Available options:
        'xlwt' (the default).
io.excel.xlsm.writer: [default: openpyxl] [currently: openpyxl]
: string
        The default Excel writer engine for 'xlsm' files. Available options:
        'openpyxl' (the default).
io.excel.xlsx.writer: [default: xlsxwriter] [currently: xlsxwriter]
: string
        The default Excel writer engine for 'xlsx' files. Available options:
        'xlsxwriter' (the default), 'openpyxl'.
io.hdf.default_format: [default: None] [currently: None]
: format
        default format writing format, if None, then
        put will default to 'fixed' and append will default to 'table'
io.hdf.dropna_table: [default: True] [currently: True]
: boolean
        drop ALL nan rows when appending to a table
mode.chained_assignment: [default: warn] [currently: warn]
: string
        Raise an exception, warn, or no action if trying to use chained assignment,
        The default is warn
mode.sim_interactive: [default: False] [currently: False]
: boolean
        Whether to simulate interactive mode for purposes of testing
mode.use_inf_as_null: [default: False] [currently: False]
: boolean
        True means treat None, NaN, INF, -INF as null (old way),
        False means None and NaN are null, but INF, -INF are not null
        (new way).

or you can get the description for just the options that match the regexp you pass in:

In [253]: describe_option("date")
display.date_dayfirst: [default: False] [currently: False]
: boolean
        When True, prints and parses dates with the day first, eg 20/01/2005
display.date_yearfirst: [default: False] [currently: False]
: boolean
        When True, prints and parses dates with the year first, eg 2005/01/20

All options also have a default value, and you can use the reset_option to do just that:

In [254]: get_option("display.max_rows")
60

In [255]: set_option("display.max_rows",999)

In [256]: get_option("display.max_rows")
999

In [257]: reset_option("display.max_rows")

In [258]: get_option("display.max_rows")
60

It’s also possible to reset multiple options at once (using a regex):

In [259]: reset_option("^display")

Console Output Formatting¶

Use the set_eng_float_format function in the pandas.core.common module to alter the floating-point formatting of pandas objects to produce a particular format.

For instance:

In [260]: set_eng_float_format(accuracy=3, use_eng_prefix=True)

In [261]: s = Series(randn(5), index=['a', 'b', 'c', 'd', 'e'])

In [262]: s/1.e3

a      1.116m
b   -829.274u
c    402.284u
d    159.191u
e   -447.033u
dtype: float64

In [263]: s/1.e6

a      1.116u
b   -829.274n
c    402.284n
d    159.191n
e   -447.033n
dtype: float64

The set_printoptions function has a number of options for controlling how floating point numbers are formatted (using hte precision argument) in the console and . The max_rows and max_columns control how many rows and columns of DataFrame objects are shown by default. If max_columns is set to 0 (the default, in fact), the library will attempt to fit the DataFrame’s string representation into the current terminal width, and defaulting to the summary view otherwise.

Navigation

Table Of Contents

Search

Essential Basic Functionality¶

Head and Tail¶

Attributes and the raw ndarray(s)¶

Accelerated operations¶

Flexible binary operations¶

Matching / broadcasting behavior¶

Missing data / operations with fill values¶

Flexible Comparisons¶

Boolean Reductions¶

Combining overlapping data sets¶

General DataFrame Combine¶

Descriptive statistics¶

Summarizing data: describe¶

Index of Min/Max Values¶

Value counts (histogramming) / Mode¶

Discretization and quantiling¶

Function application¶

Applying elementwise Python functions¶

Reindexing and altering labels¶

Reindexing to align with another object¶

Reindexing with reindex_axis¶

Aligning objects with each other with align¶

Filling while reindexing¶

Dropping labels from an axis¶

Renaming / mapping labels¶

Iteration¶

iteritems¶

iterrows¶

itertuples¶

Vectorized string methods¶

Splitting and Replacing Strings¶

Extracting Substrings¶

Testing for Strings that Match or Contain a Pattern¶

Sorting by index and value¶

Copying¶

dtypes¶

defaults¶

upcasting¶

astype¶

object conversion¶

gotchas¶

Working with package options¶

Console Output Formatting¶

Navigation

Reindexing with `reindex_axis`¶

Aligning objects with each other with `align`¶