o `۷i@sddlZddlZddlmZddlmZmZmZmZm Z m Z m Z ddl m Z ddlmZededefdZeeZd Z dddd d d ed eedeedee eeefdeddf ddZe ddddd dd eedeede eeefdeegeff ddZe dddd ed eedeede eeefdeegeff ddZ ddddd eed eedeede eeefdeegeff ddZdS)N)wraps)AnyCallableOptionalTypeVarUnioncastoverload)log_once)_mark_annotatedF.)bound)helperror stackleveloldnewrrrreturncCsjd||r d|n|rd|nd}|r(t|ts$t|tr$||t|tjd|d|ddS) a'Warns (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. stacklevel: The stacklevel to use for the warning message. Use 2 to point to where this function is called, 3+ to point further up the stack. 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!)rN)format isinstancebool issubclass Exception ValueErrorloggerwarning)rrrrrmsgr!M/home/ubuntu/vllm_env/lib/python3.10/site-packages/ray/_common/deprecation.pydeprecation_warnings   r#)rrcCdSNr!rrrrr!r!r" DeprecatedBr'cCr$r%r!r&r!r!r"r'Mr(cs dtdtffdd }|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._common.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): ... objrcsjtrjfdd}|_tSfdd}tr0t|}tt|S)Ncs4tpjrtp jdd|i|SN)rrrrrr __name__r#argskwargs)rrrr)obj_initrr!r" patched_initsz0Deprecated.._inner..patched_initcs4tpjrtp jdd|i|Sr*r,r.)rrrr)rr!r"_ctorsz)Deprecated.._inner.._ctor)inspectisclass__init__r callablerrr )r)r2r3rrrr)r)r1r"_inners    zDeprecated.._inner)r )rrrrr9r!r8r"r'Xs./r%)r4logging functoolsrtypingrrrrrrr ray.utilr ray.util.annotationsr r getLoggerr-rDEPRECATED_VALUEstrrtyperintr#r'r!r!r!r"s $    ,