Datatypes

rerun.blueprint.datatypes

ComponentColumnSelectorArrayLike module-attribute

ComponentColumnSelectorArrayLike = (
    ComponentColumnSelector
    | Sequence[ComponentColumnSelectorLike]
)

A type alias for any ComponentColumnSelector-like array object.

ComponentColumnSelectorLike module-attribute

ComponentColumnSelectorLike = ComponentColumnSelector | str

A type alias for any ComponentColumnSelector-like object.

ComponentSourceKindArrayLike module-attribute

ComponentSourceKindArrayLike = (
    ComponentSourceKind
    | Literal[
        "Default",
        "Override",
        "SourceComponent",
        "default",
        "override",
        "sourcecomponent",
    ]
    | int
    | Sequence[ComponentSourceKindLike]
)

A type alias for any ComponentSourceKind-like array object.

ComponentSourceKindLike module-attribute

ComponentSourceKindLike = (
    ComponentSourceKind
    | Literal[
        "Default",
        "Override",
        "SourceComponent",
        "default",
        "override",
        "sourcecomponent",
    ]
    | int
)

A type alias for any ComponentSourceKind-like object.

FilterByRangeArrayLike module-attribute

FilterByRangeArrayLike = (
    FilterByRange | Sequence[FilterByRangeLike]
)

A type alias for any FilterByRange-like array object.

FilterByRangeLike module-attribute

FilterByRangeLike = FilterByRange

A type alias for any FilterByRange-like object.

FilterIsNotNullArrayLike module-attribute

FilterIsNotNullArrayLike = (
    FilterIsNotNull | Sequence[FilterIsNotNullLike]
)

A type alias for any FilterIsNotNull-like array object.

FilterIsNotNullLike module-attribute

FilterIsNotNullLike = (
    FilterIsNotNull | ComponentColumnSelectorLike
)

A type alias for any FilterIsNotNull-like object.

SelectedColumnsArrayLike module-attribute

SelectedColumnsArrayLike = (
    SelectedColumns | Sequence[SelectedColumnsLike]
)

A type alias for any SelectedColumns-like array object.

SelectedColumnsLike module-attribute

SelectedColumnsLike = (
    SelectedColumns
    | Sequence[ComponentColumnSelectorLike | Utf8Like]
)

A type alias for any SelectedColumns-like object.

TensorDimensionIndexSliderArrayLike module-attribute

TensorDimensionIndexSliderArrayLike = (
    TensorDimensionIndexSlider
    | Sequence[TensorDimensionIndexSliderLike]
    | ArrayLike
)

A type alias for any TensorDimensionIndexSlider-like array object.

TensorDimensionIndexSliderLike module-attribute

TensorDimensionIndexSliderLike = (
    TensorDimensionIndexSlider | int
)

A type alias for any TensorDimensionIndexSlider-like object.

TextLogColumnArrayLike module-attribute

TextLogColumnArrayLike = (
    TextLogColumn | Sequence[TextLogColumnLike]
)

A type alias for any TextLogColumn-like array object.

TextLogColumnKindArrayLike module-attribute

TextLogColumnKindArrayLike = (
    TextLogColumnKind
    | Literal[
        "Body",
        "EntityPath",
        "LogLevel",
        "body",
        "entitypath",
        "loglevel",
    ]
    | int
    | Sequence[TextLogColumnKindLike]
)

A type alias for any TextLogColumnKind-like array object.

TextLogColumnKindLike module-attribute

TextLogColumnKindLike = (
    TextLogColumnKind
    | Literal[
        "Body",
        "EntityPath",
        "LogLevel",
        "body",
        "entitypath",
        "loglevel",
    ]
    | int
)

A type alias for any TextLogColumnKind-like object.

TextLogColumnLike module-attribute

TextLogColumnLike = TextLogColumn | TextLogColumnKindLike

A type alias for any TextLogColumn-like object.

TimelineColumnArrayLike module-attribute

TimelineColumnArrayLike = (
    TimelineColumn | Sequence[TimelineColumnLike]
)

A type alias for any TimelineColumn-like array object.

TimelineColumnLike module-attribute

TimelineColumnLike = TimelineColumn | Utf8Like

