Fixed to_html ignoring index_names parameter

[CRP]

• [x ] closes to_html(index_names=False) still renders a row with index names #16493
• tests added / passed
• passes git diff upstream/master --name-only -- '*.py' | flake8 --diff
• whatsnew entry

[TomAugspurger]

Thanks. Could you add a test to verify the output is correct? Something simple like

df = pd.DataFrame({"A": [1, 2], index=pd.Index(['a', 'b'], name='myindexname'})
result = df.to_html(index_names=False)
assert 'myindexname' not in result

You should probably also do some checking that there blank rows aren't put in either.
It can go in pandas/tests/io/formats/test_to_html.py

Also need a release not in doc/source/whatsnew/v0.20.2.txt. Thanks!

[TomAugspurger]

Oh, you'll also need to use self.fmt.show_index_names (need the .fmt in there). For reference, most (all?) of the common DataFrame formatting arguments are bundled into a DataFrameFormatter, which is then passed as the first argument to HTMLFormatter.

[CRP]

ok, sorry, was a bit too hasty. please check the new pull request.

…

On Thu, May 25, 2017 at 3:31 PM, Tom Augspurger ***@***.***> wrote: Oh, you'll also need to use self.fmt.show_index_names (need the .fmt in there). For reference, most (all?) of the common DataFrame formatting arguments are bundled into a DataFrameFormatter, which is then passed as the first argument to HTMLFormatter. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#16495 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAxTkORU50RSmLEDmMBEy8ugUNCRFTkLks5r9YKpgaJpZM4NmWv6> .

-- Christian Prinoth

[TomAugspurger]

Sorry, looks like it's saved as show_index_names on DataFrameFormatter, not index_names.

FYI you can test it locally with pytest pandas/tests/io/formats/test_to_html.py -k test_to_html_with_index_names_false. It also looks like that line is too long: https://travis-ci.org/pandas-dev/pandas/jobs/236007626#L2829

[TomAugspurger]

Change to_html to

``DataFrame.to_html``

and put index_names in double backticks

[CRP]

I used show_index_names on purpose, based on this line: [image: Inline image 1] should line 372 be modified as well for consistency with the parameter name?

…

On Thu, May 25, 2017 at 6:33 PM, Tom Augspurger ***@***.***> wrote: ***@***.**** commented on this pull request. Sorry, looks like it's saved as show_index_names on DataFrameFormatter, not index_names. FYI you can test it locally with pytest pandas/tests/io/formats/test_to_html.py -k test_to_html_with_index_names_false. It also looks like that line is too long: https://travis-ci.org/pandas-dev/pandas/jobs/236007626#L2829 ------------------------------ In doc/source/whatsnew/v0.20.2.txt <#16495 (comment)>: > @@ -59,6 +59,7 @@ I/O - Bug in pd.read_csv() when comment is passed in space deliminted text files (:issue:`16472`) - Bug that would force importing of the clipboard routines unnecessarily, potentially causing an import error on startup (:issue:`16288`) - Bug that raised IndexError HTML-rendering an empty DataFrame (:issue:`15953`) +- Bug where to_html ignored the index_names parameter (:issue:`16493`) Change to_html to ``DataFrame.to_html`` and put index_names in double backticks — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#16495 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAxTkBwtcWgWwtMK5vtuZtMIeoUyn9qhks5r9a1bgaJpZM4NmWv6> .

-- Christian Prinoth

[TomAugspurger]

Your image didn't show up, so I don't know what lines you're referring to.

You shouldn't have to change any parameter names. I must have been confused though. The current version is correct (the line might be too long though. Try flake8 pandas/io/formats/format.py to make sure)

[codecov]

Codecov Report

Merging #16495 into master will not change coverage.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master   #16495   +/-   ##
=======================================
  Coverage   90.43%   90.43%           
=======================================
  Files         161      161           
  Lines       51045    51045           
=======================================
  Hits        46161    46161           
  Misses       4884     4884

Flag	Coverage Δ
#multiple	88.27% <100%> (ø)	⬆️
#single	40.16% <0%> (ø)	⬆️

Impacted Files	Coverage Δ
pandas/io/formats/format.py	96.02% <100%> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e41fe7f...20d512f. Read the comment docs.

[codecov]

Codecov Report

Merging #16495 into master will increase coverage by 0.36%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #16495      +/-   ##
==========================================
+ Coverage   90.43%   90.79%   +0.36%     
==========================================
  Files         161      161              
  Lines       51045    51063      +18     
==========================================
+ Hits        46161    46365     +204     
+ Misses       4884     4698     -186

Flag	Coverage Δ
#multiple	88.63% <100%> (+0.36%)	⬆️
#single	40.15% <0%> (-0.01%)	⬇️

Impacted Files	Coverage Δ
pandas/io/formats/format.py	96.02% <100%> (ø)	⬆️
pandas/plotting/_converter.py	63.23% <0%> (-1.82%)	⬇️
pandas/core/categorical.py	95.5% <0%> (-0.42%)	⬇️
pandas/core/frame.py	97.66% <0%> (-0.03%)	⬇️
pandas/core/reshape/pivot.py	95.08% <0%> (ø)	⬆️
pandas/core/resample.py	96.09% <0%> (+0.01%)	⬆️
pandas/core/generic.py	92.26% <0%> (+0.09%)	⬆️
pandas/core/series.py	94.9% <0%> (+0.18%)	⬆️
pandas/util/testing.py	80.98% <0%> (+0.19%)	⬆️
pandas/io/parsers.py	95.66% <0%> (+0.32%)	⬆️
... and 4 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e41fe7f...567ae69. Read the comment docs.

[CRP]

what I meant is that the name of parameter of the to_html method is "index_names". Internally, in the fmt structure, it is renamed "show_index_names", which I then use to determine whether relevant header row should be included in the html table. I fixed the line too long by replacing with all(...) and splitting content of statement on several lines.

…

On Thu, May 25, 2017 at 7:21 PM, Tom Augspurger ***@***.***> wrote: Your image didn't show up, so I don't know what lines you're referring to. You shouldn't have to change any parameter names. I must have been confused though. The current version is correct (the line might be too long though. Try flake8 pandas/io/formats/format.py to make sure) — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#16495 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAxTkCFVXJMcYmjNAZgT08zZaDQWn8DLks5r9biHgaJpZM4NmWv6> .

-- Christian Prinoth

[TomAugspurger]

Sounds good. Looks like a small issue with the usage of `all`: https://travis-ci.org/pandas-dev/pandas/jobs/236274960#L1522 if all(self.fmt.has_index_names, self.fmt.index,

self.fmt.show_index_names):

