10000 ENH: `multirow` naive implementation `Styler.to_latex` part1 by attack68 · Pull Request #43369 · pandas-dev/pandas · GitHub
[go: up one dir, main page]
Skip to content

ENH: multirow naive implementation Styler.to_latex part1 #43369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Sep 7, 2021
Merged

ENH: multirow naive implementation Styler.to_latex part1 #43369

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d7779b6
multirow naive implementation
attack68 Sep 2, 2021
11ac603
multirow naive implementation
attack68 Sep 2, 2021
121062f
Merge remote-tracking branch 'upstream/master' into latex_multirow_naive
attack68 Sep 4, 2021
20f9b31
fix tests
attack68 Sep 4, 2021
f561651
Merge remote-tracking branch 'upstream/master' into latex_multirow_naive
attack68 Sep 6, 2021
1732772
fixture
attack68 Sep 6, 2021
318bc7b
clean up tests with fixture
attack68 Sep 6, 2021
6fa0b35
(ivanomg req) ref tests
attack68 Sep 6, 2021
237bee2
ivoanovmg req
attack68 Sep 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
clean up tests with fixture
  • Loading branch information
@attack68
attack68 committed Sep 6, 2021
commit 318bc7bee18bfaf7a9f204300ece16d24a84573c
114 changes: 53 additions & 61 deletions pandas/tests/io/formats/style/test_to_latex.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ def df():


@pytest.fixture
def df2(df):
df2 = df.copy()
df2.loc[2, :] = [2, -2.22, "de"]
df2 = df2.astype({"A": int})
return df2
def df_ext(df):
df = df.copy()
df.loc[2, :] = [2, -2.22, "de"]
df = df.astype({"A": int})
return df
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about just this?

return DataFrame({"A": [0, 1, 2], "B": [-0.61, -1.22, -2.22], "C": ["ab", "cd", "de"]})

I mean, there is probably no reason to couple two fixtures together.



@pytest.fixture
Expand Down Expand Up @@ -218,9 +218,9 @@ def test_multiindex_columns(df):
assert expected == s.to_latex(sparse_columns=False)


def test_multiindex_row(df2):
def test_multiindex_row(df_ext):
ridx = MultiIndex.from_tuples([("A", "a"), ("A", "b"), ("B", "c")])
df2.index = ridx
df_ext.index = ridx
expected = dedent(
"""\
\\begin{tabular}{llrrl}
Expand All @@ -231,7 +231,7 @@ def test_multiindex_row(df2):
\\end{tabular}
"""
)
styler = df2.style.format(precision=2)
styler = df_ext.style.format(precision=2)
result = styler.to_latex()
assert expected == result

Expand All @@ -250,11 +250,9 @@ def test_multiindex_row(df2):
assert expected == result


def test_multirow_naive(df):
def test_multirow_naive(df_ext):
ridx = MultiIndex.from_tuples([("A", "a"), ("A", "b"), ("B", "c")])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest that the letters A and B should not be repeated in both the index and columns.
What if you use these for the index?

ridx = MultiIndex.from_tuples([("X", "x"), ("X", "y"), ("Z", "z")])

I guess it will be easier to differentiate from the columns.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fully agree. silly oversight.

df.loc[2, :] = [2, -2.22, "de"]
df = df.astype({"A": int})
df.index = ridx
df_ext.index = ridx
expected = dedent(
"""\
\\begin{tabular}{llrrl}
Expand All @@ -265,16 +263,15 @@ def test_multirow_naive(df):
\\end{tabular}
"""
)
s = df.style.format(precision=2)
assert expected == s.to_latex(multirow_align="naive")
styler = df_ext.style.format(precision=2)
result = styler.to_latex(multirow_align="naive")
assert expected == result


def test_multiindex_row_and_col(df):
def test_multiindex_row_and_col(df_ext):
cidx = MultiIndex.from_tuples([("Z", "a"), ("Z", "b"), ("Y", "c")])
ridx = MultiIndex.from_tuples([("A", "a"), ("A", "b"), ("B", "c")])
df.loc[2, :] = [2, -2.22, "de"]
df = df.astype({"A": int})
df.index, df.columns = ridx, cidx
df_ext.index, df_ext.columns = ridx, cidx
expected = dedent(
"""\
\\begin{tabular}{llrrl}
Expand All @@ -286,8 +283,9 @@ def test_multiindex_row_and_col(df):
\\end{tabular}
"""
)
s = df.style.format(precision=2)
assert s.to_latex(multirow_align="b", multicol_align="l") == expected
styler = df_ext.style.format(precision=2)
result = styler.to_latex(multirow_align="b", multicol_align="l")
assert result == expected