A type alias for any TimelineColumn-like object.

VisualizerComponentMappingArrayLike module-attribute

VisualizerComponentMappingArrayLike = (
    VisualizerComponentMapping
    | Sequence[VisualizerComponentMappingLike]
)

A type alias for any VisualizerComponentMapping-like array object.

VisualizerComponentMappingLike module-attribute

VisualizerComponentMappingLike = VisualizerComponentMapping

A type alias for any VisualizerComponentMapping-like object.

ComponentColumnSelector

Bases: ComponentColumnSelectorExt

Datatype: Describe a component column to be selected in the dataframe view.

⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

__init__

def __init__(
    spec: str | None = None,
    *,
    entity_path: EntityPathLike | None = None,
    component: Utf8Like | None = None,
) -> None

Create a new instance of the ComponentColumnSelector datatype.

PARAMETER	DESCRIPTION
spec	A string in the format "/entity/path:Component". If used, entity_path and component must be None. TYPE: str | None DEFAULT: None
entity_path	The column's entity path. If used, spec must be None and component must be provided. TYPE: EntityPathLike | None DEFAULT: None
component	The column's component type. If used, spec must be None and entity_path must be provided. TYPE: Utf8Like | None DEFAULT: None

ComponentColumnSelectorBatch

Bases: BaseBatch[ComponentColumnSelectorArrayLike]

__init__

def __init__(
    data: T | None, strict: bool | None = None
) -> None

Construct a new batch.

This method must flexibly accept native data (which comply with type T). Subclasses must provide a type parameter specifying the type of the native data (this is automatically handled by the code generator).

A value of None indicates that the component should be cleared and results in the creation of an empty array.

The actual creation of the Arrow array is delegated to the _native_to_pa_array() method, which is not implemented by default.

PARAMETER	DESCRIPTION
data	The data to convert into an Arrow array. TYPE: T | None
strict	Whether to raise an exception if the data cannot be converted into an Arrow array. If None, the value defaults to the value of the rerun.strict global setting. TYPE: bool | None DEFAULT: None

RETURNS	DESCRIPTION
The Arrow array encapsulating the data.

as_arrow_array

def as_arrow_array() -> Array

The component as an arrow batch.

Part of the rerun.ComponentBatchLike logging interface.

ComponentSourceKind

Bases: Enum

Datatype: What kind of source to use for a visualizer component mapping.

Default class-attribute instance-attribute

Default = 3

Default as specified on the view's blueprint.

If the view doesn't specify a default for the target component name, a heuristically determined value will be used instead.

Override class-attribute instance-attribute

Override = 2

Use a timeless override value that is defined in the blueprint.

The override value is stored on the same entity as the visualizer instruction and uses the target as its component name.

If there is no override value with the target component name, a heuristically determined value will be used instead.

SourceComponent class-attribute instance-attribute

SourceComponent = 1

Use an explicit selection defined by source_component.

May or may not make use of a selector string.

If the source component is not found on the entity, a heuristically determined value will be used instead.

__str__

def __str__() -> str

Returns the variant name.

auto classmethod

def auto(
    val: str | int | ComponentSourceKind,
) -> ComponentSourceKind

Best-effort converter, including a case-insensitive string matcher.

ComponentSourceKindBatch

Bases: BaseBatch[ComponentSourceKindArrayLike]

__init__

def __init__(
    data: T | None, strict: bool | None = None
) -> None

Construct a new batch.

This method must flexibly accept native data (which comply with type T). Subclasses must provide a type parameter specifying the type of the native data (this is automatically handled by the code generator).

A value of None indicates that the component should be cleared and results in the creation of an empty array.

The actual creation of the Arrow array is delegated to the _native_to_pa_array() method, which is not implemented by default.

PARAMETER	DESCRIPTION
data	The data to convert into an Arrow array. TYPE: T | None
strict	Whether to raise an exception if the data cannot be converted into an Arrow array. If None, the value defaults to the value of the rerun.strict global setting. TYPE: bool | None DEFAULT: None

RETURNS	DESCRIPTION
The Arrow array encapsulating the data.

as_arrow_array

def as_arrow_array() -> Array

The component as an arrow batch.

Part of the rerun.ComponentBatchLike logging interface.

