#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (c) 2017-2023 Satpy developers
#
# This file is part of satpy.
#
# satpy is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# satpy is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# satpy. If not, see <http://www.gnu.org/licenses/>.
"""Tests for compatible netCDF/Zarr DataArray encodings."""
import datetime
import pytest
import xarray as xr
[docs]
class TestUpdateEncoding:
"""Test update of dataset encodings."""
[docs]
@pytest.fixture()
def fake_ds(self):
"""Create fake data for testing."""
ds = xr.Dataset({"foo": (("y", "x"), [[1, 2], [3, 4]]),
"bar": (("y", "x"), [[3, 4], [5, 6]])},
coords={"y": [1, 2],
"x": [3, 4],
"lon": (("y", "x"), [[7, 8], [9, 10]])})
return ds
[docs]
@pytest.fixture()
def fake_ds_digit(self):
"""Create fake data for testing."""
ds_digit = xr.Dataset({"CHANNEL_1": (("y", "x"), [[1, 2], [3, 4]]),
"CHANNEL_2": (("y", "x"), [[3, 4], [5, 6]])},
coords={"y": [1, 2],
"x": [3, 4],
"lon": (("y", "x"), [[7, 8], [9, 10]])})
return ds_digit
[docs]
def test_dataset_name_digit(self, fake_ds_digit):
"""Test data with dataset name staring with a digit."""
from satpy.cf.encoding import update_encoding
# Dataset with name staring with digit
ds_digit = fake_ds_digit
kwargs = {"encoding": {"1": {"dtype": "float32"},
"2": {"dtype": "float32"}},
"other": "kwargs"}
enc, other_kwargs = update_encoding(ds_digit, kwargs, numeric_name_prefix="CHANNEL_")
expected_dict = {
"y": {"_FillValue": None},
"x": {"_FillValue": None},
"CHANNEL_1": {"dtype": "float32"},
"CHANNEL_2": {"dtype": "float32"}
}
assert enc == expected_dict
assert other_kwargs == {"other": "kwargs"}
[docs]
def test_without_time(self, fake_ds):
"""Test data with no time dimension."""
from satpy.cf.encoding import update_encoding
# Without time dimension
ds = fake_ds.chunk(2)
kwargs = {"encoding": {"bar": {"chunksizes": (1, 1)}},
"other": "kwargs"}
enc, other_kwargs = update_encoding(ds, kwargs)
expected_dict = {
"y": {"_FillValue": None},
"x": {"_FillValue": None},
"lon": {"chunksizes": (2, 2)},
"foo": {"chunksizes": (2, 2)},
"bar": {"chunksizes": (1, 1)}
}
assert enc == expected_dict
assert other_kwargs == {"other": "kwargs"}
# Chunksize may not exceed shape
ds = fake_ds.chunk(8)
kwargs = {"encoding": {}, "other": "kwargs"}
enc, other_kwargs = update_encoding(ds, kwargs)
expected_dict = {
"y": {"_FillValue": None},
"x": {"_FillValue": None},
"lon": {"chunksizes": (2, 2)},
"foo": {"chunksizes": (2, 2)},
"bar": {"chunksizes": (2, 2)}
}
assert enc == expected_dict
[docs]
def test_with_time(self, fake_ds):
"""Test data with a time dimension."""
from satpy.cf.encoding import update_encoding
# With time dimension
ds = fake_ds.chunk(8).expand_dims({"time": [datetime.datetime(2009, 7, 1, 12, 15)]})
kwargs = {"encoding": {"bar": {"chunksizes": (1, 1, 1)}},
"other": "kwargs"}
enc, other_kwargs = update_encoding(ds, kwargs)
expected_dict = {
"y": {"_FillValue": None},
"x": {"_FillValue": None},
"lon": {"chunksizes": (2, 2)},
"foo": {"chunksizes": (1, 2, 2)},
"bar": {"chunksizes": (1, 1, 1)},
"time": {"_FillValue": None,
"calendar": "proleptic_gregorian",
"units": "days since 2009-07-01 12:15:00"},
"time_bnds": {"_FillValue": None,
"calendar": "proleptic_gregorian",
"units": "days since 2009-07-01 12:15:00"}
}
assert enc == expected_dict
# User-defined encoding may not be altered
assert kwargs["encoding"] == {"bar": {"chunksizes": (1, 1, 1)}}