pandas.describe_option

pandas.describe_option(pat, _print_desc=False)=<pandas._config.config.CallableDynamicDoc object>

Выводит описание одного или нескольких зарегистрированных параметров.

Вызов без аргументов выводит список всех зарегистрированных параметров.

Доступные параметры:

• compute.[use_bottleneck, use_numba, use_numexpr]

• display.[chop_threshold, colheader_justify, date_dayfirst, date_yearfirst, encoding, expand_frame_repr, float_format]

• display.html.[border, table_schema, use_mathjax]

• display.[large_repr, max_categories, max_columns, max_colwidth, max_dir_items, max_info_columns, max_info_rows, max_rows, max_seq_items, memory_usage, min_rows, multi_sparse, notebook_repr_html, pprint_nest_depth, precision, show_dimensions]

• display.unicode.[ambiguous_as_wide, east_asian_width]

• display.[width]

• future.[infer_string, no_silent_downcasting]

• io.excel.ods.[reader, writer]

• io.excel.xls.[reader]

• io.excel.xlsb.[reader]

• io.excel.xlsm.[reader, writer]

• io.excel.xlsx.[reader, writer]

• io.hdf.[default_format, dropna_table]

• io.parquet.[engine]

• io.sql.[engine]

• mode.[chained_assignment, copy_on_write, data_manager, sim_interactive, string_storage, use_inf_as_na]

• plotting.[backend]

• plotting.matplotlib.[register_converters]

• styler.format.[decimal, escape, formatter, na_rep, precision, thousands]

• styler.html.[mathjax]

• styler.latex.[environment, hrules, multicol_align, multirow_align]

• styler.render.[encoding, max_columns, max_elements, max_rows, repr]

• styler.sparse.[columns, index]

Параметры:

pat:str

Шаблон регулярного выражения. Будут выведены описания всех совпадающих ключей.

_print_desc:bool, default True

Если True (по умолчанию), описание(я) выводится в stdout. В противном случае описание(я) возвращается в виде строки Unicode (для тестирования).

Возвращает:

По умолчанию None; если _print_desc

равен False, возвращается описание(я) в виде строки Unicode

Примечания

Дополнительную информацию см. в руководстве пользователя.

Доступные параметры и их описания:

compute.use_bottleneck:bool

Использовать библиотеку bottleneck для ускорения, если она установлена; по умолчанию True. Допустимые значения: False,True [по умолчанию: True] [текущее значение: True]

compute.use_numba:bool

Использовать параметр движка numba для выбранных операций, если он установлен; по умолчанию False. Допустимые значения: False,True [по умолчанию: False] [текущее значение: False]

compute.use_numexpr:bool

Использовать библиотеку numexpr для ускорения вычислений, если она установлена; по умолчанию True. Допустимые значения: False,True [по умолчанию: True] [текущее значение: True]

display.chop_threshold:float or None

Если задано значение типа float, все значения с плавающей точкой, меньшие указанного порога, будут отображаться как точный 0 при выводе с помощью repr и связанных функций. [по умолчанию: None] [текущее значение: None]

display.colheader_justify:‘left’/’right’

Управляет выравниванием заголовков столбцов. Используется DataFrameFormatter. [по умолчанию: right] [текущее значение: right]

display.date_dayfirst:boolean

Если True, даты выводятся и разбираются так, что первым указывается день, например 20/01/2005 [по умолчанию: False] [текущее значение: False]

display.date_yearfirst:boolean

Если True, даты выводятся и разбираются так, что первым указывается год, например 2005/01/20 [по умолчанию: False] [текущее значение: False]

display.encoding:str/unicode

По умолчанию используется определённая кодировка консоли. Задаёт кодировку строк, возвращаемых методом to_string; обычно это строки, предназначенные для вывода в консоль. [по умолчанию: utf-8] [текущее значение: utf-8]

display.expand_frame_repr:boolean