FilterByRange

Bases: FilterByRangeExt

Datatype: Configuration for the filter-by-range feature of the dataframe view.

⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

__init__

def __init__(start: TimeIntLike, end: TimeIntLike) -> None

Create a new instance of the FilterByRange datatype.

PARAMETER	DESCRIPTION
start	Beginning of the time range. TYPE: TimeIntLike
end	End of the time range (inclusive). TYPE: TimeIntLike

FilterByRangeBatch

Bases: BaseBatch[FilterByRangeArrayLike]

__init__

def __init__(
    data: T | None, strict: bool | None = None
) -> None

Construct a new batch.

This method must flexibly accept native data (which comply with type T). Subclasses must provide a type parameter specifying the type of the native data (this is automatically handled by the code generator).

A value of None indicates that the component should be cleared and results in the creation of an empty array.

The actual creation of the Arrow array is delegated to the _native_to_pa_array() method, which is not implemented by default.

PARAMETER	DESCRIPTION
data	The data to convert into an Arrow array. TYPE: T | None
strict	Whether to raise an exception if the data cannot be converted into an Arrow array. If None, the value defaults to the value of the rerun.strict global setting. TYPE: bool | None DEFAULT: None

RETURNS	DESCRIPTION
The Arrow array encapsulating the data.

as_arrow_array

def as_arrow_array() -> Array

The component as an arrow batch.

Part of the rerun.ComponentBatchLike logging interface.

FilterIsNotNull

Bases: FilterIsNotNullExt

Datatype: Configuration for the filter is not null feature of the dataframe view.

⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

__init__

def __init__(
    active: BoolLike, column: ComponentColumnSelectorLike
) -> None

Create a new instance of the FilterIsNotNull datatype.

PARAMETER	DESCRIPTION
active	Whether the filter by event feature is active. TYPE: BoolLike
column	The column used when the filter by event feature is used. TYPE: ComponentColumnSelectorLike

FilterIsNotNullBatch

Bases: BaseBatch[FilterIsNotNullArrayLike]

__init__

def __init__(
    data: T | None, strict: bool | None = None
) -> None

Construct a new batch.

This method must flexibly accept native data (which comply with type T). Subclasses must provide a type parameter specifying the type of the native data (this is automatically handled by the code generator).

A value of None indicates that the component should be cleared and results in the creation of an empty array.

The actual creation of the Arrow array is delegated to the _native_to_pa_array() method, which is not implemented by default.

PARAMETER	DESCRIPTION
data	The data to convert into an Arrow array. TYPE: T | None
strict	Whether to raise an exception if the data cannot be converted into an Arrow array. If None, the value defaults to the value of the rerun.strict global setting. TYPE: bool | None DEFAULT: None

RETURNS	DESCRIPTION
The Arrow array encapsulating the data.

as_arrow_array

def as_arrow_array() -> Array

The component as an arrow batch.

Part of the rerun.ComponentBatchLike logging interface.

SelectedColumns

Bases: SelectedColumnsExt

Datatype: List of selected columns in a dataframe.

⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

__init__

def __init__(
    columns: Sequence[
        ComponentColumnSelectorLike | Utf8Like
    ],
) -> None

Create a new instance of the SelectedColumns datatype.

Example:

SelectedColumns(["timeline", "/entity/path:Component"])

PARAMETER	DESCRIPTION
columns	The columns to include. The column must be either of the timeline, or component kind. Timeline columns can be specified using a str without any :, or an Utf8. Component columns can be specified using either a str in the form of "/entity/path:Component", or a ComponentColumnSelector. TYPE: Sequence[ComponentColumnSelectorLike | Utf8Like]

SelectedColumnsBatch

Bases: BaseBatch[SelectedColumnsArrayLike]

__init__

def __init__(
    data: T | None, strict: bool | None = None
) -> None

Construct a new batch.

This method must flexibly accept native data (which comply with type T). Subclasses must provide a type parameter specifying the type of the native data (this is automatically handled by the code generator).

A value of None indicates that the component should be cleared and results in the creation of an empty array.

The actual creation of the Arrow array is delegated to the _native_to_pa_array() method, which is not implemented by default.

