issues

What happened:

When trying to build the docs locally, the make html step fails with UdunitsError: UT_PARSE and OSError: [UT_PARSE] Failed to open UDUNITS-2 XML unit database. Searching online only results in a single (unanswered) mention on the gitter channel and a few results of errors on windows, but this is on Ubuntu 18.04

What you expected to happen: A succesful sphinx build of the xarray documentation

Minimal Complete Verifiable Example:

bash (xarray-docs) rijnsjvan@turbine:~/src/xarray/doc$ make html sphinx-build -b html -d _build/doctrees . _build/html Running Sphinx v3.1.2 python exec: /home/rijnsjvan/miniconda3/envs/xarray-docs/bin/python3.8 sys.path: ['/home/rijnsjvan/src/xarray', '/home/rijnsjvan/miniconda3/envs/xarray-docs/bin', '/home/rijnsjvan/miniconda3/envs/xarray-docs/lib/python38.zip', '/home/rijnsjvan/miniconda3/envs/xarray-docs/lib/python3.8', '/home/rijnsjvan/miniconda3/envs/xarray-docs/lib/python3.8/lib-dynload', '/home/rijnsjvan/miniconda3/envs/xarray-docs/lib/python3.8/site-packages', '/home/rijnsjvan/src/xarray']

```bash [autosummary] generating autosummary for: README.rst, api-hidden.rst, api.rst, combining.rst, computation.rst, contributing.rst, dask.rst, data-structures.rst, examples.rst, examples/ERA5-GRIB-example.ipynb, ..., plotting.rst, quick-overview.rst, related-projects.rst, reshaping.rst, roadmap.rst, terminology.rst, time-series.rst, weather-climate.rst, whats-new.rst, why-xarray.rst [autosummary] generating autosummary for: /home/rijnsjvan/src/xarray/doc/generated/xarray.CFTimeIndex.T.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.CFTimeIndex.all.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.CFTimeIndex.any.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.CFTimeIndex.append.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.CFTimeIndex.argsort.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.CFTimeIndex.array.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.CFTimeIndex.asi8.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.CFTimeIndex.asof.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.CFTimeIndex.asof_locs.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.CFTimeIndex.astype.rst, ..., /home/rijnsjvan/src/xarray/doc/generated/xarray.ufuncs.signbit.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.ufuncs.sin.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.ufuncs.sinh.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.ufuncs.sqrt.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.ufuncs.square.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.ufuncs.tan.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.ufuncs.tanh.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.ufuncs.trunc.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.where.rst, /home/rijnsjvan/src/xarray/doc/generated/xarray.zeros_like.rst loading intersphinx inventory from https://docs.python.org/3/objects.inv... loading intersphinx inventory from https://pandas.pydata.org/pandas-docs/stable/objects.inv... loading intersphinx inventory from https://scitools.org.uk/iris/docs/latest/objects.inv... loading intersphinx inventory from https://numpy.org/doc/stable/objects.inv... loading intersphinx inventory from https://docs.scipy.org/doc/scipy/reference/objects.inv... loading intersphinx inventory from https://numba.pydata.org/numba-doc/latest/objects.inv... loading intersphinx inventory from https://matplotlib.org/objects.inv... loading intersphinx inventory from https://docs.dask.org/en/latest/objects.inv... loading intersphinx inventory from https://unidata.github.io/cftime/objects.inv... building [mo]: targets for 0 po files that are out of date building [html]: targets for 37 source files that are out of date updating environment: [new config] 1156 added, 0 changed, 0 removed reading sources... [ 99%] io

---

Exception in /home/rijnsjvan/src/xarray/doc/io.rst at block ending on line 516 Specify :okexcept: as an option in the ipython:: block to suppress this message

UdunitsError Traceback (most recent call last) ~/miniconda3/envs/xarray-docs/lib/python3.8/site-packages/cf_units/init.py in <module> 187 try: --> 188 _ud_system = _ud.read_xml() 189 except _ud.UdunitsError:

cf_units/_udunits2.pyx in cf_units._udunits2.read_xml()

cf_units/_udunits2.pyx in cf_units._udunits2.wrap_system()

cf_units/_udunits2.pyx in cf_units._udunits2._raise_error()

UdunitsError: UT_PARSE

During handling of the above exception, another exception occurred:

UdunitsError Traceback (most recent call last) ~/miniconda3/envs/xarray-docs/lib/python3.8/site-packages/cf_units/init.py in <module> 194 try: --> 195 _ud_system = _ud.read_xml(_alt_xml_path.encode()) 196 except _ud.UdunitsError as e:

cf_units/_udunits2.pyx in cf_units._udunits2.read_xml()

cf_units/_udunits2.pyx in cf_units._udunits2.wrap_system()

cf_units/_udunits2.pyx in cf_units._udunits2._raise_error()

UdunitsError: UT_PARSE

During handling of the above exception, another exception occurred:

OSError Traceback (most recent call last) <ipython-input-12-cca90e1ed038> in <module> ----> 1 cube = da.to_iris()

~/src/xarray/xarray/core/dataarray.py in to_iris(self) 2570 from ..convert import to_iris 2571 -> 2572 return to_iris(self) 2573 2574 @classmethod

~/src/xarray/xarray/convert.py in to_iris(dataarray) 176 """ 177 # Iris not a hard dependency --> 178 import iris 179 from iris.fileformats.netcdf import parse_cell_methods 180

~/miniconda3/envs/xarray-docs/lib/python3.8/site-packages/iris/init.py in <module> 108 109 import iris.config --> 110 import iris.cube 111 import iris._constraints 112 from iris._deprecation import IrisDeprecation, warn_deprecated

~/miniconda3/envs/xarray-docs/lib/python3.8/site-packages/iris/cube.py in <module> 51 import numpy.ma as ma 52 ---> 53 from iris._cube_coord_common import CFVariableMixin 54 import iris._concatenate 55 import iris._constraints

~/miniconda3/envs/xarray-docs/lib/python3.8/site-packages/iris/_cube_coord_common.py in <module> 25 import string 26 ---> 27 import cf_units 28 29 import iris.std_names

~/miniconda3/envs/xarray-docs/lib/python3.8/site-packages/cf_units/init.py in <module> 196 except _ud.UdunitsError as e: 197 error_msg = ': "%s"' % e.error_msg() if e.errnum else '' --> 198 raise OSError( 199 '[%s] Failed to open UDUNITS-2 XML unit database%s' 200 % (e.status_msg(), error_msg))

OSError: [UT_PARSE] Failed to open UDUNITS-2 XML unit database <<<-------------------------------------------------------------------------

Exception occurred: File "/home/rijnsjvan/miniconda3/envs/xarray-docs/lib/python3.8/site-packages/IPython/sphinxext/ipython_directive.py", line 570, in process_input raise RuntimeError('Non Expected exception in {} line {}'.format(filename, lineno)) RuntimeError: Non Expected exception in /home/rijnsjvan/src/xarray/doc/io.rst line 516 The full traceback has been saved in /tmp/sphinx-err-8dbrbi71.log, if you want to report the issue to the developers. Please also report this if it was a user error, so that a better error message can be provided next time. A bug report can be filed in the tracker at https://github.com/sphinx-doc/sphinx/issues. Thanks! Makefile:57: recipe for target 'html' failed make: *** [html] Error 2

```

