DEP: Deprecate incorrect behavior of expand_dims. #9132
Merged
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
eric-wieser
reviewed
May 17, 2017
numpy/lib/shape_base.py
Outdated
| axis = normalize_axis_index(axis, a.ndim + 1) | ||
| if axis > a.ndim or axis < -a.ndim - 1: | ||
| # 2017-05-17, 1.13.0 | ||
| warnings.warn("Both axis > a.ndim and axis < a.ndim - 1 are " |
There was a problem hiding this comment.
Missing minus in axis < a.ndim - 1
| if axis < 0: | ||
| axis = axis + a.ndim + 1 | ||
| # and uncomment the following line. | ||
| # axis = normalize_axis_index(axis, a.ndim + 1) |
There was a problem hiding this comment.
I'd be tempted to go with
try:
axis = normalize_axis_index(axis, a.ndim + 1)
except AxisError:
warnings.warn(...)
There was a problem hiding this comment.
I think the current code is an easier way to preserve the current behavior.
There was a problem hiding this comment.
It's a balance between being sure not to introduce a regression now vs when we remove this deprecation.
c507c1a to
a474013
Compare
eric-wieser
reviewed
May 18, 2017
| assert_(b.shape[axis] == 1) | ||
| assert_(np.squeeze(b).shape == s) | ||
|
|
||
| def test_deprecations(self): |
There was a problem hiding this comment.
This should have a 1.13 ... comment, right?
Expand_dims works as documented when the index of the inserted NewAxis in the resulting array satisfies -a.ndim - 1 <= index <= a.ndim. However, when index > a.ndim index is replaced by a.ndim and, when index < -a.ndim - 1, it is replaced by index + a.ndim + 1, which may be negative and results in incorrect placement. The latter two cases are now deprecated. Closes numpy#9100.
a474013 to
beac50c
Compare
eric-wieser
approved these changes
May 18, 2017
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.
Expand_dims works as documented when the index of the inserted NewAxis
in the resulting array satisfies
-a.ndim - 1 <= index <= a.ndim.However, when
index > a.ndim, index is replaced by a.ndim and, whenindex < -a.ndim - 1, index is replaced byindex + a.ndim + 1, which may benegative and results in incorrect placement. The latter two cases are
now deprecated.
Closes #9100.