Определяет, следует ли выводить полное представление DataFrame для широких DataFrame в несколько строк. Ограничение max_columns по-прежнему учитывается, но вывод будет переноситься на несколько «страниц», если его ширина превышает display.width. [по умолчанию: True] [текущее значение: True]

display.float_format:callable

Вызываемый объект должен принимать число с плавающей точкой и возвращать строку с желаемым форматом числа. Используется, например, в SeriesFormatter. Пример см. в formats.format.EngFormatter. [по умолчанию: None] [текущее значение: None]

display.html.border:int

Атрибут border=value добавляется в тег <table> для HTML-представления DataFrame. [по умолчанию: 1] [текущее значение: 1]

display.html.table_schema:boolean

Определяет, следует ли публиковать представление Table Schema для поддерживающих его интерфейсов. (по умолчанию: False) [по умолчанию: False] [текущее значение: False]

display.html.use_mathjax:boolean

Если True, блокнот Jupyter будет обрабатывать содержимое таблиц с помощью MathJax, отображая математические выражения, заключённые в символы доллара. (по умолчанию: True) [по умолчанию: True] [текущее значение: True]

display.large_repr:‘truncate’/’info’

Для DataFrame, превышающих max_rows/max_cols, представление (и HTML-представление) может показывать усечённую таблицу или переключаться на представление из df.info() (как это работало в предыдущих версиях pandas). [по умолчанию: truncate] [текущее значение: truncate]

display.max_categories:int

Задаёт максимальное число категорий, выводимых pandas при печати Categorical или Series с типом данных «category». [по умолчанию: 8] [текущее значение: 8]

display.max_columns:int

Если число столбцов превышает max_cols, используется усечённое представление. В зависимости от значения large_repr, объекты либо усекаются по центру, либо выводятся в виде сводки. Значение ‘None’ означает отсутствие ограничений.

Если python/IPython запущен в терминале и large_repr равно ‘truncate’, для этого параметра можно задать 0 или None, и pandas автоматически определит ширину терминала и выведет усечённый объект, который поместится по ширине экрана. Блокнот IPython, IPython qtconsole и IDLE не работают в терминале, поэтому корректное автоматическое определение невозможно; по умолчанию используется значение 20. [по умолчанию: 0] [текущее значение: 0]

display.max_colwidth:int or None

Максимальная ширина столбца в символах в представлении структуры данных pandas. Если содержимое столбца превышает это значение, в вывод вставляется заполнитель «…». Значение ‘None’ означает отсутствие ограничений. [по умолчанию: 50] [текущее значение: 50]

display.max_dir_items:int

Число элементов, добавляемых в dir(…). Значение ‘None’ означает отсутствие ограничений. Поскольку dir кэшируется, изменение этого параметра не сразу повлияет на уже существующие DataFrame, пока столбец не будет удалён или добавлен.

Например, это используется для подсказки столбцов DataFrame при автодополнении. [по умолчанию: 100] [текущее значение: 100]

display.max_info_columns:int

max_info_columns используется методом DataFrame.info, чтобы определить, следует ли выводить сведения по каждому столбцу. [по умолчанию: 100] [текущее значение: 100]

display.max_info_rows:int

df.info() обычно показывает количество значений null для каждого столбца. Для больших таблиц это может выполняться довольно медленно. max_info_rows и max_info_cols ограничивают эту проверку таблицами, размеры которых меньше указанных. [по умолчанию: 1690785] [текущее значение: 1690785]

display.max_rows:int

Если число строк превышает max_rows, используется усечённое представление. В зависимости от значения large_repr, объекты либо усекаются по центру, либо выводятся в виде сводки. Значение ‘None’ означает отсутствие ограничений.

Если python/IPython запущен в терминале и large_repr равно ‘truncate’, для этого параметра можно задать 0, и pandas автоматически определит высоту терминала и выведет усечённый объект, который поместится по высоте экрана. Блокнот IPython, IPython qtconsole и IDLE не работают в терминале, поэтому корректное автоматическое определение невозможно. [по умолчанию: 60] [текущее значение: 60]

