Rename virtualfile_from_data to virtualfile_in

Author: seisman

doc/api/index.rst

@@ -288,11 +288,11 @@ conversion of Python variables to GMT virtual files:
 
 .. autosummary::
     :toctree: generated
-
-    clib.Session.virtualfile_from_data
+    
     clib.Session.virtualfile_from_matrix
     clib.Session.virtualfile_from_vectors
     clib.Session.virtualfile_from_grid
+    clib.Session.virtualfile_in
     clib.Session.virtualfile_out
 
 

pygmt/clib/session.py

@@ -1478,7 +1478,7 @@ def virtualfile_from_grid(self, grid):
             yield vfile
 
     @fmt_docstring
-    def virtualfile_from_data(  # noqa: PLR0912
+    def virtualfile_in(  # noqa: PLR0912
         self,
         check_kind=None,
         data=None,
@@ -1535,7 +1535,7 @@ def virtualfile_from_data(  # noqa: PLR0912
         ...     ),
         ... )
         >>> with Session() as ses:
-        ...     with ses.virtualfile_from_data(check_kind="vector", data=data) as fin:
+        ...     with ses.virtualfile_in(check_kind="vector", data=data) as fin:
         ...         # Send the output to a file so that we can read it
         ...         with GMTTempFile() as fout:
         ...             ses.call_module("info", fin + " ->" + fout.name)
@@ -1609,6 +1609,9 @@ def virtualfile_from_data(  # noqa: PLR0912
 
         return file_context
 
+    # virtualfile_from_data is the old name for virtualfile_in
+    virtualfile_from_data = virtualfile_in
+
     @contextlib.contextmanager
     def virtualfile_out(
         self, kind: Literal["dataset", "grid"] = "dataset", fname: str | None = None

pygmt/src/binstats.py

@@ -111,7 +111,7 @@ def binstats(data, **kwargs):
     """
     with GMTTempFile(suffix=".nc") as tmpfile:
         with Session() as lib:
-            file_context = lib.virtualfile_from_data(check_kind="vector", data=data)
+            file_context = lib.virtualfile_in(check_kind="vector", data=data)
             with file_context as infile:
                 if (outgrid := kwargs.get("G")) is None:
                     kwargs["G"] = outgrid = tmpfile.name  # output to tmpfile

pygmt/src/blockm.py

@@ -43,7 +43,7 @@ def _blockm(block_method, data, x, y, z, outfile, **kwargs):
     """
     with GMTTempFile(suffix=".csv") as tmpfile:
         with Session() as lib:
-            table_context = lib.virtualfile_from_data(
+            table_context = lib.virtualfile_in(
                 check_kind="vector", data=data, x=x, y=y, z=z, required_z=True
             )
             # Run blockm* on data table

pygmt/src/contour.py

@@ -115,7 +115,7 @@ def contour(self, data=None, x=None, y=None, z=None, **kwargs):
     kwargs = self._preprocess(**kwargs)
 
     with Session() as lib:
-        file_context = lib.virtualfile_from_data(
+        file_context = lib.virtualfile_in(
             check_kind="vector", data=data, x=x, y=y, z=z, required_z=True
         )
         with file_context as fname:

pygmt/src/dimfilter.py

@@ -151,7 +151,7 @@ def dimfilter(grid, **kwargs):
 
     with GMTTempFile(suffix=".nc") as tmpfile:
         with Session() as lib:
-            file_context = lib.virtualfile_from_data(check_kind="raster", data=grid)
+            file_context = lib.virtualfile_in(check_kind="raster", data=grid)
             with file_context as infile:
                 if (outgrid := kwargs.get("G")) is None:
                     kwargs["G"] = outgrid = tmpfile.name  # output to tmpfile

pygmt/src/filter1d.py

@@ -119,7 +119,7 @@ def filter1d(data, output_type="pandas", outfile=None, **kwargs):
 
     with GMTTempFile() as tmpfile:
         with Session() as lib:
-            file_context = lib.virtualfile_from_data(check_kind="vector", data=data)
+            file_context = lib.virtualfile_in(check_kind="vector", data=data)
             with file_context as infile:
                 if outfile is None:
                     outfile = tmpfile.name

pygmt/src/grd2cpt.py

@@ -184,7 +184,7 @@ def grd2cpt(grid, **kwargs):
     if kwargs.get("W") is not None and kwargs.get("Ww") is not None:
         raise GMTInvalidInput("Set only categorical or cyclic to True, not both.")
     with Session() as lib:
-        file_context = lib.virtualfile_from_data(check_kind="raster", data=grid)
+        file_context = lib.virtualfile_in(check_kind="raster", data=grid)
         with file_context as infile:
             if kwargs.get("H") is None:  # if no output is set
                 arg_str = build_arg_string(kwargs, infile=infile)

pygmt/src/grd2xyz.py

@@ -158,7 +158,7 @@ def grd2xyz(grid, output_type="pandas", outfile=None, **kwargs):
 
     with GMTTempFile() as tmpfile:
         with Session() as lib:
-            file_context = lib.virtualfile_from_data(check_kind="raster", data=grid)
+            file_context = lib.virtualfile_in(check_kind="raster", data=grid)
             with file_context as infile:
                 if outfile is None:
                     outfile = tmpfile.name

pygmt/src/grdclip.py

@@ -97,7 +97,7 @@ def grdclip(grid, **kwargs):
     """
     with GMTTempFile(suffix=".nc") as tmpfile:
         with Session() as lib:
-            file_context = lib.virtualfile_from_data(check_kind="raster", data=grid)
+            file_context = lib.virtualfile_in(check_kind="raster", data=grid)
             with file_context as infile:
                 if (outgrid := kwargs.get("G")) is None:
                     kwargs["G"] = outgrid = tmpfile.name  # output to tmpfile