BUG: Fix Index.repr when `display.max_seq_items` = 1 #38443

skvrahul · 2020-12-13T09:10:20Z

closes BUG: MultiIndex.__repr__ is broken when display.max_seq_items = 1 #38415
tests added / passed
passes black pandas
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

simonjayhawkins · 2020-12-13T17:39:21Z

Thanks @skvrahul for the PR. please add a test.

jreback

this issue needs to confirm / add any tests that we are missing

doc/source/whatsnew/v1.3.0.rst

jreback · 2020-12-13T17:44:10Z

pandas/io/formats/printing.py

@@ -382,7 +382,11 @@ def best_len(values: List[str]) -> int:
        summary = f"[{first}, {last}]{close}"
    else:

-        if n > max_seq_items:
+        if max_seq_items == 1:


can you also cover in a test the max_seq_items == 0 case (I think we have this but maybe not). Also pls confirm that we have a test for n == max_seq_items.

Looks like we don't have a test for n == max_seq_items. Will cover these in my tests.

Just wanted to confirm that this is the relevant location for adding these?

pandas/pandas/tests/indexes/multi/test_formats.py

Lines 92 to 119 in e2dec8d

def test_repr(self, idx):

result = idx[:1].__repr__()

expected = """\

MultiIndex([('foo', 'one')],

names=['first', 'second'])"""

assert result == expected

result = idx.__repr__()

expected = """\

MultiIndex([('foo', 'one'),

('foo', 'two'),

('bar', 'one'),

('baz', 'two'),

('qux', 'one'),

('qux', 'two')],

names=['first', 'second'])"""

assert result == expected

with pd.option_context("display.max_seq_items", 5):

result = idx.__repr__()

expected = """\

MultiIndex([('foo', 'one'),

('foo', 'two'),

...

('qux', 'one'),

('qux', 'two')],

names=['first', 'second'], length=6)"""

assert result == expected

yeah there plus some generic Index ones (look in pandas/tests/indexes/); you may have to grep around a bit

e.g.

~/pandas-dev$ grep -r max_seq_items pandas/tests/ pandas/tests/io/formats/test_format.py: with option_context("display.max_seq_items", 2000): pandas/tests/io/formats/test_format.py: with option_context("display.max_seq_items", 5): pandas/tests/groupby/test_groupby.py: "max_seq_items, expected", pandas/tests/groupby/test_groupby.py:def test_groups_repr_truncates(max_seq_items, expected): pandas/tests/groupby/test_groupby.py: with pd.option_context("display.max_seq_items", max_seq_items): pandas/tests/indexes/multi/test_formats.py: with pd.option_context("display.max_seq_items", None): pandas/tests/indexes/multi/test_formats.py: with pd.option_context("display.max_seq_items", 5): pandas/tests/indexes/common.py: with pd.option_context("display.max_seq_items", None): pandas/tests/indexes/base_class/test_formats.py: with cf.option_context("display.max_seq_items", 10):

i think pandas/tests/indexes/base_class/test_formats.py: with cf.option_context("display.max_seq_items", 10):
has a number of tests as well

skvrahul · 2020-12-14T09:32:51Z

@jreback @simonjayhawkins
Could you confirm that this parameter is expected to affect even the list of names of columns in the index
I.e. repr evaluates to:

MultiIndex([...
            ('qux', 'two')],
           names=['first', ...], length=6)

and not

MultiIndex([...
            ('qux', 'two')],
           names=['first', 'second'], length=6)

…' = n

skvrahul · 2020-12-14T19:05:30Z

Could you confirm that this parameter is expected to affect even the list of names of columns in the index
I.e. repr evaluates to:
MultiIndex([...
            ('qux', 'two')],
           names=['first', ...], length=6)
and not
MultiIndex([...
            ('qux', 'two')],
           names=['first', 'second'], length=6)

Checked on master and can confirm this (parameter affects even the list of column names)
Added tests accordingly.

jreback · 2020-12-14T20:43:13Z

pandas/io/formats/printing.py

@@ -382,7 +382,11 @@ def best_len(values: List[str]) -> int:
        summary = f"[{first}, {last}]{close}"
    else:

-        if n > max_seq_items:
+        if max_seq_items == 1:


yeah there plus some generic Index ones (look in pandas/tests/indexes/); you may have to grep around a bit

e.g.

~/pandas-dev$ grep -r max_seq_items pandas/tests/ pandas/tests/io/formats/test_format.py: with option_context("display.max_seq_items", 2000): pandas/tests/io/formats/test_format.py: with option_context("display.max_seq_items", 5): pandas/tests/groupby/test_groupby.py: "max_seq_items, expected", pandas/tests/groupby/test_groupby.py:def test_groups_repr_truncates(max_seq_items, expected): pandas/tests/groupby/test_groupby.py: with pd.option_context("display.max_seq_items", max_seq_items): pandas/tests/indexes/multi/test_formats.py: with pd.option_context("display.max_seq_items", None): pandas/tests/indexes/multi/test_formats.py: with pd.option_context("display.max_seq_items", 5): pandas/tests/indexes/common.py: with pd.option_context("display.max_seq_items", None): pandas/tests/indexes/base_class/test_formats.py: with cf.option_context("display.max_seq_items", 10):

i think pandas/tests/indexes/base_class/test_formats.py: with cf.option_context("display.max_seq_items", 10):
has a number of tests as well

jreback · 2020-12-14T20:43:55Z

pandas/tests/indexes/multi/test_formats.py