Anything else we need to know?:

Environment:

Fresh install of miniconda on Ubuntu 18.04.4 LTS (GNU/Linux 4.15.0-111-generic x86_64)

Discussed this in #3820, would have been possible a year ago... Better late than never 😅

• [x] Closes #5527
• [x] Tests added
• [x] Passes pre-commit run --all-files
• [x] User visible changes (including notable bug fixes) are documented in whats-new.rst

Since Python 3.7, key order is fixed by the language specification, making the original reason for deprecation obsolete. See the prior discussion in #3820.

Just a small typo

• [x] Closes #3606
• [x] User visible changes (including notable bug fixes) are documented in whats-new.rst

• [x] Closes #755
• [x] User visible changes (including notable bug fixes) are documented in whats-new.rst

Could not confirm in the web-based documentation (see #4257), but manually confirmed to work: ```python

import xarray as xr help(xr.DataArray.count) Help on function count in module xarray.core.common:

count(self, dim=None, axis=None, **kwargs) Reduce this DataArray's data by applying count along some dimension(s).

Parameters
----------
dim : str or sequence of str, optional
    Dimension(s) over which to apply `count`.
axis : int or sequence of int, optional
    Axis(es) over which to apply `count`. Only one of the 'dim'
    and 'axis' arguments can be supplied. If neither are supplied, then
    `count` is calculated over axes.
keep_attrs : bool, optional
    If True, the attributes (`attrs`) will be copied from the original
    object to the new one.  If False (default), the new object will be
    returned without attributes.
**kwargs : dict
    Additional keyword arguments passed on to the appropriate array
    function for calculating `count` on this object's data.

Returns
-------
reduced : DataArray
    New DataArray object with `count` applied to its data and the
    indicated dimension(s) removed.

```

The documentation states:

coords... ... Additionally, it is possible to define a coord whose name does not match the dimension name, or a coord based on multiple dimensions, with one of the following notations: - mapping {coord name: DataArray} - mapping {coord name: Variable} - mapping {coord name: (dimension name, array-like)} - mapping {coord name: (tuple of dimension names, array-like)}

dims (hashable or sequence of hashable, optional) – Name(s) of the data dimension(s). Must be either a hashable (only for 1D data) or a sequence of hashables with length equal to the number of dimensions. If this argument is omitted, dimension names are taken from coords (if possible) and otherwise default to ['dim_0', ... 'dim_n'].

Which seems to be no longer the case.

MCVE Code Sample

```python da = xr.DataArray(np.zeros((2, 2)), coords={'x': [1, 2], 'y': [1, 2]})

ValueError Traceback (most recent call last) <ipython-input-22-0d63eed9a72f> in <module> ----> 1 da = xr.DataArray(np.zeros((2, 2)), coords={'x': [1, 2], 'y': [1, 2]})

/scratch/local/lib/python3.8/site-packages/xarray/core/dataarray.py in init(self, data, coords, dims, name, attrs, encoding, indexes, fastpath) 366 data = _check_data_shape(data, coords, dims) 367 data = as_compatible_data(data) --> 368 coords, dims = _infer_coords_and_dims(data.shape, coords, dims) 369 variable = Variable(dims, data, attrs, encoding, fastpath=True) 370

/scratch/local/lib/python3.8/site-packages/xarray/core/dataarray.py in _infer_coords_and_dims(shape, coords, dims) 105 if utils.is_dict_like(coords): 106 # deprecated in GH993, removed in GH1539 --> 107 raise ValueError( 108 "inferring DataArray dimensions from " 109 "dictionary like coords is no longer "

ValueError: inferring DataArray dimensions from dictionary like coords is no longer supported. Use an explicit list of dims instead. ```

Expected Output

An update of the documentation to correctly specify the current behavior. (I'll propose a PR later today)

Problem Description

A mismatch between API specification and it's behavior seems like a problem to me :)

Output of xr.show_versions()

…ted in DataArray

• [x] Closes #3820