Make check_encoding function private

Author: seisman

pygmt/helpers/__init__.py

@@ -15,11 +15,11 @@
     unique_name,
 )
 from pygmt.helpers.utils import (
+    _check_encoding,
     _validate_data_input,
     args_in_kwargs,
     build_arg_list,
     build_arg_string,
-    check_encoding,
     data_kind,
     is_nonstr_iter,
     launch_external_viewer,

pygmt/helpers/utils.py

@@ -192,7 +192,7 @@ def data_kind(
     return kind
 
 
-def check_encoding(
+def _check_encoding(
     argstr: str,
 ) -> Literal[
     "ascii",
@@ -233,15 +233,15 @@ def check_encoding(
 
     Examples
     --------
-    >>> check_encoding("123ABC+-?!")  # ASCII characters only
+    >>> _check_encoding("123ABC+-?!")  # ASCII characters only
     'ascii'
-    >>> check_encoding("12AB±β①②")  # Characters in ISOLatin1+
+    >>> _check_encoding("12AB±β①②")  # Characters in ISOLatin1+
     'ISOLatin1+'
-    >>> check_encoding("12ABāáâãäåβ①②")  # Characters in ISO-8859-4
+    >>> _check_encoding("12ABāáâãäåβ①②")  # Characters in ISO-8859-4
     'ISO-8859-4'
-    >>> check_encoding("12ABŒā")  # Mix characters in ISOLatin1+ (Œ) and ISO-8859-4 (ā)
+    >>> _check_encoding("12ABŒā")  # Mix characters in ISOLatin1+ (Œ) and ISO-8859-4 (ā)
     'ISOLatin1+'
-    >>> check_encoding("123AB中文")  # Characters not in any charset encoding
+    >>> _check_encoding("123AB中文")  # Characters not in any charset encoding
     'ISOLatin1+'
     """
     # Return "ascii" if the string only contains ASCII characters.
@@ -431,7 +431,7 @@ def build_arg_list(  # noqa: PLR0912
             gmt_args.append(f"-{key}{value}")
 
     # Convert non-ASCII characters (if any) in the arguments to octal codes
-    encoding = check_encoding("".join(gmt_args))
+    encoding = _check_encoding("".join(gmt_args))
     if encoding != "ascii":
         gmt_args = [non_ascii_to_octal(arg, encoding=encoding) for arg in gmt_args]
     gmt_args = sorted(gmt_args)

pygmt/src/text.py

@@ -6,8 +6,8 @@
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput
 from pygmt.helpers import (
+    _check_encoding,
     build_arg_list,
-    check_encoding,
     data_kind,
     fmt_docstring,
     is_nonstr_iter,
@@ -229,7 +229,7 @@ def text_(  # noqa: PLR0912
     confdict = {}
     if kind == "vectors":
         text = np.atleast_1d(text).astype(str)
-        encoding = check_encoding("".join(text))
+        encoding = _check_encoding("".join(text))
         if encoding != "ascii":
             text = np.vectorize(non_ascii_to_octal, excluded="encoding")(
                 text, encoding=encoding