implemented additionally functionality of formatters_col in to_latex #32666

wgranados · 2020-03-12T18:11:02Z

Not sure what I should do for the whatsnew entry, bit confused about versioning.

[ x ] closes Feature request: easier digit format in to_latex() #26278
[ x] tests added / passed
[ x] passes black pandas
[ x] passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

pep8speaks · 2020-03-12T18:11:07Z

Hello @wlgranados! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-10-06 01:25:04 UTC

mroeschke · 2020-03-12T19:15:35Z

pandas/core/generic.py

@@ -2809,6 +2810,10 @@ def to_latex(
            Formatter functions to apply to columns' elements by position or
            name. The result of each function must be a unicode string.
            List must be of length equal to the number of columns.
+        formatter_col: list of str, optional


Can you specify the default argument? default None

mroeschke · 2020-03-12T19:16:35Z

pandas/core/generic.py

@@ -2762,6 +2762,7 @@ def to_latex(
        index=True,
        na_rep="NaN",
        formatters=None,
+        formatters_col=None,


To not break API compatibility for user who are calling this function positionally, this kwarg should go at the end.

mroeschke · 2020-03-12T19:17:06Z

pandas/core/generic.py

@@ -2897,6 +2902,10 @@ def to_latex(
        if multirow is None:
            multirow = config.get_option("display.latex.multirow")

+        # formatters is a list
+        if formatters_col:
+            formatters = [lambda x: style % x for style in formatters_col]


Is it possible to use an f-string here instead?

Also could you add a check to validate that formatters_col is a list (or an iterable)?

I've added a check that silently fails if it's not a list, not sure if this is the best way to do this (feels un-pythonic but I digress)

I attempted an f-string approach as such:
formatters = [lambda x: f"{style}{x}" for style in formatters_col]
But I was failing the test suite (broke functionality), maybe there's a better approach I'm not seeing?

mroeschke · 2020-03-12T19:18:25Z

pandas/tests/io/formats/test_to_latex.py

+"""
+        assert result == expected
+
+    def test_to_latex_with_formatters_col(self):


If you could put the issue number as a comment below this line e.g. #GH ...

jreback · 2020-03-12T19:24:21Z

i am not sure the proposed api is in line how we format for example
i’m to_csv is there a reason you are diverging?

wgranados · 2020-03-16T16:17:29Z

i am not sure the proposed api is in line how we format for example
i’m to_csv is there a reason you are diverging?

No particular reason, just wasn't paying attention, I believe I have addressed this issue with the latest commit.

mroeschke · 2020-03-16T16:29:09Z

pandas/core/generic.py

@@ -2776,6 +2776,7 @@ def to_latex(
        multirow=None,
        caption=None,
        label=None,
+        formatters_col=None,


In line what @jreback was referring to, this should probably be float_format that mirrors the kwarg in to_csv

I think I've addressed with the name change of the variable? If not let me know.

mroeschke · 2020-03-16T16:30:05Z

pandas/core/generic.py

@@ -2897,6 +2903,10 @@ def to_latex(
        if multirow is None:
            multirow = config.get_option("display.latex.multirow")

+        # formatters is a list
+        if formatters_col and type(formatters_col) == list:


Use is_list_like here and add raise a ValueError if the use has passed something other than a list.

mroeschke · 2020-05-23T04:34:23Z

@wlgranados do you have time to merge in master and to address the review comments?

wgranados · 2020-05-23T05:36:22Z

@mroeschke yes, I have some time.
I believe I addressed some comments on my local branch, just forgot to mention it here.
I'll update this shortly.

mroeschke · 2020-05-24T03:51:41Z

pandas/core/generic.py

@@ -2776,6 +2776,7 @@ def to_latex(
        multirow=None,
        caption=None,
        label=None,
+        multifloat_format=None,


How about float_format so it matches the to_csv signature

WillAyd · 2020-06-26T15:41:30Z

@wlgranados is this still active? Can you address latest comments?

wgranados · 2020-06-29T20:41:25Z

@WillAyd @mroeschke Yeah still active, I found that the test case I included was incorrect. There is an issue with the lambda function generation inside the list comprehension, so attempting to fix that currently. Also I read in the original thread that it might be possible to use the formatters variable instead, I think this should address the api usage comments then what I had before.

wgranados · 2020-08-18T21:44:57Z

@WillAyd @mroeschke this should be code complete, so any comments would be appreciated

mroeschke · 2020-08-19T06:23:45Z

Looks pretty good. Just needs a whatsnew entry for 1.2.0

WillAyd · 2020-08-19T13:11:41Z

pandas/core/generic.py

+                    for style in formatters
+                ]
+            elif not formatter_elems_is_lambda:
+                raise ValueError("Formatters elements should be strings")


So if a user passes a mix of callable and strings this error gets thrown no? Is there a way to more generically support that case?

WillAyd · 2020-09-30T15:44:26Z

@wlgranados looks like some merge conflicts have piled up and there are some outstanding CI failures - can you take a look and try to get things green?

arw2019 · 2020-11-01T04:37:36Z

Closing in favor of #37552

ENH: implemented addtionally functionality of formatters_col in to_latex

b95e721

mroeschke reviewed Mar 12, 2020

View reviewed changes

mroeschke added Enhancement IO LaTeX to_latex labels Mar 12, 2020

formatting and code refactor

dbce558

mroeschke reviewed Mar 16, 2020

View reviewed changes

William Granados added 2 commits May 23, 2020 02:17

added ValueError for incorrect usage of formatters_col

ac68757

renamed kwarg param for consistency

a8afd72

mroeschke reviewed May 24, 2020

View reviewed changes

change api usage and fstring usage

7e0ef76

William Granados added 3 commits June 29, 2020 17:14

fixed lambda functionality and updated test

2dce2e2

formatting change

ac2f774

update docs

3656b23

WillAyd reviewed Aug 19, 2020

View reviewed changes

William Granados added 3 commits August 30, 2020 16:58

added what's new entry and made to_latex more flexible

7f96b48

Merge branch 'master' into 26278

59ca2fb

fix doc build error

4d54834

William Granados added 2 commits August 31, 2020 01:06

change whats new line length

969c087

spacing linting

bc6f2cd

github-actions bot added the Stale label Sep 30, 2020

William Granados added 2 commits October 5, 2020 21:10

changed docs formatting

dd76b5b

Merge branch 'master' into 26278

0833861

wgranados mentioned this pull request Nov 1, 2020

implemented additionally functionality of formatters_col in to_latex #37552

Closed

arw2019 closed this Nov 1, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

implemented additionally functionality of formatters_col in to_latex #32666

implemented additionally functionality of formatters_col in to_latex #32666

wgranados commented Mar 12, 2020

pep8speaks commented Mar 12, 2020 •

edited

Loading

mroeschke Mar 12, 2020 •

edited

Loading

mroeschke Mar 12, 2020

mroeschke Mar 12, 2020

mroeschke Mar 12, 2020

wgranados Mar 16, 2020

wgranados May 23, 2020

mroeschke Mar 12, 2020

jreback commented Mar 12, 2020

wgranados commented Mar 16, 2020

mroeschke Mar 16, 2020

wgranados May 23, 2020

mroeschke Mar 16, 2020

mroeschke commented May 23, 2020

wgranados commented May 23, 2020

mroeschke May 24, 2020

WillAyd commented Jun 26, 2020

wgranados commented Jun 29, 2020

wgranados commented Aug 18, 2020

mroeschke commented Aug 19, 2020

WillAyd Aug 19, 2020

WillAyd commented Sep 30, 2020

arw2019 commented Nov 1, 2020

implemented additionally functionality of formatters_col in to_latex #32666

implemented additionally functionality of formatters_col in to_latex #32666

Conversation

wgranados commented Mar 12, 2020

pep8speaks commented Mar 12, 2020 • edited Loading

Comment last updated at 2020-10-06 01:25:04 UTC

mroeschke Mar 12, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Mar 12, 2020

wgranados commented Mar 16, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mroeschke commented May 23, 2020

wgranados commented May 23, 2020

Choose a reason for hiding this comment

WillAyd commented Jun 26, 2020

wgranados commented Jun 29, 2020

wgranados commented Aug 18, 2020

mroeschke commented Aug 19, 2020

Choose a reason for hiding this comment

WillAyd commented Sep 30, 2020

arw2019 commented Nov 1, 2020

pep8speaks commented Mar 12, 2020 •

edited

Loading

mroeschke Mar 12, 2020 •

edited

Loading