Skip to content

PDEP-8: Inplace methods in pandas #51466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
simonjayhawkins merged 18 commits into from
Jul 22, 2025
Merged

PDEP-8: Inplace methods in pandas #51466

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
55cff53
PDEP 8: Inplace methods in pandas
lithomas1 Feb 17, 2023
57390ad
changes
lithomas1 Feb 17, 2023
92c6a0a
Update
lithomas1 Feb 23, 2023
fee405b
Merge branch 'main' into pdep8
phofl Feb 28, 2023
6b0a91b
Apply suggestions from code review
lithomas1 Mar 11, 2023
03ace50
cleanups + formatting
lithomas1 Mar 12, 2023
2110b34
simplify by focusing on inplace keyword (removing explicit listing of…
jorisvandenbossche Mar 20, 2023
2ca875a
explain values-inplace vs object-inplace
jorisvandenbossche Mar 20, 2023
cf1c3c1
Merge remote-tracking branch 'upstream/main' into pdep8
jorisvandenbossche Oct 27, 2023
762f4cb
Some textual edits to Proposed changes section
jorisvandenbossche Oct 27, 2023
eb4f6f8
clarify example of replace method and relationship with CoW rules
jorisvandenbossche Oct 27, 2023
1a4605d
Update PDEP8 text around open questions
jorisvandenbossche Oct 27, 2023
733e06a
update timeline for deprecation/removal
jorisvandenbossche Nov 13, 2023
04ad61e
update abstract
jorisvandenbossche Nov 13, 2023
4bbd02f
Apply suggestions from code review
jorisvandenbossche Dec 4, 2023
2654fe9
Merge remote-tracking branch 'upstream/main' into pdep8
jorisvandenbossche Dec 4, 2023
ff0958a
Merge branch 'main' of https://github.com/pandas-dev/pandas into pdep8
rhshadrach Feb 16, 2025
1cbf071
Update status to accepted
rhshadrach Feb 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update timeline for deprecation/removal
  • Loading branch information
@jorisvandenbossche
jorisvandenbossche committed Nov 13, 2023
commit 733e06af309c924bcf5228574dcfa50f070b9e88
27 changes: 17 additions & 10 deletions web/pandas/pdeps/0008-inplace-methods-in-pandas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,16 +409,23 @@ It may be helpful to review those discussions (see links) [^2] [^3] [^4] to bett

## Timeline

Copy-on-Write is a relatively new feature (added in version 1.5) and some methods are missing the "lazy copy"
optimization (equivalent to `copy=False`).

Therefore, we propose deprecating the `copy` and `inplace` parameters in pandas 2.1, to
allow for bugs with Copy-on-Write to be addressed and for more optimizations to be added.

Hopefully, users will be able to switch to Copy-on-Write to keep the no-copy behavior and to silence the warnings.

The full removal of the `copy` parameter and `inplace` (where necessary) is set for pandas 3.0, which will coincide
with the enablement of Copy-on-Write for pandas by default.
The `inplace` keyword is widely used, and thus we need to take considerable time to
deprecate and remove this feature.

- For those methods where the `inplace` keyword will be removed, we add a
DeprecationWarning in the first release after acceptance (2.2 if possible, otherwise
3.0)
- Together with enabling Copy-on-Write in the pandas 3.0 major release, we already
update those methods that will keep the `inplace` keyword with the new behaviour
(returning `self`, working inplace when possible)
- Somewhere during the 3.x release cycle (e.g. in 3.1, depending on when the deprecation
was started), we change the DeprecationWarning to a more visible FutureWarning.
- The deprecated keyword is removed in pandas 4.0.

When introducing the warning in 2.2 (or 3.0), users will already have the ability to
enable Copy-on-Write so they can rewrite their code in a way that avoids the deprecation
warning (remove the usage of `inplace`) while keeping the no-copy behaviour (which will
be the default with Copy-on-Write).

## PDEP History

Expand Down