pandas.io.formats.style.Styler.to_latex

Styler.to_latex(buf=None, *, column_format=None, position=None, position_float=None, hrules=None, clines=None, label=None, caption=None, sparse_index=None, sparse_columns=None, multirow_align=None, multicol_align=None, siunitx=False, environment=None, encoding=None, convert_css=False)[source]

Запись стилей в файл, буфер или строку в формате LaTeX.

Новое в версии 1.3.0.

Параметры:

buf:str, путь к объекту, объекту типа файл или None, по умолчанию None

Строка, объект пути (реализующий os.PathLike[str]), или объект типа файл, реализующий функцию строки write(). Если None, результат возвращается в виде строки.

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

Спецификация столбца LaTeX, помещенная в местоположение:

\begin{tabular}{<column_format>}

По умолчанию 'l' для столбцов индексов и нечисловых данных, и для численных столбцов — 'r' по умолчанию или 'S', если siunitx равно True.

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

Позиционный аргумент LaTeX (например, 'h!') для таблиц, помещаемый в местоположение:

\\begin{table}[<position>].

position_float:{“centering”, “raggedleft”, “raggedright”}, необязательно

Команда LaTeX float, помещенная в местоположение:

\begin{table}[<position>]

\<position_float>

Не может использоваться, если environment равно “longtable”.

hrules:bool

Установите в True, чтобы добавить \toprule, \midrule и \bottomrule из пакета LaTeX {booktabs}. По умолчанию pandas.options.styler.latex.hrules, что равно False.

Изменено в версии 1.4.0.

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

Используется для управления добавлением команд \cline для разделения меток индексов. Возможные значения:

• None: команды cline не добавляются (по умолчанию).

• “all;data”: команда cline добавляется для каждого значения индекса, расширяя ширину таблицы, включая записи данных.

• “all;index”: как выше, но линии расширяют только ширину записей индекса.

• “skip-last;data”: команда cline добавляется для каждого значения индекса, кроме последнего уровня (который никогда не разрежается), расширяя ширину таблицы.

• “skip-last;index”: как выше, но линии расширяют только ширину записей индекса.

Новое в версии 1.4.0.

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

Метка LaTeX, включенная в виде: \label{<label>}. Используется с \ref{<label>} в основном файле .tex.

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

Если строка, подпись таблицы LaTeX, включенная в виде: \caption{<caption>}. Если кортеж, т.е. (“полная подпись”, “короткая подпись”), подпись включена в виде: \caption[<caption[1]>]{<caption[0]>}.

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

Выполнять ли разрежение отображения иерархического индекса. Если установлено в False, каждый явный элемент уровня в иерархическом ключе отображается для каждой строки. По умолчанию pandas.options.styler.sparse.index, что равно True.

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

Выполнять ли разрежение отображения иерархического индекса. Если установлено в False, каждый явный элемент уровня в иерархическом ключе отображается для каждого столбца. По умолчанию pandas.options.styler.sparse.columns, что равно True.

multirow_align:{“c”, “t”, “b”, “naive”}, необязательно

Если разрежается иерархический MultiIndex, выравнивать текст по центру, вверху или внизу с помощью пакета multirow. Если не задано, по умолчанию pandas.options.styler.latex.multirow_align, что равно “c”. Если задано “naive”, рендеринг выполняется без multirow.

Изменено в версии 1.4.0.

multicol_align:{“r”, “c”, “l”, “naive-l”, “naive-r”}, необязательно

Если разрежается иерархический MultiIndex столбцов, выравнивать текст слева, по центру или справа. Если не задано, по умолчанию pandas.options.styler.latex.multicol_align, что равно “r”. Если задан вариант «naive», рендеринг выполняется без multicol. К значениям, отличным от «naive», можно добавлять декораторы с вертикальными линиями, например, «|r» нарисует линию слева от объединённых ячеек, выровненных по правому краю.

Изменено в версии 1.4.0.

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

Установите в True для структурирования LaTeX, совместимого с пакетом {siunitx}.

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

