Add more tests

Author: seisman

pygmt/params/frame.py

@@ -52,8 +52,7 @@ class Axis(BaseParam):
 
     #: Add a leading text prefix for axis annotation (e.g., dollar sign for plots
     #: related to money) (for Cartesian plots only). For geographic maps the addition
-    #: of degree symbols, etc. is automatic and controlled by
-    #: :gmt-term:`FORMAT_GEO_MAP`.
+    #: of degree symbols is automatic and controlled by :gmt-term:`FORMAT_GEO_MAP`.
     prefix: str | None = None
 
     #: Append a unit to the annotations (for Cartesian plots only). For geographic maps
@@ -79,6 +78,7 @@ def _aliases(self):
             Alias(self.hlabel, name="hlabel", prefix="+L"),
             Alias(self.alt_label, name="alt_label", prefix="+s"),
             Alias(self.alt_hlabel, name="alt_hlabel", prefix="+S"),
+            Alias(self.prefix, name="prefix", prefix="+p"),
             Alias(self.unit, name="unit", prefix="+u"),
         ]
 
@@ -113,7 +113,7 @@ def _aliases(self):
             Alias(self.yzfill, name="yzfill", prefix="+y"),
             Alias(self.xzfill, name="xzfill", prefix="+x"),
             Alias(self.xyfill, name="xyfill", prefix="+z"),
-            Alias(self.pole, name="pole", prefix="+o"),
+            Alias(self.pole, name="pole", prefix="+o", sep="/", size=2),
         ]
 
 

pygmt/tests/test_params_frame.py

@@ -9,54 +9,81 @@ def test_params_axis():
     """
     Test the Axis class.
     """