display.max_seq_items:int or None

При форматированном выводе длинной последовательности будет напечатано не более max_seq_items элементов. Если некоторые элементы пропущены, в результирующую строку добавляется «…».

Если задано значение None, число выводимых элементов не ограничено. [по умолчанию: 100] [текущее значение: 100]

display.memory_usage:bool, string or None

Определяет, следует ли показывать использование памяти DataFrame при вызове df.info(). Допустимые значения: True,False,’deep’ [по умолчанию: True] [текущее значение: True]

display.min_rows:int

Число строк, отображаемых в усечённом представлении (когда превышено значение max_rows). Не учитывается, если для max_rows задано None или 0. Если задано значение None, используется значение max_rows. [по умолчанию: 10] [текущее значение: 10]

display.multi_sparse:boolean

«Разрежённое» отображение MultiIndex (не отображать повторяющиеся элементы внешних уровней внутри групп) [по умолчанию: True] [текущее значение: True]

display.notebook_repr_html:boolean

Если True, блокнот IPython будет использовать HTML-представление объектов pandas (если оно доступно). [по умолчанию: True] [текущее значение: True]

display.pprint_nest_depth:int

Управляет количеством вложенных уровней для обработки при форматированном выводе [по умолчанию: 3] [текущее значение: 3]

display.precision:int

Точность вывода чисел с плавающей точкой, выраженная количеством знаков после десятичной точки, как для обычного формата, так и для научной нотации. Аналогично precision в numpy.set_printoptions(). [по умолчанию: 6] [текущее значение: 6]

display.show_dimensions:boolean or ‘truncate’

Выводить ли размеры в конце представления DataFrame. Если указано значение ‘truncate’, размеры выводятся только в том случае, если фрейм усечён (например, отображаются не все строки и/или столбцы) [по умолчанию: truncate] [текущее значение: truncate]

display.unicode.ambiguous_as_wide:boolean

Использовать ли ширину символов Unicode для восточноазиатских языков при вычислении ширины отображаемого текста. Включение этой настройки может повлиять на производительность (по умолчанию: False) [по умолчанию: False] [текущее значение: False]

display.unicode.east_asian_width:boolean

Использовать ли ширину символов Unicode для восточноазиатских языков при вычислении ширины отображаемого текста. Включение этой настройки может повлиять на производительность (по умолчанию: False) [по умолчанию: False] [текущее значение: False]

display.width:int

Ширина отображения в символах. Если Python/IPython запущен в терминале, этому параметру можно присвоить None, и pandas корректно определит ширину автоматически. Обратите внимание, что IPython notebook, IPython qtconsole и IDLE не работают в терминале, поэтому корректно определить ширину невозможно. [по умолчанию: 80] [текущее значение: 80]

future.infer_string Следует ли определять последовательность объектов str как тип данных pyarrow string, который станет типом по умолчанию в pandas 3.0 (после чего этот параметр будет объявлен устаревшим).

[по умолчанию: False] [текущее значение: False]

future.no_silent_downcasting Следует ли включить будущее поведение, при котором результаты методов Series и DataFrame where, mask и clip не будут автоматически понижать тип без уведомления. Автоматическое понижение типа без уведомления будет удалено в pandas 3.0 (после чего этот параметр будет объявлен устаревшим).

[по умолчанию: False] [текущее значение: False]

io.excel.ods.reader:string

Механизм чтения Excel по умолчанию для файлов ‘ods’. Доступные варианты: auto, odf, calamine. [по умолчанию: auto] [текущее значение: auto]

io.excel.ods.writer:string

Механизм записи Excel по умолчанию для файлов ‘ods’. Доступные варианты: auto, odf. [по умолчанию: auto] [текущее значение: auto]

io.excel.xls.reader:string

Механизм чтения Excel по умолчанию для файлов ‘xls’. Доступные варианты: auto, xlrd, calamine. [по умолчанию: auto] [текущее значение: auto]

