feat: add dotplot variant (#3890)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Phil Schaf <flying-sheep@web.de>

Author: 3 people

src/scanpy/plotting/__init__.py

@@ -15,6 +15,7 @@
     violin,
 )
 from ._dotplot import DotPlot, dotplot
+from ._easter_egg import dogplot
 from ._matrixplot import MatrixPlot, matrixplot
 from ._preprocessing import filter_genes_dispersion, highly_variable_genes
 from ._qc import highest_expr_genes
@@ -63,6 +64,7 @@
     "correlation_matrix",
     "dendrogram",
     "diffmap",
+    "dogplot",
     "dotplot",
     "dpt_groups_pseudotime",
     "dpt_timeseries",

src/scanpy/plotting/_easter_egg.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from importlib.resources import files
+
+import numpy as np
+from matplotlib import pyplot as plt
+from matplotlib.image import imread
+
+
+def dogplot(*_, **__) -> None:
+    """Show who’s a good boy."""
+    rng = np.random.default_rng()
+    n = int(rng.integers(1, 4))
+    img_path = files("scanpy.plotting") / f"dogplot_images/doggo_{n}.webp"
+    with img_path.open("rb") as f:
+        img = imread(f)
+
+    _, ax = plt.subplots(figsize=(3, 3))
+    ax.imshow(img)
+    ax.set_axis_off()

src/scanpy/plotting/dogplot_images/doggo_1.webp

@@ -1851,3 +1851,8 @@ def test_violin_scale_warning(monkeypatch):
     monkeypatch.setattr(sc.pl.StackedViolin, "DEFAULT_SCALE", "count", raising=False)
     with pytest.warns(FutureWarning, match="Don’t set DEFAULT_SCALE"):
         sc.pl.StackedViolin(adata, adata.var_names[:3], groupby="louvain")
+
+
+def test_dogplot() -> None:
+    """Test that the dogplot function runs without errors."""
+    sc.pl.dogplot()