@@ -118,6 +118,28 @@ def test_repr(self, idx):
           names=['first', 'second'], length=6)"""
            assert result == expected

+        # display.max_seq_items == n


prob better to make a new test as easier to see / run

Got it. Moved this to it's own test case

skvrahul · 2020-12-20T08:39:50Z

@jreback Added tests and moved one of the tests to its own TC.

simonjayhawkins · 2020-12-26T14:28:49Z

doc/source/whatsnew/v1.3.0.rst

@@ -144,8 +144,6 @@ Performance improvements
 Bug fixes
 ~~~~~~~~~

-
-



can you undo this

Done. Have reverted the changes.

Revert deleted bullet points

jreback

pls also merge master

jreback · 2020-12-28T18:05:39Z

pandas/io/formats/printing.py

@@ -382,7 +382,11 @@ def best_len(values: List[str]) -> int:
        summary = f"[{first}, {last}]{close}"
    else:

-        if n > max_seq_items:
+        if max_seq_items == 1:


do we have a case of max_seq_items==0 ? (I think this is a valid value), < 0 is restricted i am pretty sure?

Yes we do. Max_seq_items ==0 implies unlimited if I'm not mistaken

jreback · 2020-12-28T18:38:54Z

thanks @skvrahul very nice

…38443)

skvrahul added 2 commits December 13, 2020 14:02

Handles case in printing summary when max_seq_items=0

b0b363d

Adds whatsnew entry

bbb19bd

simonjayhawkins added this to the 1.2.1 milestone Dec 13, 2020

simonjayhawkins added Bug Output-Formatting __repr__ of pandas objects, to_string labels Dec 13, 2020

jreback requested changes Dec 13, 2020

View reviewed changes

Removes duplicate I/O section

cb829fb

skvrahul and others added 2 commits December 14, 2020 15:06

Adds tests for 'display.max_seq_items' = 1 and 'display.max_seq_items…

62506cb

…' = n

Merge branch 'master' into 38415

d5224da

skvrahul requested a review from jreback December 14, 2020 19:05

jreback requested changes Dec 14, 2020

View reviewed changes

skvrahul added 3 commits December 16, 2020 00:44

Adds additional tests

539a055

Moves display.max_seq_items == n tests to own test

ceefa45

run black

3191e6f

skvrahul requested a review from jreback December 17, 2020 13:51

simonjayhawkins reviewed Dec 26, 2020

View reviewed changes

simonjayhawkins modified the milestones: 1.2.1, 1.3 Dec 26, 2020

skvrahul added 2 commits December 26, 2020 20:21

Update v1.3.0.rst

280518a

Revert deleted bullet points

Update v1.3.0.rst

4e381bf

skvrahul requested a review from simonjayhawkins December 26, 2020 14:54

jreback requested changes Dec 28, 2020

View reviewed changes

jreback approved these changes Dec 28, 2020

View reviewed changes

jreback merged commit 760c6ff into pandas-dev:master Dec 28, 2020

luckyvs1 pushed a commit to luckyvs1/pandas that referenced this pull request Jan 20, 2021

BUG: Fix Index.__repr__ when display.max_seq_items = 1 (pandas-dev#…

712b7a0

…38443)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BUG: Fix Index.repr when `display.max_seq_items` = 1 #38443

BUG: Fix Index.repr when `display.max_seq_items` = 1 #38443

skvrahul commented Dec 13, 2020 •

edited

Loading

simonjayhawkins commented Dec 13, 2020

jreback left a comment

jreback Dec 13, 2020

skvrahul Dec 13, 2020

jreback Dec 14, 2020

skvrahul commented Dec 14, 2020

skvrahul commented Dec 14, 2020

jreback Dec 14, 2020

jreback Dec 14, 2020

skvrahul Dec 15, 2020

skvrahul commented Dec 20, 2020

simonjayhawkins Dec 26, 2020

skvrahul Dec 26, 2020

jreback left a comment

jreback Dec 28, 2020

skvrahul Dec 28, 2020

jreback commented Dec 28, 2020

	def test_repr(self, idx):
	result = idx[:1].__repr__()
	expected = """\
	MultiIndex([('foo', 'one')],
	names=['first', 'second'])"""
	assert result == expected

	result = idx.__repr__()
	expected = """\
	MultiIndex([('foo', 'one'),
	('foo', 'two'),
	('bar', 'one'),
	('baz', 'two'),
	('qux', 'one'),
	('qux', 'two')],
	names=['first', 'second'])"""
	assert result == expected

	with pd.option_context("display.max_seq_items", 5):
	result = idx.__repr__()
	expected = """\
	MultiIndex([('foo', 'one'),
	('foo', 'two'),
	...
	('qux', 'one'),
	('qux', 'two')],
	names=['first', 'second'], length=6)"""
	assert result == expected

BUG: Fix Index.__repr__ when display.max_seq_items = 1 #38443

BUG: Fix Index.__repr__ when display.max_seq_items = 1 #38443

Conversation

skvrahul commented Dec 13, 2020 • edited Loading

simonjayhawkins commented Dec 13, 2020

jreback left a 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

skvrahul commented Dec 14, 2020

skvrahul commented Dec 14, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skvrahul commented Dec 20, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Dec 28, 2020

BUG: Fix Index.repr when `display.max_seq_items` = 1 #38443

BUG: Fix Index.repr when `display.max_seq_items` = 1 #38443

skvrahul commented Dec 13, 2020 •

edited

Loading