pygmt.binstats: Validate the quantile_value parameter (#4332)

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Author: willschlitzer

pygmt/src/binstats.py

@@ -9,6 +9,7 @@
 from pygmt._typing import PathLike, TableLike
 from pygmt.alias import Alias, AliasSystem
 from pygmt.clib import Session
+from pygmt.exceptions import GMTTypeError, GMTValueError
 from pygmt.helpers import build_arg_list, fmt_docstring, use_alias
 
 
@@ -166,6 +167,16 @@ def binstats(
     )
     aliasdict.merge(kwargs)
     if statistic == "quantile":
+        if not isinstance(quantile_value, (int, float)):
+            raise GMTTypeError(
+                quantile_value, reason="quantile_value must be an 'int' or 'float'."
+            )
+        if not (0 <= quantile_value <= 100):
+            raise GMTValueError(
+                quantile_value,
+                description="quantile_value",
+                reason="Must be a value between 0 and 100.",
+            )
         aliasdict["C"] += f"{quantile_value}"
 
     with Session() as lib:

pygmt/tests/test_binstats.py

@@ -8,6 +8,7 @@
 import pytest
 from pygmt import binstats
 from pygmt.enums import GridRegistration, GridType
+from pygmt.exceptions import GMTTypeError, GMTValueError
 from pygmt.helpers import GMTTempFile
 
 
@@ -51,6 +52,24 @@ def test_binstats_no_outgrid():
     npt.assert_allclose(temp_grid.mean(), 4227489)
 
 
+def test_binstats_invalid_quantile_value():
+    """
+    Tests the input validation for quantile_value.
+    """
+    kwargs = {
+        "data": "@capitals.gmt",
+        "spacing": 5,
+        "statistic": "quantile",
+        "search_radius": "1000k",
+        "aspatial": "2=population",
+        "region": "g",
+    }
+    with pytest.raises(GMTValueError):
+        binstats(quantile_value=175, **kwargs)
+    with pytest.raises(GMTTypeError):
+        binstats(quantile_value="invalid", **kwargs)
+
+
 def test_binstats_quantile():
     """
     Test binstats quantile statistic functionality.