Cleanup / review of callbacks.py

Author: Jon M. Mease

plotly/callbacks.py

@@ -1,8 +1,16 @@
-import typing as typ
+from plotly.utils import _list_repr_elided
 
 
 class InputDeviceState:
-    def __init__(self, ctrl=None, alt=None, shift=None, meta=None, button=None, buttons=None, **_):
+    def __init__(self,
+                 ctrl=None,
+                 alt=None,
+                 shift=None,
+                 meta=None,
+                 button=None,
+                 buttons=None,
+                 **_):
+
         self._ctrl = ctrl
         self._alt = alt
         self._meta = meta
@@ -12,15 +20,22 @@ def __init__(self, ctrl=None, alt=None, shift=None, meta=None, button=None, butt
 
     def __repr__(self):
         return """\
-InputState(ctrl={ctrl}, 
-           alt={alt}, 
-           shift={shift}, 
-           meta={meta}, 
-           button={button}, 
-           buttons={buttons})"""
+InputDeviceState(
+    ctrl={ctrl}, 
+    alt={alt}, 
+    shift={shift}, 
+    meta={meta}, 
+    button={button}, 
+    buttons={buttons})""".format(
+            ctrl=repr(self.ctrl),
+            alt=repr(self.alt),
+            meta=repr(self.meta),
+            shift=repr(self.shift),
+            button=repr(self.button),
+            buttons=repr(self.buttons))
 
     @property
-    def alt(self) -> bool:
+    def alt(self):
         """
         Whether alt key pressed
 
@@ -31,7 +46,7 @@ def alt(self) -> bool:
         return self._alt
 
     @property
-    def ctrl(self) -> bool:
+    def ctrl(self):
         """
         Whether ctrl key pressed
 
@@ -42,7 +57,7 @@ def ctrl(self) -> bool:
         return self._ctrl
 
     @property
-    def shift(self) -> bool:
+    def shift(self):
         """
         Whether shift key pressed
 
@@ -53,7 +68,7 @@ def shift(self) -> bool:
         return self._shift
 
     @property
-    def meta(self) -> bool:
+    def meta(self):
         """
         Whether meta key pressed
 
@@ -64,12 +79,15 @@ def meta(self) -> bool:
         return self._meta
 
     @property
-    def button(self) -> int:
+    def button(self):
         """
-        Integer code for the button that was pressed on the mouse to trigger the event
+        Integer code for the button that was pressed on the mouse to trigger
+        the event
 
-        - 0: Main button pressed, usually the left button or the un-initialized state
-        - 1: Auxiliary button pressed, usually the wheel button or the middle button (if present)
+        - 0: Main button pressed, usually the left button or the
+             un-initialized state
+        - 1: Auxiliary button pressed, usually the wheel button or the middle
+             button (if present)
         - 2: Secondary button pressed, usually the right button
         - 3: Fourth button, typically the Browser Back button
         - 4: Fifth button, typically the Browser Forward button
@@ -81,9 +99,10 @@ def button(self) -> int:
         return self._button
 
     @property
-    def buttons(self) -> int:
+    def buttons(self):
         """
-        Integer code for which combination of buttons are pressed on the mouse when the event is triggered.
+        Integer code for which combination of buttons are pressed on the
+        mouse when the event is triggered.
 
         -  0: No button or un-initialized
         -  1: Primary button (usually left)
@@ -92,9 +111,11 @@ def buttons(self) -> int:
         -  8: 4th button (typically the "Browser Back" button)
         - 16: 5th button (typically the "Browser Forward" button)
 
-        Combinations of buttons are represented as the decimal form of the bitmask of the values above.
+        Combinations of buttons are represented as the decimal form of the
+        bitmask of the values above.
 
-        For example, pressing both the primary (1) and auxilary (4) buttons will result in a code of 5
+        For example, pressing both the primary (1) and auxilary (4) buttons
+        will result in a code of 5
 
         Returns
         -------
@@ -105,31 +126,85 @@ def buttons(self) -> int:
 
 class Points:
 
-    def __init__(self, point_inds=None, xs=None, ys=None, trace_name=None, trace_index=None):
+    def __init__(self,
+                 point_inds=None,
+                 xs=None,
+                 ys=None,
+                 trace_name=None,
+                 trace_index=None):
+
         self._point_inds = point_inds
         self._xs = xs
         self._ys = ys
         self._trace_name = trace_name
         self._trace_index = trace_index
 
+    def __repr__(self):
+        return """\
+Points(point_inds={point_inds},
+       xs={xs},
+       ys={ys},
+       trace_name={trace_name},
+       trace_index={trace_index})""".format(
+            point_inds=_list_repr_elided(self.point_inds),
+            xs=_list_repr_elided(self.xs),
+            ys=_list_repr_elided(self.ys),
+            trace_name=repr(self.trace_name),
+            trace_index=repr(self.trace_index))
+
     @property
-    def point_inds(self) -> typ.List[int]:
+    def point_inds(self):
+        """
+        List of selected indexes into the trace's points
+
+        Returns
+        -------
+        list[int]
+        """
         return self._point_inds
 
     @property
-    def xs(self) -> typ.List:
+    def xs(self):
+        """
+        List of x-coordinates of selected points
+
+        Returns
+        -------
+        list[float]
+        """
         return self._xs
 
     @property
-    def ys(self) -> typ.List:
+    def ys(self):
+        """
+        List of y-coordinates of selected points
+
+        Returns
+        -------
+        list[float]
+        """
         return self._ys
 
     @property
-    def trace_name(self) -> str:
+    def trace_name(self):
+        """
+        Name of the trace
+
+        Returns
+        -------
+        str
+        """
         return self._trace_name
 
     @property
-    def trace_index(self) -> int:
+    def trace_index(self):
+        """
+        Index of the trace in the figure
+
+        Returns
+        -------
+        int
+        """
         return self._trace_index
 
 
@@ -139,16 +214,44 @@ def __init__(self, xrange=None, yrange=None, **_):
         self._xrange = xrange
         self._yrange = yrange
 
+    def __repr__(self):
+        return """\
+BoxSelector(xrange={xrange},
+            yrange={yrange})""".format(
+            xrange=self.xrange,
+            yrange=self.yrange)
+
     @property
-    def type(self) -> str:
+    def type(self):
+        """
+        The selector's type
+
+        Returns
+        -------
+        str
+        """
         return self._type
 
     @property
-    def xrange(self) -> typ.Tuple[float, float]:
+    def xrange(self):
+        """
+        x-axis range extents of the box selection
+
+        Returns
+        -------
+        (float, float)
+        """
         return self._xrange
 
     @property
-    def yrange(self) -> typ.Tuple[float, float]:
+    def yrange(self):
+        """
+        y-axis range extents of the box selection
+
+        Returns
+        -------
+        (float, float)
+        """
         return self._yrange
 
 
@@ -158,14 +261,44 @@ def __init__(self, xs=None, ys=None, **_):
         self._xs = xs
         self._ys = ys
 
+    def __repr__(self):
+        return """\
+LassoSelector(xs={xs},
+              ys={ys})""".format(
+            xs=_list_repr_elided(self.xs, 8),
+            ys=_list_repr_elided(self.ys, 8))
+
     @property
-    def type(self) -> str:
+    def type(self):
+        """
+        The selector's type
+
+        Returns
+        -------
+        str
+        """
         return self._type
 
     @property
-    def xs(self) -> typ.List[float]:
+    def xs(self):
+        """
+        list of x-axis coordinates of each point in the lasso selection
+        boundary
+
+        Returns
+        -------
+        list[float]
+        """
         return self._xs
 
     @property
-    def ys(self) -> typ.List[float]:
+    def ys(self):
+        """
+        list of y-axis coordinates of each point in the lasso selection
+        boundary
+
+        Returns
+        -------
+        list[float]
+        """
         return self._ys

plotly/utils.py

@@ -490,3 +490,26 @@ def _memoize(*all_args, **kwargs):
         return result
 
     return decorator(_memoize)
+
+
+def _list_repr_elided(v, n=20):
+    """
+    Return a string representation for of a list where list is elided if
+    it has more than n elements
+
+    Parameters
+    ----------
+    v : list
+        Input list
+    n :
+        Maximum number of elements to display
+
+    Returns
+    -------
+    str
+    """
+    if len(v) <= n:
+        return str(v)
+    else:
+        disp_v = v[:n // 2 - 1] + ['...'] + v[-n // 2 + 1:]
+        return '[' + ', '.join([str(e) for e in disp_v]) + ']'