Skip to content

text_internal.py

rerun.log.text_internal

class LogLevel dataclass

Represents the standard log levels.

This is a collection of constants rather than an enum because we do support arbitrary strings as level (e.g. for user-defined levels).

CRITICAL: Final = 'CRITICAL' class-attribute

Designates catastrophic failures.

ERROR: Final = 'ERROR' class-attribute

Designates very serious errors.

WARN: Final = 'WARN' class-attribute

Designates hazardous situations.

INFO: Final = 'INFO' class-attribute

Designates useful information.

DEBUG: Final = 'DEBUG' class-attribute

Designates lower priority information.

TRACE: Final = 'TRACE' class-attribute

Designates very low priority, often extremely verbose, information.

def log_text_entry_internal(entity_path, text, *, level=LogLevel.INFO, color=None, timeless=False)

Internal API to log a text entry, with optional level.

This implementation doesn't support extension components, or the exception-capturing decorator and is intended to be used from inside the other rerun log functions.

Parameters:

Name Type Description Default
entity_path str

The object path to log the text entry under.

required
text str

The text to log.

required
level Optional[str]

The level of the text entry (default: LogLevel.INFO). Note this can technically be an arbitrary string, but it's recommended to use one of the constants from LogLevel

LogLevel.INFO
color Optional[Sequence[int]]

Optional RGB or RGBA triplet in 0-255 sRGB.

None
timeless bool

Whether the text entry should be timeless.

False