DEPR: `LatexFormatter` in `DataFrame.to_latex` in favour of `Styler`

The tracker of items needed to do before deprecating DataFrame.to_latex().

• acceptance of the jinja2 requirement for LaTeX output, since Styler requires jinja2: this is blocker.
• make Styler functional for all DataFrames (i.e. including non-unique columns, indexes) (#41269).
• enhance for longtable keyword or other environments (#41866).
• enhance for caption to allow short and long captions, and allow top/bottom caption placement. (#41659)
• enhance with ability to style indexes/column headers with styles (e.g bold rows). (#41993)
• enhance with an escape option for LaTeX characters. (#41619)
• enhance .hide_columns with .show_columns alternative (optional) not necessary
• enhance .hide_columns and .hide_index to have dual function to hide the entire array, or specific items (#41266)
• make styler reactive to separate sparse columns and index separately (#41512)
• acceptance of removal of specific kwargs and all formatting keyword args (see below).
• validation for column_format to pass tests or just rely on docs/duck typing? not necessary
• validation for caption to pass tests (#43368) or just remove the validation in favour of duck typing?
• ability to format index with a formatter #43101
• separate siunitx for encapsulating headers in curly braces only when necessary #43397
• index names removal #43346
• Optionally use multirow / multicol or just blank out cells. #43369 #43382
• fix bug: label doesnt render if a caption is not given (table and longtable) #43399

Removed Keyword Args

col_space: removed since Styler.to_latex() does not necessarily produce display values of equal length, (this is a console display only arg) sparsify: replaced by alternative kwargs sparse_index and sparse_columns multicolumn, multicolumn_format, multirow: replaced by alternative kwargs multirow_align multicol_align formatters float_format : replaced by the superior df.style.format(...) args

[jreback]

we can straight depreciate DataFrame.to_latex w/o changing the implementation at all

sure if u can totally do everything in styler.to_latex that would be great but it’s likely not a big deal to implement things later / drop features if needed

[attack68]

What about backward compatibility? If I understand correctly we would need to delegate DataFrame.to_latex to Styler.to_latex() and issue a FutureWarning. Should this be added to a checklist as well?

Don’t deprecations by definition warn of failing backwards compatibility in a future version? For 1.x is it enough to just warn that DataFrame methods will not be developed in future and will eventually be removed (or refactored), albeit they remain in place, as is, for those versions?

I’m trying hard to try and avoid the case where the existing keyword signature of DataFrame.to_html and DataFrame.to_latex must be maintained/replicated or squeezed into Stylers format, for the reason that some of them are bad arguments, and subjectively the new format is decoupled (more maintainable) and more flexible, and consistent from format to format (html, excel, latex).