# non-sparse
expected = dedent(
Expand All @@ -301,16 +299,15 @@ def test_multiindex_row_and_col(df):
\\end{tabular}
"""
)
assert s.to_latex(sparse_index=False, sparse_columns=False) == expected
result = styler.to_latex(sparse_index=False, sparse_columns=False)
assert result == expected


def test_multi_options(df):
def test_multi_options(df_ext):
cidx = MultiIndex.from_tuples([("Z", "a"), ("Z", "b"), ("Y", "c")])
ridx = MultiIndex.from_tuples([("A", "a"), ("A", "b"), ("B", "c")])
df.loc[2, :] = [2, -2.22, "de"]
df = df.astype({"A": int})
df.index, df.columns = ridx, cidx
styler = df.style.format(precision=2)
df_ext.index, df_ext.columns = ridx, cidx
styler = df_ext.style.format(precision=2)

expected = dedent(
"""\
Expand All @@ -319,7 +316,8 @@ def test_multi_options(df):
\\multirow[c]{2}{*}{A} & a & 0 & -0.61 & ab \\\\
"""
)
assert expected in styler.to_latex()
result = styler.to_latex()
assert expected in result

with option_context("styler.latex.multicol_align", "l"):
assert " & & \\multicolumn{2}{l}{Z} & Y \\\\" in styler.to_latex()
Expand All @@ -338,30 +336,25 @@ def test_multiindex_columns_hidden():
assert "{tabular}{lrrr}" in s.to_latex()


def test_sparse_options(df):
@pytest.mark.parametrize(
"option, value",
[
("styler.sparse.index", True),
("styler.sparse.index", False),
("styler.sparse.columns", True),
("styler.sparse.columns", False),
],
)
def test_sparse_options(df_ext, option, value):
cidx = MultiIndex.from_tuples([("Z", "a"), ("Z", "b"), ("Y", "c")])
ridx = MultiIndex.from_tuples([("A", "a"), ("A", "b"), ("B", "c")])
df.loc[2, :] = [2, -2.22, "de"]
df.index, df.columns = ridx, cidx
s = df.style

latex1 = s.to_latex()
df_ext.index, df_ext.columns = ridx, cidx
styler = df_ext.style

with option_context("styler.sparse.index", True):
latex2 = s.to_latex()
assert latex1 == latex2

with option_context("styler.sparse.index", False):
latex2 = s.to_latex()
assert latex1 != latex2

with option_context("styler.sparse.columns", True):
latex2 = s.to_latex()
assert latex1 == latex2

with option_context("styler.sparse.columns", False):
latex2 = s.to_latex()
assert latex1 != latex2
latex1 = styler.to_latex()
with option_context(option, value):
latex2 = styler.to_latex()
assert (latex1 == latex2) is value


def test_hidden_index(styler):
Expand All @@ -379,16 +372,14 @@ def test_hidden_index(styler):


@pytest.mark.parametrize("environment", ["table", "figure*", None])
def test_comprehensive(df, environment):
def test_comprehensive(df_ext, environment):
# test as many low level features simultaneously as possible
cidx = MultiIndex.from_tuples([("Z", "a"), ("Z", "b"), ("Y", "c")])
ridx = MultiIndex.from_tuples([("A", "a"), ("A", "b"), ("B", "c")])
df.loc[2, :] = [2, -2.22, "de"]
df = df.astype({"A": int})
df.index, df.columns = ridx, cidx
s = df.style
s.set_caption("mycap")
s.set_table_styles(
df_ext.index, df_ext.columns = ridx, cidx
stlr = df_ext.style
stlr.set_caption("mycap")
stlr.set_table_styles(
[
{"selector": "label", "props": ":{fig§item}"},
{"selector": "position", "props": ":h!"},
Expand All @@ -400,8 +391,8 @@ def test_comprehensive(df, environment):
{"selector": "rowcolors", "props": ":{3}{pink}{}"}, # custom command
]
)
s.highlight_max(axis=0, props="textbf:--rwrap;cellcolor:[rgb]{1,1,0.6}--rwrap")
s.highlight_max(axis=None, props="Huge:--wrap;", subset=[("Z", "a"), ("Z", "b")])
stlr.highlight_max(axis=0, props="textbf:--rwrap;cellcolor:[rgb]{1,1,0.6}--rwrap")
stlr.highlight_max(axis=None, props="Huge:--wrap;", subset=[("Z", "a"), ("Z", "b")])

expected = (
"""\
Expand All @@ -425,7 +416,8 @@ def test_comprehensive(df, environment):
\\end{table}
"""
).replace("table", environment if environment else "table")
assert s.format(precision=2).to_latex(environment=environment) == expected
result = stlr.format(precision=2).to_latex(environment=environment)
assert result == expected


def test_environment_option(styler):
Expand Down Expand Up @@ -714,11 +706,11 @@ def test_longtable_caption_label(styler, caption, cap_exp, label, lab_exp):
(False, False),
],
)
def test_apply_map_header_render_mi(df, index, columns, siunitx):
def test_apply_map_header_render_mi(df_ext, index, columns, siunitx):
cidx = MultiIndex.from_tuples([("Z", "a"), ("Z", "b"), ("Y", "c")])
ridx = MultiIndex.from_tuples([("A", "a"), ("A", "b"), ("B", "c")])
df.index, df.columns = ridx, cidx
styler = df.style
df_ext.index, df_ext.columns = ridx, cidx
styler = df_ext.style

func = lambda v: "bfseries: --rwrap" if "A" in v or "Z" in v or "c" in v else None

Expand Down
0