pydata / pydata/xarray

xr.merge does not respect datatypes of inputs

Open
#7,560 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
4.2k
Forks
1.4k
Avg merge
2d 15h
Merged PRs (30d)
14

Description

What happened?

I have noticed a behaviour when using xr.merge to combine results where the datatype of the inputs are changed on the output to float.

This is undesirable at times, in particular when the results are to be used to index into an array.

What did you expect to happen?

Expected the datatypes to be preserved.

Minimal Complete Verifiable Example
subsets = []
for i in range(10):
    subsets.append(xr.DataArray([i,],dims=['idx'],coords={'idx':[i,]},name='da'))

display(subsets[0].dtype)

merged=xr.merge(subsets)

display(merged)
display(merged.da.dtype)
MVCE confirmation
  • Minimal example — the example is as focused as reasonably possible to demonstrate the underlying issue in xarray.
  • Complete example — the example is self-contained, including all data and the text of any traceback.
  • Verifiable example — the example copy & pastes into an IPython prompt or Binder notebook, returning the result.
  • New issue — a search of GitHub Issues suggests this is not a duplicate.
Relevant log output
dtype('int32')

<xarray.Dataset>
Dimensions:  (idx: 10)
Coordinates:
  * idx      (idx) int32 0 1 2 3 4 5 6 7 8 9
Data variables:
    da       (idx) float64 0.0 1.0 2.0 3.0 4.0 5.0 6.0 7.0 8.0 9.0

dtype('float64')
Anything else we need to know?

No response

Environment
INSTALLED VERSIONS ------------------ commit: None python: 3.10.9 | packaged by conda-forge | (main, Jan 11 2023, 15:15:40) [MSC v.1916 64 bit (AMD64)] python-bits: 64 OS: Windows OS-release: 10 machine: AMD64 processor: Intel64 Family 6 Model 154 Stepping 3, GenuineIntel byteorder: little LC_ALL: None LANG: None LOCALE: ('English_Australia', '1252') libhdf5: 1.12.1 libnetcdf: 4.8.1

xarray: 2023.1.0
pandas: 1.5.2
numpy: 1.23.5
scipy: 1.10.0
netCDF4: 1.6.2
pydap: None
h5netcdf: None
h5py: None
Nio: None
zarr: 2.13.6
cftime: 1.6.2
nc_time_axis: None
PseudoNetCDF: None
rasterio: None
cfgrib: None
iris: None
bottleneck: 1.3.5
dask: 2023.1.1
distributed: 2023.1.1
matplotlib: 3.6.2
cartopy: None
seaborn: 0.12.2
numbagg: None
fsspec: 2023.1.0
cupy: None
pint: None
sparse: None
flox: None
numpy_groupies: None
setuptools: 65.6.3
pip: 22.3.1
conda: None
pytest: None
mypy: None
IPython: 8.9.0
sphinx: None

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the minimal example with xarray's xr.merge entry point and inspect how the merged DataArray is constructed. Trace the merge path to find where the integer input is converted, then add a regression test based on the example; done means the merged data variable preserves the input integer dtype.

Written by the indexing model from the issue text.

Assessment

Tech stack
numpy, python
Domain
data
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.