dim -> coord in DataArray.integrate #3993

TomNicholas · 2020-04-21T20:30:35Z

Closes DataArray.integrate has a 'dim' arg, but Dataset.integrate has a 'coord' arg #3992
Tests added
Passes isort -rc . && black . && mypy . && flake8
Fully documented, including whats-new.rst for all changes and api.rst for new API

keewis

thanks, @TomNicholas, I totally forgot about this

keewis · 2020-04-21T20:41:37Z

xarray/core/dataarray.py

+        coord: Union[Hashable, Sequence[Hashable]],
+        dim: Union[Hashable, Sequence[Hashable]] = None,
+        datetime_unit: str = None,


dim should be a keyword-only parameter until it is removed. Otherwise, this would be possible:

da.integrate("x", "y", "ns")

so:

Suggested change

coord: Union[Hashable, Sequence[Hashable]],

dim: Union[Hashable, Sequence[Hashable]] = None,

datetime_unit: str = None,

coord: Union[Hashable, Sequence[Hashable]] = None,

datetime_unit: str = None,

*,

dim: Union[Hashable, Sequence[Hashable]] = None,

However, this means that you have to guard against specifying both (or none) of them

keewis · 2020-04-21T20:46:17Z

doc/whats-new.rst

@@ -27,6 +27,12 @@ Breaking changes
  (:pull:`3274`)
  By `Elliott Sales de Andrade <https://github.com/QuLogic>`_

+- New deprecations (behavior will be changed in xarray 0.17):
+  - ``dim`` argument to :py:meth:`DataArray.integrate` is being deprecated in


I think you need a newline before the nested list (this should be the reason why the docs CI fails)

