Pandas Util xs_df¶
xs_df
¶
xs_df(df: DataFrame, keys: Hashable | list[Hashable], axis: Axis = 0, level: Hashable = None) -> DataFrame
Extract cross-section from MultiIndex DataFrame with support for multiple keys.
Works like DataFrame.xs, but also accepts a list of keys.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
df
|
DataFrame
|
Input DataFrame with MultiIndex (either on index or columns). |
required |
keys
|
Hashable | list[Hashable]
|
Single key or list of keys to select from the specified level. For single keys, uses pandas .xs() method with drop_level=True. For multiple keys, uses .isin() for efficient selection. |
required |
axis
|
Axis
|
Axis to operate on. Can be 0/'index'/'rows' for index operations or 1/'columns' for column operations. Defaults to 0. |
0
|
level
|
Hashable
|
Name or position of the MultiIndex level to select from. Must be specified for MultiIndex operations. |
None
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
DataFrame with cross-section data. For single keys, the specified level is dropped. For multiple keys, the level is preserved. |
Examples:
>>> prices = study.scen.fetch('Node.Results.price')
>>> xs_df(prices, 'base', axis='columns', level='dataset').columns.tolist()
['N1', 'N2', 'N3', 'N4']
>>> xs_df(prices, ['base', 'short'], axis='columns', level='dataset').columns.get_level_values('dataset').unique().tolist()
['base', 'short']
Source code in src/mesqual/utils/pandas_utils/xs_df.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | |