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,13 @@ 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 :py:mod:`struct` or other methods to read binary data.
+
     """
     import struct
 
-    import numpy as np
+    warnings.warn("binaryread_struct() is deprecated", DeprecationWarning)
 
     # store the mapping from type to struct format (fmt)
     typefmtd = {np.int32: "i", np.float32: "f", np.float64: "d"}