Если указано, среда, которая заменит 'table' в \\begin{table}. Если указано ‘longtable’, рендерится более подходящая шаблон. Если не указано, по умолчанию pandas.options.styler.latex.environment, что равно None.

Новое в версии 1.4.0.

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

Настройка кодировки символов. По умолчанию pandas.options.styler.render.encoding, что равно “utf-8”.

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

Преобразовать простые стили ячеек из CSS в формат LaTeX. Любой CSS, не найденный в таблице преобразования, отбрасывается. Стиль можно принудительно установить, добавив параметр –latex. См. примечания.

Возвращает:

str или None

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

См. также

Styler.format

Форматирование текстового значения отображения ячеек.

Примечания

Пакеты LaTeX

Для следующих функций рекомендуется включить следующие пакеты LaTeX:

Функция	Включение
разреженные столбцы	нет: включено в среде {tabular} по умолчанию
разреженные строки	\usepackage{multirow}
hrules	\usepackage{booktabs}
цвета	\usepackage[table]{xcolor}
siunitx	\usepackage{siunitx}
полужирный шрифт (с siunitx)	\usepackage{etoolbox} \robustify\bfseries \sisetup{detect-all = true} (внутри {document})
курсив (с siunitx)	\usepackage{etoolbox} \robustify\itshape \sisetup{detect-all = true} (внутри {document})
среда	\usepackage{longtable} если arg равен “longtable” | или любой другой соответствующий пакет среды
гиперссылки	\usepackage{hyperref}

Стили ячеек

Стили LaTeX могут быть отображены только в том случае, если соответствующие функции стилизации были созданы с подходящими командами LaTeX. Все функции стилизации основаны на понятии пары CSS (<attribute>, <value>) (см. Визуализация таблиц), и это должно быть заменено подходом LaTeX (<command>, <options>). Каждая ячейка будет стилизована индивидуально с использованием вложенных команд LaTeX со своими параметрами.

Например, следующий код выделит и сделает полужирным шрифтом ячейку в HTML-CSS:

>>> df = pd.DataFrame([[1,2], [3,4]])
>>> s = df.style.highlight_max(axis=None,
...                            props='background-color:red; font-weight:bold;')
>>> s.to_html()  

Эквивалент с использованием только команд LaTeX:

>>> s = df.style.highlight_max(axis=None,
...                            props='cellcolor:{red}; bfseries: ;')
>>> s.to_latex()  

Внутренне эти структурированные пары LaTeX (<command>, <options>) переводятся в display_value с помощью структуры по умолчанию: \<command><options> <display_value>. При наличии нескольких команд последняя вкладывается рекурсивно, так что ячейка выделения в примере выше рендерится как \cellcolor{red} \bfseries 4.

Иногда этот формат не подходит для применяемой команды или комбинации пакетов LaTeX, которые используются, поэтому к <options>, внутри кортежа, можно добавить дополнительные флаги, чтобы получить разные положения необходимых скобок (по умолчанию это то же, что и --nowrap):

Формат кортежа	Структура вывода
(<команда>,<опции>)	\<команда><опции> <значение_отображения>
(<команда>,<опции> --nowrap)	\<команда><опции> <значение_отображения>
(<команда>,<опции> --rwrap)	\<команда><опции>{<значение_отображения>}
(<команда>,<опции> --wrap)	{\<команда><опции> <значение_отображения>}
(<команда>,<опции> --lwrap)	{\<команда><опции>} <значение_отображения>
(<команда>,<опции> --dwrap)	{\<команда><опции>}{<значение_отображения>}

Например, команда textbf для начертания шрифта всегда должна использоваться с –rwrap, поэтому ('textbf', '--rwrap') отобразит работающую ячейку, обернутую в фигурные скобки, как \textbf{<display_value>}.

Более подробный пример:

