Standardize function signatures #14645

gfyoung · 2016-11-13T06:19:13Z

Standardize the following function signatures:

repeat(reps, *args, **kwargs)
searchsorted(value, side='left', sorter=None)

codecov-io · 2016-11-13T07:44:49Z

Current coverage is 85.22% (diff: 97.67%)

Merging #14645 into master will increase coverage by <.01%

@@             master     #14645   diff @@
==========================================
  Files           143        143          
  Lines         50807      50813     +6   
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
+ Hits          43297      43304     +7   
+ Misses         7510       7509     -1   
  Partials          0          0

Powered by Codecov. Last update d8e427b...f448639

jreback · 2016-11-13T13:31:23Z

pandas/tests/series/test_operators.py

@@ -1818,3 +1818,31 @@ def test_op_duplicate_index(self):
        result = s1 + s2
        expected = pd.Series([11, 12, np.nan], index=[1, 1, 2])
        assert_series_equal(result, expected)
+
+    def test_searchsorted(self):


put these tests alongside the other ones / u need to search for them

Alongside what other ones? Where should I put these tests?

u need to search for them
i think that's pretty clear

Fair enough, though as written, the "/" made the sentence confusing.

chris-b1 · 2016-11-13T15:59:12Z

doc/source/whatsnew/v0.20.0.txt

@@ -53,6 +53,9 @@ Other API Changes
 Deprecations
 ^^^^^^^^^^^^

+- ``Series.repeat()`` has deprecated the ``reps`` parameter in favor of ``repeats`` (:issue:`12662`)
+- ``Index.repeat()`` and ``MultiIndex.repeat()`` have deprecated the ``n`` parameter in favor of ``repeats`` (:issue:`12662`)
+- ``Categorical.searchsorted()`` and ``Series.searchsorted()`` have deprecated the ``v`` parameter in favor of ``key`` (:issue:`12662`)


Doesn't numpy still call this parameter v?

In [9]: a = np.array([1,2,3]) In [11]: a.searchsorted? Docstring: a.searchsorted(v, side='left', sorter=None) Find indices where elements of v should be inserted in a to maintain order. For full documentation, see `numpy.searchsorted` See Also -------- numpy.searchsorted : equivalent function Type: builtin_function_or_method In [12]: np.__version__ Out[12]: '1.11.1'

Oh, I see that Index was already using key as the name - I guess I don't feel strongly between the two.

I don't see a reason to follow the numpy convention, especially since it is very unclear what exactly that parameter is. Unless someone strongly objects, I would prefer to use key.

so we typically will use value in this case (not sure why it was key in the timedelta one). We are searching the .values of the object, and NOT the index (where we typically use key).

@jreback : Okay...so should we still keep to key or should they all be changed to value for searchsorted?

Since we are already changing keyword names, for me it is OK to choose value instead of key

Okay, fair enough. Will change.

gfyoung · 2016-11-13T22:36:53Z

@jreback , @chris-b1 : Everything looks green. Ready to merge if there are no concerns.

jreback · 2016-11-15T11:45:18Z

lgtm.

jorisvandenbossche · 2016-11-24T10:11:39Z

pandas/tests/indexes/test_base.py

+        tm.assert_index_equal(result, expected)
+
+        with tm.assert_produces_warning(FutureWarning,
+                                        check_stacklevel=False):


Is the check_stacklevel=False needed here? This looks like a simple example where stacklevel=2 should just work

Yes, it is needed unfortunately.

For which builds does it error? If we always have to pass check_stacklevel=False, even for those (I think) straightforward case, there is not much point in having the keyword.

For me it passes locally.

It didn't pass locally for me. TBH, not really sure why we need this argument in the first place.

Can you show the error traceback?

The reason we have this argument, is to ensure that the FutureWarnings are correctly attributed. Towards users, this is really helpful.

Perhaps, but look at how many times we have had to pass in check_stacklevel=False. I don't necessarily object to specifying a stack level, but if we're unable to consistently specify the correct stack level, why are we using it in our tests?

BTW, I'm not trying to avoid showing my error traceback. I'm just in the middle of another PR.