* upstream/master: (342 commits) fix decode for scale/ offset list (pydata#4802) Expand user dir paths (~) in open_mfdataset and to_zarr. (pydata#4795) add a version info step to the upstream-dev CI (pydata#4815) fix the ci trigger action (pydata#4805) scatter plot by order of the first appearance of hue (pydata#4723) don't skip the scheduled CI (pydata#4806) coords: retain str dtype (pydata#4759) Fix interval labels with units (pydata#4794) Always force dask arrays to float in missing.interp_func (pydata#4771) Print number of variables in repr (pydata#4762) install conda as a library in the minimum dependency check CI (pydata#4792) Migrate CI from azure pipelines to GitHub Actions (pydata#4730) use conda.api instead of parallel calls to the conda binary (pydata#4775) Speed up missing._get_interpolator (pydata#4776) Remove special case in guess_engines (pydata#4777) improve typing of OrderedSet (pydata#4774) CI: ignore some warnings (pydata#4773) DOC: update hyperlink for xskillscore (pydata#4778) drop support for python 3.6 (pydata#4720) Trigger upstream CI on cron schedule (by default) (pydata#4729) ...

keewis

I would move the value set back to the numpydoc type spec, but otherwise this looks good to me.

xarray/core/dataarray.py

xarray/core/dataset.py

* upstream/master: Bugfix in list_engine (pydata#4811) Add drop_isel (pydata#4819) Fix RST. Remove the references to `_file_obj` outside low level code paths, change to `_close` (pydata#4809)

* master: WIP: backend interface, now it uses subclassing (pydata#4836) weighted: small improvements (pydata#4818) Update related-projects.rst (pydata#4844) iris update doc url (pydata#4845) Faster unstacking (pydata#4746) Allow swap_dims to take kwargs (pydata#4841) Move skip ci instructions to contributing guide (pydata#4829) fix issues in drop_sel and drop_isel (pydata#4828)

dcherian · 2021-01-29T22:59:21Z

Thanks for the review @keewis

* upstream/master: speed up the repr for big MultiIndex objects (pydata#4846) dim -> coord in DataArray.integrate (pydata#3993) WIP: backend interface, now it uses subclassing (pydata#4836) weighted: small improvements (pydata#4818) Update related-projects.rst (pydata#4844) iris update doc url (pydata#4845) Faster unstacking (pydata#4746) Allow swap_dims to take kwargs (pydata#4841) Move skip ci instructions to contributing guide (pydata#4829) fix issues in drop_sel and drop_isel (pydata#4828) Bugfix in list_engine (pydata#4811) Add drop_isel (pydata#4819) Fix RST. Remove the references to `_file_obj` outside low level code paths, change to `_close` (pydata#4809)

TomNicholas · 2021-01-31T22:36:44Z

Oh I completely forgot about this one! Thanks @keewis and @dcherian !

* master: (458 commits) Add units if "unit" is in the attrs. (pydata#4850) speed up the repr for big MultiIndex objects (pydata#4846) dim -> coord in DataArray.integrate (pydata#3993) WIP: backend interface, now it uses subclassing (pydata#4836) weighted: small improvements (pydata#4818) Update related-projects.rst (pydata#4844) iris update doc url (pydata#4845) Faster unstacking (pydata#4746) Allow swap_dims to take kwargs (pydata#4841) Move skip ci instructions to contributing guide (pydata#4829) fix issues in drop_sel and drop_isel (pydata#4828) Bugfix in list_engine (pydata#4811) Add drop_isel (pydata#4819) Fix RST. Remove the references to `_file_obj` outside low level code paths, change to `_close` (pydata#4809) fix decode for scale/ offset list (pydata#4802) Expand user dir paths (~) in open_mfdataset and to_zarr. (pydata#4795) add a version info step to the upstream-dev CI (pydata#4815) fix the ci trigger action (pydata#4805) scatter plot by order of the first appearance of hue (pydata#4723) ...

keewis

there are some issues with the documentation I think we missed. I'll open a new PR.

keewis · 2021-02-03T21:47:56Z

xarray/core/dataarray.py

+        datetime_unit: {'Y', 'M', 'W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns', \
+                        'ps', 'fs', 'as'}, optional


Suggested change

datetime_unit: {'Y', 'M', 'W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns', \

'ps', 'fs', 'as'}, optional

datetime_unit : {'Y', 'M', 'W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns', \

'ps', 'fs', 'as'}, optional

Specify the unit if a datetime coordinate is used.

keewis · 2021-02-03T21:48:18Z

xarray/core/dataarray.py

            must be one dimensional.

        Parameters
        ----------
+        coord: hashable, or a sequence of hashable


Suggested change

coord: hashable, or a sequence of hashable

coord : hashable, or a sequence of hashable

keewis · 2021-02-03T21:48:54Z

xarray/core/dataset.py

-        datetime_unit : {"Y", "M", "W", "D", "h", "m", "s", "ms", "us", "ns", \
-                         "ps", "fs", "as"}, optional
-            Can be specify the unit if datetime coordinate is used.
+        datetime_unit: {'Y', 'M', 'W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns', \


Suggested change

datetime_unit: {'Y', 'M', 'W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns', \

datetime_unit : {'Y', 'M', 'W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns', \

keewis · 2021-02-03T21:49:25Z

xarray/core/dataset.py


        .. note::
            This feature is limited to simple cartesian geometry, i.e. coord
            must be one dimensional.

        Parameters
        ----------
-        coord: str, or sequence of str
+        coord: hashable, or a sequence of hashable


Suggested change

coord: hashable, or a sequence of hashable

coord : hashable, or sequence of hashable

keewis · 2021-02-03T22:35:00Z

doc/whats-new.rst

+
+- ``dim`` argument to :py:meth:`DataArray.integrate` is being deprecated in
+  favour of a ``coord`` argument, for consistency with :py:meth:`Dataset.integrate`.
+  For now using ``dim`` issues a ``FutureWarning``. By `Tom Nicholas <https://github.com/TomNicholas>`_.


should we add the version in which we expect to remove dim here, too?

…_and_bounds_as_coords * upstream/master: (51 commits) Ensure maximum accuracy when encoding and decoding cftime.datetime values (pydata#4758) Fix `bounds_error=True` ignored with 1D interpolation (pydata#4855) add a drop_conflicts strategy for merging attrs (pydata#4827) update pre-commit hooks (mypy) (pydata#4883) ensure warnings cannot become errors in assert_ (pydata#4864) update pre-commit hooks (pydata#4874) small fixes for the docstrings of swap_dims and integrate (pydata#4867) Modify _encode_datetime_with_cftime for compatibility with cftime > 1.4.0 (pydata#4871) vélin (pydata#4872) don't skip the doctests CI (pydata#4869) fix da.pad example for numpy 1.20 (pydata#4865) temporarily pin dask (pydata#4873) Add units if "unit" is in the attrs. (pydata#4850) speed up the repr for big MultiIndex objects (pydata#4846) dim -> coord in DataArray.integrate (pydata#3993) WIP: backend interface, now it uses subclassing (pydata#4836) weighted: small improvements (pydata#4818) Update related-projects.rst (pydata#4844) iris update doc url (pydata#4845) Faster unstacking (pydata#4746) ...

* upstream/master: (24 commits) Compatibility with dask 2021.02.0 (pydata#4884) Ensure maximum accuracy when encoding and decoding cftime.datetime values (pydata#4758) Fix `bounds_error=True` ignored with 1D interpolation (pydata#4855) add a drop_conflicts strategy for merging attrs (pydata#4827) update pre-commit hooks (mypy) (pydata#4883) ensure warnings cannot become errors in assert_ (pydata#4864) update pre-commit hooks (pydata#4874) small fixes for the docstrings of swap_dims and integrate (pydata#4867) Modify _encode_datetime_with_cftime for compatibility with cftime > 1.4.0 (pydata#4871) vélin (pydata#4872) don't skip the doctests CI (pydata#4869) fix da.pad example for numpy 1.20 (pydata#4865) temporarily pin dask (pydata#4873) Add units if "unit" is in the attrs. (pydata#4850) speed up the repr for big MultiIndex objects (pydata#4846) dim -> coord in DataArray.integrate (pydata#3993) WIP: backend interface, now it uses subclassing (pydata#4836) weighted: small improvements (pydata#4818) Update related-projects.rst (pydata#4844) iris update doc url (pydata#4845) ...

TomNicholas added 4 commits April 21, 2020 21:27

changed arg and docstrings

504ef80

test warning is raised

0fcdfe6

updated kwarg in test

f0074bf

updated what's new

ecb7cb1

keewis reviewed Apr 21, 2020

View reviewed changes

dcherian mentioned this pull request May 5, 2020

0.16.0 release #4031

Closed

23 tasks

dcherian added 3 commits January 18, 2021 06:57

Fix error checking

75be024

Fix whats-new

4614d76

dcherian requested a review from keewis January 27, 2021 15:15

keewis approved these changes Jan 29, 2021

View reviewed changes

xarray/core/dataarray.py Outdated Show resolved Hide resolved

xarray/core/dataset.py Outdated Show resolved Hide resolved

dcherian added 4 commits January 29, 2021 09:42

Merge remote-tracking branch 'upstream/master' into integrate_dim_arg

54a5fce

* upstream/master: Bugfix in list_engine (pydata#4811) Add drop_isel (pydata#4819) Fix RST. Remove the references to `_file_obj` outside low level code paths, change to `_close` (pydata#4809)

fix docstring

5bbee25

small fix

92ac2dc

dcherian merged commit f4b95cd into pydata:master Jan 29, 2021

keewis reviewed Feb 5, 2021

View reviewed changes

keewis mentioned this pull request Feb 5, 2021

small fixes for the docstrings of swap_dims and integrate #4867

Merged

1 task

TomNicholas mentioned this pull request Jun 29, 2023

Polyfit uses dimension as x and not coordinate as stated in the documentation #7949

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dim -> coord in DataArray.integrate #3993

dim -> coord in DataArray.integrate #3993

TomNicholas commented Apr 21, 2020

keewis left a comment •

edited

Loading

keewis Apr 21, 2020

keewis Apr 21, 2020

keewis left a comment

dcherian commented Jan 29, 2021

TomNicholas commented Jan 31, 2021

keewis left a comment

keewis Feb 3, 2021

keewis Feb 3, 2021

keewis Feb 3, 2021

keewis Feb 3, 2021

keewis Feb 3, 2021

dcherian Feb 5, 2021

		datetime_unit: {'Y', 'M', 'W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns', \
		'ps', 'fs', 'as'}, optional

	coord: hashable, or a sequence of hashable
	coord : hashable, or a sequence of hashable

	datetime_unit: {'Y', 'M', 'W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns', \
	datetime_unit : {'Y', 'M', 'W', 'D', 'h', 'm', 's', 'ms', 'us', 'ns', \

	coord: hashable, or a sequence of hashable
	coord : hashable, or sequence of hashable

dim -> coord in DataArray.integrate #3993

dim -> coord in DataArray.integrate #3993

Conversation

TomNicholas commented Apr 21, 2020

keewis left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keewis left a comment

Choose a reason for hiding this comment

dcherian commented Jan 29, 2021

TomNicholas commented Jan 31, 2021

keewis left a 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

keewis left a comment •

edited

Loading