Warning
Starting with the 1.x series of releases, pandas only supports Python 3.6.1 and higher.
Starting with Pandas 1.0.0, pandas will adopt a version of SemVer.
Historically, pandas has used a "rolling" deprecation policy, with occasional outright breaking API changes. Where possible, we would deprecate the behavior we'd like to change, giving an option to adopt the new behavior (via a keyword or an alternative method), and issuing a warning for users of the old behavior. Sometimes, a deprecation was not possible, and we would make an outright API breaking change.
We'll continue to introduce deprecations in major and minor releases (e.g. 1.0.0, 1.1.0, ...). Those deprecations will be enforced in the next major release.
Note that behavior changes and API breaking changes are not identical. API breaking changes will only be released in major versions. If we consider a behavior to be a bug, and fixing that bug induces a behavior change, we'll release that change in a minor release. This is a sometimes difficult judgment call that we'll do our best on.
This doesn't mean that pandas' pace of development will slow down. In the 2019 Pandas User Survey, about 95% of the respondents said they considered pandas "stable enough". This indicates there's an appetite for new features, even if it comes at the cost of break API. The difference is that now API breaking changes will be accompanied with a bump in the major version number (e.g. pandas 1.5.1 -> 2.0.0).
See :ref:`policies.version` for more.
{{ header }}
These are the changes in pandas 1.0.0. See :ref:`release` for a full changelog including other versions of pandas.
We've added :class:`StringDtype`, an extension type dedicated to string data. Previously, strings were typically stored in object-dtype NumPy arrays.
Warning
StringDtype
is currently considered experimental. The implementation
and parts of the API may change without warning.
The 'string'
extension type solves several issues with object-dtype NumPy arrays:
- You can accidentally store a mixture of strings and non-strings in an
object
dtype array. AStringArray
can only store strings. object
dtype breaks dtype-specific operations like :meth:`DataFrame.select_dtypes`. There isn't a clear way to select just text while excluding non-text, but still object-dtype columns.- When reading code, the contents of an
object
dtype array is less clear thanstring
.
.. ipython:: python pd.Series(['abc', None, 'def'], dtype=pd.StringDtype())
You can use the alias "string"
as well.
.. ipython:: python s = pd.Series(['abc', None, 'def'], dtype="string") s
The usual string accessor methods work. Where appropriate, the return type of the Series or columns of a DataFrame will also have string dtype.
.. ipython:: python s.str.upper() s.str.split('b', expand=True).dtypes
String accessor methods returning integers will return a value with :class:`Int64Dtype`
.. ipython:: python s.str.count("a")
We recommend explicitly using the string
data type when working with strings.
See :ref:`text.types` for more.
- :meth:`DataFrame.to_string` added the
max_colwidth
parameter to control when wide columns are truncated (:issue:`9784`) - :meth:`MultiIndex.from_product` infers level names from inputs if not explicitly provided (:issue:`27292`)
- :meth:`DataFrame.to_latex` now accepts
caption
andlabel
arguments (:issue:`25436`) - The :ref:`integer dtype <integer_na>` with support for missing values and the
new :ref:`string dtype <text.types>` can now be converted to
pyarrow
(>= 0.15.0), which means that it is supported in writing to the Parquet file format when using thepyarrow
engine. It is currently not yet supported when converting back to pandas, so it will become an integer or float (depending on the presence of missing data) or object dtype column. (:issue:`28368`) - :meth:`DataFrame.to_json` now accepts an
indent
integer argument to enable pretty printing of JSON output (:issue:`12004`) - :meth:`read_stata` can read Stata 119 dta files. (:issue:`28250`)
- Implemented :meth:`pandas.core.window.Window.var` and :meth:`pandas.core.window.Window.std` functions (:issue:`26597`)
- Added
encoding
argument to :meth:`DataFrame.to_string` for non-ascii text (:issue:`28766`) - Added
encoding
argument to :func:`DataFrame.to_html` for non-ascii text (:issue:`28663`) - :meth:`Styler.background_gradient` now accepts
vmin
andvmax
arguments (:issue:`12145`) - Roundtripping DataFrames with nullable integer or string data types to parquet (:meth:`~DataFrame.to_parquet` / :func:`read_parquet`) using the 'pyarrow' engine now preserve those data types with pyarrow >= 1.0.0 (:issue:`20612`).
Pandas has added a pyproject.toml file and will no longer include
cythonized files in the source distribution uploaded to PyPI (:issue:`28341`, :issue:`20775`). If you're installing
a built distribution (wheel) or via conda, this shouldn't have any effect on you. If you're building pandas from
source, you should no longer need to install Cython into your build environment before calling pip install pandas
.
As part of a larger refactor to :class:`MultiIndex` the level names are now stored separately from the levels (:issue:`27242`). We recommend using :attr:`MultiIndex.names` to access the names, and :meth:`Index.set_names` to update the names.
For backwards compatibility, you can still access the names via the levels.
.. ipython:: python mi = pd.MultiIndex.from_product([[1, 2], ['a', 'b']], names=['x', 'y']) mi.levels[0].name
However, it is no longer possible to update the names of the MultiIndex
via the name of the level. The following will silently fail to update the
name of the MultiIndex
.. ipython:: python mi.levels[0].name = "new name" mi.names
To update, use MultiIndex.set_names
, which returns a new MultiIndex
.
.. ipython:: python mi2 = mi.set_names("new name", level=0) mi2.names
New repr for :class:`pandas.core.arrays.IntervalArray`
- :class:`pandas.core.arrays.IntervalArray` adopts a new
__repr__
in accordance with other array classes (:issue:`25022`)
pandas 0.25.x
In [1]: pd.arrays.IntervalArray.from_tuples([(0, 1), (2, 3)])
Out[2]:
IntervalArray([(0, 1], (2, 3]],
closed='right',
dtype='interval[int64]')
pandas 1.0.0
.. ipython:: python pd.arrays.IntervalArray.from_tuples([(0, 1), (2, 3)])
- Bumpded the minimum supported version of
s3fs
from 0.0.8 to 0.3.0 (:issue:`28616`) - :class:`pandas.core.groupby.GroupBy.transform` now raises on invalid operation names (:issue:`27489`)
- :meth:`pandas.api.types.infer_dtype` will now return "integer-na" for integer and
np.nan
mix (:issue:`27283`) - :meth:`MultiIndex.from_arrays` will no longer infer names from arrays if
names=None
is explicitly provided (:issue:`27292`) - In order to improve tab-completion, Pandas does not include most deprecated attributes when introspecting a pandas object using
dir
(e.g.dir(df)
). To see which attributes are excluded, see an object's_deprecations
attribute, for examplepd.DataFrame._deprecations
(:issue:`28805`). - The returned dtype of ::func:`pd.unique` now matches the input dtype. (:issue:`27874`)
- Changed the default configuration value for
options.matplotlib.register_converters
fromTrue
to"auto"
(:issue:`18720`). Now, pandas custom formatters will only be applied to plots created by pandas, through :meth:`~DataFrame.plot`. Previously, pandas' formatters would be applied to all plots created after a :meth:`~DataFrame.plot`. See :ref:`units registration <whatsnew_1000.matplotlib_units>` for more. - :meth:`Series.dropna` has dropped its
**kwargs
argument in favor of a singlehow
parameter. Supplying anything else thanhow
to**kwargs
raised aTypeError
previously (:issue:`29388`)
- Added new section on :ref:`scale` (:issue:`28315`).
- Added sub-section Query MultiIndex in IO tools user guide (:issue:`28791`)
Index.set_value
has been deprecated. For a given indexidx
, arrayarr
, value inidx
ofidx_val
and a new value ofval
,idx.set_value(arr, idx_val, val)
is equivalent toarr[idx.get_loc(idx_val)] = val
, which should be used instead (:issue:`28621`).- :func:`is_extension_type` is deprecated, :func:`is_extension_array_dtype` should be used instead (:issue:`29457`)
SparseSeries
, SparseDataFrame
and the DataFrame.to_sparse
method
have been removed (:issue:`28425`). We recommend using a Series
or
DataFrame
with sparse values instead. See :ref:`sparse.migration` for help
with migrating existing code.
Matplotlib unit registration
Previously, pandas would register converters with matplotlib as a side effect of importing pandas (:issue:`18720`). This changed the output of plots made via matplotlib plots after pandas was imported, even if you were using matplotlib directly rather than rather than :meth:`~DataFrame.plot`.
To use pandas formatters with a matplotlib plot, specify
>>> import pandas as pd
>>> pd.options.plotting.matplotlib.register_converters = True
Note that plots created by :meth:`DataFrame.plot` and :meth:`Series.plot` do register the converters
automatically. The only behavior change is when plotting a date-like object via matplotlib.pyplot.plot
or matplotlib.Axes.plot
. See :ref:`plotting.formatters` for more.
Other removals
- Removed the previously deprecated :meth:`Series.get_value`, :meth:`Series.set_value`, :meth:`DataFrame.get_value`, :meth:`DataFrame.set_value` (:issue:`17739`)
- Changed the the default value of inplace in :meth:`DataFrame.set_index` and :meth:`Series.set_axis`. It now defaults to False (:issue:`27600`)
- :meth:`pandas.Series.str.cat` now defaults to aligning
others
, usingjoin='left'
(:issue:`27611`) - :meth:`pandas.Series.str.cat` does not accept list-likes within list-likes anymore (:issue:`27611`)
- Removed the previously deprecated :meth:`ExtensionArray._formatting_values`. Use :attr:`ExtensionArray._formatter` instead. (:issue:`23601`)
- Removed the previously deprecated
IntervalIndex.from_intervals
in favor of the :class:`IntervalIndex` constructor (:issue:`19263`) - Ability to read pickles containing :class:`Categorical` instances created with pre-0.16 version of pandas has been removed (:issue:`27538`)
- Removed the previously deprecated
reduce
andbroadcast
arguments from :meth:`DataFrame.apply` (:issue:`18577`) - Removed the previously deprecated
assert_raises_regex
function inpandas.util.testing
(:issue:`29174`) - Removed :meth:`Index.is_lexsorted_for_tuple` (:issue:`29305`)
- Removed support for nexted renaming in :meth:`DataFrame.aggregate`, :meth:`Series.aggregate`, :meth:`DataFrameGroupBy.aggregate`, :meth:`SeriesGroupBy.aggregate`, :meth:`Rolling.aggregate` (:issue:`29608`)
- :func:`read_stata` and :meth:`DataFrame.to_stata` no longer supports the "encoding" argument (:issue:`21400`)
- Performance improvement in indexing with a non-unique :class:`IntervalIndex` (:issue:`27489`)
- Performance improvement in MultiIndex.is_monotonic (:issue:`27495`)
- Performance improvement in :func:`cut` when
bins
is an :class:`IntervalIndex` (:issue:`27668`) - Performance improvement in :meth:`DataFrame.corr` when
method
is"spearman"
(:issue:`28139`) - Performance improvement in :meth:`DataFrame.replace` when provided a list of values to replace (:issue:`28099`)
- Performance improvement in :meth:`DataFrame.select_dtypes` by using vectorization instead of iterating over a loop (:issue:`28317`)
- Performance improvement in :meth:`Categorical.searchsorted` and :meth:`CategoricalIndex.searchsorted` (:issue:`28795`)
- Added test to assert the :func:`fillna` raises the correct ValueError message when the value isn't a value from categories (:issue:`13628`)
- Bug in :meth:`Categorical.astype` where
NaN
values were handled incorrectly when casting to int (:issue:`28406`) - :meth:`DataFrame.reindex` with a :class:`CategoricalIndex` would fail when the targets contained duplicates, and wouldn't fail if the source contained duplicates (:issue:`28107`)
- Bug in :meth:`Categorical.astype` not allowing for casting to extension dtypes (:issue:`28668`)
- Bug where :func:`merge` was unable to join on categorical and extension dtype columns (:issue:`28668`)
- :meth:`Categorical.searchsorted` and :meth:`CategoricalIndex.searchsorted` now work on unordered categoricals also (:issue:`21667`)
- Added test to assert roundtripping to parquet with :func:`DataFrame.to_parquet` or :func:`read_parquet` will preserve Categorical dtypes for string types (:issue:`27955`)
- Changed the error message in :meth:`Categorical.remove_categories` to always show the invalid removals as a set (:issue:`28669`)
- Using date accessors on a categorical dtyped :class:`Series` of datetimes was not returning an object of the same type as if one used the :meth:`.str.` / :meth:`.dt.` on a :class:`Series` of that type. E.g. when accessing :meth:`Series.dt.tz_localize` on a :class:`Categorical` with duplicate entries, the accessor was skipping duplicates (:issue: 27952)
- Bug in :meth:`DataFrame.replace` and :meth:`Series.replace` that would give incorrect results on categorical data (:issue:`26988`)
- Bug in :meth:`Series.__setitem__` incorrectly casting
np.timedelta64("NaT")
tonp.datetime64("NaT")
when inserting into a :class:`Series` with datetime64 dtype (:issue:`27311`) - Bug in :meth:`Series.dt` property lookups when the underlying data is read-only (:issue:`27529`)
- Bug in
HDFStore.__getitem__
incorrectly reading tz attribute created in Python 2 (:issue:`26443`) - Bug in :func:`to_datetime` where passing arrays of malformed
str
with errors="coerce" could incorrectly lead to raisingValueError
(:issue:`28299`) - Bug in :meth:`pandas.core.groupby.SeriesGroupBy.nunique` where
NaT
values were interfering with the count of unique values (:issue:`27951`) - Bug in :class:`Timestamp` subtraction when subtracting a :class:`Timestamp` from a
np.datetime64
object incorrectly raisingTypeError
(:issue:`28286`) - Addition and subtraction of integer or integer-dtype arrays with :class:`Timestamp` will now raise
NullFrequencyError
instead ofValueError
(:issue:`28268`) - Bug in :class:`Series` and :class:`DataFrame` with integer dtype failing to raise
TypeError
when adding or subtracting anp.datetime64
object (:issue:`28080`) - Bug in :class:`Week` with
weekday
incorrectly raisingAttributeError
instead ofTypeError
when adding or subtracting an invalid type (:issue:`28530`) - Bug in :class:`DataFrame` arithmetic operations when operating with a :class:`Series` with dtype 'timedelta64[ns]' (:issue:`28049`)
- Bug in :func:`pandas.core.groupby.generic.SeriesGroupBy.apply` raising
ValueError
when a column in the original DataFrame is a datetime and the column labels are not standard integers (:issue:`28247`) - Bug in :func:`pandas._config.localization.get_locales` where the
locales -a
encodes the locales list as windows-1252 (:issue:`23638`, :issue:`24760`, :issue:`27368`) - Bug in :meth:`Series.var` failing to raise
TypeError
when called withtimedelta64[ns]
dtype (:issue:`28289`) - Bug in :meth:`DatetimeIndex.strftime` and :meth:`Series.dt.strftime` where
NaT
was converted to the string'NaT'
instead ofnp.nan
(:issue:`29578`)
- Bug in subtracting a :class:`TimedeltaIndex` or :class:`TimedeltaArray` from a
np.datetime64
object (:issue:`29558`)
- Bug in :meth:`DataFrame.quantile` with zero-column :class:`DataFrame` incorrectly raising (:issue:`23925`)
- :class:`DataFrame` flex inequality comparisons methods (:meth:`DataFrame.lt`, :meth:`DataFrame.le`, :meth:`DataFrame.gt`, :meth: DataFrame.ge) with object-dtype and
complex
entries failing to raiseTypeError
like their :class:`Series` counterparts (:issue:`28079`) - Bug in :class:`DataFrame` logical operations (&, |, ^) not matching :class:`Series` behavior by filling NA values (:issue:`28741`)
- Bug in :meth:`DataFrame.interpolate` where specifying axis by name references variable before it is assigned (:issue:`29142`)
- Bug in :meth:`Series.var` not computing the right value with a nullable integer dtype series not passing through ddof argument (:issue:`29128`)
- Improved error message when using frac > 1 and replace = False (:issue:`27451`)
- Bug in numeric indexes resulted in it being possible to instantiate an :class:`Int64Index`, :class:`UInt64Index`, or :class:`Float64Index` with an invalid dtype (e.g. datetime-like) (:issue:`29539`)
- Bug in :class:`UInt64Index` precision loss while constructing from a list with values in the
np.uint64
range (:issue:`29526`)
- Calling :meth:`Series.str.isalnum` (and other "ismethods") on an empty Series would return an object dtype instead of bool (:issue:`29624`)
- Bug in assignment using a reverse slicer (:issue:`26939`)
- Bug in :meth:`DataFrame.explode` would duplicate frame in the presence of duplicates in the index (:issue:`28010`)
- Bug in reindexing a :meth:`PeriodIndex` with another type of index that contained a Period (:issue:`28323`) (:issue:`28337`)
- Fix assignment of column via .loc with numpy non-ns datetime type (:issue:`27395`)
- Bug in :meth:`Float64Index.astype` where
np.inf
was not handled properly when casting to an integer dtype (:issue:`28475`) - :meth:`Index.union` could fail when the left contained duplicates (:issue:`28257`)
- :meth:`Index.get_indexer_non_unique` could fail with TypeError in some cases, such as when searching for ints in a string index (:issue:`28257`)
- Constructior for :class:`MultiIndex` verifies that the given
sortorder
is compatible with the actuallexsort_depth
ifverify_integrity
parameter isTrue
(the default) (:issue:`28735`)
- :meth:`read_csv` now accepts binary mode file buffers when using the Python csv engine (:issue:`23779`)
- Bug in :meth:`DataFrame.to_json` where using a Tuple as a column or index value and using
orient="columns"
ororient="index"
would produce invalid JSON (:issue:`20500`) - Improve infinity parsing. :meth:`read_csv` now interprets
Infinity
,+Infinity
,-Infinity
as floating point values (:issue:`10065`) - Bug in :meth:`DataFrame.to_csv` where values were truncated when the length of
na_rep
was shorter than the text input data. (:issue:`25099`) - Bug in :func:`DataFrame.to_string` where values were truncated using display options instead of outputting the full content (:issue:`9784`)
- Bug in :meth:`DataFrame.to_json` where a datetime column label would not be written out in ISO format with
orient="table"
(:issue:`28130`) - Bug in :func:`DataFrame.to_parquet` where writing to GCS would fail with engine='fastparquet' if the file did not already exist (:issue:`28326`)
- Bug in :func:`read_hdf` closing stores that it didn't open when Exceptions are raised (:issue:`28699`)
- Bug in :meth:`DataFrame.read_json` where using
orient="index"
would not maintain the order (:issue:`28557`) - Bug in :meth:`DataFrame.to_html` where the length of the
formatters
argument was not verified (:issue:`28469`) - Bug in :meth:`DataFrame.read_excel` with
engine='ods'
whensheet_name
argument references a non-existent sheet (:issue:`27676`) - Bug in :meth:`pandas.io.formats.style.Styler` formatting for floating values not displaying decimals correctly (:issue:`13257`)
- Bug in :meth:`DataFrame.to_html` when using
formatters=<list>
andmax_cols
together. (:issue:`25955`) - Bug in :meth:`Styler.background_gradient` not able to work with dtype
Int64
(:issue:`28869`) - Bug in :meth:`DataFrame.to_clipboard` which did not work reliably in ipython (:issue:`22707`)
- Bug in :func:`read_json` where default encoding was not set to
utf-8
(:issue:`29565`)
- Bug in :meth:`Series.plot` not able to plot boolean values (:issue:`23719`)
- Bug in :meth:`DataFrame.plot` not able to plot when no rows (:issue:`27758`)
- Bug in :meth:`DataFrame.plot` producing incorrect legend markers when plotting multiple series on the same axis (:issue:`18222`)
- Bug in :meth:`DataFrame.plot` when
kind='box'
and data contains datetime or timedelta data. These types are now automatically dropped (:issue:`22799`) - Bug in :meth:`DataFrame.plot.line` and :meth:`DataFrame.plot.area` produce wrong xlim in x-axis (:issue:`27686`, :issue:`25160`, :issue:`24784`)
- Bug where :meth:`DataFrame.boxplot` would not accept a color parameter like DataFrame.plot.box (:issue:`26214`)
- Bug in the
xticks
argument being ignored for :meth:`DataFrame.plot.bar` (:issue:`14119`) - :func:`set_option` now validates that the plot backend provided to
'plotting.backend'
implements the backend when the option is set, rather than when a plot is created (:issue:`28163`) - :meth:`DataFrame.plot` now allow a
backend
keyword arugment to allow changing between backends in one session (:issue:`28619`). - Bug in color validation incorrectly raising for non-color styles (:issue:`29122`).
- Bug in :meth:`DataFrame.groupby` with multiple groups where an
IndexError
would be raised if any group contained all NA values (:issue:`20519`) - Bug in :meth:`pandas.core.resample.Resampler.size` and :meth:`pandas.core.resample.Resampler.count` returning wrong dtype when used with an empty series or dataframe (:issue:`28427`)
- Bug in :meth:`DataFrame.rolling` not allowing for rolling over datetimes when
axis=1
(:issue: 28192) - Bug in :meth:`DataFrame.rolling` not allowing rolling over multi-index levels (:issue: 15584).
- Bug in :meth:`DataFrame.rolling` not allowing rolling on monotonic decreasing time indexes (:issue: 19248).
- Bug in :meth:`DataFrame.groupby` not offering selection by column name when
axis=1
(:issue:`27614`) - Bug in :meth:`DataFrameGroupby.agg` not able to use lambda function with named aggregation (:issue:`27519`)
- Bug in :meth:`DataFrame.groupby` losing column name information when grouping by a categorical column (:issue:`28787`)
- Bug in :meth:`DataFrameGroupBy.rolling().quantile()` ignoring
interpolation
keyword argument (:issue:`28779`)
- Bug in :meth:`DataFrame.apply` that caused incorrect output with empty :class:`DataFrame` (:issue:`28202`, :issue:`21959`)
- Bug in :meth:`DataFrame.stack` not handling non-unique indexes correctly when creating MultiIndex (:issue: 28301)
- Bug :func:`merge_asof` could not use :class:`datetime.timedelta` for
tolerance
kwarg (:issue:`28098`) - Bug in :func:`merge`, did not append suffixes correctly with MultiIndex (:issue:`28518`)
- :func:`qcut` and :func:`cut` now handle boolean input (:issue:`20303`)
- Fix to ensure all int dtypes can be used in :func:`merge_asof` when using a tolerance value. Previously every non-int64 type would raise an erroneous
MergeError
(:issue:`28870`). - Better error message in :func:`get_dummies` when columns isn't a list-like value (:issue:`28383`)
- Bug :meth:`Series.pct_change` where supplying an anchored frequency would throw a ValueError (:issue:`28664`)
- Bug where :meth:`DataFrame.equals` returned True incorrectly in some cases when two DataFrames had the same columns in different orders (:issue:`28839`)
- Bug in :class:`SparseDataFrame` arithmetic operations incorrectly casting inputs to float (:issue:`28107`)
- Bug in :class:`arrays.PandasArray` when setting a scalar string (:issue:`28118`, :issue:`28150`).
- Trying to set the
display.precision
,display.max_rows
ordisplay.max_columns
using :meth:`set_option` to anything but aNone
or a positive int will raise aValueError
(:issue:`23348`) - Using :meth:`DataFrame.replace` with overlapping keys in a nested dictionary will no longer raise, now matching the behavior of a flat dictionary (:issue:`27660`)
- :meth:`DataFrame.to_csv` and :meth:`Series.to_csv` now support dicts as
compression
argument with key'method'
being the compression method and others as additional compression options when the compression method is'zip'
. (:issue:`26023`) - Bug in :meth:`Series.diff` where a boolean series would incorrectly raise a
TypeError
(:issue:`17294`) - :meth:`Series.append` will no longer raise a
TypeError
when passed a tuple ofSeries
(:issue:`28410`) - :meth:`SeriesGroupBy.value_counts` will be able to handle the case even when the :class:`Grouper` makes empty groups (:issue: 28479)
- Fix corrupted error message when calling
pandas.libs._json.encode()
on a 0d array (:issue:`18878`) - Bug in :meth:`DataFrame.append` that raised
IndexError
when appending with empty list (:issue:`28769`) - Fix :class:`AbstractHolidayCalendar` to return correct results for years after 2030 (now goes up to 2200) (:issue:`27790`)