a .Sicm@sNdZddlZddlZddlZddlZddlmZddlm Z ddlm Z ddlm Z ddlm Z ddlm Z dd lmZd aiZGd d d eZd dZddZddZddZd3ddZddZddZd4ddZddZd5d d!Zed"gd#Zd$d%Z d6d&d'Z!d(d)Z"d*d+Z#e j$d,d-Z%d.d/Z&Gd0d1d1e'Z(e(Z)e(d2Z*dS)7zTensor utility functions.N) tf_logging)decorator_utils)is_in_graph_mode) tf_contextlib) tf_decorator) tf_inspect) doc_controlsTc@seZdZdZdS)DeprecatedNamesAlreadySetzHRaised when setting deprecated names multiple times for the same symbol.N)__name__ __module__ __qualname____doc__rr^/var/www/html/django/DPS/env/lib/python3.9/site-packages/tensorflow/python/util/deprecation.pyr &sr cCs>d|durdnd|g}|r(|dtj||dd|dd S) zBAdds a deprecation notice to a docstring for deprecated functions.z3THIS FUNCTION IS DEPRECATED. It will be removed %s.Nin a future versionafter %sInstructions for updating:zDEPRECATED FUNCTION (deprecated) DeprecatedZ notice_type)appendradd_notice_to_docstring)docdate instructionsZ main_textrrr,_add_deprecated_function_notice_to_docstring+s rc Cs@dt|}tj||ddd||dur*dnd|fdgd d S) BAdds a deprecation notice to a docstring for deprecated arguments., zDEPRECATED FUNCTION ARGUMENTSz(deprecated arguments)z?SOME ARGUMENTS ARE DEPRECATED: `(%s)`. They will be removed %s.Nrrrrr)joinsortedrr)rrrZdeprecated_namesdeprecation_stringrrr'_add_deprecated_arg_notice_to_docstring:sr!cCsRdddt|D}|dur(dnd|}tj||ddd ||fd gd d S) rrcss|]\}}d||fVqdS)z%s=%rNr).0keyvaluerrr Qsz@_add_deprecated_arg_value_notice_to_docstring..Nrrz#DEPRECATED FUNCTION ARGUMENT VALUESz(deprecated argument values)zESOME ARGUMENT VALUES ARE DEPRECATED: `(%s)`. They will be removed %s.rrr)rritemsrr)rrrZdeprecated_name_value_dictr whenrrr-_add_deprecated_arg_value_notice_to_docstringMs   r(cCs2|dur"td|s"td||s.tddS)Nz20\d\d-[01]\d-[0123]\dz-Date must be in format YYYY-MM-DD. Received: z\Don't deprecate things without conversion instructions! Specify the `instructions` argument.)rematch ValueError)rrrrr_validate_deprecation_argscs r,FcCs8tjj}|o|j}|r&|dur&|}d|jj|jS)z7Returns call location given level up from current call.Nz{}:{})inspect currentframef_backformatf_code co_filenamef_lineno)outerfparentrrr_call_locationls    r7cCs(|dus|dur |duo|duS||kSNr)abrrr_safe_eqysr;csfdd}|S)aIndicate that one function wraps another. This decorator wraps a function using `tf_decorator.make_decorator` so that doc generation scripts can pick up original function signature. It would be better to use @functools.wrap decorator, but it would not update function signature to match wrapped function in Python 2. Args: wrapped_function: The function that decorated function wraps. Returns: Function that accepts wrapper function as an argument and returns `TFDecorator` instance. cs t|Sr8)rmake_decorator)Z wrapper_funcwrapped_functionrrwrappersz _wrap_decorator..wrapperr)r>r?rr=r_wrap_decorators r@c svtr*GfdddStdtfddtdtj ddSdS)ayDeprecate a symbol in favor of a new name with identical semantics. This function is meant to be used when defining a backwards-compatibility alias for a symbol which has been moved. For example: module1.py: ```python class NewNameForClass: pass ``` module2.py: ```python import module1 DeprecatedNameForClass = deprecated_alias( deprecated_name='module2.DeprecatedNameForClass', name='module1.NewNameForClass', func_or_class=module1.NewNameForClass) ``` This function works for classes and functions. For classes, it creates a new class which is functionally identical (it inherits from the original, and overrides its constructor), but which prints a deprecation warning when an instance is created. It also adds a deprecation notice to the class' docstring. For functions, it returns a function wrapped by `tf_decorator.make_decorator`. That function prints a warning when used, and has a deprecation notice in its docstring. This is more or less equivalent (the deprecation warning has slightly different text) to writing: ```python @deprecated def deprecated_alias(original_args): real_function(original_args) ``` Args: deprecated_name: The name of the symbol that is being deprecated, to be used in the warning message. This should be its fully qualified name to avoid confusion. name: The name of the symbol that is to be used instead of the deprecated name. This should be a fully qualified name to avoid confusion. func_or_class: The (non-deprecated) class or function for which a deprecated alias should be created. warn_once: If True (the default), only print a deprecation warning the first time this function is used, or the class is instantiated. Returns: A wrapped version of `func_or_class` which prints a deprecation warning on use and has a modified docstring. cs^eZdZejjddddgddZjZeddZejfd d ZZ S) z#deprecated_alias.._NewClassPlease use %s instead.zDEPRECATED CLASSrzBTHIS CLASS IS DEPRECATED. It will be removed in a future version. rrT)r4csptjdrjjjj_n jjj_trVjtvrVrDdtj<tdtt |j|i|dS)N__func__T;From %s: The name %s is deprecated. Please use %s instead. ) hasattr__init__r rB_PRINT_DEPRECATION_WARNINGS_PRINTED_WARNINGloggingwarningr7super)selfargskwargs) _NewClass __class__deprecated_name func_or_classname warn_oncerrrEs    z,deprecated_alias.._NewClass.__init__) r r r rrr r7r@rE __classcell__r)rNrPrQrRrSrOrrNs  rN deprecatedcs8tr*tvr*rdt<tdt|i|S)NTrC)rFrGrHrIr7rLrM)rPrQrRnew_funcrSrrrXsz"deprecated_alias..new_funcNrA) risclassrvalidate_callable functoolswrapsrr<rr )rPrRrQrSr)rNrPrQrRrXrSrdeprecated_aliass6 "   r]csfdd}|S)aDecorator for marking endpoints deprecated. This decorator does not print deprecation messages. TODO(annarev): eventually start printing deprecation warnings when @deprecation_endpoints decorator is added. Args: *args: Deprecated endpoint names. Returns: A function that takes symbol as an argument and adds _tf_deprecated_api_names to that symbol. _tf_deprecated_api_names would be set to a list of deprecated endpoint names for the symbol. cs4d|jvr*td|jdd|jd|_|S)N_tf_deprecated_api_namesz Cannot set deprecated names for z to z&. Deprecated names are already set to .)__dict__r r r^funcrLrrdeprecated_wrappers z0deprecated_endpoints..deprecated_wrapperr)rLrdrrcrdeprecated_endpointss recstfdd}|S)aDecorator for marking functions or methods deprecated. This decorator logs a deprecation warning whenever the decorated function is called. It has the following format: (from ) is deprecated and will be removed after . Instructions for updating: If `date` is None, 'after ' is replaced with 'in a future version'. will include the class name if it is a method. It also edits the docstring of the function: ' (deprecated)' is appended to the first line of the docstring and a deprecation notice is prepended to the rest of the docstring. Args: date: String or None. The date the function is scheduled to be removed. Must be ISO 8601 (YYYY-MM-DD), or None. instructions: String. Instructions on how to update code using the deprecated function. warn_once: Boolean. Set to `True` to warn only the first time the decorated function is called. Otherwise, every call will log a warning. Returns: Decorated function or method. Raises: ValueError: If date is not None or in ISO 8601 format, or instructions are empty. c st|tr2|}|jtjur&|jd}q>|jd}n d}d}|tdtfdd}t |t |dt j}|dur|St|||t |j|_|SdS)Deprecation wrapper.rE__new__NrVcsTtrFtvrFrdt<tdttjdur:dnd|i|S)NTzYFrom %s: %s (from %s) is deprecated and will be removed %s. Instructions for updating: %srr)rFrGrHrIr7rget_qualified_namer rW)rrbrrSrrrXXs z8deprecated..deprecated_wrapper..new_func) isinstancetypergobjectrErrZr[r\rZset_deprecatedrr<rr setattr)rQclsZconstructor_namerXrrrSrarrdFs6     z&deprecated..deprecated_wrapper)r,)rrrSrdrrnrrV$s 3rVDeprecatedArgSpec)position has_ok_valueok_valuecststd|rFt|dgkrF|ddtd||ddfdd}dd |fd d }|S) aDecorator for marking specific function arguments as deprecated. This decorator logs a deprecation warning whenever the decorated function is called with the deprecated argument. It has the following format: Calling (from ) with is deprecated and will be removed after . Instructions for updating: If `date` is None, 'after ' is replaced with 'in a future version'. includes the class name if it is a method. It also edits the docstring of the function: ' (deprecated arguments)' is appended to the first line of the docstring and a deprecation notice is prepended to the rest of the docstring. Args: date: String or None. The date the function is scheduled to be removed. Must be ISO 8601 (YYYY-MM-DD), or None. instructions: String. Instructions on how to update code using the deprecated function. *deprecated_arg_names_or_tuples: String or 2-Tuple (String, ok_val). The string is the deprecated argument name. Optionally, an ok-value may be provided. If the user provided argument equals this value, the warning is suppressed. **kwargs: If `warn_once=False` is passed, every call with a deprecated argument will log a warning. The default behavior is to only warn the first time the function is called with any given deprecated argument. All other kwargs raise `ValueError`. Returns: Decorated function or method. Raises: ValueError: If date is not None or in ISO 8601 format, instructions are empty, the deprecated arguments are not present in the function signature, the second element of a deprecated_tuple is not a list, or if a kwarg other than `warn_once` is passed. z%Specify which argument is deprecated.rSNz,Illegal argument passed to deprecated_args: TcsFi}D]8}t|tr0tdd|d||d<qtddd||<q|S)zBReturns a dict mapping arg_name to DeprecatedArgSpec w/o position.TrFN)rituplero)d name_or_tuple)deprecated_arg_names_or_tuplesrr_get_arg_names_to_ok_valss  z2deprecated_args.._get_arg_names_to_ok_valscSs`|j|j}ddt|D}i}t|D],\}}||vr.||}t||j|j||<q.|S)aBuilds a dictionary from deprecated arguments to their spec. Returned dict is keyed by argument name. Each value is a DeprecatedArgSpec with the following fields: position: The zero-based argument position of the argument within the signature. None if the argument isn't found in the signature. ok_values: Values of this argument for which warning will be suppressed. Args: names_to_ok_vals: dict from string arg_name to a list of values, possibly empty, which should not elicit a warning. arg_spec: Output from tf_inspect.getfullargspec on the called function. Returns: Dictionary from arg_name to DeprecatedArgSpec. cSsi|]\}}||qSrr)r"posrRrrr szQdeprecated_args.._get_deprecated_positional_arguments..)rL kwonlyargs enumerateiterr&rorqrr)Znames_to_ok_valsarg_specZ arg_spaceZarg_name_to_posZdeprecated_positional_argsarg_namespecrzrrr$_get_deprecated_positional_argumentss  z=deprecated_args.._get_deprecated_positional_argumentsc stdt j vj vtt krjjjjgfdd D}t d|ddddt    f d d }t j  t }t|d |S) Deprecation decorator.deprecated_argscsg|]}|vr|qSrr)r"r) known_argsrr sz?deprecated_args..deprecated_wrapper..zNThe following deprecated arguments are not present in the function signature: z.. Expected arguments from the following list: r_cSsB||ur dSz||k}t|tr&|WSWnty<YdS0dS)aA comparison operation that works for multiple object types. Returns True for two empty lists, two numeric values with the same value, etc. Returns False for (pd.DataFrame, None), and other pairs which should not be considered equivalent. Args: a: value one of the comparison. b: value two of the comparison. Returns: A boolean indicating whether the two inputs are the same value for the purposes of deprecation. TF)ribool TypeError)r9r:equalityrrr _same_values   z@deprecated_args..deprecated_wrapper.._same_valuec sHtr:tr:g}tjg|Ri|}tD]6\}}|jt|kr8|j rd|||j s8| |q8rt|tj kr| j r|r| jD]4}||vr|j rԈ|||j s| |q|D]T}|ftvr rdt|f<tdttj|dur,dndq|i|S)rfTziFrom %s: calling %s (from %s) with %s is deprecated and will be removed %s. Instructions for updating: %sNrr)rIS_IN_GRAPH_MODErFr getcallargsr~r&rplenrqrrrrLvarargsvarkwrGrHrIr7rrhr )rLrM invalid_args named_argsrr) rrrdeprecated_arg_namesdeprecated_positionsrbris_kwargs_deprecatedis_varargs_deprecatedrSrrrXsF       z=deprecated_args..deprecated_wrapper..new_funcrV)rrZrgetfullargspecrrrrLr|r+r[r\r!r rkeysrr<)rbZ missing_argsrXrrrrrxrrS)rrrrbrrrrrds<        #z+deprecated_args..deprecated_wrapper)r,r+listrpopget)rrrxrMryrdrrrrs)    [rc s,tstdfdd}|S)aDDecorator for marking specific function argument values as deprecated. This decorator logs a deprecation warning whenever the decorated function is called with the deprecated argument values. It has the following format: Calling (from ) with = is deprecated and will be removed after . Instructions for updating: If `date` is None, 'after ' is replaced with 'in a future version'. will include the class name if it is a method. It also edits the docstring of the function: ' (deprecated arguments)' is appended to the first line of the docstring and a deprecation notice is prepended to the rest of the docstring. Args: date: String or None. The date the function is scheduled to be removed. Must be ISO 8601 (YYYY-MM-DD), or None instructions: String. Instructions on how to update code using the deprecated function. warn_once: If `True`, warn only the first time this function is called with deprecated argument values. Otherwise, every call (with a deprecated argument value) will log a warning. **deprecated_kwargs: The deprecated argument values. Returns: Decorated function or method. Raises: ValueError: If date is not None or in ISO 8601 format, or instructions are empty. z-Specify which argument values are deprecated.csJtdtfdd}tj}t|d|S)rdeprecated_arg_valuesc strtjg|Ri|}D]l\}}||vr$t|||r$|ftvr$r^dt|f<tdtt j ||durdndq$|i|S)rfTzlFrom %s: calling %s (from %s) with %s=%s is deprecated and will be removed %s. Instructions for updating: %sNrr) rFrrr&r;rGrHrIr7rrhr )rLrMrr arg_value)rdeprecated_kwargsrbrrSrrrXds$   zCdeprecated_arg_values..deprecated_wrapper..new_funcrV)rrZr[r\r(r rr<)rbrXrrrrrSrarrdas  z1deprecated_arg_values..deprecated_wrapper)r,r+)rrrSrrdrrrr:s # rcCs.|dur*|dur&td|d|d|S|S)aLooks up deprecated argument name and ensures both are not used. Args: new_name: new name of argument new_value: value of new argument (or None if not used) old_name: old name of argument old_value: value of old argument (or None if not used) Returns: The effective argument that should be used. Raises: ValueError: if new_value and old_value are both non-null NzCannot specify both 'z' and 'z'.)r+)new_name new_valueold_name old_valuerrrdeprecated_argument_lookup~s rcCs$|d|d|d|d|S)Nz`%s`z%s:)replace)Zold_docZ old_argumentZ new_argumentrrrrewrite_argument_docstrings rccst}dadV|adS)z)Temporarily silence deprecation warnings.FN)rF)Zprint_deprecation_warningsrrrsilencesrcsfddS)auLogs a warning when a module that has been moved to a new location is used. Copy the following code into the old module: ``` import deprecation import new_module __getattr__ = deprecation.deprecate_moved_module( __name__, new_module, "2.9") # adjust version number. ``` Args: deprecated_name: Name of old module. new_module: Module to replace the old module. deletion_version: Version of TensorFlow in which the old module will be removed. Returns: A function that logs a warning and returns the symbol from the new module. Set this function as the module's `__getattr__`. cs0tvr&tr&dt<tdjt|S)NTzfPlease fix your imports. Module %s has been moved to %s. The old module will be deleted in version %s.)rGrFrHrIr getattr)rRdeletion_versionrPgetter new_modulerrrs z&deprecate_moved_module..getterr)rPrrrrrdeprecate_moved_modulesrcs eZdZdZfddZZS)HiddenTfApiAttributea&Hides a class attribute from the public API. Attributes in public classes can be hidden from the API by having an '_' in front of the name (e.g. ClassName._variables). This doesn't work when attributes or methods are inherited from a parent class. To hide inherited attributes, set their values to be `deprecation.hide_attribute_from_api`. For example, this is used in V2 Estimator to hide the deprecated export_savedmodel method: class EstimatorV2(Estimator): export_savedmodel = deprecation.hide_attribute_from_api('...') cs fdd}tt||dS)Ncs tdSr8)AttributeError)Z unused_selfdeprecation_messagerr raise_errorsz2HiddenTfApiAttribute.__init__..raise_error)rJrrE)rKrrrUrrrEs zHiddenTfApiAttribute.__init__)r r r r rErTrrrUrrs rz#This attribute has been deprecated.)F)T)T)T)+r collectionsr[r-r)tensorflow.python.platformrrHtensorflow.python.utilrrrrrZtensorflow.tools.docsrrFrG Exceptionr rr!r(r,r7r;r@r]rerV namedtuplerorrrrcontextmanagerrrpropertyrZhide_attribute_from_apiZHIDDEN_ATTRIBUTErrrrsL         s X; D "