Merge branch 'main' into options

Author: seisman

.github/workflows/cache_data.yaml

@@ -35,7 +35,7 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].0
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |

.github/workflows/ci_docs.yml

@@ -65,7 +65,7 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].0
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |
@@ -101,7 +101,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.28.0
+        uses: dawidd6/action-download-artifact@v3.0.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/ci_doctests.yaml

@@ -40,7 +40,7 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].0
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |
@@ -69,7 +69,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.28.0
+        uses: dawidd6/action-download-artifact@v3.0.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/ci_tests.yaml

@@ -94,7 +94,7 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].0
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |
@@ -123,7 +123,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.28.0
+        uses: dawidd6/action-download-artifact@v3.0.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/ci_tests_dev.yaml

@@ -88,7 +88,7 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].0
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |
@@ -169,7 +169,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.28.0
+        uses: dawidd6/action-download-artifact@v3.0.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/ci_tests_legacy.yaml

@@ -52,7 +52,7 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].0
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |
@@ -85,7 +85,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.28.0
+        uses: dawidd6/action-download-artifact@v3.0.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

pygmt/clib/session.py

@@ -381,7 +381,7 @@ def print_func(file_pointer, message):
             self._error_log.append(message)
             # flush to make sure the messages are printed even if we have a
             # crash.
-            print(message, file=sys.stderr, flush=True)
+            print(message, file=sys.stderr, flush=True)  # noqa: T201
             return 0
 
         # Need to store a copy of the function because ctypes doesn't and it

pygmt/helpers/decorators.py

@@ -281,7 +281,7 @@
         """,
     "projection": r"""
         projection : str
-            *projcode*\[*projparams*/]\ *width*\ |*scale*.
+            *projcode*\[*projparams*/]\ *width*\|\ *scale*.
             Select map :doc:`projection </projections/index>`.""",
     "region": r"""
         region : str or list
@@ -438,7 +438,7 @@ def fmt_docstring(module_func):
         *xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*].
         Specify the :doc:`region </tutorials/basics/regions>` of interest.
     projection : str
-        *projcode*\[*projparams*/]\ *width*\ |*scale*.
+        *projcode*\[*projparams*/]\ *width*\|\ *scale*.
         Select map :doc:`projection </projections/index>`.
     <BLANKLINE>
     **Aliases:**

pygmt/tests/test_clib_virtualfiles.py

@@ -80,7 +80,7 @@ def test_virtual_file_fails():
     with clib.Session() as lib, mock(lib, "GMT_Open_VirtualFile", returns=1):
         with pytest.raises(GMTCLibError):
             with lib.open_virtual_file(*vfargs):
-                print("Should not get to this code")
+                pass
 
     # Test the status check when closing the virtual file
     # Mock the opening to return 0 (success) so that we don't open a file that
@@ -91,7 +91,6 @@ def test_virtual_file_fails():
         with pytest.raises(GMTCLibError):
             with lib.open_virtual_file(*vfargs):
                 pass
-            print("Shouldn't get to this code either")
 
 
 def test_virtual_file_bad_direction():
@@ -107,7 +106,7 @@ def test_virtual_file_bad_direction():
         )
         with pytest.raises(GMTInvalidInput):
             with lib.open_virtual_file(*vfargs):
-                print("This should have failed")
+                pass
 
 
 @pytest.mark.parametrize(
@@ -280,7 +279,7 @@ def test_virtualfile_from_vectors_diff_size():
     with clib.Session() as lib:
         with pytest.raises(GMTInvalidInput):
             with lib.virtualfile_from_vectors(x, y):
-                print("This should have failed")
+                pass
 
 
 def test_virtualfile_from_matrix(dtypes):

pyproject.toml

@@ -117,9 +117,11 @@ select = [
     "PGH",  # pygrep-hooks
     "PIE",  # flake8-pie
     "PL",   # pylint
+    "RET",  # flake8-return
     "RSE",  # flake8-raise
     "S",    # flake8-bandit
     "SIM",  # flake8-simplify
+    "T20",  # flake8-print
     "TCH",  # flake8-type-checking
     "TID",  # flake8-tidy-imports
     "UP",   # pyupgrade
@@ -131,6 +133,7 @@ ignore = [
     "ISC001",   # Single-line-implicit-string-concatenation, conflict with formatter
     "PD901",    # Allow using the generic variable name `df` for DataFrames
     "PLR2004",  # Allow any magic values
+    "RET504",   # Allow variable assignment and return immediately for readability
     "S603",     # Allow method calls that initiate a subprocess without a shell
     "SIM117",   # Allow nested `with` statements
 ]
@@ -141,6 +144,7 @@ known-third-party = ["pygmt"]
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401"]  # Ignore `F401` (unused-import) in all `__init__.py` files
 "*/tests/test_*.py" = ["S101"]  # Ignore `S101` (use of assert) in all tests files
+"examples/**/*.py" = ["T201"]  # Allow `print` in examples
 
 [tool.ruff.lint.pycodestyle]
 max-doc-length = 79