Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

warn if dim is passed to rolling operations. #3513

Merged
merged 3 commits into from
Nov 13, 2019
Merged

warn if dim is passed to rolling operations. #3513

merged 3 commits into from
Nov 13, 2019

Conversation

dcherian
Copy link
Contributor

dcherian
dcherian commented Nov 12, 2019
View reviewed changes
xarray/core/rolling.py
@@ -351,6 +352,14 @@ def _bottleneck_reduce(self, func, **kwargs):
def _numpy_or_bottleneck_reduce(
self, array_agg_func, bottleneck_move_func, **kwargs
):
if "dim" in kwargs:
warnings.warn(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this just be a UserWarning saying that the dim kwargs is ignored?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's definitely incorrect to pass (i.e. there's no legitimate potential use), I'd vote to raise an error in the future, rather than a warning. If someone makes a mistake, we should let them know quickly & loudly.

max-sixty
max-sixty approved these changes Nov 12, 2019
View reviewed changes
Copy link
Collaborator

@max-sixty max-sixty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dcherian !

doc/whats-new.rst Outdated Show resolved Hide resolved
xarray/core/rolling.py
@@ -351,6 +352,14 @@ def _bottleneck_reduce(self, func, **kwargs):
def _numpy_or_bottleneck_reduce(
self, array_agg_func, bottleneck_move_func, **kwargs
):
if "dim" in kwargs:
warnings.warn(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's definitely incorrect to pass (i.e. there's no legitimate potential use), I'd vote to raise an error in the future, rather than a warning. If someone makes a mistake, we should let them know quickly & loudly.

xarray/core/rolling.py Outdated Show resolved Hide resolved
dcherian and others added 2 commits November 12, 2019 19:01
@dcherian @max-sixty
Update doc/whats-new.rst
51ab976 
Co-Authored-By: Maximilian Roos <5635139+max-sixty@users.noreply.github.com>
@dcherian @max-sixty
Update xarray/core/rolling.py
855de10 
Co-Authored-By: Maximilian Roos <5635139+max-sixty@users.noreply.github.com>
@dcherian dcherian merged commit 7241aa1 into pydata:master Nov 13, 2019
@dcherian dcherian deleted the warn-rolling-dim branch November 13, 2019 15:53
dcherian added a commit to dcherian/xarray that referenced this pull request Nov 14, 2019
@dcherian
Merge remote-tracking branch 'upstream/master' into fix/user-coordinates
e1a3823 
* upstream/master:
  Allow appending datetime & boolean variables to zarr stores (pydata#3504)
  warn if dim is passed to rolling operations. (pydata#3513)
  Deprecate allow_lazy (pydata#3435)
  Recursive tokenization (pydata#3515)
  format indexing.rst code with black (pydata#3511)
dcherian added a commit to dcherian/xarray that referenced this pull request Nov 17, 2019
@dcherian
Merge remote-tracking branch 'upstream/master' into indexes/dataarray
747962d 
* upstream/master:
  Added fill_value for unstack (pydata#3541)
  Add DatasetGroupBy.quantile (pydata#3527)
  ensure rename does not change index type (pydata#3532)
  Leave empty slot when not using accessors
  interpolate_na: Add max_gap support. (pydata#3302)
  units & deprecation merge (pydata#3530)
  Fix set_index when an existing dimension becomes a level (pydata#3520)
  add Variable._replace (pydata#3528)
  Tests for module-level functions with units (pydata#3493)
  Harmonize `FillValue` and `missing_value` during encoding and decoding steps (pydata#3502)
  FUNDING.yml (pydata#3523)
  Allow appending datetime & boolean variables to zarr stores (pydata#3504)
  warn if dim is passed to rolling operations. (pydata#3513)
  Deprecate allow_lazy (pydata#3435)
  Recursive tokenization (pydata#3515)
dcherian added a commit to dcherian/xarray that referenced this pull request Nov 17, 2019
@dcherian
Merge remote-tracking branch 'upstream/master' into coarsen-reduce
aa39279 
* upstream/master: (22 commits)
  Added fill_value for unstack (pydata#3541)
  Add DatasetGroupBy.quantile (pydata#3527)
  ensure rename does not change index type (pydata#3532)
  Leave empty slot when not using accessors
  interpolate_na: Add max_gap support. (pydata#3302)
  units & deprecation merge (pydata#3530)
  Fix set_index when an existing dimension becomes a level (pydata#3520)
  add Variable._replace (pydata#3528)
  Tests for module-level functions with units (pydata#3493)
  Harmonize `FillValue` and `missing_value` during encoding and decoding steps (pydata#3502)
  FUNDING.yml (pydata#3523)
  Allow appending datetime & boolean variables to zarr stores (pydata#3504)
  warn if dim is passed to rolling operations. (pydata#3513)
  Deprecate allow_lazy (pydata#3435)
  Recursive tokenization (pydata#3515)
  format indexing.rst code with black (pydata#3511)
  add missing pint integration tests (pydata#3508)
  DOC: update bottleneck repo url (pydata#3507)
  add drop_sel, drop_vars, map to api.rst (pydata#3506)
  remove syntax warning (pydata#3505)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@max-sixty max-sixty max-sixty approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

reduce() got multiple values for keyword argument 'dim'
2 participants
@dcherian @max-sixty