Skip to content

Deprecate inplace methods #1756

Closed
Closed
@shoyer

Description

@shoyer

The following methods have an inplace argument:
DataArray.reset_coords
DataArray.set_index
DataArray.reset_index
DataArray.reorder_levels
Dataset.set_coords
Dataset.reset_coords
Dataset.rename
Dataset.swap_dims
Dataset.set_index
Dataset.reset_index
Dataset.reorder_levels
Dataset.update
Dataset.merge

As proposed in #1755 (comment), let's deprecate all of these at the next major release (v0.11). They add unnecessary complexity to methods and promote confusing about xarray's data model.

Practically, we would change all of the default values to inplace=None and issue either a DeprecationWarning or FutureWarning (see PEP 565 for more details on that choice).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions