roboto.warnings

Module Contents

exception roboto.warnings.ExperimentalWarning

Bases: Warning

Warning issued when an experimental API is used.

Experimental APIs may be incomplete, subject to change, or removed without notice.

Users can suppress these warnings with:

import warnings
from roboto import ExperimentalWarning

warnings.filterwarnings("ignore", category=ExperimentalWarning)

roboto.warnings.experimental(target: type) → type

roboto.warnings.experimental(target: _F) → _F

roboto.warnings.experimental(target: str) → Callable[[type | _F], type | _F]

roboto.warnings.experimental(*, message: str) → Callable[[type | _F], type | _F]

Mark a class, function, or method as experimental.

Experimental APIs may be incomplete, subject to change, or removed without notice. When called, the decorated target emits an ExperimentalWarning.

Can be used in three ways:

@experimental
def my_function(): ...


@experimental("Custom message about this API.")
def my_function(): ...


@experimental(message="Custom message about this API.")
def my_function(): ...

roboto.warnings.roboto_default_warning_behavior()