(
    deprecated_version: str,
    removed_version: str,
    name: Optional[str] = None,
    text: Optional[str] = None,
)
return _deprecated_wrapper
Decorate class or function as deprecated.

    Args:
        deprecated_version:
            The version in which the target feature is deprecated.
        removed_version:
            The version in which the target feature will be removed.
        name:
            The name of the feature. Defaults to the function or class name. Optional.
        text:
            The additional text for the deprecation note. The default note is build using specified
            ``deprecated_version`` and ``removed_version``. If you want to provide additional
            information, please specify this argument yourself.

            .. note::
                The default deprecation note is as follows: "Deprecated in v{d_ver}. This feature
                will be removed in the future. The removal of this feature is currently scheduled
                for v{r_ver}, but this schedule is subject to change. See
                https://github.com/optuna/optuna/releases/tag/v{d_ver}."

            .. note::
                The specified text is concatenated after the default deprecation note.
Decorate class or function as deprecated.
Decorate class or function as deprecated .
def deprecated(
    deprecated_version: str,
    removed_version: str,
    name: Optional[str] = None,
    text: Optional[str] = None,
) -> Any:
    """Decorate class or function as deprecated.

    Args:
        deprecated_version:
            The version in which the target feature is deprecated.
        removed_version:
            The version in which the target feature will be removed.
        name:
            The name of the feature. Defaults to the function or class name. Optional.
        text:
            The additional text for the deprecation note. The default note is build using specified
            ``deprecated_version`` and ``removed_version``. If you want to provide additional
            information, please specify this argument yourself.

            .. note::
                The default deprecation note is as follows: "Deprecated in v{d_ver}. This feature
                will be removed in the future. The removal of this feature is currently scheduled
                for v{r_ver}, but this schedule is subject to change. See
                https://github.com/optuna/optuna/releases/tag/v{d_ver}."

            .. note::
                The specified text is concatenated after the default deprecation note.
    """

    _validate_version(deprecated_version)
    _validate_version(removed_version)
    _validate_two_version(deprecated_version, removed_version)

    def _deprecated_wrapper(f: Any) -> Any:
        # f is either func or class.

        def _deprecated_func(func: Callable[[Any], Any]) -> Callable[[Any], Any]:
            """Decorates a function as deprecated.

            This decorator is supposed to be applied to the deprecated function.
            """
            if func.__doc__ is None:
                func.__doc__ = ""

            note = _DEPRECATION_NOTE_TEMPLATE.format(
                d_ver=deprecated_version, r_ver=removed_version
            )
            if text is not None:
                note += _format_text(text)
            indent = _get_docstring_indent(func.__doc__)
            func.__doc__ = func.__doc__.strip() + textwrap.indent(note, indent) + indent

            # TODO(mamu): Annotate this correctly.
            @functools.wraps(func)
            def new_func(*args: Any, **kwargs: Any) -> Any:
                message = _DEPRECATION_WARNING_TEMPLATE.format(
                    name=(name if name is not None else func.__name__),
                    d_ver=deprecated_version,
                    r_ver=removed_version,
                )
                if text is not None:
                    message += " " + text
                warnings.warn(message, FutureWarning, stacklevel=2)

                return func(*args, **kwargs)  # type: ignore

            return new_func

        def _deprecated_class(cls: Any) -> Any:
            """Decorates a class as deprecated.

            This decorator is supposed to be applied to the deprecated class.
            """
            _original_init = cls.__init__

            @functools.wraps(_original_init)
            def wrapped_init(self, *args, **kwargs) -> None:  # type: ignore
                message = _DEPRECATION_WARNING_TEMPLATE.format(
                    name=(name if name is not None else cls.__name__),
                    d_ver=deprecated_version,
                    r_ver=removed_version,
                )
                if text is not None:
                    message += " " + text
                warnings.warn(
                    message,
                    FutureWarning,
                    stacklevel=2,
                )

                _original_init(self, *args, **kwargs)

            cls.__init__ = wrapped_init

            if cls.__doc__ is None:
                cls.__doc__ = ""

            note = _DEPRECATION_NOTE_TEMPLATE.format(
                d_ver=deprecated_version, r_ver=removed_version
            )
            if text is not None:
                note += _format_text(text)
            indent = _get_docstring_indent(cls.__doc__)
            cls.__doc__ = cls.__doc__.strip() + textwrap.indent(note, indent) + indent

            return cls

        return _deprecated_class(f) if inspect.isclass(f) else _deprecated_func(f)

    return _deprecated_wrapper
def deprecated ( deprecated_version : str , removed_version : str , name : Optional [ str ] = None , text : Optional [ str ] = None , ) -> Any : _validate_version ( deprecated_version ) _validate_version ( removed_version ) _validate_two_version ( deprecated_version , removed_version ) def _deprecated_wrapper ( f : Any ) -> Any : # f is either func or class. def _deprecated_func ( func : Callable [ [ Any ] , Any ] ) -> Callable [ [ Any ] , Any ] : """Decorates a function as deprecated.

            This decorator is supposed to be applied to the deprecated function.
            """ if func . __doc__ is None : func . __doc__ = "" note = _DEPRECATION_NOTE_TEMPLATE . format ( d_ver = deprecated_version , r_ver = removed_version ) if text is not None : note += _format_text ( text ) indent = _get_docstring_indent ( func . __doc__ ) func . __doc__ = func . __doc__ . strip ( ) + textwrap . indent ( note , indent ) + indent # TODO(mamu): Annotate this correctly. @ functools . wraps ( func ) def new_func ( * args : Any , * * kwargs : Any ) -> Any : message = _DEPRECATION_WARNING_TEMPLATE . format ( name = ( name if name is not None else func . __name__ ) , d_ver = deprecated_version , r_ver = removed_version , ) if text is not None : message += " " + text warnings . warn ( message , FutureWarning , stacklevel = 2 ) return func ( * args , * * kwargs ) # type: ignore return new_func def _deprecated_class ( cls : Any ) -> Any : """Decorates a class as deprecated.

            This decorator is supposed to be applied to the deprecated class.
            """ _original_init = cls . __init__ @ functools . wraps ( _original_init ) def wrapped_init ( self , * args , * * kwargs ) -> None : # type: ignore message = _DEPRECATION_WARNING_TEMPLATE . format ( name = ( name if name is not None else cls . __name__ ) , d_ver = deprecated_version , r_ver = removed_version , ) if text is not None : message += " " + text warnings . warn ( message , FutureWarning , stacklevel = 2 , ) _original_init ( self , * args , * * kwargs ) cls . __init__ = wrapped_init if cls . __doc__ is None : cls . __doc__ = "" note = _DEPRECATION_NOTE_TEMPLATE . format ( d_ver = deprecated_version , r_ver = removed_version ) if text is not None : note += _format_text ( text ) indent = _get_docstring_indent ( cls . __doc__ ) cls . __doc__ = cls . __doc__ . strip ( ) + textwrap . indent ( note , indent ) + indent return cls return _deprecated_class ( f ) if inspect . isclass ( f ) else _deprecated_func ( f ) return _deprecated_wrapper