_encode_dataarray to _encode_time_dataarray

echopype/tests/utils/test_coding.py

@@ -5,7 +5,7 @@
 import dask
 import warnings
 
-from echopype.utils.coding import _get_auto_chunk, set_netcdf_encodings, _encode_dataarray, DEFAULT_TIME_ENCODING
+from echopype.utils.coding import _get_auto_chunk, set_netcdf_encodings, _encode_time_dataarray, DEFAULT_TIME_ENCODING
 
 @pytest.mark.parametrize(
     "chunk",
@@ -72,7 +72,7 @@ def test_set_netcdf_encodings():
     assert encoding["var3"]["zlib"] is False
 
 @pytest.mark.unit
-def test_encode_dataarray_on_nanosecond_resolution_encoding():
+def test_encode_time_dataarray_on_nanosecond_resolution_encoding():
     """Test to ensure that the expected warning / lack of warnings comes up."""
     # Create an array with a multiple datetime64 elements
     datetime_array = np.array(
@@ -89,15 +89,15 @@ def test_encode_dataarray_on_nanosecond_resolution_encoding():
     # between time differences in 2023 and 1970
     with warnings.catch_warnings():
         warnings.simplefilter("error")
-        decoded_datetime_array = _encode_dataarray(
+        decoded_datetime_array = _encode_time_dataarray(
             datetime_array,
         )
 
     # Check if datetime_array and decoded_datetime_array are equal
     assert np.array_equal(datetime_array, decoded_datetime_array), "Arrays are not equal"
 
 @pytest.mark.unit
-def test_encode_dataarray_on_encoded_time_data():
+def test_encode_time_dataarray_on_encoded_time_data():
     """Test to ensure that the array equality and expected error hold."""
     # Create an array with a multiple datetime64 elements
     datetime_array = np.array(
@@ -121,16 +121,16 @@ def test_encode_dataarray_on_encoded_time_data():
     # Check that no warning is raised
     with warnings.catch_warnings():
         warnings.simplefilter("error")
-        decoded_datetime_array = _encode_dataarray(
+        decoded_datetime_array = _encode_time_dataarray(
             encoded_datetime_array
         )
 
     # Check if datetime_array and decoded_datetime_array are equal
     assert np.array_equal(datetime_array, decoded_datetime_array), "Arrays are not equal"
 
     # Check to see if returns empty array
-    assert np.array_equal(np.empty(0), _encode_dataarray(np.empty(0)))
+    assert np.array_equal(np.empty(0), _encode_time_dataarray(np.empty(0)))
 
     # Check to see if value error is raised when we pass in an encoded float datetime array
     with pytest.raises(ValueError, match="Encoded time data array must be of type ```np.int64```."):
-        _encode_dataarray(encoded_datetime_array.astype(np.float64))
+        _encode_time_dataarray(encoded_datetime_array.astype(np.float64))

echopype/utils/coding.py

@@ -70,7 +70,7 @@ def sanitize_dtypes(ds: xr.Dataset) -> xr.Dataset:
     return ds
 
 
-def _encode_dataarray(da):
+def _encode_time_dataarray(da):
     """Encodes and decode datetime64 array similar to writing to file"""
     if da.size == 0:
         return da
@@ -132,7 +132,7 @@ def set_time_encodings(ds: xr.Dataset) -> xr.Dataset:
             # Examples: ping_time, ping_time_2, time1, time2
             if bool(search(r"_time|^time[\d]+$", var)):
                 new_ds[var] = xr.apply_ufunc(
-                    _encode_dataarray,
+                    _encode_time_dataarray,
                     da,
                     keep_attrs=True,
                 )