refactor: deprecate unused flopy.utils.binaryfile.binaryread_struct

autotest/test_binaryfile.py

@@ -578,3 +578,20 @@ def test_read_mf6_budgetfile(example_data_path):
     assert len(rch_zone_1) == 120 * 3 + 1
     assert len(rch_zone_2) == 120 * 3 + 1
     assert len(rch_zone_3) == 120 * 3 + 1
+
+
+def test_deprecated_binaryread_struct(example_data_path):
+    pth = example_data_path / "freyberg" / "freyberg.githds"
+    with open(pth, "rb") as fp:
+        with pytest.deprecated_call():
+            res = flopy.utils.binaryfile.binaryread_struct(fp, np.int32, 2)
+        np.testing.assert_array_equal(res, np.array([1, 1], np.int32))
+        with pytest.deprecated_call():
+            res = flopy.utils.binaryfile.binaryread_struct(fp, np.float32, 2)
+        np.testing.assert_array_equal(res, np.array([10, 10], np.float32))
+        with pytest.deprecated_call():
+            res = flopy.utils.binaryfile.binaryread_struct(fp, str)
+        assert res == b"            HEAD"
+        with pytest.deprecated_call():
+            res = flopy.utils.binaryfile.binaryread_struct(fp, np.int32)
+        assert res == 20

flopy/utils/binaryfile.py

@@ -274,10 +274,16 @@ def binaryread_struct(file, vartype, shape=(1,), charlen=16):
             cannot be returned, only multi-character strings.  Shape has no
             affect on strings.
 
+    .. deprecated:: 3.8.0
+       Use :meth:`binaryread` instead.
+
     """
     import struct
 
-    import numpy as np
+    warnings.warn(
+        "binaryread_struct() is deprecated; use binaryread() instead.",
+        DeprecationWarning,
+    )
 
     # store the mapping from type to struct format (fmt)
     typefmtd = {np.int32: "i", np.float32: "f", np.float64: "d"}
@@ -306,8 +312,22 @@ def binaryread_struct(file, vartype, shape=(1,), charlen=16):
 
 def binaryread(file, vartype, shape=(1,), charlen=16):
     """
-    Uses numpy to read from binary file.  This was found to be faster than the
-        struct approach and is used as the default.
+    Read text, a scalar value, or an array of values from a binary file.
+
+    Parameters
+    ----------
+    file : file object
+        is an open file object
+    vartype : type
+        is the return variable type: str, numpy.int32, numpy.float32,
+        or numpy.float64
+    shape : tuple
+        is the shape of the returned array (shape(1, ) returns a single
+        value) for example, shape = (nlay, nrow, ncol)
+    charlen : int
+        is the length of the text string.  Note that string arrays
+        cannot be returned, only multi-character strings.  Shape has no
+        affect on strings.
 
     """
 
@@ -318,9 +338,7 @@ def binaryread(file, vartype, shape=(1,), charlen=16):
         # find the number of values
         nval = np.prod(shape)
         result = np.fromfile(file, vartype, nval)
-        if nval == 1:
-            result = result  # [0]
-        else:
+        if nval != 1:
             result = np.reshape(result, shape)
     return result