pandas.describe_option

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

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

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

Доступные опции:

• compute.[use_bottleneck, use_numexpr]
• display.[chop_threshold, colheader_justify, column_space, date_dayfirst, date_yearfirst, encoding, expand_frame_repr, float_format, height]
• display.html.[border, table_schema]
• display.[large_repr]
• display.latex.[escape, longtable, multicolumn, multicolumn_format, multirow, repr]
• display.[line_width, max_categories, max_columns, max_colwidth, max_info_columns, max_info_rows, max_rows, max_seq_items, memory_usage, multi_sparse, notebook_repr_html, pprint_nest_depth, precision, show_dimensions]
• display.unicode.[ambiguous_as_wide, east_asian_width]
• display.[width]
• html.[border]
• io.excel.xls.[writer]
• io.excel.xlsm.[writer]
• io.excel.xlsx.[writer]
• io.hdf.[default_format, dropna_table]
• io.parquet.[engine]
• mode.[chained_assignment, sim_interactive, use_inf_as_na, use_inf_as_null]
• plotting.matplotlib.[register_converters]

Параметры:	pat : str Шаблон регулярного выражения. Все совпадающие ключи будут отображены вместе с их описанием. _print_desc : bool, по умолчанию True Если True (по умолчанию), описание(я) будет(будут) выведены в стандартный вывод. В противном случае, описание(я) вернётся(вернутся) в виде строки Unicode (для тестирования).
Возвращает:	По умолчанию None, описание(я) в виде строки Unicode, если _print_desc равно False

Примечания

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

compute.use_bottleneck : bool

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

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 Нет описания.

[по умолчанию: 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.height : int

Устарело. [по умолчанию: 60] [текущее значение: 60]

display.html.border : int

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

display.html.table_schema : boolean

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

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.line_width : int

Устарело. [по умолчанию: 80] [текущее значение: 80]

display.max_categories : int

Устанавливает максимальное количество категорий, которое pandas должен вывести при печати Categorical или Series типа “category”. [по умолчанию: 8] [текущее значение: 8]

display.max_columns : int

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

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

display.max_colwidth : int

Максимальная ширина в символах столбца в представлении pandas data structure. При переполнении столбца в выводе используется маркер ”...". [по умолчанию: 50] [текущее значение: 50]

display.max_info_columns : int

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

display.max_info_rows : int or None

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

display.max_rows : int

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

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

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.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

Точность вывода чисел с плавающей точкой (количество значащих цифр). Это только предположение [по умолчанию: 6] [текущее значение: 6]

display.show_dimensions : boolean or ‘truncate’

Выводить ли размерности в конце представления DataFrame. Если указано ‘truncate’, выводятся только размерности, если таблица усечена (например, не отображаются все строки и/или столбцы) [по умолчанию: 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]

html.border : int

Атрибут border=value вставлен в тег <table> для представления DataFrame в формате HTML. [по умолчанию: 1] [текущее значение: 1] (Устарело, используйте display.html.border вместо него.)

io.excel.xls.writer : string

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

io.excel.xlsm.writer : string

По умолчанию движок Excel-писателя для файлов ‘xlsm’. Доступные варианты: auto, openpyxl. [по умолчанию: 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]

mode.chained_assignment : string

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

mode.sim_interactive : boolean

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

mode.use_inf_as_na : boolean

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.matplotlib.register_converters : bool

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