Enable ruff's pep8-naming (N) rules (#2877)

Author: seisman

pygmt/exceptions.py

@@ -35,7 +35,7 @@ class GMTCLibNoSessionError(GMTCLibError):
     """
 
 
-class GMTInvalidInput(GMTError):
+class GMTInvalidInput(GMTError):  # noqa: N818
     """
     Raised when the input of a function/method is invalid.
     """
@@ -47,7 +47,7 @@ class GMTVersionError(GMTError):
     """
 
 
-class GMTImageComparisonFailure(AssertionError):
+class GMTImageComparisonFailure(AssertionError):  # noqa: N818
     """
     Raised when a comparison between two images fails.
     """

pygmt/helpers/testing.py

@@ -73,8 +73,8 @@ def check_figures_equal(*, extensions=("png",), tol=0.0, result_dir="result_imag
     ...
     >>> shutil.rmtree(path="tmp_result_images")  # cleanup folder if tests pass
     """
-    ALLOWED_CHARS = set(string.digits + string.ascii_letters + "_-[]()")
-    KEYWORD_ONLY = inspect.Parameter.KEYWORD_ONLY
+    allowed_chars = set(string.digits + string.ascii_letters + "_-[]()")
+    keyword_only = inspect.Parameter.KEYWORD_ONLY
 
     def decorator(func):
         import pytest
@@ -90,7 +90,7 @@ def wrapper(*args, ext="png", request=None, **kwargs):
             if "request" in old_sig.parameters:
                 kwargs["request"] = request
             try:
-                file_name = "".join(c for c in request.node.name if c in ALLOWED_CHARS)
+                file_name = "".join(c for c in request.node.name if c in allowed_chars)
             except AttributeError:  # 'NoneType' object has no attribute 'node'
                 file_name = func.__name__
             try:
@@ -129,9 +129,9 @@ def wrapper(*args, ext="png", request=None, **kwargs):
             if param.name not in {"fig_test", "fig_ref"}
         ]
         if "ext" not in old_sig.parameters:
-            parameters += [inspect.Parameter("ext", KEYWORD_ONLY)]
+            parameters += [inspect.Parameter("ext", keyword_only)]
         if "request" not in old_sig.parameters:
-            parameters += [inspect.Parameter("request", KEYWORD_ONLY)]
+            parameters += [inspect.Parameter("request", keyword_only)]
         new_sig = old_sig.replace(parameters=parameters)
         wrapper.__signature__ = new_sig
 

pygmt/src/config.py

@@ -6,7 +6,7 @@
 from pygmt.clib import Session
 
 
-class config:
+class config:  # noqa: N801
     """
     Set GMT defaults globally or locally.
 

pygmt/src/grdhisteq.py

@@ -19,7 +19,7 @@
 __doctest_skip__ = ["grdhisteq.*"]
 
 
-class grdhisteq:
+class grdhisteq:  # noqa: N801
     r"""
     Perform histogram equalization for a grid.
 

pygmt/src/triangulate.py

@@ -17,7 +17,7 @@
 from pygmt.io import load_dataarray
 
 
-class triangulate:
+class triangulate:  # noqa: N801
     """
     Delaunay triangulation or Voronoi partitioning and gridding of Cartesian
     data.

pyproject.toml

@@ -108,6 +108,7 @@ select = [
     "I",    # isort
     "ICN",  # flake8-import-conventions
     "ISC",  # flake8-implicit-str-concat
+    "N",    # pep8-naming
     "NPY",  # numpy
     "PD",   # pandas-vet
     "PGH",  # pygrep-hooks