>>> df = pd.DataFrame([[1, 2.2, "dogs"], [3, 4.4, "cats"], [2, 6.6, "cows"]],
...                   index=["ix1", "ix2", "ix3"],
...                   columns=["Integers", "Floats", "Strings"])
>>> s = df.style.highlight_max(
...     props='cellcolor:[HTML]{FFFF00}; color:{red};'
...           'textit:--rwrap; textbf:--rwrap;'
... )
>>> s.to_latex()  

Стили таблиц

Внутри Styler использует свой объект table_styles для разбора аргументов column_format, position, position_float, и label. Эти аргументы добавляются к стилям таблицы в формате:

set_table_styles([
    {"selector": "column_format", "props": f":{column_format};"},
    {"selector": "position", "props": f":{position};"},
    {"selector": "position_float", "props": f":{position_float};"},
    {"selector": "label", "props": f":{{{label.replace(':','§')}}};"}
], overwrite=False)

Исключение делается для аргумента hrules, который фактически управляет всеми тремя командами: toprule, bottomrule и midrule одновременно. Вместо установки hrules в True, можно установить каждое индивидуальное определение правила, вручную задавая table_styles, например, как показано ниже: мы задаем обычный toprule, устанавливаем hline для bottomrule и исключаем midrule.

set_table_styles([
    {'selector': 'toprule', 'props': ':toprule;'},
    {'selector': 'bottomrule', 'props': ':hline;'},
], overwrite=False)

Если к стилям таблицы добавляются другие commands, они будут обнаружены и размещены непосредственно над командой ‘\begin{tabular}’. Например, чтобы добавить окраску нечётных и чётных строк из пакета {colortbl}, в формате \rowcolors{1}{pink}{red}, используйте:

set_table_styles([
    {'selector': 'rowcolors', 'props': ':{1}{pink}{red};'}
], overwrite=False)

Более подробный пример использования этих аргументов приведён ниже:

>>> df.columns = pd.MultiIndex.from_tuples([
...     ("Numeric", "Integers"),
...     ("Numeric", "Floats"),
...     ("Non-Numeric", "Strings")
... ])
>>> df.index = pd.MultiIndex.from_tuples([
...     ("L0", "ix1"), ("L0", "ix2"), ("L1", "ix3")
... ])
>>> s = df.style.highlight_max(
...     props='cellcolor:[HTML]{FFFF00}; color:{red}; itshape:; bfseries:;'
... )
>>> s.to_latex(
...     column_format="rrrrr", position="h", position_float="centering",
...     hrules=True, label="table:5", caption="Styled LaTeX Table",
...     multirow_align="t", multicol_align="r"
... )  

Форматирование

Для форматирования значений следует использовать Styler.format() до вызова Styler.to_latex, а также других методов, таких как Styler.hide(), например:

>>> s.clear()
>>> s.table_styles = []
>>> s.caption = None
>>> s.format({
...    ("Numeric", "Integers"): '\${}',
...    ("Numeric", "Floats"): '{:.3f}',
...    ("Non-Numeric", "Strings"): str.upper
... })  
                Numeric      Non-Numeric
          Integers   Floats    Strings
L0    ix1       $1   2.200      DOGS
      ix2       $3   4.400      CATS
L1    ix3       $2   6.600      COWS

>>> s.to_latex()  
\begin{tabular}{llrrl}
{} & {} & \multicolumn{2}{r}{Numeric} & {Non-Numeric} \\
{} & {} & {Integers} & {Floats} & {Strings} \\
\multirow[c]{2}{*}{L0} & ix1 & \\$1 & 2.200 & DOGS \\
 & ix2 & \$3 & 4.400 & CATS \\
L1 & ix3 & \$2 & 6.600 & COWS \\
\end{tabular}

Преобразование CSS

Этот метод может преобразовать конструкцию Styler с HTML-CSS в LaTeX с помощью следующих ограниченных преобразований.

