Функция describe_option

Функция describe_option применяется для получения подробного описания конкретной опции конфигурации Pandas. Она выводит информацию о назначении, допустимых значениях и поведении опции. Первым параметром передаётся строка с путём к опции, например, display.max_rows.

Синтаксис

pd.describe_option(pattern)

Пример

Давайте получим описание опции display.max_rows:

import pandas as pd

pd.describe_option("display.max_rows")

Результат выполнения кода:

display.max_rows : int or None
If this is set to a number, pandas will not show rows above this
number. Default is 60.
[default: 60] [currently: 60]

Пример

Получим описание опции display.precision:

import pandas as pd

pd.describe_option("display.precision")

Результат выполнения кода:

display.precision : int
Floating point output precision in terms of number of places after
the decimal, for regular formatting as well as scientific notation.
[default: 6] [currently: 6]

Пример

Получим описание нескольких опций, начинающихся с display.max:

import pandas as pd

pd.describe_option("display.max")

Результат выполнения кода:

display.max_rows : int or None
...
display.max_columns : int or None
...
display.max_colwidth : int or None
...
display.max_info_rows : int or None
...

Пример

Если опция не найдена, функция не выводит результат:

import pandas as pd

pd.describe_option("display.nonexistent")

Результат выполнения кода:

""

Смотрите также

функция set_option,
которая устанавливает значение опции
функция get_option,
которая получает значение опции
функция reset_option,
которая сбрасывает опцию к значению по умолчанию
функция option_context,
которая временно меняет значения опций