It takes an iterable of booleans. So something like ```python if all((self.fmt.has_index_names, self.fmt.index, self.fmt.show_index_names)): ``` On Fri, May 26, 2017 at 2:17 AM, Christian Prinoth <[email protected]

…

wrote: what I meant is that the name of parameter of the to_html method is "index_names". Internally, in the fmt structure, it is renamed "show_index_names", which I then use to determine whether relevant header row should be included in the html table. I fixed the line too long by replacing with all(...) and splitting content of statement on several lines. On Thu, May 25, 2017 at 7:21 PM, Tom Augspurger ***@***.***> wrote: > Your image didn't show up, so I don't know what lines you're referring to. > > You shouldn't have to change any parameter names. I must have been > confused though. The current version is correct (the line might be too long > though. Try flake8 pandas/io/formats/format.py to make sure) > > — > You are receiving this because you authored the thread. > Reply to this email directly, view it on GitHub > <#16495 (comment) >, > or mute the thread > <https://github.com/notifications/unsubscribe-auth/ AAxTkCFVXJMcYmjNAZgT08zZaDQWn8DLks5r9biHgaJpZM4NmWv6> > . > -- Christian Prinoth — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#16495 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABQHIk1akgdSoB5zNBsxUOIiTH8E2waKks5r9nyNgaJpZM4NmWv6> .

[CRP]

done and pushed. You certainly are a patient guy ;) On Fri, May 26, 2017 at 1:42 PM, Tom Augspurger <[email protected]> wrote:

…

Sounds good. Looks like a small issue with the usage of `all`: https://travis-ci.org/pandas-dev/pandas/jobs/236274960#L1522 if all(self.fmt.has_index_names, self.fmt.index, > self.fmt.show_index_names): It takes an iterable of booleans. So something like ```python if all((self.fmt.has_index_names, self.fmt.index, self.fmt.show_index_names)): ``` On Fri, May 26, 2017 at 2:17 AM, Christian Prinoth < ***@***.*** > wrote: > what I meant is that the name of parameter of the to_html method is > "index_names". Internally, in the fmt structure, it is renamed > "show_index_names", which I then use to determine whether relevant header > row should be included in the html table. > > I fixed the line too long by replacing with all(...) and splitting content > of statement on several lines. > > On Thu, May 25, 2017 at 7:21 PM, Tom Augspurger < ***@***.***> > wrote: > > > Your image didn't show up, so I don't know what lines you're referring > to. > > > > You shouldn't have to change any parameter names. I must have been > > confused though. The current version is correct (the line might be too > long > > though. Try flake8 pandas/io/formats/format.py to make sure) > > > > — > > You are receiving this because you authored the thread. > > Reply to this email directly, view it on GitHub > > <#16495# issuecomment-304068837 > >, > > or mute the thread > > <https://github.com/notifications/unsubscribe-auth/ > AAxTkCFVXJMcYmjNAZgT08zZaDQWn8DLks5r9biHgaJpZM4NmWv6> > > . > > > > > > -- > > Christian Prinoth > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <#16495 (comment) >, > or mute the thread > <https://github.com/notifications/unsubscribe-auth/ ABQHIk1akgdSoB5zNBsxUOIiTH8E2waKks5r9nyNgaJpZM4NmWv6> > . > — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#16495 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAxTkPThnPifm9cu86Rkt0uj66QyXEHwks5r9rqlgaJpZM4NmWv6> .

-- Christian Prinoth

[jreback]

lgtm. minor comment.

[jreback]

can you add the issue reference as a comment.

[jreback]

DataFrame.to_html()

[TomAugspurger]

@CRP make sure to pull this branch before pushing those fixes. I pushed a commit fixing a small lint error.

[CRP]

sorry you lost me, what else do i need to do to close this issue?

…

On Wed, May 31, 2017 at 4:41 AM, Tom Augspurger ***@***.***> wrote: @CRP <https://github.com/crp> make sure to pull this branch before pushing those fixes. I pushed a commit fixing a small lint error. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#16495 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAxTkNcnCBSRTYn8xLqeJu-1cKCrbPRGks5r_NNKgaJpZM4NmWv6> .

-- Christian Prinoth

[jreback]

thanks!