-    assert str(Axis(annotation=1, tick=0.5)) == "a1f0.5"
-    assert str(Axis(annotation=1, tick=0.5, angle=30)) == "a1f0.5+a30"
-    assert (
-        str(Axis(annotation=1, tick=0.5, angle=30, skip_edge="left")) == "a1f0.5+a30+el"
-    )
-    assert str(Axis(annotation=1, tick=0.5, fancy=True)) == "a1f0.5+f"
-    assert str(Axis(annotation=1, tick=0.5, label="My Label")) == "a1f0.5+lMy Label"
-    assert str(Axis(annotation=1, tick=0.5, hlabel="My HLabel")) == "a1f0.5+LMy HLabel"
-    assert (
-        str(Axis(annotation=1, tick=0.5, alt_label="Alt Label")) == "a1f0.5+sAlt Label"
-    )
-    assert (
-        str(Axis(annotation=1, tick=0.5, alt_hlabel="Alt HLabel"))
-        == "a1f0.5+SAlt HLabel"
+    assert str(Axis(annotation=True)) == "a"
+    assert str(Axis(annotation=True, tick=True, grid=True)) == "afg"
+    assert str(Axis(annotation=1, tick=0.5, grid=0.1)) == "a1f0.5g0.1"
+
+    assert str(Axis(annotation=1, angle=30)) == "a1+a30"
+    assert str(Axis(annotation=1, angle=30, skip_edge="left")) == "a1+a30+el"
+    assert str(Axis(annotation=1, fancy=True)) == "a1+f"
+    assert str(Axis(annotation=1, label="My Label")) == "a1+lMy Label"
+    assert str(Axis(annotation=1, hlabel="My HLabel")) == "a1+LMy HLabel"
+    assert str(Axis(annotation=1, alt_label="Alt Label")) == "a1+sAlt Label"
+    assert str(Axis(annotation=1, alt_hlabel="Alt HLabel")) == "a1+SAlt HLabel"
+    assert str(Axis(annotation=1, prefix="$")) == "a1+p$"
+    assert str(Axis(annotation=1, unit="km")) == "a1+ukm"
+
+    axis = Axis(
+        annotation=1,
+        tick=0.5,
+        grid=0.1,
+        angle=45,
+        skip_edge="right",
+        fancy=True,
+        label="Label",
+        hlabel="HLabel",
+        alt_label="AltLabel",
+        alt_hlabel="AltHLabel",
+        prefix="$",
+        unit="m",
     )
-    assert str(Axis(annotation=1, tick=0.5, unit="km")) == "a1f0.5+ukm"
+    assert str(axis) == "a1f0.5g0.1+a45+er+f+lLabel+LHLabel+sAltLabel+SAltHLabel+p$+um"
 
 
 def test_params_frame():
     """
     Test the Frame class.
     """
-    frame = Frame(axes="WSen")
-    assert str(frame) == "WSen"
-
-    frame = Frame(title="My Plot Title")
-    assert str(frame) == "+tMy Plot Title"
-
-    frame = Frame(subtitle="My Subtitle")
-    assert str(frame) == "+sMy Subtitle"
-
-    frame = Frame(fill="red")
-    assert str(frame) == "+gred"
-
-    frame = Frame(fill="lightblue", title="Plot Title", subtitle="My Subtitle")
-    assert str(frame) == "+glightblue+tPlot Title+sMy Subtitle"
+    # Test individual parameters of the Axes part.
+    assert str(Frame(axes="WSen")) == "WSen"
+    assert str(Frame(fill="red")) == "+gred"
+    assert str(Frame(title="My Plot Title")) == "+tMy Plot Title"
+    assert str(Frame(subtitle="My Subtitle")) == "+sMy Subtitle"
+    assert str(Frame(box=True)) == "+b"
+    assert str(Frame(pen="thick")) == "+wthick"
+    assert str(Frame(yzfill="blue")) == "+yblue"
+    assert str(Frame(xzfill="green")) == "+xgreen"
+    assert str(Frame(xyfill="yellow")) == "+zyellow"
+    assert str(Frame(pole=[30, -90])) == "+o30/-90"
 
+    # Test all parameters of the Axes part.
     frame = Frame(
-        axes="WSen", fill="lightblue", title="Plot Title", subtitle="My Subtitle"
+        axes="lrtb",
+        fill="lightblue",
+        title="Plot Title",
+        subtitle="My Subtitle",
+        box=True,
+        pen="1p,blue",
+        yzfill="pink",
+        xzfill="orange",
+        xyfill="purple",
+        pole=["45N", "100W"],
     )
-    assert str(frame) == "WSen+glightblue+tPlot Title+sMy Subtitle"
-
-    frame = Frame(
-        x=Axis(annotation=1, tick=0.5), y=Axis(label="Y Axis"), title="Plot Title"
+    assert str(frame) == (
+        "lrtb+glightblue+tPlot Title+sMy Subtitle+b+w1p,blue+ypink+xorange+zpurple+o45N/100W"
     )
-    assert list(frame) == ["xa1f0.5", "y+lY Axis", "+tPlot Title"]
 
+    # Test Frame with Axis parameters.
+    frame = Frame(axis=Axis(annotation=True, tick=True))
+    assert str(frame) == "af"
+    frame = Frame(axis=Axis(annotation=1, tick=0.5, label="Y Axis"), title="Plot Title")
+    assert str(frame) == "a1f0.5+lY Axis+tPlot Title"
+
+    # Test Frame with separate Axis for x and y axes.
     frame = Frame(
-        axis=Axis(annotation=1, tick=0.5, label="Label", angle=30), title="Plot Title"
+        x=Axis(annotation=1, tick=0.5, label="X Axis"),
+        y=Axis(annotation=True, tick=True, label="Y Axis"),
+        axes="WSen",
+        title="Plot Title",
     )
-    assert list(frame) == ["a1f0.5+a30+lLabel", "+tPlot Title"]
+    assert list(frame) == ["xa1f0.5+lX Axis", "yaf+lY Axis", "WSen+tPlot Title"]