Skeleton of annotated shapes test

Moved the tests for axis spanning shapes and their annotated versions to
test_autoshapes.

Author: nicholas-esterer

Diff for: packages/python/plotly/plotly/shapeannotation.py

@@ -25,12 +25,12 @@ def annotation_params_for_line(shape_type, shape_args, position):
     M = "middle"
     aY = max(Y)
     iY = min(Y)
-    mY = mean(Y)
+    eY = mean(Y)
     aaY = argmax(Y)
     aiY = argmin(Y)
     aX = max(X)
     iX = min(X)
-    mX = mean(X)
+    eX = mean(X)
     aaX = argmax(X)
     aiX = argmin(X)
 
@@ -58,13 +58,13 @@ def annotation_params_for_line(shape_type, shape_args, position):
         if position == "top right":
             return _df_anno(R, B, aX, Y[aaX])
         if position == "top":
-            return _df_anno(C, B, mX, mY)
+            return _df_anno(C, B, eX, eY)
         if position == "bottom left":
             return _df_anno(L, T, iX, Y[aiX])
         if position == "bottom right":
             return _df_anno(R, T, aX, Y[aaX])
         if position == "bottom":
-            return _df_anno(C, T, mX, mY)
+            return _df_anno(C, T, eX, eY)
         if position == "left":
             return _df_anno(R, M, iX, Y[aiX])
         if position == "right":
@@ -98,15 +98,35 @@ def annotation_params_for_rect(shape_type, shape_args, position):
         # TODO: Do we want this?
         return _df_anno("center", "middle", mean([x0, x1]), mean([y0, y1]))
     if position == "outside top left":
-        return _df_anno("right", "bottom", min([x0, x1]), max([y0, y1]))
+        return _df_anno(
+            "right" if shape_type == "vrect" else "left",
+            "bottom" if shape_type == "hrect" else "top",
+            min([x0, x1]),
+            max([y0, y1]),
+        )
     if position == "outside top right":
-        return _df_anno("left", "bottom", max([x0, x1]), max([y0, y1]))
+        return _df_anno(
+            "left" if shape_type == "vrect" else "right",
+            "bottom" if shape_type == "hrect" else "top",
+            max([x0, x1]),
+            max([y0, y1]),
+        )
     if position == "outside top":
         return _df_anno("center", "bottom", mean([x0, x1]), max([y0, y1]))
     if position == "outside bottom left":
-        return _df_anno("right", "top", min([x0, x1]), min([y0, y1]))
+        return _df_anno(
+            "right" if shape_type == "vrect" else "left",
+            "top" if shape_type == "hrect" else "bottom",
+            min([x0, x1]),
+            min([y0, y1]),
+        )
     if position == "outside bottom right":
-        return _df_anno("left", "top", max([x0, x1]), min([y0, y1]))
+        return _df_anno(
+            "left" if shape_type == "vrect" else "right",
+            "top" if shape_type == "hrect" else "bottom",
+            max([x0, x1]),
+            min([y0, y1]),
+        )
     if position == "outside bottom":
         return _df_anno("center", "top", mean([x0, x1]), min([y0, y1]))
     if position == "outside left":
@@ -141,11 +161,8 @@ def axis_spanning_shape_annotation(annotation, shape_type, shape_args, kwargs):
     annotation_position, annotation_ prefixed kwargs or the original annotation
     passed in to this function.
     """
-    # Force to go.layout.Annotation, no matter if it is that already, a dict or None
-    # TODO: We can't import go.layout.Annotation so we initialize this as a
-    # dict. This strategy is inferior to initializing as a go.layout.Annotation
-    # because there's no checking if a key is valid. Eventually it'd be better
-    # to use go.layout.Annotation.
+    # TODO: Would it be better if annotation were initialized to an instace of
+    # go.layout.Annotation ?
     if annotation is None:
         annotation = dict()
     # set properties based on annotation_ prefixed kwargs

Diff for: packages/python/plotly/plotly/tests/test_core/test_autoshapes/test_annotated_shapes.py

@@ -0,0 +1,72 @@
+import plotly.graph_objects as go
+from plotly.subplots import make_subplots
+from itertools import product
+import os
+
+visualize = os.environ.get("VISUALIZE", 0)
+
+line_positions = [
+    "top left",
+    "top right",
+    "top",
+    "bottom left",
+    "bottom right",
+    "bottom",
+    "left",
+    "right",
+]
+rect_positions = [
+    "inside top left",
+    "inside top right",
+    "inside top",
+    "inside bottom left",
+    "inside bottom right",
+    "inside bottom",
+    "inside left",
+    "inside right",
+    "inside",
+    "outside top left",
+    "outside top right",
+    "outside top",
+    "outside bottom left",
+    "outside bottom right",
+    "outside bottom",
+    "outside left",
+    "outside right",
+]
+fig = make_subplots(
+    2, 2, column_widths=[3, 1], row_heights=[1, 3], vertical_spacing=0.07
+)
+for rc, pos, ax, sh in zip(
+    product(range(2), range(2)),
+    [line_positions, line_positions, rect_positions, rect_positions],
+    ["x", "y", "x", "y"],
+    ["vline", "hline", "vrect", "hrect"],
+):
+    r, c = rc
+    r += 1
+    c = ((c + 1) % 2 if r == 1 else c) + 1
+    fig.update_xaxes(row=r, col=c, range=[0, len(pos) if sh[0] == "v" else 1])
+    fig.update_yaxes(row=r, col=c, range=[0, len(pos) if sh[0] == "h" else 1])
+    fig.add_trace(go.Scatter(x=[], y=[]), row=r, col=c)
+    for n, p in enumerate(pos):
+        f = eval("fig.add_%s" % (sh,))
+        args = (
+            {ax: n + 0.5}
+            if sh.endswith("line")
+            else {ax + "0": n + 0.1, ax + "1": n + 0.9}
+        )
+        args["annotation_text"] = p
+        args["annotation_position"] = p
+        args["annotation_font_size"] = 8
+        args["annotation_font_color"] = "white"
+        args["row"] = r
+        args["col"] = c
+        args["annotation_bgcolor"] = "grey"
+        if sh[0] == "v":
+            args["annotation_textangle"] = 90
+        f(**args)
+fig.update_layout(title="Annotated hline, vline, hrect, vrect")
+
+if visualize:
+    fig.show()