DEPR: deprecate notebook argument in DataFrame.to_html() #26815

simonjayhawkins · 2019-06-12T18:12:48Z

closes DISC: deprecate notebook parameter in to_html() #23820
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

WillAyd · 2019-06-12T18:24:34Z

Code looks pretty good. Just to clarify since I'm not super familiar with this one, does this serve any purpose from an end user perspective or is it pure cruft?

Just wondering if we should document the alternatives to this if any

simonjayhawkins · 2019-06-12T18:36:32Z

Code looks pretty good. Just to clarify since I'm not super familiar with this one, does this serve any purpose from an end user perspective or is it pure cruft?

I'm not sure of the history. Assuming that it was needed internally but added to a public method. So I don't see it serving any purpose to an end user.

Just wondering if we should document the alternatives to this if any

The alternative is the _repr_html_ method. As this is not part of the public API, i'm reluctant to suggest this as an alternative.

jreback

add the deprecation here: #6581

jreback · 2019-06-12T18:37:47Z

doc/source/whatsnew/v0.25.0.rst

@@ -495,7 +495,7 @@ Other Deprecations
  Use the public attributes :attr:`~RangeIndex.start`, :attr:`~RangeIndex.stop` and :attr:`~RangeIndex.step` instead (:issue:`26581`).
 - The :meth:`Series.ftype`, :meth:`Series.ftypes` and :meth:`DataFrame.ftypes` methods are deprecated and will be removed in a future version.
  Instead, use :meth:`Series.dtype` and :meth:`DataFrame.dtypes` (:issue:`26705`).
-
+- The ``notebook`` argument of :meth:`DataFrame.to_html` is deprecated (:issue:`23820`).


mention the replacement

there would be no replacement from an end user perspective. see #26815 (comment)

jreback · 2019-06-12T18:38:21Z

pandas/core/frame.py

@@ -650,8 +650,11 @@ def _repr_html_(self):
            max_cols = get_option("display.max_columns")
            show_dimensions = get_option("display.show_dimensions")

