o y\@sdZddlZddlZddlZddlmZddlmZddd Zdd d Z dd dZ dddZ ddZ dddZ ddZddZdS)zSHelpers related to deprecation of functions, methods, classes, other functionality.N) decorator)exccCtj|tj|ddSN stacklevel)warningswarnrSADeprecationWarningmsgr rN/var/www/html/env/lib/python3.10/site-packages/sqlalchemy/util/deprecations.pywarn_deprecatedrcCrr)r r rSAPendingDeprecationWarningrrrrwarn_pending_deprecationrrTc8|r d|pdfnddurdfdd}|S)aDecorates a function and issues a deprecation warning on use. :param version: Issue version in the warning. :param message: If provided, issue message in the warning. A sensible default is used if not provided. :param add_deprecation_to_docstring: Default True. If False, the wrapped function's __doc__ is left as-is. If True, the 'message' is prepended to the docs if provided, or sensible default if message is omitted. z.. deprecated:: %s %sN$Call to deprecated function %(func)sct|tjt|jdSNfunc)_decorate_with_warningrr dict__name__fnheadermessagerrdecorate4 zdeprecated..decoraterversionr$add_deprecation_to_docstringr%rr"r deprecatedsr*cr)aEDecorates a function and issues a pending deprecation warning on use. :param version: An approximate future version at which point the pending deprecation will become deprecated. Not used in messaging. :param message: If provided, issue message in the warning. A sensible default is used if not provided. :param add_deprecation_to_docstring: Default True. If False, the wrapped function's __doc__ is left as-is. If True, the 'message' is prepended to the docs if provided, or sensible default if message is omitted. z.. deprecated:: %s (pending) %srNrcrr)rrrrrr r"rrr%Zr&z%pending_deprecation..decoraterr'rr"rpending_deprecation?sr+cCsdd}td||S)NcSs$|dd\}}|dvr|d7}|S)Nrr)rmethz())group)mtype_namerrrreplfsz)_sanitize_restructured_text..replz\:(\w+)\:`~?\.?(.+?)`)resub)textr1rrr_sanitize_restructured_textesr5csdttfdd}|jdur|jpd}|dur)|t|jd;}t||d}||}||_|S)z=Wrap a function with a warnings.warn and augmented docstring.cstjdd||i|S)Nrr )r r )r!argskwargsr$wtyperrwarnedtsz&_decorate_with_warning..warnedNrrr)r5r__doc__rrinject_docstring_text)rr9r$docstring_headerr:doc decoratedrr8rros rcCsJ|dd}t|dkr|S|\}}|ds |dt|St|S)N r )splitlen startswithtextwrapdedent)r4 split_text firstline remainingrrr_dedent_docstrings    rJcCst|pd}|d}t|d}|dr|ddddt|D}|dd|t|t|d}|d||||d}d|S)Nrr@rcSsg|] \}}|s|qSr)strip).0numlinerrr sz)inject_docstring_text..r) rJrBrErFinsert enumerateminrCjoin)doctext injecttextposlines injectlinesblanks inject_posrrrr<s     r<)r)NT)N)r;r2rEr langhelpersrrrrrr*r+r5rrJr<rrrrs     % &