PARAMETER	DESCRIPTION
data	The data to convert into an Arrow array. TYPE: T | None
strict	Whether to raise an exception if the data cannot be converted into an Arrow array. If None, the value defaults to the value of the rerun.strict global setting. TYPE: bool | None DEFAULT: None

RETURNS	DESCRIPTION
The Arrow array encapsulating the data.

as_arrow_array

def as_arrow_array() -> Array

The component as an arrow batch.

Part of the rerun.ComponentBatchLike logging interface.

TensorDimensionIndexSlider

Bases: TensorDimensionIndexSliderExt

Datatype: Defines a slider for the index of some dimension.

⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

__init__

def __init__(dimension: TensorDimensionIndexSliderLike) -> None

Create a new instance of the TensorDimensionIndexSlider datatype.

PARAMETER	DESCRIPTION
dimension	The dimension number. TYPE: TensorDimensionIndexSliderLike

TensorDimensionIndexSliderBatch

Bases: BaseBatch[TensorDimensionIndexSliderArrayLike]

__init__

def __init__(
    data: T | None, strict: bool | None = None
) -> None

Construct a new batch.

This method must flexibly accept native data (which comply with type T). Subclasses must provide a type parameter specifying the type of the native data (this is automatically handled by the code generator).

A value of None indicates that the component should be cleared and results in the creation of an empty array.

The actual creation of the Arrow array is delegated to the _native_to_pa_array() method, which is not implemented by default.

PARAMETER	DESCRIPTION
data	The data to convert into an Arrow array. TYPE: T | None
strict	Whether to raise an exception if the data cannot be converted into an Arrow array. If None, the value defaults to the value of the rerun.strict global setting. TYPE: bool | None DEFAULT: None

RETURNS	DESCRIPTION
The Arrow array encapsulating the data.

as_arrow_array

def as_arrow_array() -> Array

The component as an arrow batch.

Part of the rerun.ComponentBatchLike logging interface.

TextLogColumn

Bases: TextLogColumnExt

Datatype: A text log column.

⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

__init__

def __init__(
    kind: TextLogColumnKindLike, *, visible: BoolLike = True
) -> None

Create a new instance of the TextLogColumn datatype.

PARAMETER	DESCRIPTION
kind	What kind of column is this? TYPE: TextLogColumnKindLike
visible	Is this column visible? TYPE: BoolLike DEFAULT: True

TextLogColumnBatch

Bases: BaseBatch[TextLogColumnArrayLike]

__init__

def __init__(
    data: T | None, strict: bool | None = None
) -> None

Construct a new batch.

This method must flexibly accept native data (which comply with type T). Subclasses must provide a type parameter specifying the type of the native data (this is automatically handled by the code generator).

A value of None indicates that the component should be cleared and results in the creation of an empty array.

The actual creation of the Arrow array is delegated to the _native_to_pa_array() method, which is not implemented by default.

PARAMETER	DESCRIPTION
data	The data to convert into an Arrow array. TYPE: T | None
strict	Whether to raise an exception if the data cannot be converted into an Arrow array. If None, the value defaults to the value of the rerun.strict global setting. TYPE: bool | None DEFAULT: None

RETURNS	DESCRIPTION
The Arrow array encapsulating the data.

as_arrow_array

def as_arrow_array() -> Array

The component as an arrow batch.

Part of the rerun.ComponentBatchLike logging interface.

TextLogColumnKind

Bases: Enum

Datatype: A text log column kind.

Body class-attribute instance-attribute

Body = 3

The text message the log has.

EntityPath class-attribute instance-attribute

EntityPath = 1

Which entity path this was logged to.

LogLevel class-attribute instance-attribute

LogLevel = 2

The log level, i.e INFO, WARN, ERROR.

__str__

def __str__() -> str

Returns the variant name.

auto classmethod

def auto(
    val: str | int | TextLogColumnKind,
) -> TextLogColumnKind

Best-effort converter, including a case-insensitive string matcher.

TextLogColumnKindBatch

Bases: BaseBatch[TextLogColumnKindArrayLike]

__init__

def __init__(
    data: T | None, strict: bool | None = None
) -> None

Construct a new batch.