Атрибут CSS	Значение CSS	Команда LaTeX	Параметры LaTeX
font-weight	жирный более жирный	bfseries bfseries
font-style	курсивный наклонный	itshape slshape
background-color	красный #fe01ea #f0e rgb(128,255,0) rgba(128,0,0,0.5) rgb(25%,255,50%)	cellcolor	{красный}–lwrap [HTML]{FE01EA}–lwrap [HTML]{FF00EE}–lwrap [rgb]{0.5,1,0}–lwrap [rgb]{0.5,0,0}–lwrap [rgb]{0.25,1,0.5}–lwrap
цвет	красный #fe01ea #f0e rgb(128,255,0) rgba(128,0,0,0.5) rgb(25%,255,50%)	цвет	{красный} [HTML]{FE01EA} [HTML]{FF00EE} [rgb]{0.5,1,0} [rgb]{0.5,0,0} [rgb]{0.25,1,0.5}

Также можно добавить пользовательские стили только для LaTeX к HTML-CSS Styler с помощью флага --latex и добавить параметры разбора LaTeX, которые конвертер обнаружит внутри комментария CSS.

>>> df = pd.DataFrame([[1]])
>>> df.style.set_properties(
...     **{"font-weight": "bold /* --dwrap */", "Huge": "--latex--rwrap"}
... ).to_latex(convert_css=True)  
\begin{tabular}{lr}
{} & {0} \\
0 & {\bfseries}{\Huge{1}} \\
\end{tabular}

Примеры

Ниже приведён полный пошаговый пример, в котором добавлены некоторые расширенные возможности и отмечены некоторые распространённые ошибки.

Сначала создаём DataFrame и Styler как обычно, включая MultiIndex строки и столбцы, что позволяет использовать более расширенные параметры форматирования:

>>> cidx = pd.MultiIndex.from_arrays([
...     ["Equity", "Equity", "Equity", "Equity",
...      "Stats", "Stats", "Stats", "Stats", "Rating"],
...     ["Energy", "Energy", "Consumer", "Consumer", "", "", "", "", ""],
...     ["BP", "Shell", "H&M", "Unilever",
...      "Std Dev", "Variance", "52w High", "52w Low", ""]
... ])
>>> iidx = pd.MultiIndex.from_arrays([
...     ["Equity", "Equity", "Equity", "Equity"],
...     ["Energy", "Energy", "Consumer", "Consumer"],
...     ["BP", "Shell", "H&M", "Unilever"]
... ])
>>> styler = pd.DataFrame([
...     [1, 0.8, 0.66, 0.72, 32.1678, 32.1678**2, 335.12, 240.89, "Buy"],
...     [0.8, 1.0, 0.69, 0.79, 1.876, 1.876**2, 14.12, 19.78, "Hold"],
...     [0.66, 0.69, 1.0, 0.86, 7, 7**2, 210.9, 140.6, "Buy"],
...     [0.72, 0.79, 0.86, 1.0, 213.76, 213.76**2, 2807, 3678, "Sell"],
... ], columns=cidx, index=iidx).style

Затем отформатируем отображение и, поскольку наша таблица довольно широкая, скроем повторяющийся уровень-0 индекса:

>>> (styler.format(subset="Equity", precision=2)
...       .format(subset="Stats", precision=1, thousands=",")
...       .format(subset="Rating", formatter=str.upper)
...       .format_index(escape="latex", axis=1)
...       .format_index(escape="latex", axis=0)
...       .hide(level=0, axis=0))  

Обратите внимание, что одна из строковых записей заголовков индекса и столбцов — «H&M». Без применения опции escape=”latex” к методу format_index результирующий LaTeX не будет отображаться, а возвращаемая ошибка будет трудно отлаживаться. С помощью соответствующего экранирования «&» преобразуется в «\&».

В-третьих, применим некоторые стили (CSS-HTML) к нашему объекту. Используем встроенный метод и также определим свой собственный метод для выделения рекомендации по акциям:

>>> def rating_color(v):
...     if v == "Buy": color = "#33ff85"
...     elif v == "Sell": color = "#ff5933"
...     else: color = "#ffdd33"
...     return f"color: {color}; font-weight: bold;"
>>> (styler.background_gradient(cmap="inferno", subset="Equity", vmin=0, vmax=1)
...       .map(rating_color, subset="Rating"))  

