Checks for left_index and right_index merge parameters #14434
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Current coverage is 85.25% (diff: 100%)@@ master #14434 diff @@
==========================================
Files 140 140
Lines 50631 50635 +4
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
+ Hits 43166 43171 +5
+ Misses 7465 7464 -1
Partials 0 0
|
sinhrks
reviewed
Oct 16, 2016
| @@ -471,6 +471,14 @@ def __init__(self, left, right, how='inner', on=None, | |||
| raise ValueError( | |||
| 'can not merge DataFrame with instance of ' | |||
| 'type {0}'.format(type(right))) | |||
| if not isinstance(left_index, bool): | |||
There was a problem hiding this comment.
pls use pandas.api.types.is_bool.
| @@ -471,6 +471,14 @@ def __init__(self, left, right, how='inner', on=None, | |||
| raise ValueError( | |||
| 'can not merge DataFrame with instance of ' | |||
| 'type {0}'.format(type(right))) | |||
| if not isinstance(left_index, bool): | |||
| raise ValueError( | |||
| 'left_index parameter must be of type bool, not ' | |||
There was a problem hiding this comment.
can u add tests to check expected error is raised?
jreback
reviewed
Oct 17, 2016
| @@ -4049,6 +4049,24 @@ def test_merge(self): | |||
| result = pd.merge(cleft, cright, how='left', left_on='b', right_on='c') | |||
| tm.assert_frame_equal(result, expected) | |||
|
|
|||
| # params left_index right_index checks | |||
| self.assertRaises(ValueError, | |||
There was a problem hiding this comment.
wrong file. should go in tools/tests/test_merge.py
|
Updated! |
|
Is there still any change to do? Thanks! |
jreback
reviewed
Oct 19, 2016
| @@ -109,6 +109,15 @@ def test_merge_misspecified(self): | |||
| self.assertRaises(ValueError, merge, self.df, self.df2, | |||
| left_on=['key1'], right_on=['key1', 'key2']) | |||
|
|
|||
| def test_index_and_on_parameters_confusion(self): | |||
| self.assertRaises(ValueError, merge, self.df, self.df2, how='left', | |||
There was a problem hiding this comment.
add the github issue reference as a comment
There was a problem hiding this comment.
Can you address this one?
|
pls add a whatsnew entry in 0.19.1. ping on green. |
…meters have correct types. Tests added.
|
Done! |
|
@jreback green |
|
|
||
| New features | ||
| ~~~~~~~~~~~~ | ||
| - Add checks to assure that left_index and right_index are of type bool |
There was a problem hiding this comment.
Can you move this to the bug fixes section? (I think that it is rather a bug that it accepted a wrong value, than a new feature that it now checks that)
| @@ -109,6 +109,15 @@ def test_merge_misspecified(self): | |||
| self.assertRaises(ValueError, merge, self.df, self.df2, | |||
| left_on=['key1'], right_on=['key1', 'key2']) | |||
|
|
|||
| def test_index_and_on_parameters_confusion(self): | |||
| self.assertRaises(ValueError, merge, self.df, self.df2, how='left', | |||
There was a problem hiding this comment.
Can you address this one?
|
@jorisvandenbossche was your 2nd one the comment reference in the tests? (decided not a big deal) |
|
yep, but indeed not a big deal |
tworec
pushed a commit
to RTBHOUSE/pandas
that referenced
this pull request
Oct 21, 2016
Author: Iván Vallés Pérez <[email protected]> Closes pandas-dev#14434 from ivallesp/add-check-for-merge-indices and squashes the following commits: e18b7c9 [Iván Vallés Pérez] Add some checks for assuring that the left_index and right_index parameters have correct types. Tests added.
jorisvandenbossche
pushed a commit
that referenced
this pull request
Nov 1, 2016
…rameters Author: Iván Vallés Pérez <[email protected]> Closes #14434 from ivallesp/add-check-for-merge-indices and squashes the following commits: e18b7c9 [Iván Vallés Pérez] Add some checks for assuring that the left_index and right_index parameters have correct types. Tests added. (cherry picked from commit 2d3a739)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
I just committed an error when I was doing an analysis using pandas and this motivated me to implement two checks which in my opinion are necessary.
I was trying to perform a merge and I confused the parameters "left_on" and "right_on" for "left_index" and "right_index". I ran the code and it did not raised me any error. It produced a table which seem to be fine in terms of shape. I suspect that what happened is that the tables got merged by the index of the data frame. I think it would be a great idea to check if right_index and left_index are of type bool, if not, raise an error. This way we will avoid that more people got the same error as mine :D.
Tests passed
Thanks!