ENH: Add font* aesthestics to geom_text

closes #790

Author: has2k1

doc/changelog.qmd

@@ -1,6 +1,21 @@
 ---
 title: Changelog
 ---
+## v0.14.0
+
+(not-yet-released)
+
+### Enhancements
+
+- The `family`, `fontstyle` and `fontweight` parameters of
+  [](:class:`~plotnine.geom_text`) are now aesthetics ({{< issue 790 >}}).
+
+### New Features
+
+- [](:class:`~plotnine.geom_text`) has gained new aesthetics
+  `fontvariant` and `fontstretch`.
+
+
 ## v0.13.6
 (2024-05-09)
 

plotnine/geoms/geom_text.py

@@ -42,12 +42,6 @@ class geom_text(geom):
     parse : bool, default=False
         If `True`{.py}, the labels will be rendered with
         [latex](http://matplotlib.org/users/usetex.html).
-    family : str, default=None
-        Font family.
-    fontweight : int | str, default="normal"
-        Font weight.
-    fontstyle : Literal["normal", "italic", "oblique"], default="normal"
-        Font style.
     nudge_x : float, default=0
         Horizontal adjustment to apply to the text
     nudge_y : float, default=0
@@ -87,13 +81,64 @@ class geom_text(geom):
 
     **Aesthetics Descriptions**
 
+    `size`
+
+    :   Float or one of:
+
+        ```python
+        {
+            "xx-small", "x-small", "small", "medium", "large",
+            "x-large", "xx-large"
+        }
+        ```
+
     `ha`
 
-    :   Horizontal alignment. One of *left*, *center* or *right.*
+    :   Horizontal alignment. One of `{"left", "center", "right"}`{.py}.
 
     `va`
 
-    :   Vertical alignment. One of *top*, *center*, *bottom*, *baseline*.
+    :   Vertical alignment. One of
+        `{"top", "center", "bottom", "baseline", "center_baseline"}`{.py}.
+
+    `family`
+
+    :   Font family. Can be a font name
+        e.g. "Arial", "Helvetica", "Times", ... or a family that is one of
+        `{"serif", "sans-serif", "cursive", "fantasy", "monospace"}}`{.py}
+
+    `fontweight`
+
+    :   Font weight. A numeric value in range 0-1000 or a string that is
+        one of:
+
+        ```python
+        {
+            "ultralight", "light", "normal", "regular", "book", "medium",
+            "roman", "semibold", "demibold", "demi", "bold", "heavy",
+            "extra bold", "black"
+        }
+        ```
+
+    `fontstyle`
+
+    :   Font style. One of `{"normal", "italic", "oblique"}`{.py}.
+
+    `fontvariant`
+
+    :   Font variant. One of `{"normal", "small-caps"}`{.py}.
+
+    `fontstretch`
+
+    :   Font Stretch. A numeric value in range 0-1000, or one of:
+
+        ```python
+        {
+            "ultra-condensed", "extra-condensed", "condensed",
+            "semi-condensed", "normal", "semi-expanded", "expanded",
+            "extra-expanded", "ultra-expanded"
+        }
+        ```
     """
     DEFAULT_AES = {
         "alpha": 1,
@@ -103,16 +148,18 @@ class geom_text(geom):
         "lineheight": 1.2,
         "ha": "center",
         "va": "center",
+        "family": None,
+        "fontweight": "normal",
+        "fontstyle": "normal",
+        "fontvariant": None,
+        "fontstretch": None,
     }
     REQUIRED_AES = {"label", "x", "y"}
     DEFAULT_PARAMS = {
         "stat": "identity",
         "position": "identity",
         "na_rm": False,
         "parse": False,
-        "family": None,
-        "fontweight": "normal",
-        "fontstyle": "normal",
         "nudge_x": 0,
         "nudge_y": 0,
         "adjust_text": None,
@@ -198,14 +245,18 @@ def draw_group(
 
         # Create a dataframe for the plotting data required
         # by ax.text
-        plot_data = data[["x", "y", "size", "ha", "va"]].copy()
-        plot_data["s"] = data["label"]
-        plot_data["rotation"] = data["angle"]
-        plot_data["linespacing"] = data["lineheight"]
+        ae_names = list(set(geom_text.DEFAULT_AES) | geom_text.REQUIRED_AES)
+        plot_data = data[ae_names]
+        plot_data.rename(
+            {
+                "label": "s",
+                "angle": "rotation",
+                "lineheight": "linespacing",
+            },
+            axis=1,
+            inplace=True,
+        )
         plot_data["color"] = color
-        plot_data["family"] = params["family"]
-        plot_data["fontweight"] = params["fontweight"]
-        plot_data["fontstyle"] = params["fontstyle"]
         plot_data["zorder"] = params["zorder"]
         plot_data["rasterized"] = params["raster"]
         plot_data["clip_on"] = True
@@ -299,7 +350,7 @@ def draw_legend(
             y=0.5 * da.height,
             text="a",
             size=data["size"],
-            family=lyr.geom.params["family"],
+            family=data["family"],
             color=color,
             rotation=data["angle"],
             horizontalalignment="center",

tests/baseline_images/test_geom_text_label/adjust_label.png

@@ -88,7 +88,6 @@ def test_label_aesthetics():
     assert p == "label_aesthetics"
 
 
-@pytest.mark.skipif(is_CI, reason="Sudden small difference on GHA")
 def test_adjust_text():
     p = (
         ggplot(mtcars.tail(2), aes("mpg", "disp", label="name"))
@@ -98,7 +97,6 @@ def test_adjust_text():
     assert p == "adjust_text"
 
 
-@pytest.mark.skipif(is_CI, reason="Sudden small difference on GHA")
 def test_adjust_label():
     p = (
         ggplot(mtcars.tail(2), aes("mpg", "disp", label="name"))
@@ -108,7 +106,6 @@ def test_adjust_label():
     assert p == "adjust_label"
 
 
-@pytest.mark.skipif(is_CI, reason="Sudden small difference on GHA")
 def test_adjust_text_default_color():
     adjust_text2 = adjust_text.copy()
     del adjust_text2["arrowprops"]["color"]