Ran the tests again to see if I could replicate the issue but invoked the tests in a different way, and I could not replicate. So let's see what Travis says about it.

gfyoung · 2016-11-25T17:11:10Z

@jreback , @jorisvandenbossche : Everything seems to be passing still. Ready to merge if there are no other concerns.

jorisvandenbossche · 2016-11-25T21:05:24Z

doc/source/whatsnew/v0.20.0.txt

+- ``Series.repeat()`` has deprecated the ``reps`` parameter in favor of ``repeats`` (:issue:`12662`)
+- ``Index.repeat()`` and ``MultiIndex.repeat()`` have deprecated the ``n`` parameter in favor of ``repeats`` (:issue:`12662`)
+- ``Categorical.searchsorted()`` and ``Series.searchsorted()`` have deprecated the ``v`` parameter in favor of ``value`` (:issue:`12662`)
+- ``IndexOpsMixin.searchsorted()``, ``TimedeltaIndex.searchsorted()``, ``DatetimeIndex.searchsorted()``, and ``PeriodIndex.searchsorted()`` have deprecated the ``key`` parameter in favor of ``value`` (:issue:`12662`)


Listing IndexOpsMixin is not needed here I think

Fair enough. Done.

jorisvandenbossche · 2016-11-25T21:05:56Z

pandas/tests/indexes/test_multi.py

@@ -97,6 +97,10 @@ def test_repeat(self):
            numbers, names.repeat(reps)], names=names)
        tm.assert_index_equal(m.repeat(reps), expected)

+        with tm.assert_produces_warning(FutureWarning,
+                                        check_stacklevel=False):


I think you can removed all other occurences of check_stacklevel=False in this PR as well

Seems so. Done.

Standardize the following function signatures: 1) repeat(reps, *args, **kwargs) 2) searchsorted(value, side='left', sorter=None) Closes pandas-devgh-12662.

gfyoung · 2016-11-26T07:14:33Z

@jreback , @jorisvandenbossche : Changes made, and everything seems to be passing still. Ready to merge if there are no other concerns.

xref pandas-devgh-14645.

xref gh-14645.

For Index and MultiIndex. xref pandas-devgh-14645.

For Index and MultiIndex. xref gh-14645.

The parameter is "value" across the board. xref pandas-devgh-14645.

"values" is the law of the land. xref pandas-devgh-14645.

"values" is the law of the land. xref pandas-devgh-14645. Follow-up to pandas-devgh-15601.

"values" is the law of the land. This usage is internal, hence why we aren't going through a deprecation cycle. xref pandas-devgh-14645. Follow-up to pandas-devgh-15601.

The parameter is "value" across the board. xref gh-14645.

"values" is the law of the land. This usage is internal, hence why we aren't going through a deprecation cycle. xref pandas-devgh-14645. Follow-up to pandas-devgh-15601.

"values" is the law of the land. xref pandas-devgh-14645. Follow-up to pandas-devgh-15601.

"value" is the law of the land. xref gh-14645. Follow-up to gh-15601.

For Index and MultiIndex. xref pandas-devgh-14645.

The parameter is "value" across the board. xref pandas-devgh-14645.

"value" is the law of the land. xref pandas-devgh-14645. Follow-up to pandas-devgh-15601.

xref pandas-devgh-14645.

For Index and MultiIndex. xref pandas-devgh-14645.

The parameter is "value" across the board. xref pandas-devgh-14645.

"value" is the law of the land. xref pandas-devgh-14645. Follow-up to pandas-devgh-15601.

gfyoung force-pushed the signature-standardize branch from e529572 to 6c59f44 Compare November 13, 2016 07:44

jreback requested changes Nov 13, 2016

View reviewed changes

chris-b1 reviewed Nov 13, 2016

View reviewed changes

gfyoung force-pushed the signature-standardize branch from 6c59f44 to fdd6fbf Compare November 13, 2016 20:21

jorisvandenbossche added the Clean label Nov 14, 2016

jorisvandenbossche added this to the 0.20.0 milestone Nov 14, 2016

gfyoung force-pushed the signature-standardize branch from fdd6fbf to a29bba6 Compare November 14, 2016 22:40

