roboto.warnings
Module Contents
ExperimentalWarning
Bases: Warning
Warning category for experimental APIs.
experimental()
roboto.
roboto.
roboto.
Mark a class, function, or method as experimental.
Experimental APIs may be incomplete, subject to change, or removed without notice.
Prepends a .. warning:: notice to the target’s docstring, so documentation rendered from it and help() show the target as experimental, then returns the target itself.
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(): ...Parameters
targetThe object to mark when applied as @experimental, or the notice text when called as @experimental("...").
messageThe notice text. Defaults to “<qualified name of the target> is experimental and may change or be removed without notice.”
Raises
TypeErrorThe target is not callable, as when the decorator is placed above @property or @classmethod and not below it.