Updates

Author: seisman

Makefile

@@ -60,7 +60,7 @@ test_no_images: PYTEST_ARGS=-o addopts="--verbose --durations=0 --durations-min=
 test_no_images: _runtest
 
 format:
-	ruff check --fix $(FORMAT_FILES)
+	ruff check --fix --exit-zero $(FORMAT_FILES)
 	ruff format $(FORMAT_FILES)
 
 check:

pygmt/alias.py

@@ -1,3 +1,6 @@
+"""
+Alias system to convert PyGMT parameters to GMT options.
+"""
 import inspect
 from collections import defaultdict
 from typing import NamedTuple
@@ -6,13 +9,40 @@
 
 
 class Alias(NamedTuple):
+    """
+    Alias system for mapping a PyGMT parameter to its equivalent GMT option string.
+
+    Attributes
+    ----------
+    name : str
+        PyGMT parameter name.
+    flag : str
+        GMT single-letter option flag.
+    modifier : str
+        GMT option modifier. Can be None.
+    separator : str
+        Separator to join the iterable argument into a string.
+    """
+
     name: str
     flag: str
     modifier: str
     separator: str
 
 
 def sequence_to_str(seq, separator):
+    """
+    Join a sequence (list, tuple) into a string with the specified separator.
+
+    Examples
+    --------
+    >>> sequence_to_str((1, 2, 3), "/")
+    '1/2/3'
+    >>> sequence_to_str((1, 2, 3), ",")
+    '1,2,3'
+    >>> sequence_to_str((1, 2, 3), " ")
+    '1 2 3'
+    """
     return separator.join(str(item) for item in seq)
 
 
@@ -21,13 +51,39 @@ def convert_aliases():
     Convert PyGMT parameters to GMT options.
 
     The caller function must have the special variable ``_aliases`` defined.
+
+    Examples
+    --------
+    >>> def module_func(**kwargs):
+    ...     _aliases = [
+    ...         Alias("par1", "A", "", ""),
+    ...         Alias("par2", "B", "", "/"),
+    ...         Alias("par3", "C", "", ","),
+    ...         Alias("pard1", "D", "", ""),
+    ...         Alias("pard2", "D", "+a", ""),
+    ...         Alias("pard3", "D", "+b", ","),
+    ...         Alias("pard4", "D", "+c", "/"),
+    ...     ]
+    ...     options = convert_aliases()
+    ...     print(options)
+    >>>
+    >>> module_func(
+    ...     par1="value1",
+    ...     par2=[1, 2, 3, 4],
+    ...     par3=[0, 1],
+    ...     pard1="value2",
+    ...     pard2="value3",
+    ...     pard3=[1, 2, 3, 4],
+    ...     pard4=[1, 2, 3, 4],
+    ... )
+    {'A': 'value1', 'B': '1/2/3/4', 'C': '0,1', 'D': 'value2+avalue3+b1,2,3,4+c1/2/3/4'}
     """
     # Get the local namespace of the caller function
     p_locals = inspect.currentframe().f_back.f_locals
     params = p_locals.pop("kwargs", {}) | p_locals
 
     # Define a dict to store GMT option flags and arguments
-    options = defaultdict(lambda: "")
+    kwdict = defaultdict(lambda: "")  # use defaultdict to avoid KeyError
     for alias in p_locals.get("_aliases"):
         value = params.get(alias.name)
         if is_nonstr_iter(value):
@@ -39,5 +95,5 @@ def convert_aliases():
             continue
         elif value is True:  # Convert True to an empty string
             value = ""
-        options[alias.flag] += f"{alias.modifier}{value}"
-    return dict(options)
+        kwdict[alias.flag] += f"{alias.modifier}{value}"
+    return dict(kwdict)

pygmt/clib/session.py

@@ -371,7 +371,7 @@ def create(self, name):
         self._error_log = []
 
         @ctp.CFUNCTYPE(ctp.c_int, ctp.c_void_p, ctp.c_char_p)
-        def print_func(file_pointer, message):  # noqa: ARG001
+        def print_func(file_pointer, message):
             """
             Callback function that the GMT C API will use to print log and error
             messages.

pygmt/sphinx_gallery.py

@@ -19,7 +19,7 @@ class PyGMTScraper:
     ``conf.py`` as the ``"image_scrapers"`` argument.
     """
 
-    def __call__(self, block, block_vars, gallery_conf):  # noqa: ARG002
+    def __call__(self, block, block_vars, gallery_conf):
         """
         Called by sphinx-gallery to save the figures generated after running code.
         """

pygmt/tests/test_clib.py

@@ -38,7 +38,7 @@ def mock(session, func, returns=None, mock_func=None):
     """
     if mock_func is None:
 
-        def mock_api_function(*args):  # noqa: ARG001
+        def mock_api_function(*args):
             """
             A mock GMT API function that always returns a given value.
             """
@@ -525,7 +525,7 @@ def test_info_dict():
         assert lib.info
 
     # Mock GMT_Get_Default to return always the same string
-    def mock_defaults(api, name, value):  # noqa: ARG001
+    def mock_defaults(api, name, value):
         """
         Put 'bla' in the value buffer.
         """
@@ -554,7 +554,7 @@ def test_fails_for_wrong_version():
     """
 
     # Mock GMT_Get_Default to return an old version
-    def mock_defaults(api, name, value):  # noqa: ARG001
+    def mock_defaults(api, name, value):
         """
         Return an old version.
         """

pygmt/tests/test_clib_loading.py

@@ -85,7 +85,7 @@ def test_load_libgmt_fails(monkeypatch):
         mpatch.setattr(
             subprocess,
             "check_output",
-            lambda cmd, encoding: "libfakegmt.so",  # noqa: ARG005
+            lambda cmd, encoding: "libfakegmt.so",
         )
         with pytest.raises(GMTCLibNotFoundError):
             check_libgmt(load_libgmt())
@@ -220,7 +220,7 @@ class TestLibgmtCount:
     loaded_libgmt = load_libgmt()  # Load the GMT library and reuse it when necessary
     counter = 0  # Global counter for how many times ctypes.CDLL is called
 
-    def _mock_ctypes_cdll_return(self, libname):  # noqa: ARG002
+    def _mock_ctypes_cdll_return(self, libname):
         """
         Mock ctypes.CDLL to count how many times the function is called.
 

pygmt/tests/test_figure.py

@@ -224,7 +224,7 @@ def test_figure_savefig():
     """
     kwargs_saved = []
 
-    def mock_psconvert(*args, **kwargs):  # noqa: ARG001
+    def mock_psconvert(*args, **kwargs):
         """
         Just record the arguments.
         """