-            return self.to_html(max_rows=max_rows, max_cols=max_cols,
-                                show_dimensions=show_dimensions, notebook=True)
+            formatter = fmt.DataFrameFormatter(


why the change?

_repr_html_ just calls to_html with notebook=True, so need to avoid the FutureWarning in the notebook.

eventually i'd like to have _repr_html_ instantiate NotebookFormatter directly and to_html instantiate HTMLFormatter directly. But at the moment neither are subclasses of DataFrameFormatter

jreback · 2019-06-12T18:38:32Z

pandas/core/frame.py

@@ -2158,6 +2162,9 @@ def to_html(self, buf=None, columns=None, col_space=None, header=True,
            Convert the characters <, >, and & to HTML-safe sequences.
        notebook : {True, False}, default False
            Whether the generated HTML is for IPython Notebook.
+
+            .. deprecated:: 0.25.0


is there a replacement?

there would be no replacement from an end user perspective. see #26815 (comment)

Need to update this to 1.0.0

codecov · 2019-06-12T18:49:09Z

Codecov Report

Merging #26815 into master will decrease coverage by 1.41%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #26815      +/-   ##
==========================================
- Coverage   91.86%   90.45%   -1.42%     
==========================================
  Files         179      179              
  Lines       50707    50710       +3     
==========================================
- Hits        46584    45870     -714     
- Misses       4123     4840     +717

Flag	Coverage Δ
#multiple	`90.45% <100%> (ø)`	⬆️
#single	`?`

Impacted Files	Coverage Δ
pandas/core/frame.py	`96.89% <100%> (-0.12%)`	⬇️
pandas/core/computation/pytables.py	`62.5% <0%> (-27.75%)`	⬇️
pandas/io/pytables.py	`63.82% <0%> (-26.48%)`	⬇️
pandas/io/gbq.py	`88.88% <0%> (-11.12%)`	⬇️
pandas/core/computation/common.py	`84.21% <0%> (-5.27%)`	⬇️
pandas/core/computation/expr.py	`94.78% <0%> (-3.03%)`	⬇️
pandas/io/clipboard/clipboards.py	`31.88% <0%> (-2.9%)`	⬇️
pandas/io/formats/printing.py	`84.49% <0%> (-1.07%)`	⬇️
pandas/core/indexes/datetimes.py	`96.21% <0%> (-0.17%)`	⬇️
pandas/core/arrays/categorical.py	`95.8% <0%> (-0.13%)`	⬇️
... and 2 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 e6d27ec...fd23985. Read the comment docs.

codecov · 2019-06-12T18:49:12Z

Codecov Report

❗ No coverage uploaded for pull request base (master@7b25463). Click here to learn what that means.
The diff coverage is 100%.

@@            Coverage Diff            @@
##             master   #26815   +/-   ##
=========================================
  Coverage          ?   91.86%           
=========================================
  Files             ?      180           
  Lines             ?    50719           
  Branches          ?        0           
=========================================
  Hits              ?    46593           
  Misses            ?     4126           
  Partials          ?        0

Flag	Coverage Δ
#multiple	`90.45% <100%> (?)`
#single	`41.12% <25%> (?)`

Impacted Files	Coverage Δ
pandas/core/frame.py	`96.89% <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 7b25463...97dd413. Read the comment docs.

simonjayhawkins · 2019-06-12T18:52:34Z

add the deprecation here: #6581

done

…k-argument

WillAyd

minor comment otherwise lgtm

WillAyd · 2019-08-28T16:55:18Z

pandas/core/frame.py

@@ -2158,6 +2162,9 @@ def to_html(self, buf=None, columns=None, col_space=None, header=True,
            Convert the characters <, >, and & to HTML-safe sequences.
        notebook : {True, False}, default False
            Whether the generated HTML is for IPython Notebook.
+
+            .. deprecated:: 0.25.0


Need to update this to 1.0.0

WillAyd · 2019-08-30T14:41:57Z

General question on this - are we adding deprecations to the 1.0.0 release or removing outright?

TomAugspurger · 2019-08-30T14:55:29Z

I thought adding deprecations. May be wrong though.

…

On Fri, Aug 30, 2019 at 9:42 AM William Ayd ***@***.***> wrote: General question on this - are we adding deprecations to the 1.0.0 release or removing outright? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#26815?email_source=notifications&email_token=AAKAOITUQYS56WHE4KJFJT3QHEWT5A5CNFSM4HXNVKSKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD5R3JRI#issuecomment-526628037>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAKAOIWJS5BOXZNVFF7I4OLQHEWT5ANCNFSM4HXNVKSA> .

…k-argument

WillAyd

lgtm @TomAugspurger

TomAugspurger · 2019-09-05T18:47:51Z

This deprecation docs / warning should have some indication for what users should do instead. What do we recommend?

simonjayhawkins · 2019-09-06T08:20:04Z

This deprecation docs / warning should have some indication for what users should do instead. What do we recommend?

there would be no replacement from an end user perspective. see #26815 (comment)

TomAugspurger · 2019-09-06T16:08:18Z

So you're saying it's not useful to users? How do you know that? Why don't we document what `notebook=True` used to imply? Or, alternatively, we could just say `_repr_html_` is part of the API for this purpose. It's a well established interface that we aren't going to remove.

…

On Fri, Sep 6, 2019 at 3:20 AM Simon Hawkins ***@***.***> wrote: This deprecation docs / warning should have some indication for what users should do instead. What do we recommend? there would be no replacement from an end user perspective. see #26815 (comment) <#26815 (comment)> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#26815?email_source=notifications&email_token=AAKAOIWZXQI3LAV3AFES7G3QIIHEFA5CNFSM4HXNVKSKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD6CD7AY#issuecomment-528760707>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAKAOIWXDTAIVOAO3L6WSY3QIIHEFANCNFSM4HXNVKSA> .

jreback · 2019-10-06T22:46:26Z

@simonjayhawkins can you summarize status here

simonjayhawkins · 2019-10-07T12:36:49Z

there is not agreement that this should be deprecated. so will close and maybe reopen in the future if there is a stronger argument for deprecation.

DEPR: deprecate notebook argument in DataFrame.to_html()

fd23985

simonjayhawkins added Deprecate Functionality to remove in pandas IO HTML read_html, to_html, Styler.apply, Styler.applymap Output-Formatting __repr__ of pandas objects, to_string labels Jun 12, 2019

jreback requested changes Jun 12, 2019

View reviewed changes

jsexauer mentioned this pull request Jun 12, 2019

DEPR: Clean up list of deprecations from prior versions #6581

Closed

1 task

simonjayhawkins added 5 commits June 13, 2019 11:31

Merge remote-tracking branch 'upstream/master' into deprecate-noteboo…

a1794a7

…k-argument

resolve merge conflict

66c22d8

resolve merge conflicts

41751ca

whatsnew

271a329

format black

9daa62b

WillAyd requested changes Aug 28, 2019

View reviewed changes

WillAyd modified the milestones: 0.25.2, 1.0 Aug 28, 2019

simonjayhawkins added 2 commits August 30, 2019 16:12

Merge remote-tracking branch 'upstream/master' into deprecate-noteboo…

a9db1c3

…k-argument

update .. deprecated::

97dd413

WillAyd approved these changes Sep 5, 2019

View reviewed changes

simonjayhawkins closed this Oct 7, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DEPR: deprecate notebook argument in DataFrame.to_html() #26815

DEPR: deprecate notebook argument in DataFrame.to_html() #26815

simonjayhawkins commented Jun 12, 2019

WillAyd commented Jun 12, 2019

simonjayhawkins commented Jun 12, 2019

jreback left a comment

jreback Jun 12, 2019

simonjayhawkins Jun 12, 2019

jreback Jun 12, 2019

simonjayhawkins Jun 12, 2019

jreback Jun 12, 2019

simonjayhawkins Aug 24, 2019

WillAyd Aug 28, 2019

codecov bot commented Jun 12, 2019

codecov bot commented Jun 12, 2019 •

edited

Loading

simonjayhawkins commented Jun 12, 2019

WillAyd left a comment

WillAyd Aug 28, 2019

WillAyd commented Aug 30, 2019

TomAugspurger commented Aug 30, 2019 via email

WillAyd left a comment

TomAugspurger commented Sep 5, 2019

simonjayhawkins commented Sep 6, 2019

TomAugspurger commented Sep 6, 2019 via email

jreback commented Oct 6, 2019

simonjayhawkins commented Oct 7, 2019

DEPR: deprecate notebook argument in DataFrame.to_html() #26815

DEPR: deprecate notebook argument in DataFrame.to_html() #26815

Conversation

simonjayhawkins commented Jun 12, 2019

WillAyd commented Jun 12, 2019

simonjayhawkins commented Jun 12, 2019

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

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

codecov bot commented Jun 12, 2019

Codecov Report

codecov bot commented Jun 12, 2019 • edited Loading

Codecov Report

simonjayhawkins commented Jun 12, 2019

WillAyd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WillAyd commented Aug 30, 2019

TomAugspurger commented Aug 30, 2019 via email

WillAyd left a comment

Choose a reason for hiding this comment

TomAugspurger commented Sep 5, 2019

simonjayhawkins commented Sep 6, 2019

TomAugspurger commented Sep 6, 2019 via email

jreback commented Oct 6, 2019

simonjayhawkins commented Oct 7, 2019

codecov bot commented Jun 12, 2019 •

edited

Loading