+
nDj$L R t ^ RIHt ^ RIt^ RIt^ RIHt ^ RIHtH t ^ RI
t
^ RI
H t H t ^RI
HtHt ]' d ^ RIHt ^ RIHtHt ^ RIt^ RIt^R IHt ^ R
IHt ^ R IH t ^R I H t H t H t H!t!H"t"H#t#H$t$H%t%H&t&H't'H(t(H)t) ^R
I*H+t+H,t, . R Ot-Rt. ^ RI/H0t1H2t3 ^ RI4H5t6H7t8 R R lt:]! ];4 Px R, P{ 4 t>R R lt?Rs@RsA] R , tB] R , tCR R ltD ! R R4 t7R# ]9 d Rt. Lfi ; i) z7Helper functions for converting streams to inline html.) annotationsN)Path)
TYPE_CHECKINGLiteral) RecordBatchipc)to_nanosto_nanos_since_epoch)Callable)datetime timedelta)
BlueprintLike)bindings)RerunMissingDependencyError) ContainerSelectionItemEntitySelectionItem
PauseEvent PlayEventRecordingOpenEventSelectionChangeEvent
SelectionItemTimelineChangeEventTimeUpdateEvent ViewerEventViewSelectionItem_viewer_event_from_json_str)RecordingStreamget_data_recordingViewerT)HTMLVBox) ErrorWidgetr Fc V ^8 d QhRR/# returnNone )formats "R/data/cameron/venvs/s3viz/lib/python3.14/site-packages/rerun_sdk/rerun/notebook.py __annotate__r* D s $ c ^ RI p V P 4 ;_uu_ 4 pV! ^4 RRR4 R# + ' g i R# ; i)zTPump the Jupyter event loop so pending widget updates are delivered to the frontend.N)jupyter_ui_poll ui_events)r- polls r) _flush_ui_eventsr0 D s, " " $ $ Q
% $ $ $s 0 A z_loading_widget.cssc V ^8 d QhRRRR/# )r$ table_idstrr% r' )r( s "r) r* r* Q s 3 3 r+ c D R\ R\ P ! V 4 R2# )zKBuild the HTML fragment shown in the loading widget for the given table id.z) _LOADING_CSShtmlescape)r2 s &r) _render_loading_htmlr8 Q s0 , % &*[[%:$; < r+ i i c $ V ^8 d QhRRRRRR/# )r$ width
int | Noneheightr% r& r' )r( s "r) r* r* c s! ! !z !: !$ !r+ c " V e V s Ve VsR# R# )z
Set the default size for the viewer.
This will be used for any viewers created after this call.
Parameters
----------
width:
The width of the viewer in pixels.
height:
The height of the viewer in pixels.
N)_default_width_default_height)r: r< s $$r) set_default_sizer@ c s
r+ c . ] tR t^ytRtRRRRRRRRRRRRR R/R
R lltR5R R
lltR R ltRRRR/R R lltR R lt R6R R llt
R R lt R R lt R RRRR RR R/R! R" llt
R# R$ ltR% R& ltR' R( ltR)RR*RR+RR,RR-R/R. R/ lltR0 R1 ltR2 R3 ltR4tR# )7r zi
A viewer embeddable in a notebook.
This viewer is a wrapper around the `rerun_notebook.Viewer` widget.
r: Nr< url blueprint recordinguse_global_recordingthemec 8 V ^8 d QhRRRRRRRRRR R
R R R
RR/# )r$ r: z int | Literal['auto'] | Noner< rB
str | NonerC BlueprintLike | NonerD RecordingStream | NonerE z bool | NonerF z)Literal['dark', 'light', 'system'] | Noner% r& r' )r( s "r) r* Viewer.__annotate__ sf m m ,m - m
m (
m *m *m 9m
mr+ c
a \ ' g
\ RR4 h\ 4 S n \ RR7 S n Rp\ P P RR4 p RpV f& \ P ! 4 pVe
VP p \ Ve TM\ Ve TM\ VV VR7 S n Ve1 S P P! VP VP" 4 . S n R V 3R llp
S P P' V
4 Vf VRJ pV' d \) V4 pVe1 \ P* ! VP- 4 S P. R
7 Ve# Ve VP1 V4 R# \3 R 4 hR# ) a
Create a new Rerun viewer widget for use in a notebook.
Any data logged to the recording after initialization will be sent directly to the viewer.
This widget can be displayed by returning it at the end of your cells execution, or immediately
by calling [`rerun.notebook.Viewer.display`][].
Parameters
----------
width:
The width of the viewer in pixels, or "auto".
When set to "auto", scales to 100% of the notebook cell's width.
height:
The height of the viewer in pixels, or "auto".
When set to "auto", scales using a 16:9 aspect ratio with `width`.
url:
Optional URL passed to the viewer for displaying its contents.
recording:
Specifies the [`rerun.RecordingStream`][] to use.
If left unspecified, defaults to the current active data recording, if there is one.
See also: [`rerun.init`][], [`rerun.set_global_data_recording`][].
blueprint:
A blueprint object to send to the viewer.
It will be made active and set as the default blueprint in the recording.
Setting this is equivalent to calling [`rerun.send_blueprint`][] before initializing the viewer.
use_global_recording:
If no explicit `recording` is provided, the Viewer uses the thread-local/global recording created by `rr.init`
or set explicitly via `rr.set_thread_local_data_recording`/`rr.set_global_data_recording`.
Settings this to `False` causes the Viewer to not pick up the global recording.
Defaults to `False` if `url` is provided, and `True` otherwise.
theme:
The color theme to use. Either "dark", "light", or "system".
If not set, the viewer uses the previously persisted theme preference or defaults to "system".
zrerun-notebooknotebook )valueN REDAP_TOKEN)r: r< rB fallback_tokenrF c V ^8 d QhRRRR/# )r$ json_strr3 r% r& r' )r( s "r) r* %Viewer.__init__..__annotate__ s 3 4 r+ c T < \ V 4 pSP F pV! V4 K
R # N)r _event_callbacks)rS evtcallbackselfs & r) on_raw_event%Viewer.__init__..on_raw_event s$ -h7C 1 1
2r+ rD rY zWCan only set a blueprint if there's either an active recording or a recording passed in) HAS_NOTEBOOKr _ErrorWidget
_error_widget_HTML_loading_widgetosenvirongetr get_credentials access_token_Viewerr> r? _viewerset_credentials
user_emailrW
_on_raw_eventr set_callback_sink to_native _flush_hooksend_blueprint
ValueError) rZ r: r< rB rC rD rE rF credentialsrQ r[ s f$$$$$$$ r) __init__Viewer.__init__ sh j |-.>
K K )^ $2
t< !"224K&!,!9!9 ,%. # /6_)
" LL ( ()A)A;CYCY Z FH
""<0 '#&$; *95I & &#--/ ))
$((3 m !r+ c $ V ^8 d QhRRRRRR/# )r$ rD rJ rC rI r% r& r' )r( s "r) r* rK s( %0 %0)%0 (%0
%0r+ c
\ V4 pVf \ R4 h\ P ! VP 4 V P
R7 Ve VP
V4 R# R# )a;
Adds a recording to the viewer.
If no recording is specified, the current active recording will be used.
NOTE: By default all calls to `rr.init()` will re-use the same recording_id, meaning
that your recordings will be merged together. If you want to keep them separate, you
should call `rr.init("my_app_id", recording_id=uuid.uuid4())`.
Parameters
----------
recording:
Specifies the [`rerun.RecordingStream`][] to use.
If left unspecified, defaults to the current active data recording, if there is one.
See also: [`rerun.init`][], [`rerun.set_global_data_recording`][].
blueprint:
A blueprint object to send to the viewer.
It will be made active and set as the default blueprint in the recording.
Setting this is equivalent to calling [`rerun.send_blueprint`][] before initializing the viewer.
Nz4No recording specified and no active recording foundr] )r rq r rm rn ro rp )rZ rD rC s &&&r)
add_recordingViewer.add_recording s^ 6 'y1 ST T"" ))+%%
$ $Y / !r+ c $ V ^8 d QhRRRRRR/# )r$ record_batchr r2 r3 r% r' )r( s "r) r* rK s& L L+ L L Lr+ c VP pVP R V/4 p\ P ! VP VR7 # )s
__table_id)schema)r|
with_metadatar from_arrayscolumns)rZ rz r2 r| s &&& r)
_add_table_idViewer._add_table_id s= $$%%}h&?@ &&|';';FKKr+ make_activeT make_defaultc
, V ^8 d QhRRRRRRRRRR /# )
r$ application_idr3 rC r
r boolr r% r& r' )r( s "r) r* rK s4 (
(
!(
.;(
MQ(
hl(
(
r+ c
. VP 4 p\ P ! \ P ! VRRRR7 4 pVP R^ R7 VP
V4 \ P ! V P VVVP 4 R7 R# )a
Set the blueprint for the given application.
Parameters
----------
application_id:
The ID of the application to set the blueprint for.
blueprint:
The blueprint to set for the application.
make_active:
Whether to make the blueprint active.
If `True`, the blueprint will be set as the active blueprint for the application.
make_default:
Whether to make the blueprint the default blueprint for the application.
If `True`, the blueprint will be set as the default blueprint for the application.
FT)r r make_thread_defaultdefault_enabledrC )sequence)rY r r blueprint_streamN)
to_blueprintr _from_nativer
new_blueprintset_time_log_to_streamset_callback_sink_blueprintro rn )rZ r rC r r r s &&&$$ r) set_application_blueprint Viewer.set_application_blueprint s * **, *77 " " - "$) $
!!+!: !12,,%%#% - 7 7 9
r+ c $ V ^8 d QhRRRRRR/# )r$ idr3 tablez6RecordBatch | list[RecordBatch] | datafusion.DataFramer% r& r' )r( s "r) r* rK H s) ", ", ", F",
",r+ c
^ RI Hp \ V4 V P n \ 4 V! V4 pV P
WA4 p\ P ! 4 p\ P ! WeP 4 pVP V4 VP 4 VP 4 P 4 pV P P# V4 RV P n R# RT P n i ; i)a2
Sends a table in the form of a dataframe to the viewer.
Parameters
----------
id:
The name that uniquely identifies the table in the viewer.
This name will also be shown in the recording panel.
table:
The table data as an Arrow RecordBatch, list of RecordBatches, or a datafusion DataFrame.
)to_record_batchrN N) rerun._arrowr r8 rb rO r0 r pyarrowBufferOutputStreamr
new_streamr| write_batchclosegetvalue
to_pybytesri
send_table) rZ r r r rz new_tablesinkwritertable_as_bytess &&& r) r Viewer.send_tableH s " 1%9"%= "
,*51L **< 17 17 517 ; 17
; 17 6
17
17r+ c
/ pV' d WR& V' d W%R& V' d W5R& V' d WER& V P P V4 R# )a
Partially update the state of panels in the viewer.
Valid states are the strings `expanded`, `collapsed`, `hidden`, `default`, and the value `None`.
Panels set to:
- `None` will be unchanged.
- `expanded` will be fully expanded, taking up the most space.
- `collapsed` will be smaller and simpler, omitting some information.
- `hidden` will be completely invisible, taking up no space.
- `default` will be reset to the default state.
The `collapsed` state is the same as the `hidden` state for panels
which do not support the `collapsed` state.
Setting the panel state using this function will also prevent the user
from modifying that panel's state in the viewer.
Parameters
----------
top: str
State of the top panel of the viewer.
blueprint: str
State of the blueprint panel, positioned on the left side of the viewer.
selection: str
State of the selection panel, positioned on the right side of the viewer.
time: str
State of the time panel, positioned on the bottom side of the viewer.
r rC r r N)ri update_panel_states)rZ r rC r r panel_statess &$$$$ r)
update_panelsViewer.update_panels sJ N HJ "% (1 % (1 % #' (( 6r+ c V ^8 d QhRRRR/# )r$ recording_idr3 r% r& r' )r( s "r) r* rK s 8 8 8
8r+ c
< V P P V4 R# )a,
Set the active recording for the viewer.
This is equivalent to clicking on the given recording in the blueprint panel.
Parameters
----------
recording_id: str
The ID of the recording to set the viewer to.
Using this requires setting an explicit recording ID when creating the recording.
N)ri set_active_recording)rZ r s &$r) r Viewer.set_active_recording s &
)),7r+ c V ^8 d QhRRRR/# r$ rB r3 r% r& r' )r( s "r) r* rK s # #
#
#r+ c
< V P P V4 R# )zy
Open a URL in the viewer.
Parameters
----------
url: str
The URL to open.
Must point to a valid data source.
N)ri open_urlrZ rB s &&r) r Viewer.open_url s
c"r+ c V ^8 d QhRRRR/# r r' )r( s "r) r* rK s $ $
$
$r+ c
< V P P V4 R# )z
Close an open URL in the viewer.
Does nothing if the URL is not open.
Parameters
----------
url: str
The URL to close.
N)ri close_urlr s &&r) r Viewer.close_url s
s#r+ r duration timestamptimelineplayc 0 V ^8 d QhRRRRRRRRR R
R R /# )
r$ r r; r z/int | float | timedelta | np.timedelta64 | Noner z-int | float | datetime | np.datetime64 | Noner rH r r r% r& r' )r( s "r) r* rK sJ /9 /9 /9 B /9
A /9
/9 /9
/9r+ c
\ R WV3 4 4 ^8 d \ RV R24 hVe TpM"Ve
\ V4 pMVe
\ V4 pMRpV P P WFV4 R# )a
Set the time control for the viewer.
You are expected to set at most ONE of the arguments `sequence`, `duration`, or `timestamp`.
Parameters
----------
sequence:
Used for sequential indices, like `frame_nr`.
Must be an integer.
duration:
Used for relative times, like `time_since_start`.
Must either be in seconds, a [`datetime.timedelta`][], or [`numpy.timedelta64`][].
For nanosecond precision, use `numpy.timedelta64(nanoseconds, 'ns')`.
timestamp:
Used for absolute time indices, like `capture_time`.
Must either be in seconds since Unix epoch, a [`datetime.datetime`][], or [`numpy.datetime64`][].
For nanosecond precision, use `numpy.datetime64(nanoseconds, 'ns')`.
play:
Whether to start playing from the specified time point. Defaults to paused.
timeline:
The name of the timeline to switch to. If not provided, time will remain on the current timeline.
c 3 ( " T F qR Jx K
R # 5irV r' ).0xs & r) 'Viewer.set_time_ctrl.. s F&E}&Es z]set_time_ctrl: Exactly one of `sequence`, `duration`, and `timestamp` must be set (timeline='z')N)sumrq r r ri
set_time_ctrl)rZ r r r r r r s &$$$$$ r) r Viewer.set_time_ctrl s B Fx9&EF F J opxoyy{|
D
!H%D
"' 2DD ""848r+ c V ^8 d QhRRRR/# )r$ rY z Callable[[ViewerEvent], None]r% r& r' )r( s "r) r* rK ' s / /!> /4 /r+ c
< V P P V4 R# )a\
Register a callback to be called when a viewer event occurs.
The callback will receive a [`ViewerEvent`][rerun.notebook.ViewerEvent], which is one of:
[`PlayEvent`][rerun.notebook.PlayEvent], [`PauseEvent`][rerun.notebook.PauseEvent],
[`TimeUpdateEvent`][rerun.notebook.TimeUpdateEvent], [`TimelineChangeEvent`][rerun.notebook.TimelineChangeEvent],
[`SelectionChangeEvent`][rerun.notebook.SelectionChangeEvent], or [`RecordingOpenEvent`][rerun.notebook.RecordingOpenEvent].
Parameters
----------
callback:
A function that takes a [`ViewerEvent`][rerun.notebook.ViewerEvent] as its only argument.
N)rW append)rZ rY s &&r) on_eventViewer.on_event' s
$$X.r+ c $ V ^8 d QhRRRRRR/# )r$ rg r3 emailr% r& r' )r( s "r) r* rK 8 s! : :C : : :r+ c < V P P W4 R # rV )ri rj )rZ rg r s &&&r) rj Viewer.set_credentials8 s $$\9r+ )r` rW rb ri )NN)F)__name__
__module__ __qualname____firstlineno____doc__rs rw r r r r r ro r r r r r r rj __static_attributes__r' r+ r) r r y s m /3m 04 m
m +/
m -1m -1m <@m^%0NL(
TX(
os(
T",H-0$17 8<17 >B 17
>B 17 9=
17f8*#$$$/9 $/9 EI /9
DH /9 $
/9 /9b/": :r+ )
r r r r r r r r r r r r r@ )r rC r r )expanded collapsedhidden)Er
__future__r r6 rc pathlibr typingr r r r r r r r collections.abcr
r r
datafusionnumpynprC r
rerunr rerun.error_utilsr _eventr r r r r r r r r r r r recording_streamr r __all__r^
ipywidgetsr ra r r rerun_notebookr! r_ r rh ModuleNotFoundErrorr0 __file__parent read_textr5 r8 r> r? _Panel _PanelStater@ r' r+ r) r s = " ) $ 0(,( 9
B 7M
X%%(==HHJ 8 978 !,@: @:s Ls C9 9 DD