DEPR: deprecate fastpath keyword in Index constructors #23110

jorisvandenbossche · 2018-10-12T15:12:06Z

From all that looking at Index constructors ...

Apparently it was even hardly used internally for the Index classes (except a little bit in RangeIndex).

Part of #20110

pep8speaks · 2018-10-12T15:12:15Z

Hello @jorisvandenbossche! Thanks for submitting the PR.

There are no PEP8 issues in the file pandas/core/indexes/base.py !
There are no PEP8 issues in the file pandas/core/indexes/category.py !
There are no PEP8 issues in the file pandas/core/indexes/numeric.py !
There are no PEP8 issues in the file pandas/core/indexes/period.py !
There are no PEP8 issues in the file pandas/core/indexes/range.py !
There are no PEP8 issues in the file pandas/tests/indexes/test_base.py !

codecov · 2018-10-12T17:42:16Z

Codecov Report

Merging #23110 into master will increase coverage by 0.01%.
The diff coverage is 96.29%.

@@            Coverage Diff             @@
##           master   #23110      +/-   ##
==========================================
+ Coverage    92.2%   92.21%   +0.01%     
==========================================
  Files         169      169              
  Lines       50888    50895       +7     
==========================================
+ Hits        46919    46935      +16     
+ Misses       3969     3960       -9

Flag	Coverage Δ
#multiple	`90.63% <96.29%> (+0.01%)`	⬆️
#single	`42.23% <40.74%> (-0.01%)`	⬇️

Impacted Files	Coverage Δ
pandas/core/indexes/period.py	`93.24% <0%> (-0.03%)`	⬇️
pandas/core/indexes/category.py	`97.56% <100%> (+0.29%)`	⬆️
pandas/core/indexes/numeric.py	`97.44% <100%> (+0.03%)`	⬆️
pandas/core/indexes/base.py	`96.6% <100%> (+0.05%)`	⬆️
pandas/core/indexes/range.py	`95.77% <100%> (+0.03%)`	⬆️
pandas/core/arrays/datetimelike.py	`95.34% <0%> (-0.15%)`	⬇️
pandas/core/indexes/datetimes.py	`95.63% <0%> (-0.02%)`	⬇️
pandas/io/formats/csvs.py	`98.21% <0%> (ø)`	⬆️
pandas/core/arrays/datetimes.py	`96.94% <0%> (+0.02%)`	⬆️
... 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 12a0dc4...4575847. Read the comment docs.

jbrockmendel · 2018-10-12T19:01:47Z

pandas/core/indexes/period.py

@@ -306,7 +306,7 @@ def __contains__(self, key):

    @cache_readonly
    def _int64index(self):
-        return Int64Index(self.asi8, name=self.name, fastpath=True)
+        return Int64Index._simple_new(self.asi8, name=self.name)


What is the performance implication of using _simple_new vs just Int64Index(...)? If its sufficiently small, we should be using the public constructors

Relatively it is a big difference:

In [8]: values = np.arange(100000) In [9]: %timeit pd.Index(values) 31 µs ± 140 ns per loop (mean ± std. dev. of 7 runs, 10000 loops each) In [10]: %timeit pd.Index._simple_new(values) 1.62 µs ± 26.1 ns per loop (mean ± std. dev. of 7 runs, 1000000 loops each)

but if that will be significant in actual code, I don't know.

But since we are using that in many places, I leave changing _simple_new calls to the public constructor for another PR.

@jbrockmendel this leads a bit further, but given that the public constructors (__init__) of Index classes are very complex (something we will not be able to change I think), I think that we need to see _simple_new as kind of a "internal public" method within the pandas code base.

jbrockmendel · 2018-10-12T19:02:39Z

pandas/core/indexes/range.py

@@ -174,7 +179,7 @@ def _data(self):

    @cache_readonly
    def _int64index(self):
-        return Int64Index(self._data, name=self.name, fastpath=True)
+        return Int64Index._simple_new(self._data, name=self.name)


shallow_copy? ditto below

Not in this case, since it is not self that is calling it, so you need to pass the self.name anyway

One case below is shallow_copy, but the other can indeed be changed.

And actually, _shallow_copy has not the ability to specify (override) the name (which is not really following how _shallow_copy works for other Index classes), so can also not use it there.

Might be a bit buggy in _shallow_copy (it is also not used at all anywhere in the RangeIndex implementation, although maybe in inherited methods ..).
But I want to keep it here just about deprecating the fastpath keyword, so let's leave that for another issue.

why are u changing these constructors at all?

I am not changing anything. fastpath=True means exactly the _simple_new what I replaced it with.
This PR does not try to do a clean-up of usage of _simple_new by replacing it with the default constructor, it only deprecates the fastpath argument.

jbrockmendel · 2018-10-12T19:03:11Z

General +1, couple of comments. Is there a tracker issue for deprecations-to-eventually-remove?

