Python convenience

Author: grtlr

docs/snippets/all/archetypes/scalars_multiple_plots.py

@@ -17,11 +17,12 @@
 
 # NOTE: `SeriesLines` and `SeriesPoints` can both be logged without any associated data
 #       (all fields are optional). In `v0.24` we removed indicators, which now results in
-#       no data logged at all, when no fields are specified. Therefore we log a circle shape
-#       here. More information: https://github.com/rerun-io/rerun/issues/10512
+#       no data logged at all, when no fields are specified. Therefore, we log a circle shape
+#       as a marker if no arguments are supplied.
+#       More information: https://github.com/rerun-io/rerun/issues/10512
 
 # Log scattered points under a different root so that they show in a different plot by default.
-rr.log("scatter/lcg", rr.SeriesPoints(markers="circle"), static=True)
+rr.log("scatter/lcg", rr.SeriesPoints(), static=True)
 
 # Log the data on a timeline called "step".
 for t in range(int(tau * 2 * 100.0)):

rerun_py/rerun_sdk/rerun/archetypes/series_points.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+from typing import Any
+
+from .. import components, datatypes
+
+from ..error_utils import catch_and_log_exceptions
+
+
+class SeriesPointsExt:
+    """Extension for [SeriesPoints][rerun.archetypes.SeriesPoints]."""
+
+    def __init__(
+        self: Any,
+        *,
+        colors: datatypes.Rgba32ArrayLike | None = None,
+        markers: components.MarkerShapeArrayLike | None = None,
+        names: datatypes.Utf8ArrayLike | None = None,
+        visible_series: datatypes.BoolArrayLike | None = None,
+        marker_sizes: datatypes.Float32ArrayLike | None = None,
+    ) -> None:
+        """
+        Create a new instance of the SeriesPoints archetype.
+
+        Parameters
+        ----------
+        colors:
+            Color for the corresponding series.
+
+            May change over time, but can cause discontinuities in the line.
+        markers:
+            What shape to use to represent the point
+
+            May change over time.
+        names:
+            Display name of the series.
+
+            Used in the legend. Expected to be unchanging over time.
+        visible_series:
+            Which lines are visible.
+
+            If not set, all line series on this entity are visible.
+            Unlike with the regular visibility property of the entire entity, any series that is hidden
+            via this property will still be visible in the legend.
+
+            May change over time.
+        marker_sizes:
+            Sizes of the markers.
+
+            May change over time.
+
+        """
+
+        # You can define your own __init__ function as a member of SeriesPointsExt in series_points_ext.py
+        with catch_and_log_exceptions(context=self.__class__.__name__):
+
+            if all(arg is None for arg in [colors, markers, names, visible_series, marker_sizes]):
+                markers = components.MarkerShape.Circle
+
+            self.__attrs_init__(
+                colors=colors, markers=markers, names=names, visible_series=visible_series, marker_sizes=marker_sizes
+            )
+            return
+        self.__attrs_clear__()