Все вышеперечисленные стили будут работать с HTML (см. ниже) и LaTeX при преобразовании:

Однако, в конечном итоге, мы хотим добавить один стиль только для LaTeX (из пакета {graphicx}), который сложно преобразовать из CSS, и pandas не поддерживает его. Обратите внимание на флаг –latex, используемый здесь, а также –rwrap, чтобы обеспечить правильное форматирование и избежать его игнорирования при преобразовании.

>>> styler.map_index(
...     lambda v: "rotatebox:{45}--rwrap--latex;", level=2, axis=1
... )  

Наконец, рендерим наш LaTeX, добавив другие необходимые параметры:

>>> styler.to_latex(
...     caption="Selected stock correlation and simple statistics.",
...     clines="skip-last;data",
...     convert_css=True,
...     position_float="centering",
...     multicol_align="|c|",
...     hrules=True,
... )  
\begin{table}
\centering
\caption{Selected stock correlation and simple statistics.}
\begin{tabular}{llrrrrrrrrl}
\toprule
 &  & \multicolumn{4}{|c|}{Equity} & \multicolumn{4}{|c|}{Stats} & Rating \\
 &  & \multicolumn{2}{|c|}{Energy} & \multicolumn{2}{|c|}{Consumer} &
\multicolumn{4}{|c|}{} &  \\
 &  & \rotatebox{45}{BP} & \rotatebox{45}{Shell} & \rotatebox{45}{H\&M} &
\rotatebox{45}{Unilever} & \rotatebox{45}{Std Dev} & \rotatebox{45}{Variance} &
\rotatebox{45}{52w High} & \rotatebox{45}{52w Low} & \rotatebox{45}{} \\
\midrule
\multirow[c]{2}{*}{Energy} & BP & {\cellcolor[HTML]{FCFFA4}}
\color[HTML]{000000} 1.00 & {\cellcolor[HTML]{FCA50A}} \color[HTML]{000000}
0.80 & {\cellcolor[HTML]{EB6628}} \color[HTML]{F1F1F1} 0.66 &
{\cellcolor[HTML]{F68013}} \color[HTML]{F1F1F1} 0.72 & 32.2 & 1,034.8 & 335.1
& 240.9 & \color[HTML]{33FF85} \bfseries BUY \\
 & Shell & {\cellcolor[HTML]{FCA50A}} \color[HTML]{000000} 0.80 &
{\cellcolor[HTML]{FCFFA4}} \color[HTML]{000000} 1.00 &
{\cellcolor[HTML]{F1731D}} \color[HTML]{F1F1F1} 0.69 &
{\cellcolor[HTML]{FCA108}} \color[HTML]{000000} 0.79 & 1.9 & 3.5 & 14.1 &
19.8 & \color[HTML]{FFDD33} \bfseries HOLD \\
\cline{1-11}
\multirow[c]{2}{*}{Consumer} & H\&M & {\cellcolor[HTML]{EB6628}}
\color[HTML]{F1F1F1} 0.66 & {\cellcolor[HTML]{F1731D}} \color[HTML]{F1F1F1}
0.69 & {\cellcolor[HTML]{FCFFA4}} \color[HTML]{000000} 1.00 &
{\cellcolor[HTML]{FAC42A}} \color[HTML]{000000} 0.86 & 7.0 & 49.0 & 210.9 &
140.6 & \color[HTML]{33FF85} \bfseries BUY \\
 & Unilever & {\cellcolor[HTML]{F68013}} \color[HTML]{F1F1F1} 0.72 &
{\cellcolor[HTML]{FCA108}} \color[HTML]{000000} 0.79 &
{\cellcolor[HTML]{FAC42A}} \color[HTML]{000000} 0.86 &
{\cellcolor[HTML]{FCFFA4}} \color[HTML]{000000} 1.00 & 213.8 & 45,693.3 &
2,807.0 & 3,678.0 & \color[HTML]{FF5933} \bfseries SELL \\
\cline{1-11}
\bottomrule
\end{tabular}
\end{table}