io.excel.xlsb.reader:string

Механизм чтения Excel по умолчанию для файлов ‘xlsb’. Доступные варианты: auto, pyxlsb, calamine. [по умолчанию: auto] [текущее значение: auto]

io.excel.xlsm.reader:string

Механизм чтения Excel по умолчанию для файлов ‘xlsm’. Доступные варианты: auto, xlrd, openpyxl, calamine. [по умолчанию: auto] [текущее значение: auto]

io.excel.xlsm.writer:string

Механизм записи Excel по умолчанию для файлов ‘xlsm’. Доступные варианты: auto, openpyxl. [по умолчанию: auto] [текущее значение: auto]

io.excel.xlsx.reader:string

Механизм чтения Excel по умолчанию для файлов ‘xlsx’. Доступные варианты: auto, xlrd, openpyxl, calamine. [по умолчанию: auto] [текущее значение: auto]

io.excel.xlsx.writer:string

Механизм записи Excel по умолчанию для файлов ‘xlsx’. Доступные варианты: auto, openpyxl, xlsxwriter. [по умолчанию: auto] [текущее значение: auto]

io.hdf.default_format:format

Формат записи по умолчанию: если указано None, put по умолчанию использует ‘fixed’, а append — ‘table’ [по умолчанию: None] [текущее значение: None]

io.hdf.dropna_table:boolean

удалять ВСЕ строки с nan при добавлении в таблицу [по умолчанию: False] [текущее значение: False]

io.parquet.engine:string

Механизм чтения/записи parquet по умолчанию. Доступные варианты: ‘auto’, ‘pyarrow’, ‘fastparquet’; по умолчанию используется ‘auto’ [по умолчанию: auto] [текущее значение: auto]

io.sql.engine:string

Механизм чтения/записи sql по умолчанию. Доступные варианты: ‘auto’, ‘sqlalchemy’; по умолчанию используется ‘auto’ [по умолчанию: auto] [текущее значение: auto]

mode.chained_assignment:string

Вызывать исключение, предупреждать или не предпринимать никаких действий при попытке использовать цепочное присваивание. По умолчанию выводится предупреждение [по умолчанию: warn] [текущее значение: warn]

mode.copy_on_write:bool

Использовать новое поведение копирования и представлений на основе Copy-on-Write. По умолчанию False, если не переопределено переменной среды ‘PANDAS_COPY_ON_WRITE’ (если установлено значение “1”, используется True; переменную необходимо задать до импорта pandas). [по умолчанию: False] [текущее значение: False]

mode.data_manager:string

Внутренний тип диспетчера данных; может иметь значение “block” или “array”. По умолчанию используется “block”, если не переопределено переменной среды ‘PANDAS_DATA_MANAGER’ (её необходимо задать до импорта pandas). [по умолчанию: block] [текущее значение: block] (Устарело, используйте ``.)

mode.sim_interactive:boolean

Имитировать ли интерактивный режим для целей тестирования [по умолчанию: False] [текущее значение: False]

mode.string_storage:string

Хранилище по умолчанию для StringDtype. [по умолчанию: auto] [текущее значение: auto]

mode.use_inf_as_na:boolean

True означает, что None, NaN, INF, -INF считаются NA (старый способ), False означает, что None и NaN являются null, а INF и -INF не считаются NA (новый способ).

Этот параметр устарел в pandas 2.1.0 и будет удалён в версии 3.0. [по умолчанию: False] [текущее значение: False] (Устарело, используйте ``.)

plotting.backend:str

Используемый механизм построения графиков. Значение по умолчанию — “matplotlib”, механизм, предоставляемый pandas. Другие механизмы можно указать, передав имя модуля, реализующего этот механизм. [по умолчанию: matplotlib] [текущее значение: matplotlib]

plotting.matplotlib.register_converters:bool or ‘auto’.

