change function name to match the convention

Author: mscheltienne

template/utils/_checks.py

@@ -174,8 +174,8 @@ def check_value(
 
 
 @fill_doc
-def check_verbose(verbose: Any) -> int:
-    """Check that the value of verbose is valid.
+def ensure_verbose(verbose: Any) -> int:
+    """Ensure that the value of verbose is valid.
 
     Parameters
     ----------

template/utils/logs.py

@@ -8,7 +8,7 @@
 from typing import TYPE_CHECKING
 from warnings import warn_explicit
 
-from ._checks import check_verbose
+from ._checks import ensure_verbose
 from ._docs import fill_doc
 from ._fixes import WrapStdOut
 
@@ -35,7 +35,7 @@ def _init_logger(*, verbose: bool | str | int | None = None) -> logging.Logger:
         The initialized logger.
     """
     # create logger
-    verbose = check_verbose(verbose)
+    verbose = ensure_verbose(verbose)
     logger = logging.getLogger(__package__.split(".utils", maxsplit=1)[0])
     logger.propagate = False
     logger.setLevel(verbose)
@@ -77,7 +77,7 @@ def add_file_handler(
     handler = logging.FileHandler(fname, mode, encoding)
     handler.setFormatter(_LoggerFormatter())
     if verbose is not None:
-        verbose = check_verbose(verbose)
+        verbose = ensure_verbose(verbose)
         handler.setLevel(verbose)
     logger.addHandler(handler)
 
@@ -90,7 +90,7 @@ def set_log_level(verbose: bool | str | int | None) -> None:
     ----------
     %(verbose)s
     """
-    verbose = check_verbose(verbose)
+    verbose = ensure_verbose(verbose)
     logger.setLevel(verbose)
 
 

template/utils/tests/test_checks.py

@@ -4,7 +4,7 @@
 import numpy as np
 import pytest
 
-from .._checks import check_type, check_value, check_verbose, ensure_int, ensure_path
+from .._checks import check_type, check_value, ensure_int, ensure_path, ensure_verbose
 
 
 def test_ensure_int():
@@ -63,23 +63,23 @@ def test_check_value():
         check_value(5, [1, 2, 3, 4], "number")
 
 
-def test_check_verbose():
-    """Test check_verbose checker."""
+def test_ensure_verbose():
+    """Test ensure_verbose checker."""
     # valids
-    assert check_verbose(12) == 12
-    assert check_verbose("INFO") == logging.INFO
-    assert check_verbose("DEBUG") == logging.DEBUG
-    assert check_verbose(True) == logging.INFO
-    assert check_verbose(False) == logging.WARNING
-    assert check_verbose(None) == logging.WARNING
+    assert ensure_verbose(12) == 12
+    assert ensure_verbose("INFO") == logging.INFO
+    assert ensure_verbose("DEBUG") == logging.DEBUG
+    assert ensure_verbose(True) == logging.INFO
+    assert ensure_verbose(False) == logging.WARNING
+    assert ensure_verbose(None) == logging.WARNING
 
     # invalids
     with pytest.raises(TypeError, match="must be an instance of"):
-        check_verbose(("INFO",))
+        ensure_verbose(("INFO",))
     with pytest.raises(ValueError, match="Invalid value"):
-        check_verbose("101")
+        ensure_verbose("101")
     with pytest.raises(ValueError, match="negative integer, -101 is invalid."):
-        check_verbose(-101)
+        ensure_verbose(-101)
 
 
 def test_ensure_path():