Move Figure.shift_origin to a standalone Python file (#2485)

Co-authored-by: Yvonne Fröhlich <[email protected]>

Author: seisman

pygmt/figure.py

@@ -418,40 +418,6 @@ def show(self, dpi=300, width=500, method=None, waiting=0.5, **kwargs):
             )
             launch_external_viewer(pdf, waiting=waiting)
 
-    def shift_origin(self, xshift=None, yshift=None):
-        """
-        Shift plot origin in x and/or y directions.
-
-        This method shifts the plot origin relative to the current origin
-        by (*xshift*, *yshift*). Optionally, append the length unit (**c**,
-        **i**, or **p**). Default unit if not given is **c** for centimeter.
-
-        Prepend **a** to shift the origin back to the original position after
-        plotting, prepend **c** to center the plot on the center of the paper
-        (optionally add shift), prepend **f** to shift the origin relative to
-        the fixed lower left corner of the page, or prepend **r** [Default] to
-        move the origin relative to its current location.
-
-        Detailed usage at
-        :gmt-docs:`cookbook/options.html#plot-positioning-and-layout-the-x-y-options`
-
-        Parameters
-        ----------
-        xshift : str
-            Shift plot origin in x direction.
-        yshift : str
-            Shift plot origin in y direction.
-        """
-        self._preprocess()
-        args = ["-T"]
-        if xshift:
-            args.append(f"-X{xshift}")
-        if yshift:
-            args.append(f"-Y{yshift}")
-
-        with Session() as lib:
-            lib.call_module(module="plot", args=" ".join(args))
-
     def _preview(self, fmt, dpi, as_bytes=False, **kwargs):
         """
         Grab a preview of the figure.
@@ -519,6 +485,7 @@ def _repr_html_(self):
         plot3d,
         rose,
         set_panel,
+        shift_origin,
         solar,
         subplot,
         ternary,

pygmt/src/__init__.py

@@ -43,6 +43,7 @@
 from pygmt.src.project import project
 from pygmt.src.rose import rose
 from pygmt.src.select import select
+from pygmt.src.shift_origin import shift_origin
 from pygmt.src.solar import solar
 from pygmt.src.sph2grd import sph2grd
 from pygmt.src.sphdistance import sphdistance

pygmt/src/shift_origin.py

@@ -0,0 +1,40 @@
+"""
+shift_origin - Shift plot origin in x and/or y directions.
+"""
+
+from pygmt.clib import Session
+
+
+def shift_origin(self, xshift=None, yshift=None):
+    """
+    Shift plot origin in x and/or y directions.
+
+    This method shifts the plot origin relative to the current origin
+    by (*xshift*, *yshift*). Optionally, append the length unit (**c**,
+    **i**, or **p**). Default unit if not given is **c** for centimeters.
+
+    Prepend **a** to shift the origin back to the original position after
+    plotting, prepend **c** to center the plot on the center of the paper
+    (optionally add shift), prepend **f** to shift the origin relative to
+    the fixed lower left corner of the page, or prepend **r** [Default] to
+    move the origin relative to its current location.
+
+    Detailed usage at
+    :gmt-docs:`cookbook/options.html#plot-positioning-and-layout-the-x-y-options`
+
+    Parameters
+    ----------
+    xshift : str
+        Shift plot origin in x direction.
+    yshift : str
+        Shift plot origin in y direction.
+    """
+    self._preprocess()  # pylint: disable=protected-access
+    args = ["-T"]
+    if xshift:
+        args.append(f"-X{xshift}")
+    if yshift:
+        args.append(f"-Y{yshift}")
+
+    with Session() as lib:
+        lib.call_module(module="plot", args=" ".join(args))