Регистрировать ли преобразователи в реестре единиц измерения matplotlib для дат, времени, даты и времени, а также периодов. При переключении на False преобразователи будут удалены, а преобразователи, перезаписанные pandas, восстановлены. [по умолчанию: auto] [текущее значение: auto]

styler.format.decimal:str

Символ, используемый в качестве десятичного разделителя для чисел с плавающей точкой и комплексных чисел. [по умолчанию: .] [текущее значение: .]

styler.format.escape:str, optional

Экранировать ли определённые символы в соответствии с указанным контекстом: html или latex. [по умолчанию: None] [текущее значение: None]

styler.format.formatter:str, callable, dict, optional

Объект форматирования, используемый по умолчанию в Styler.format. [по умолчанию: None] [текущее значение: None]

styler.format.na_rep:str, optional

Строковое представление значений, определённых как отсутствующие. [по умолчанию: None] [текущее значение: None]

styler.format.precision:int

Точность для чисел с плавающей точкой и комплексных чисел. [по умолчанию: 6] [текущее значение: 6]

styler.format.thousands:str, optional

Символ-разделитель тысяч для чисел с плавающей точкой, целых и комплексных чисел. [по умолчанию: None] [текущее значение: None]

styler.html.mathjax:bool

Если значение False, в атрибуты таблицы будут добавлены специальные CSS-классы, указывающие, что Mathjax не будет использоваться в Jupyter Notebook. [по умолчанию: True] [текущее значение: True]

styler.latex.environment:str

Среда, на которую заменяется \begin{table}. Если используется “longtable”, результатом будет специальный формат среды longtable. [по умолчанию: None] [текущее значение: None]

styler.latex.hrules:bool

Следует ли добавлять горизонтальные линии сверху, снизу и под заголовками. [по умолчанию: False] [текущее значение: False]

styler.latex.multicol_align:{“r”, “c”, “l”, “naive-l”, “naive-r”}

Указатель горизонтального выравнивания разреженных столбцов LaTeX, объединённых с помощью multicolumn. К значениям, отличным от naive, также можно добавлять символы вертикальной черты для отображения вертикальных линий: например, “|r” нарисует линию слева от объединённых ячеек с выравниванием по правому краю. [по умолчанию: r] [текущее значение: r]

styler.latex.multirow_align:{“c”, “t”, “b”}

Указатель вертикального выравнивания разреженных строк LaTeX, объединённых с помощью multirow. [по умолчанию: c] [текущее значение: c]

styler.render.encoding:str

Кодировка выходных файлов HTML и LaTeX. [по умолчанию: utf-8] [текущее значение: utf-8]

styler.render.max_columns:int, optional

Максимальное количество столбцов для отображения. Это значение всё ещё может быть уменьшено для соблюдения max_elements, которому отдаётся приоритет. [по умолчанию: None] [текущее значение: None]

styler.render.max_elements:int

Максимальное количество отображаемых элементов ячеек данных (<td>), после достижения которого при необходимости будут обрезаны столбцы, строки или и то и другое. [по умолчанию: 262144] [текущее значение: 262144]

styler.render.max_rows:int, optional

Максимальное количество строк для отображения. Это значение всё ещё может быть уменьшено для соблюдения max_elements, которому отдаётся приоритет. [по умолчанию: None] [текущее значение: None]

styler.render.repr:str

Определяет, какой формат вывода использовать в Jupyter Notebook: {“html”, “latex”}. [по умолчанию: html] [текущее значение: html]

styler.sparse.columns:bool

Следует ли разреженно отображать иерархические столбцы. Если установить значение False, для каждого столбца будут отображаться все явные элементы уровней иерархического ключа. [по умолчанию: True] [текущее значение: True]

styler.sparse.index:bool

Следует ли разреженно отображать иерархический индекс. Если установить значение False, для каждой строки будут отображаться все явные элементы уровней иерархического ключа. [по умолчанию: True] [текущее значение: True]

Примеры

>>> pd.describe_option('display.max_columns')  
display.max_columns : int
    If max_cols is exceeded, switch to truncate view...