@@ -1283,12 +1283,12 @@ def set_names(self, names, level=None, inplace=False):
1283
1283
Parameters
1284
1284
----------
1285
1285
names : str or sequence
1286
- name (s) to set
1286
+ Name (s) to set.
1287
1287
level : int, level name, or sequence of int/level names (default None)
1288
1288
If the index is a MultiIndex (hierarchical), level(s) to set (None
1289
- for all levels). Otherwise level must be None
1289
+ for all levels). Otherwise level must be None.
1290
1290
inplace : bool
1291
- if True, mutates in place
1291
+ If True, mutates in place.
1292
1292
1293
1293
Returns
1294
1294
-------
@@ -1302,16 +1302,16 @@ def set_names(self, names, level=None, inplace=False):
1302
1302
Int64Index([1, 2, 3, 4], dtype='int64', name='foo')
1303
1303
1304
1304
>>> idx = pd.MultiIndex.from_tuples([(1, u'one'), (1, u'two'),
1305
- (2, u'one'), (2, u'two')],
1306
- names=['foo', 'bar'])
1305
+ ... (2, u'one'), (2, u'two')],
1306
+ ... names=['foo', 'bar'])
1307
1307
>>> idx.set_names(['baz', 'quz'])
1308
- MultiIndex(levels=[[1, 2], [u 'one', u 'two']],
1308
+ MultiIndex(levels=[[1, 2], ['one', 'two']],
1309
1309
labels=[[0, 0, 1, 1], [0, 1, 0, 1]],
1310
- names=[u 'baz', u 'quz'])
1310
+ names=['baz', 'quz'])
1311
1311
>>> idx.set_names('baz', level=0)
1312
- MultiIndex(levels=[[1, 2], [u 'one', u 'two']],
1312
+ MultiIndex(levels=[[1, 2], ['one', 'two']],
1313
1313
labels=[[0, 0, 1, 1], [0, 1, 0, 1]],
1314
- names=[u 'baz', u 'bar'])
1314
+ names=['baz', 'bar'])
1315
1315
1316
1316
See also
1317
1317
--------
@@ -1345,35 +1345,35 @@ def set_names(self, names, level=None, inplace=False):
1345
1345
def rename (self , name , inplace = False ):
1346
1346
"""
1347
1347
Set new names on index. Defaults to returning new index.
1348
+
1348
1349
Length of names must match number of levels in MultiIndex.
1349
1350
1350
1351
Parameters
1351
1352
----------
1352
- name : str or sequence
1353
- name (s) to set
1353
+ name : str or list
1354
+ Name (s) to set.
1354
1355
inplace : bool
1355
- if True, mutates in place
1356
+ If True, mutates in place.
1356
1357
1357
1358
Returns
1358
1359
-------
1359
1360
new index (of same type and class...etc) [if inplace, returns None]
1360
1361
1361
1362
Examples
1362
1363
--------
1363
- >>> idx = Index([1, 2, 3, 4], name='foo')
1364
- Int64Index([1, 2, 3, 4], dtype='int64', name='foo')
1364
+ >>> idx = pd.Index([1, 2, 3, 4], name='foo')
1365
1365
>>> idx.rename('bar')
1366
1366
Int64Index([1, 2, 3, 4], dtype='int64', name='bar')
1367
1367
1368
- >>> idx = MultiIndex.from_tuples([(1, u'one'), (1, u'two'),
1369
- (2, u'one'), (2, u'two')],
1370
- names=['foo', 'bar'])
1371
- >>> idx.rename(['bar', None], inplace=True)
1372
- >>> idx
1368
+ >>> idx = pd.MultiIndex.from_tuples([(1, u'one'), (1, u'two'),
1369
+ ... (2, u'one'), (2, u'two')],
1370
+ ... names=['foo', 'bar'])
1371
+ >>> idx.rename(['bar', None])
1373
1372
MultiIndex(levels=[[1, 2], ['one', 'two']],
1374
- labels=[[0, 0, 1, 1], [0, 1, 0, 1]],
1375
- names=['bar', None])
1373
+ labels=[[0, 0, 1, 1], [0, 1, 0, 1]],
1374
+ names=['bar', None])
1376
1375
>>> idx.rename(['bar'])
1376
+ Traceback (most recent call last):
1377
1377
ValueError: Length of names must match number of levels in MultiIndex.
1378
1378
1379
1379
See also
0 commit comments