Updates

Author: seisman

pygmt/alias.py

@@ -30,22 +30,6 @@ class Alias(NamedTuple):
     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)
-
-
 def convert_aliases():
     """
     Convert PyGMT parameters to GMT options.
@@ -83,12 +67,12 @@ def convert_aliases():
     params = p_locals.pop("kwargs", {}) | p_locals
 
     # Define a dict to store GMT option flags and arguments
-    kwdict = defaultdict(lambda: "")  # use defaultdict to avoid KeyError
+    kwdict = defaultdict(lambda: "")  # default value is an empty string
     for alias in p_locals.get("_aliases"):
         value = params.get(alias.name)
         if is_nonstr_iter(value):
             if alias.separator != "":
-                value = sequence_to_str(value, alias.separator)
+                value = alias.separator.join(str(item) for item in value)
             else:
                 value = ""
         elif value in (None, False):  # None or False are skipped

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):
+        def print_func(file_pointer, message):  # noqa: ARG001
             """
             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):
+    def __call__(self, block, block_vars, gallery_conf):  # noqa: ARG002
         """
         Called by sphinx-gallery to save the figures generated after running code.
         """

pygmt/src/info.py

@@ -17,12 +17,12 @@ def info(
     per_column=None,
     spacing=None,
     nearest_multiple=None,
-    verbose=None,
-    aspatial=None,
-    coltypes=None,
-    incols=None,
-    registration=None,
-    **kwargs,
+    verbose=None,  # noqa: ARG001
+    aspatial=None,  # noqa: ARG001
+    coltypes=None,  # noqa: ARG001
+    incols=None,  # noqa: ARG001
+    registration=None,  # noqa: ARG001
+    **kwargs,  # noqa: ARG001
 ):
     r"""
     Get information about data tables.

pygmt/src/legend.py

@@ -13,7 +13,7 @@
 
 
 @fmt_docstring
-def legend(self, spec=None, position="JTR+jTR+o0.2c", box="+gwhite+p1p", **kwargs):
+def legend(self, spec=None, position="JTR+jTR+o0.2c", box="+gwhite+p1p", **kwargs):  # noqa: ARG001
     r"""
     Plot legends on maps.
 

pygmt/src/text.py

@@ -17,7 +17,7 @@
 
 @fmt_docstring
 @kwargs_to_strings(textfiles="sequence_space")
-def text_(
+def text_(  # noqa: PLR0913
     self,
     textfiles=None,
     x=None,
@@ -27,8 +27,8 @@ def text_(
     angle=None,
     font=None,
     justify=None,
-    projection=None,
-    region=None,
+    projection=None,  # noqa: ARG001
+    region=None,  # noqa: ARG001
     transparency=None,
     **kwargs,
 ):
@@ -213,7 +213,7 @@ def text_(
     # font or justify is str type
     for arg in (font, justify):
         if is_nonstr_iter(arg):
-            extra_arrays.append(np.atleast_1d(arg).astype(str))
+            extra_arrays.append(np.atleast_1d(arg).astype(str))  # noqa: PERF401
     # If an array of transparency is given, GMT will read it from
     # the last numerical column per data record.
     if is_nonstr_iter(transparency):

pygmt/src/timestamp.py

@@ -21,8 +21,8 @@
 def timestamp(
     self,
     text: str | None = None,
-    label: str | None = None,
-    justification: str = "BL",
+    label: str | None = None,  # noqa: ARG001
+    justification: str = "BL",  # noqa: ARG001
     offset: float | str | Sequence[float | str] = ("-54p", "-54p"),
     font: str = "Helvetica,black",
     timefmt: str = "%Y %b %d %H:%M:%S",

pygmt/src/xyz2grd.py

@@ -15,27 +15,27 @@
 
 
 @fmt_docstring
-def xyz2grd(
+def xyz2grd(  # noqa: PLR0913
     data=None,
     x=None,
     y=None,
     z=None,
     outgrid=None,
     spacing=None,
-    duplicate=None,
-    projection=None,
+    duplicate=None,  # noqa: ARG001
+    projection=None,  # noqa: ARG001
     region=None,
-    verbose=None,
-    convention=None,
-    binary=None,
-    nodata=None,
-    find=None,
-    coltypes=None,
-    header=None,
-    incols=None,
-    registration=None,
-    wrap=None,
-    **kwargs,
+    verbose=None,  # noqa: ARG001
+    convention=None,  # noqa: ARG001
+    binary=None,  # noqa: ARG001
+    nodata=None,  # noqa: ARG001
+    find=None,  # noqa: ARG001
+    coltypes=None,  # noqa: ARG001
+    header=None,  # noqa: ARG001
+    incols=None,  # noqa: ARG001
+    registration=None,  # noqa: ARG001
+    wrap=None,  # noqa: ARG001
+    **kwargs,  # noqa: ARG001
 ):
     r"""
     Create a grid file from table data.

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):
+        def mock_api_function(*args):  # noqa: ARG001
             """
             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):
+    def mock_defaults(api, name, value):  # noqa: ARG001
         """
         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):
+    def mock_defaults(api, name, value):  # noqa: ARG001
         """
         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",
+            lambda cmd, encoding: "libfakegmt.so",  # noqa: ARG005
         )
         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):
+    def _mock_ctypes_cdll_return(self, libname):  # noqa: ARG002
         """
         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):
+    def mock_psconvert(*args, **kwargs):  # noqa: ARG001
         """
         Just record the arguments.
         """

pyproject.toml

@@ -87,7 +87,7 @@ docstring-code-line-length = "dynamic"
 [tool.ruff.lint]
 select = [
     "A",    # flake8-builtins
-    #"ARG",  # flake8-unused-arguments
+    "ARG",  # flake8-unused-arguments
     "B",    # flake8-bugbear
     "BLE",  # flake8-blind-except
     "C4",   # flake8-comprehensions