Source code for satpy.tests.reader_tests.test_hdf4_utils

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (c) 2017-2019 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/>.
"""Module for testing the satpy.readers.hdf4_utils module."""

import os
import unittest

import numpy as np
import xarray as xr

try:
    from satpy.readers.hdf4_utils import HDF4FileHandler
except ImportError:
    # fake the import so we can at least run the tests in this file
    HDF4FileHandler = object  # type: ignore


[docs] class FakeHDF4FileHandler(HDF4FileHandler): """Swap-in NetCDF4 File Handler for reader tests to use.""" def __init__(self, filename, filename_info, filetype_info, **kwargs): """Get fake file content from 'get_test_content'.""" if HDF4FileHandler is object: raise ImportError("Base 'HDF4FileHandler' could not be " "imported.") super(HDF4FileHandler, self).__init__(filename, filename_info, filetype_info) self.file_content = self.get_test_content(filename, filename_info, filetype_info) self.file_content.update(kwargs)
[docs] def get_test_content(self, filename, filename_info, filetype_info): """Mimic reader input file content. Args: filename (str): input filename filename_info (dict): Dict of metadata pulled from filename filetype_info (dict): Dict of metadata from the reader's yaml config for this file type Returns: dict of file content with keys like: - 'dataset' - '/attr/global_attr' - 'dataset/attr/global_attr' - 'dataset/shape' """ raise NotImplementedError("Fake File Handler subclass must implement 'get_test_content'")
[docs] class TestHDF4FileHandler(unittest.TestCase): """Test HDF4 File Handler Utility class."""
[docs] def setUp(self): """Create a test HDF4 file.""" from pyhdf.SD import SD, SDC h = SD("test.hdf", SDC.WRITE | SDC.CREATE | SDC.TRUNC) data = np.arange(10. * 100, dtype=np.float32).reshape((10, 100)) v1 = h.create("ds1_f", SDC.FLOAT32, (10, 100)) v1[:] = data v2 = h.create("ds1_i", SDC.INT16, (10, 100)) v2[:] = data.astype(np.int16) # Add attributes h.test_attr_str = "test_string" h.test_attr_int = 0 h.test_attr_float = 1.2 # h.test_attr_str_arr = np.array(b"test_string2") for d in [v1, v2]: d.test_attr_str = "test_string" d.test_attr_int = 0 d.test_attr_float = 1.2 h.end()
[docs] def tearDown(self): """Remove the previously created test file.""" os.remove("test.hdf")
[docs] def test_all_basic(self): """Test everything about the HDF4 class.""" from satpy.readers.hdf4_utils import HDF4FileHandler file_handler = HDF4FileHandler("test.hdf", {}, {}) for ds in ("ds1_f", "ds1_i"): assert file_handler[ds + "/dtype"] == (np.float32 if ds.endswith("f") else np.int16) assert file_handler[ds + "/shape"] == (10, 100) # make sure that the dtype is an instance, not the class assert file_handler[ds].dtype.itemsize == (4 if ds.endswith("f") else 2) attrs = file_handler[ds].attrs assert attrs.get("test_attr_str") == "test_string" assert attrs.get("test_attr_int") == 0 assert attrs.get("test_attr_float") == 1.2 assert isinstance(file_handler["/attr/test_attr_str"], str) assert file_handler["/attr/test_attr_str"] == "test_string" # self.assertEqual(file_handler['/attr/test_attr_str_arr'], 'test_string2') assert isinstance(file_handler["/attr/test_attr_int"], int) assert file_handler["/attr/test_attr_int"] == 0 assert isinstance(file_handler["/attr/test_attr_float"], float) assert file_handler["/attr/test_attr_float"] == 1.2 assert isinstance(file_handler.get("ds1_f"), xr.DataArray) assert file_handler.get("fake_ds") is None assert file_handler.get("fake_ds", "test") == "test" assert "ds1_f" in file_handler assert "fake_ds" not in file_handler