pandas 1.4.2

ParametersReturns
swaplevel(self, i: 'Axis' = -2, j: 'Axis' = -1, axis: 'Axis' = 0) -> 'DataFrame'

Default is to swap the two innermost levels of the index.

Parameters

i, j : int or str

Levels of the indices to be swapped. Can pass level name as string.

axis : {0 or 'index', 1 or 'columns'}, default 0

The axis to swap levels on. 0 or 'index' for row-wise, 1 or 'columns' for column-wise.

Returns

DataFrame

DataFrame with levels swapped in MultiIndex.

Swap levels i and j in a MultiIndex .

Examples

This example is valid syntax, but we were not able to check execution
>>> df = pd.DataFrame(
...  {"Grade": ["A", "B", "A", "C"]},
...  index=[
...  ["Final exam", "Final exam", "Coursework", "Coursework"],
...  ["History", "Geography", "History", "Geography"],
...  ["January", "February", "March", "April"],
...  ],
... )
... df Grade Final exam History January A Geography February B Coursework History March A Geography April C

In the following example, we will swap the levels of the indices. Here, we will swap the levels column-wise, but levels can be swapped row-wise in a similar manner. Note that column-wise is the default behaviour. By not supplying any arguments for i and j, we swap the last and second to last indices.

This example is valid syntax, but we were not able to check execution
>>> df.swaplevel()
                                    Grade
Final exam  January     History         A
            February    Geography       B
Coursework  March       History         A
            April       Geography       C

By supplying one argument, we can choose which index to swap the last index with. We can for example swap the first index with the last one as follows.

This example is valid syntax, but we were not able to check execution
>>> df.swaplevel(0)
                                    Grade
January     History     Final exam      A
February    Geography   Final exam      B
March       History     Coursework      A
April       Geography   Coursework      C

We can also define explicitly which indices we want to swap by supplying values for both i and j. Here, we for example swap the first and second indices.

This example is valid syntax, but we were not able to check execution
>>> df.swaplevel(0, 1)
                                    Grade
History     Final exam  January         A
Geography   Final exam  February        B
History     Coursework  March           A
Geography   Coursework  April           C
See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /pandas/core/frame.py#6792
type: <class 'function'>
Commit: