o ci @sddlZddlZddlmZmZddlmZddlmZe e Z dZ ddddde dee d ee d eeeefd df d d ZddddddZdS)N)OptionalUnion)log_once)_mark_annotated)helperroroldnewrrreturncCsfd||r d|n|rd|nd}|r(t|ts$t|tr$||t|td|ddS)ayWarns (via the `logger` object) or throws a deprecation warning/error. Args: old: A description of the "thing" that is to be deprecated. new: A description of the new "thing" that replaces it. help: An optional help text to tell the user, what to do instead of using `old`. error: Whether or which exception to raise. If True, raise ValueError. If False, just warn. If `error` is-a subclass of Exception, raise that Exception. Raises: ValueError: If `error=True`. Exception: Of type `error`, iff `error` is a sub-class of `Exception`. z`{}` has been deprecated.{}z Use `{}` instead. zDeprecationWarning: z( This will raise an error in the future!N)format isinstancebool issubclass Exception ValueErrorloggerwarning)r r rrmsgrO/home/ubuntu/.local/lib/python3.10/site-packages/ray/rllib/utils/deprecation.pydeprecation_warnings  r)r rcsfdd}|S)aDecorator for documenting a deprecated class, method, or function. Automatically adds a `deprecation.deprecation_warning(old=..., error=False)` to not break existing code at this point to the decorated class' constructor, method, or function. In a next major release, this warning should then be made an error (by setting error=True), which means at this point that the class/method/function is no longer supported, but will still inform the user about the deprecation event. In a further major release, the class, method, function should be erased entirely from the codebase. .. testcode:: :skipif: True from ray.rllib.utils.deprecation import Deprecated # Deprecated class: Patches the constructor to warn if the class is # used. @Deprecated(new="NewAndMuchCoolerClass", error=False) class OldAndUncoolClass: ... # Deprecated class method: Patches the method to warn if called. class StillCoolClass: ... @Deprecated(new="StillCoolClass.new_and_much_cooler_method()", error=False) def old_and_uncool_method(self, uncool_arg): ... # Deprecated function: Patches the function to warn if called. @Deprecated(new="new_and_much_cooler_function", error=False) def old_and_uncool_function(*uncool_args): ... csPtrjfdd}|_tSfdd}|S)Ncs2tpjrtp jd|i|SN)r r rrr__name__rargskwargs)rrr objobj_initr rr patched_initesz0Deprecated.._inner..patched_initcs2tpjrtp jd|i|Srrr)rrr r r rr_ctorwsz)Deprecated.._inner.._ctor)inspectisclass__init__r)r r"r#rrr r )r r!r_inner_s   zDeprecated.._innerr)r r rrr(rr'r Deprecated7s('r))N)r$loggingtypingrrray.utilrray.util.annotationsr getLoggerrrDEPRECATED_VALUEstrrrrr)rrrrs.    '