jreback · 2018-10-12T19:12:52Z

yes
search for the label of Deprecation then sort by most comments

jorisvandenbossche · 2018-10-13T08:29:53Z

Added it to the list in #6581

jorisvandenbossche · 2018-10-13T08:34:07Z

@jbrockmendel Thanks for the review!

jreback

i would prefer simply to use the actual constructor rather than _simple_new if we can

jreback · 2018-10-14T14:11:31Z

pandas/core/indexes/range.py

@@ -174,7 +179,7 @@ def _data(self):

    @cache_readonly
    def _int64index(self):
-        return Int64Index(self._data, name=self.name, fastpath=True)
+        return Int64Index._simple_new(self._data, name=self.name)


why are u changing these constructors at all?

jreback · 2018-10-18T16:09:42Z

@jorisvandenbossche can you update

jorisvandenbossche · 2018-10-18T16:44:07Z

What do I need to update?

jreback · 2018-10-18T16:48:28Z

why are u changing these constructors at all?

comment above

jorisvandenbossche · 2018-10-18T16:50:12Z

Answer above: #23110 (comment)

jreback · 2018-10-18T17:25:39Z

thanks @jorisvandenbossche

jorisvandenbossche · 2018-10-18T18:04:56Z

thanks!

…3110)

jorisvandenbossche added 3 commits October 12, 2018 16:39

DEPR: deprecate fastpath keyword in Index constructors

b58765d

add tests

293917a

add whatsnew

a27da84

jorisvandenbossche added this to the 0.24.0 milestone Oct 12, 2018

jorisvandenbossche added the Deprecate Functionality to remove in pandas label Oct 12, 2018

jbrockmendel reviewed Oct 12, 2018

View reviewed changes

jsexauer mentioned this pull request Oct 13, 2018

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

Closed

1 task

add PR number in whatsnew

4575847

jreback requested changes Oct 14, 2018

View reviewed changes

jreback approved these changes Oct 18, 2018

View reviewed changes

jreback merged commit 795b771 into pandas-dev:master Oct 18, 2018

jorisvandenbossche deleted the index-fastpath branch October 18, 2018 18:05

tm9k1 pushed a commit to tm9k1/pandas that referenced this pull request Nov 19, 2018

DEPR: deprecate fastpath keyword in Index constructors (pandas-dev#2…

358bf13

…3110)

jreback mentioned this pull request Nov 27, 2019

DEPR: deprecations log for removed issues #13777

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DEPR: deprecate fastpath keyword in Index constructors #23110

DEPR: deprecate fastpath keyword in Index constructors #23110

jorisvandenbossche commented Oct 12, 2018 •

edited

Loading

pep8speaks commented Oct 12, 2018

codecov bot commented Oct 12, 2018 •

edited

Loading

jbrockmendel Oct 12, 2018

jorisvandenbossche Oct 13, 2018

jorisvandenbossche Oct 13, 2018

jbrockmendel Oct 12, 2018

jorisvandenbossche Oct 13, 2018 •

edited

Loading

jorisvandenbossche Oct 13, 2018

jorisvandenbossche Oct 13, 2018

jreback Oct 14, 2018

jorisvandenbossche Oct 14, 2018

jreback Oct 18, 2018

jbrockmendel commented Oct 12, 2018

jreback commented Oct 12, 2018

jorisvandenbossche commented Oct 13, 2018

jorisvandenbossche commented Oct 13, 2018

jreback left a comment

jreback Oct 14, 2018

jreback commented Oct 18, 2018

jorisvandenbossche commented Oct 18, 2018

jreback commented Oct 18, 2018

jorisvandenbossche commented Oct 18, 2018

jreback commented Oct 18, 2018

jorisvandenbossche commented Oct 18, 2018

DEPR: deprecate fastpath keyword in Index constructors #23110

DEPR: deprecate fastpath keyword in Index constructors #23110

Conversation

jorisvandenbossche commented Oct 12, 2018 • edited Loading

pep8speaks commented Oct 12, 2018

codecov bot commented Oct 12, 2018 • edited Loading

Codecov Report

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

jorisvandenbossche Oct 13, 2018 • 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

jbrockmendel commented Oct 12, 2018

jreback commented Oct 12, 2018

jorisvandenbossche commented Oct 13, 2018

jorisvandenbossche commented Oct 13, 2018

jreback left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Oct 18, 2018

jorisvandenbossche commented Oct 18, 2018

jreback commented Oct 18, 2018

jorisvandenbossche commented Oct 18, 2018

jreback commented Oct 18, 2018

jorisvandenbossche commented Oct 18, 2018

jorisvandenbossche commented Oct 12, 2018 •

edited

Loading

codecov bot commented Oct 12, 2018 •

edited

Loading

jorisvandenbossche Oct 13, 2018 •

edited

Loading