gfyoung force-pushed the signature-standardize branch 9 times, most recently from c4e0bb8 to 26f7be9 Compare November 22, 2016 18:28

gfyoung force-pushed the signature-standardize branch from 26f7be9 to c5059b6 Compare November 23, 2016 01:51

jorisvandenbossche reviewed Nov 24, 2016

View reviewed changes

gfyoung force-pushed the signature-standardize branch 3 times, most recently from 3d469de to 3cdded5 Compare November 25, 2016 09:39

jorisvandenbossche reviewed Nov 25, 2016

View reviewed changes

Standardize function signatures

f448639

Standardize the following function signatures: 1) repeat(reps, *args, **kwargs) 2) searchsorted(value, side='left', sorter=None) Closes pandas-devgh-12662.

gfyoung force-pushed the signature-standardize branch from 3cdded5 to f448639 Compare November 25, 2016 21:26

jorisvandenbossche merged commit 08d7b2c into pandas-dev:master Nov 26, 2016

gfyoung deleted the signature-standardize branch November 26, 2016 09:31

jsexauer mentioned this pull request Dec 23, 2016

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

Closed

1 task

gfyoung added a commit to forking-repos/pandas that referenced this pull request Aug 19, 2018

DEPR: Rename reps to repeats in Series.repeat

a9a17b4

xref pandas-devgh-14645.

gfyoung mentioned this pull request Aug 19, 2018

DEPR: Rename reps to repeats in Series.repeat #22417

Merged

jreback mentioned this pull request Aug 19, 2018

DEPR: deprecations log for removed issues #13777

Closed

jreback pushed a commit that referenced this pull request Aug 20, 2018

