U x^@sdZddlZddlZddlmZddlmZddlmZddlmZdd lm Z d!d d Z d"d dZ d#ddZ d$ddZ ddZd%ddZddZddZd&ddZd'dd ZdS)(zSHelpers related to deprecation of functions, methods, classes, other functionality.N)compat) decorator)inject_docstring_text)inject_param_text)exccCstj|tj|ddSN stacklevelwarningswarnrSADeprecationWarningmsgr rD/tmp/pip-install-dq5v43_d/SQLAlchemy/sqlalchemy/util/deprecations.pywarn_deprecatedsrcCstj|tj|ddSr )rrrSAPendingDeprecationWarningrrrrwarn_pending_deprecationsr__init__cs$d|p dffdd}|S)N.. deprecated:: %s %scst|tjtdSNfunc)_decorate_cls_with_warningrrdict)cls constructorheadermessagerrdecorate s z deprecated_cls..decorater)versionr$r"r%rr!rdeprecated_clss r'Tcs8|rd|pdfnddkr&dfdd}|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. rrN$Call to deprecated function %(func)scst|tjt|jdSr)_decorate_with_warningrrr__name__fnr#r$rrr%Es zdeprecated..decoraterr&r$Zadd_deprecation_to_docstringr%rr-r deprecated,sr/c s8iD]\}\}}t||<q fdd}|S)a"Decorates a function to warn on use of certain parameters. e.g. :: @deprecated_params( weak_identity_map=( "0.7", "the :paramref:`.Session.weak_identity_map parameter " "is deprecated." ) ) cst|}|jdk r\tt|jt|jt|jd|jtt n dtt fdd}|j dk r|j pd}|rt |dd D}||}||_ |S)NrcsbD]*}|||krtj|tjddqD]"}||kr4tj|tjddq4|||SNr r r )r,argskwargsm)check_defaultscheck_kwdefaultsmessagesrrwarnedssz3deprecated_params..decorate..warnedrcSs&i|]\}\}}|d||pdfqS)rrr).0paramr&r$rrr s z7deprecated_params..decorate..)rZinspect_getfullargspecr6rzipr1lenset intersection differencer__doc__ritems)r,specr8doc decoratedr7specs)r4r5r6rr%ds2  z#deprecated_params..decorate)rB_sanitize_restructured_text)rGr:r&r$r%rrFrdeprecated_paramsPs +rIcs8|rd|pdfnddkr&dfdd}|S)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) %srNr(cst|tjt|jdSr)r)rrrr*r+r-rrr%s z%pending_deprecation..decoraterr.rr-rpending_deprecationsrJcCs|dkr |St||SdS)N)r)Zparameter_value default_valueZ warning_textrrrdeprecated_option_valuesrLcCsdd}td||S)NcSs$|dd\}}|dkr |d7}|S)Nrr)rmethz())group)r3type_namerrrreplsz)_sanitize_restructured_text..replz\:(\w+)\:`~?\.?(.+?)`)resub)textrQrrrrHsrHcCs|jdk r|jpd}|dk r~|t|d;}t||d}t|tkrnt|j}||d<t|j|j|}||}n||_t||}t||t |||d|S)NrrrrA) rArrtype__dict__r* __bases__getattrsetattrr))r r"wtyper$docstring_headerrDZclsdictZconstructor_fnrrrrs"      rcstttfdd}|jdk r*|jp,d}|dk rR|t|jd;}t||d}||}||_fdd|_|S) z=Wrap a function with a warnings.warn and augmented docstring.cstjdd|||Sr0rr)r,r1r2r$rZrrr8sz&_decorate_with_warning..warnedNrrrcstjddSr0r\rr]rrz(_decorate_with_warning..)rHrrArr*rZ_sa_warn)rrZr$r[r8rDrErr]rr)s r))r )r )r)NT)NT)N)N)rArRrrrZ langhelpersrrrrrrr'r/rIrJrLrHrr)rrrrs(         $C &