This method must flexibly accept native data (which comply with type T). Subclasses must provide a type parameter specifying the type of the native data (this is automatically handled by the code generator).

A value of None indicates that the component should be cleared and results in the creation of an empty array.

The actual creation of the Arrow array is delegated to the _native_to_pa_array() method, which is not implemented by default.

PARAMETER	DESCRIPTION
data	The data to convert into an Arrow array. TYPE: T | None
strict	Whether to raise an exception if the data cannot be converted into an Arrow array. If None, the value defaults to the value of the rerun.strict global setting. TYPE: bool | None DEFAULT: None

RETURNS	DESCRIPTION
The Arrow array encapsulating the data.

as_arrow_array

def as_arrow_array() -> Array

The component as an arrow batch.

Part of the rerun.ComponentBatchLike logging interface.

TimelineColumn

Bases: TimelineColumnExt

Datatype: A timeline column in a table.

⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

__init__

def __init__(
    timeline: Utf8Like, *, visible: BoolLike = True
) -> None

Create a new instance of the TextLogColumn datatype.

PARAMETER	DESCRIPTION
timeline	What timeline is this? TYPE: Utf8Like
visible	Is this column visible? TYPE: BoolLike DEFAULT: True

TimelineColumnBatch

Bases: BaseBatch[TimelineColumnArrayLike]

__init__

def __init__(
    data: T | None, strict: bool | None = None
) -> None

Construct a new batch.

This method must flexibly accept native data (which comply with type T). Subclasses must provide a type parameter specifying the type of the native data (this is automatically handled by the code generator).

A value of None indicates that the component should be cleared and results in the creation of an empty array.

The actual creation of the Arrow array is delegated to the _native_to_pa_array() method, which is not implemented by default.

PARAMETER	DESCRIPTION
data	The data to convert into an Arrow array. TYPE: T | None
strict	Whether to raise an exception if the data cannot be converted into an Arrow array. If None, the value defaults to the value of the rerun.strict global setting. TYPE: bool | None DEFAULT: None

RETURNS	DESCRIPTION
The Arrow array encapsulating the data.

as_arrow_array

def as_arrow_array() -> Array

The component as an arrow batch.

Part of the rerun.ComponentBatchLike logging interface.

VisualizerComponentMapping

Bases: VisualizerComponentMappingExt

Datatype: Associate components of an entity to components of a visualizer.

⚠ TODO(#12600): The API for component mappings is still evolving, so this may change in the future.

⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

__init__

def __init__(
    target: Utf8Like,
    source_kind: ComponentSourceKindLike,
    *,
    source_component: str | None = None,
    selector: str | None = None,
) -> None

Create a new instance of the VisualizerComponentMapping datatype.

PARAMETER	DESCRIPTION
target	Target component name which is being mapped to. This represents a "slot" on the visualizer. TYPE: Utf8Like
source_kind	What kind of source to pick. TYPE: ComponentSourceKindLike
source_component	Component selector for mapping. Defaults to target if not specified. TYPE: str | None DEFAULT: None
selector	Optional selector string using jq-like syntax to pick a specific field on source_component. Example: ".x" picks a field called "x" from the source_component if present. Defaults to empty string if not specified. TYPE: str | None DEFAULT: None

VisualizerComponentMappingBatch

Bases: BaseBatch[VisualizerComponentMappingArrayLike]

__init__

def __init__(
    data: T | None, strict: bool | None = None
) -> None

Construct a new batch.

This method must flexibly accept native data (which comply with type T). Subclasses must provide a type parameter specifying the type of the native data (this is automatically handled by the code generator).

A value of None indicates that the component should be cleared and results in the creation of an empty array.

The actual creation of the Arrow array is delegated to the _native_to_pa_array() method, which is not implemented by default.

PARAMETER	DESCRIPTION
data	The data to convert into an Arrow array. TYPE: T | None
strict	Whether to raise an exception if the data cannot be converted into an Arrow array. If None, the value defaults to the value of the rerun.strict global setting. TYPE: bool | None DEFAULT: None

RETURNS	DESCRIPTION
The Arrow array encapsulating the data.

as_arrow_array

def as_arrow_array() -> Array

The component as an arrow batch.

Part of the rerun.ComponentBatchLike logging interface.