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, column_space, date_dayfirst, date_yearfirst, encoding, expand_frame_repr, float_format]

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

• display.[large_repr]

• display.latex.[escape, longtable, multicolumn, multicolumn_format, multirow, repr]

• display.[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]

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

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

• 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, use_inf_as_null]

• 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, по умолчанию True

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

Возвращает

None по умолчанию, описание(я) в виде строки unicode, если _print_desc

равно False

Примечания

Для получения дополнительной информации, обратитесь к Руководству пользователя.

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

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

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

display.colheader_justify:‘left’/’right’

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

display.column_space No description available.

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

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> для представления DataFrame в HTML. [по умолчанию: 1] [текущее значение: 1]

display.html.table_schema:boolean

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

display.html.use_mathjax:boolean

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

display.large_repr:‘truncate’/’info’

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

display.latex.escape:bool

Указывает, использует ли метод to_latex DataFrame экранирование специальных символов. Допустимые значения: False,True [по умолчанию: True] [текущее значение: True]

display.latex.longtable :bool

Указывает, использует ли метод to_latex DataFrame формат longtable. Допустимые значения: False,True [по умолчанию: False] [текущее значение: False]

display.latex.multicolumn:bool

Указывает, использует ли метод to_latex DataFrame многостолбцы для красивого отображения столбцов MultiIndex. Допустимые значения: False,True [по умолчанию: True] [текущее значение: True]

display.latex.multicolumn_format:bool

Указывает, использует ли метод to_latex DataFrame многостолбцы для красивого отображения столбцов MultiIndex. Допустимые значения: False,True [по умолчанию: l] [текущее значение: l]

display.latex.multirow:bool

Указывает, использует ли метод to_latex DataFrame многостроки для красивого отображения строк MultiIndex. Допустимые значения: False,True [по умолчанию: False] [текущее значение: False]

display.latex.repr:boolean

Определяет, нужно ли генерировать представление DataFrame в формате LaTeX для сред Jupyter, которые его поддерживают. (по умолчанию: False) [по умолчанию: False] [текущее значение: False]

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, и pandas будет автоматически определять ширину терминала и выводить усечённый объект, который помещается в ширине экрана. IPython notebook, IPython qtconsole или IDLE не работают в терминале, и поэтому корректное автоматическое определение ширины невозможно. [по умолчанию: 0] [текущее значение: 0]

display.max_colwidth:int or None

Максимальная ширина столбца в символах в представлении pandas data structure. При переполнении столбца в выводе вставляется маркер “…” . Значение ‘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 or None

df.info() обычно показывает количество пропущенных значений для каждого столбца. Для больших кадров это может быть довольно медленным. 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 notebook, 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 notebook будет использовать 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’, размерности выводятся только если DataFrame усечён (т.е. не отображаются все строки и/или столбцы) [по умолчанию: truncate] [текущее значение: truncate]

display.unicode.ambiguous_as_wide:boolean

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

display.unicode.east_asian_width:boolean

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

display.width:int

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

io.excel.ods.reader:string

Движок чтения по умолчанию для файлов «ods». Доступные опции: auto, odf. [по умолчанию: auto] [текущее значение: auto]

io.excel.ods.writer:string

Движок записи по умолчанию для файлов «ods». Доступные опции: auto, odf. [по умолчанию: auto] [текущее значение: auto]

io.excel.xls.reader:string

Движок чтения по умолчанию для файлов «xls». Доступные опции: auto, xlrd. [по умолчанию: auto] [текущее значение: auto]

io.excel.xls.writer:строка

Стандартный движок Excel для файлов ‘xls’. Доступные варианты: auto, xlwt. [по умолчанию: auto] [в данный момент: auto] (Устарело, используйте `` вместо.)

io.excel.xlsb.reader:строка

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

io.excel.xlsm.reader:строка

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

io.excel.xlsm.writer:строка

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

io.excel.xlsx.reader:строка

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

io.excel.xlsx.writer:строка

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

io.hdf.default_format:формат

формат записи по умолчанию, если None, то put по умолчанию использует ‘fixed’, а append — ‘table’ [по умолчанию: None] [в данный момент: None]

io.hdf.dropna_table:булево

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

io.parquet.engine:строка

Стандартный движок parquet для чтения/записи. Доступные варианты: ‘auto’, ‘pyarrow’, ‘fastparquet’, по умолчанию ‘auto’ [по умолчанию: auto] [в данный момент: auto]

io.sql.engine:строка

Стандартный движок sql для чтения/записи. Доступные варианты: ‘auto’, ‘sqlalchemy’, по умолчанию ‘auto’ [по умолчанию: auto] [в данный момент: auto]

mode.chained_assignment:строка

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

mode.copy_on_write:bool

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

mode.data_manager:строка

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

mode.sim_interactive:булево

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

mode.string_storage:строка

Стандартное хранилище для StringDtype. [по умолчанию: python] [в данный момент: python]

mode.use_inf_as_na:булево

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

mode.use_inf_as_null:булево

use_inf_as_null устарело и будет удалено в будущей версии. Используйте вместо него use_inf_as_na. [по умолчанию: False] [в данный момент: False] (Устарело, используйте вместо него mode.use_inf_as_na.)

plotting.backend:строка

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

plotting.matplotlib.register_converters:bool или ‘auto’.

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

styler.format.decimal:строка

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

styler.format.escape:строка, необязательно

Выполнять ли экранирование определенных символов в зависимости от контекста; html или latex. [по умолчанию: None] [в данный момент: None]

styler.format.formatter:строка, вызываемый объект, словарь, необязательно

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

styler.format.na_rep:строка, необязательно

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

styler.format.precision:целое число

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

styler.format.thousands:строка, необязательно

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

styler.html.mathjax:булево

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

styler.latex.environment:строка

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

styler.latex.hrules:булево

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

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

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

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

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

styler.render.encoding:строка

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

styler.render.max_columns:целое число, необязательно

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

styler.render.max_elements:целое число

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

styler.render.max_rows:целое число, необязательно

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

styler.render.repr:строка

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

styler.sparse.columns:булево

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

styler.sparse.index:булево

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