pandas.DataFrame.to_latex

DataFrame.to_latex(buf=None, *, columns=None, header=True, index=True, na_rep='NaN', formatters=None, float_format=None, sparsify=None, index_names=True, bold_rows=False, column_format=None, longtable=None, escape=None, encoding=None, decimal='.', multicolumn=None, multicolumn_format=None, multirow=None, caption=None, label=None, position=None)[source]

Вывод объекта в LaTeX-таблицу, длинную таблицу или вложенную таблицу.

Требуется \usepackage{{booktabs}}. Результат можно скопировать и вставить в основной LaTeX-документ или прочитать из внешнего файла с помощью \input{{table.tex}}.

Изменено в версии 2.0.0: Переработано для использования реализации Styler с использованием шаблонизации jinja2.

Параметры:

buf:str, Путь или StringIO-подобный объект, необязательно, по умолчанию None

Буфер для записи. Если None, результат возвращается как строка.

columns:список меток, необязательно

Подмножество столбцов для записи. По умолчанию записываются все столбцы.

header:bool или список строк, по умолчанию True

Выводить имена столбцов. Если задан список строк, предполагается, что это псевдонимы имен столбцов.

index:bool, по умолчанию True

Выводить имена строк (индекс).

na_rep:str, по умолчанию ‘NaN’

Представление пропущенных данных.

formatters:список функций или словарь {str: функция}, необязательно

Функции форматирования для применения к элементам столбцов по позиции или имени. Результат каждой функции должен быть строкой Unicode. Список должен иметь длину, равную количеству столбцов.

float_format:функция с одним параметром или строка, необязательно, по умолчанию None

Форматирование чисел с плавающей точкой. Например, float_format="%.2f" и float_format="{{:0.2f}}".format приведут к тому, что 0,1234 будет отформатировано как 0,12.

sparsify:bool, необязательно

Установите в False для DataFrame с иерархическим индексом, чтобы вывести каждый ключ многоуровневого индекса в каждой строке. По умолчанию значение будет взято из модуля конфигурации.

index_names:bool, по умолчанию True

Выводит имена индексов.

bold_rows:bool, по умолчанию False

Сделать метки строк жирными в выводе.

column_format:строка, необязательно

Формат столбцов, как указано в формате LaTeX-таблицы, например, ‘rcl’ для 3 столбцов. По умолчанию для всех столбцов, кроме столбцов чисел, используется ‘l’, а для столбцов чисел — ‘r’.

longtable:bool, необязательно

Использовать окружение longtable вместо tabular. Требуется добавить usepackage{longtable} в преамбулу LaTeX. По умолчанию значение будет взято из модуля конфигурации pandas и установлено в True, если опция styler.latex.environment равна “longtable”.

Изменено в версии 2.0.0: Опция pandas, влияющая на этот аргумент, изменилась.

escape:bool, необязательно

По умолчанию значение будет взято из модуля конфигурации pandas и установлено в True, если опция styler.format.escape равна “latex”. При установке в False предотвращает экранирование специальных символов LaTeX в именах столбцов.

Изменено в версии 2.0.0: Опция pandas, влияющая на этот аргумент, изменилась, как и значение по умолчанию, которое стало False.

encoding:str, необязательно

Строка, представляющая кодировку, используемую в выходном файле, по умолчанию ‘utf-8’.

decimal:str, по умолчанию ‘.’

Символ, распознаваемый как десятичный разделитель, например, ‘,’ в Европе.

multicolumn:bool, по умолчанию True

Использовать multicolumn для улучшения столбцов MultiIndex. Значение по умолчанию будет взято из модуля конфигурации и установлено как опция styler.sparse.columns.

Изменено в версии 2.0.0: Опция pandas, влияющая на этот аргумент, изменилась.

multicolumn_format:str, по умолчанию ‘r’

Выравнивание для multicolumn, аналогично column_format. Значение по умолчанию будет взято из модуля конфигурации, и установлено как опция styler.latex.multicol_align.

Изменено в версии 2.0.0: Опция pandas, влияющая на этот аргумент, изменилась, как и значение по умолчанию, которое стало “r”.

multirow:bool, по умолчанию True

Использовать multirow для улучшения строк MultiIndex. Требуется добавить usepackage{multirow} в преамбулу LaTeX. Будет выводить выровненные по центру метки (вместо выровненных по верху) по всем содержащимся строкам, разделяя группы с помощью clines. Значение по умолчанию будет взято из модуля конфигурации pandas, и установлено как опция styler.sparse.index.

Изменено в версии 2.0.0: Опция pandas, влияющая на этот аргумент, изменилась, как и значение по умолчанию, которое стало True.

caption:str или кортеж, необязательно

Кортеж (полное_заголовок, короткий_заголовок), что приводит к \caption[short_caption]{{full_caption}}; если передана одна строка, короткий заголовок не будет установлен.

label:str, необязательно

Метка LaTeX, которая должна быть размещена внутри \label{{}} в выходных данных. Используется с \ref{{}} в основном файле .tex.

position:str, необязательно

Позиционный аргумент LaTeX для таблиц, который будет размещен после \begin{{}} в выводе.

Возвращаемые значения:

str или None

Если buf равно None, возвращает результат как строку. В противном случае возвращает None.

См. также

io.formats.style.Styler.to_latex

Вывод DataFrame в LaTeX с условным форматированием.

DataFrame.to_string

Вывод DataFrame в удобочитаемый для консоли табличный вывод.

DataFrame.to_html

Вывод DataFrame в виде HTML-таблицы.

Примечания

Начиная с версии 2.0.0, этот метод был изменен для использования реализации Styler в качестве части Styler.to_latex() через шаблонизацию jinja2. Это означает, что jinja2 является требованием и должно быть установлено, для того чтобы этот метод работал. Рекомендуется пользователям перейти к использованию Styler, так как эта реализация чаще обновляется и предоставляет гораздо больше гибкости в выводе.

Примеры

Преобразование общего DataFrame в LaTeX с форматированием:

>>> df = pd.DataFrame(dict(name=['Raphael', 'Donatello'],
...                        age=[26, 45],
...                        height=[181.23, 177.65]))
>>> print(df.to_latex(index=False,
...                   formatters={"name": str.upper},
...                   float_format="{:.1f}".format,
... ))  
\begin{tabular}{lrr}
\toprule
name & age & height \\
\midrule
RAPHAEL & 26 & 181.2 \\
DONATELLO & 45 & 177.7 \\
\bottomrule
\end{tabular}