DEPR: Rename reps to repeats in Series.repeat (#22417)

b49e5f6

xref gh-14645.

gfyoung added a commit to forking-repos/pandas that referenced this pull request Sep 2, 2018

CLN: Rename 'n' to 'repeats' in .repeat methods

17f18f2

For Index and MultiIndex. xref pandas-devgh-14645.

gfyoung mentioned this pull request Sep 2, 2018

CLN: Rename 'n' to 'repeats' in .repeat methods #22574

Merged

gfyoung added a commit to forking-repos/pandas that referenced this pull request Sep 2, 2018

CLN: Rename 'n' to 'repeats' in .repeat methods

780019d

For Index and MultiIndex. xref pandas-devgh-14645.

jreback pushed a commit that referenced this pull request Sep 4, 2018

CLN: Rename 'n' to 'repeats' in .repeat methods (#22574)

9e362a6

For Index and MultiIndex. xref gh-14645.

gfyoung added a commit to forking-repos/pandas that referenced this pull request Sep 11, 2018

CLN: Standardize searchsorted signatures

328d8bd

The parameter is "value" across the board. xref pandas-devgh-14645.

gfyoung mentioned this pull request Sep 11, 2018

CLN: Standardize searchsorted signatures #22670

Merged

gfyoung added a commit to forking-repos/pandas that referenced this pull request Sep 11, 2018

CLN: Standardize searchsorted signatures

5cd523e

The parameter is "value" across the board. xref pandas-devgh-14645.

gfyoung added a commit to forking-repos/pandas that referenced this pull request Sep 11, 2018

CLN: Standardize searchsorted signatures

eb9f65c

The parameter is "value" across the board. xref pandas-devgh-14645.

gfyoung added a commit to forking-repos/pandas that referenced this pull request Sep 12, 2018

DEPR: Standardize searchsorted signature

574d366

"values" is the law of the land. xref pandas-devgh-14645.

gfyoung added a commit to forking-repos/pandas that referenced this pull request Sep 12, 2018

DEPR: Standardize searchsorted signature

8d1b41d

"values" is the law of the land. xref pandas-devgh-14645. Follow-up to pandas-devgh-15601.

gfyoung mentioned this pull request Sep 12, 2018

MAINT: Standardize searchsorted signature #22672

Merged

gfyoung added a commit that referenced this pull request Sep 13, 2018

CLN: Standardize searchsorted signatures (#22670)

ba2720b

The parameter is "value" across the board. xref gh-14645.

gfyoung added a commit to forking-repos/pandas that referenced this pull request Sep 14, 2018

DEPR: Standardize searchsorted signature

a0ccac1

"values" is the law of the land. xref pandas-devgh-14645. Follow-up to pandas-devgh-15601.

gfyoung added a commit that referenced this pull request Sep 15, 2018

DEPR: Standardize searchsorted signature (#22672)

9b9f6bd

"value" is the law of the land. xref gh-14645. Follow-up to gh-15601.

aeltanawy pushed a commit to aeltanawy/pandas that referenced this pull request Sep 20, 2018

CLN: Rename 'n' to 'repeats' in .repeat methods (pandas-dev#22574)

d96a334

For Index and MultiIndex. xref pandas-devgh-14645.

aeltanawy pushed a commit to aeltanawy/pandas that referenced this pull request Sep 20, 2018

CLN: Standardize searchsorted signatures (pandas-dev#22670)

788158d

The parameter is "value" across the board. xref pandas-devgh-14645.

aeltanawy pushed a commit to aeltanawy/pandas that referenced this pull request Sep 20, 2018

DEPR: Standardize searchsorted signature (pandas-dev#22672)

e5d334f

"value" is the law of the land. xref pandas-devgh-14645. Follow-up to pandas-devgh-15601.

Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018

DEPR: Rename reps to repeats in Series.repeat (pandas-dev#22417)

0211a7c

xref pandas-devgh-14645.

Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018

CLN: Rename 'n' to 'repeats' in .repeat methods (pandas-dev#22574)

5f54168

For Index and MultiIndex. xref pandas-devgh-14645.

Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018

CLN: Standardize searchsorted signatures (pandas-dev#22670)

acfb587

The parameter is "value" across the board. xref pandas-devgh-14645.

Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018

DEPR: Standardize searchsorted signature (pandas-dev#22672)

8ef7024

"value" is the law of the land. xref pandas-devgh-14645. Follow-up to pandas-devgh-15601.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Standardize function signatures #14645

Standardize function signatures #14645

gfyoung commented Nov 13, 2016 •

edited

Loading

codecov-io commented Nov 13, 2016 •

edited

Loading

jreback Nov 13, 2016

gfyoung Nov 13, 2016

jreback Nov 13, 2016

gfyoung Nov 13, 2016

chris-b1 Nov 13, 2016

chris-b1 Nov 13, 2016

gfyoung Nov 13, 2016

jreback Nov 23, 2016

gfyoung Nov 23, 2016 •

edited

Loading

jorisvandenbossche Nov 24, 2016

gfyoung Nov 24, 2016

gfyoung commented Nov 13, 2016

jreback commented Nov 15, 2016

jorisvandenbossche Nov 24, 2016

gfyoung Nov 25, 2016

jorisvandenbossche Nov 25, 2016

gfyoung Nov 25, 2016 •

edited

Loading

jorisvandenbossche Nov 25, 2016

jorisvandenbossche Nov 25, 2016

gfyoung Nov 25, 2016

gfyoung Nov 25, 2016

gfyoung commented Nov 25, 2016

jorisvandenbossche Nov 25, 2016

gfyoung Nov 25, 2016

jorisvandenbossche Nov 25, 2016

gfyoung Nov 25, 2016

gfyoung commented Nov 26, 2016

Standardize function signatures #14645

Standardize function signatures #14645

Conversation

gfyoung commented Nov 13, 2016 • edited Loading

codecov-io commented Nov 13, 2016 • edited Loading

Current coverage is 85.22% (diff: 97.67%)

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

gfyoung Nov 23, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gfyoung commented Nov 13, 2016

jreback commented Nov 15, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gfyoung Nov 25, 2016 • 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

gfyoung commented Nov 25, 2016

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

gfyoung commented Nov 26, 2016

gfyoung commented Nov 13, 2016 •

edited

Loading

codecov-io commented Nov 13, 2016 •

edited

Loading

gfyoung Nov 23, 2016 •

edited

Loading

gfyoung Nov 25, 2016 •

edited

Loading