U
|
¸ý°dè0 ã @ s d Z ddlmZ ddlZddlmZ ddlmZ ddlmZ ddlmZ ddlm Z dd lm
|
Z
|
dd
|
lm Z dd lm Z dd lm Z dd lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ededZedddZdNd d d d d d d!d"d#ZdOd d d d d d%d&d'Z dPd d(d d d d d)d*d+Z dQd d d d-d.d/d0Z dRd d d2d3d2d4d5d6d7Z d d8d9d:d;d<Z dSd d d8d4d=d>d?Z!d@d4dAdBdCZ"d d dDdEdFZ#dTdGd d d d d dGdHdIdJZ$dUdd d d d d2ddKdLdMZ%dS )VzSHelpers related to deprecation of functions, methods, classes, other
|
functionality.é )Ú annotationsN)ÚAny)ÚCallable)ÚDict)ÚMatch)ÚOptional)ÚSequence)ÚSet)ÚTuple)ÚType)ÚTypeVar)ÚUnioné )Úcompat)Ú_hash_limit_string)Ú_warnings_warn)Ú decorator)Úinject_docstring_text)Úinject_param_texté )ÚexcÚ_T)ÚboundÚ_FzCallable[..., Any]Ústrz Type[exc.SADeprecationWarning]Úintz Optional[str]ÚNone)ÚmsgÚversionÚtype_Ú
|
stacklevelÚcodeÚreturnc C s& || |d}||_ t||d d d S )N©r! r ©r )Zdeprecated_sincer )r r r r r! Úwarn© r& úSd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\sqlalchemy/util/deprecations.pyÚ_warn_with_version* s r( é )r r r r! r" c C s t | |tj||d d S )Nr# )r( r ÚSADeprecationWarning)r r r r! r& r& r' Úwarn_deprecated7 s ÿr+ z Sequence[Any])r Úargsr r r! r" c C s( |rt | d|} t| |tj||d dS )zhIssue a deprecation warning with a parameterized string,
|
limiting the number of registrations.
|
|
é
|
r# N)r r( r r* )r r, r r r! r& r& r' Úwarn_deprecated_limited? s ÿr. Ú__init__z Callable[[Type[_T]], Type[_T]])r ÚmessageÚ constructorr" c s. dp
|
df ddd fdd }|S )Nú.. deprecated:: %s %sÚ úType[_T])Úclsr" c s t | tjt d S )N©Úfunc)Ú_decorate_cls_with_warningr r* Údict)r5 ©r1 Úheaderr0 r r& r' ÚdecorateV s úz deprecated_cls.<locals>.decorater& )r r0 r1 r< r& r: r' Údeprecated_clsQ s
|
r= TÚboolz(Optional[Type[exc.SADeprecationWarning]]zCallable[[_F], _F])r r0 Ú add_deprecation_to_docstringÚwarningÚenable_warningsr" c s` |rdpdf nddkr&ddkr4t jd 7 ddd fdd }|S )
|
aá Decorates 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.
|
|
r2 r3 Nz$Call to deprecated function %(func)sz (deprecated since: %s)r ©Úfnr" c s8 d k s t d k st t| t| jd dS )Nr6 )rA )ÚAssertionErrorÚ_decorate_with_warningr9 Ú__name__)rC ©rA r; r0 r r@ r& r' r< s úz deprecated.<locals>.decorate)r r* )r r0 r? r@ rA r< r& rG r' Ú
|
deprecatedc s þ rH r z0Callable[[Callable[..., _T]], Callable[..., _T]])r0 Úkwr" c K s t d| tjd|S )Nú2.0©r0 r@ )rJ )rH r ZMovedIn20Warning)r0 rI r& r& r' Úmoved_20 s ÿ ÿÿrL )Úapi_nameÚ alternativerI r" c K s t d| ¡}|r(dddd| d¡ }nd}d| |d f }d
|
| krl| d d ¡}|sl| d ¡d ksltd| |r||d| 7 }tj}td||d|S )Nz^:(attr|func|meth):Ú attributeÚfunctionÚmethod)Úattrr7 Úmethr Z constructzPThe %s %s is considered legacy as of the 1.x series of SQLAlchemy and %s in 2.0.zbecomes a legacy constructz:attr:Zwarn_on_attribute_accessFrA zattribute %s will emit a warning on read access. If you *really* want this, add warn_on_attribute_access=True. Otherwise please add enable_warnings=False.ú rJ rK )rJ ) ÚreÚmatchÚgroupÚpopÚgetrD r ZLegacyAPIWarningrH )rM rN rI Ztype_regr r0 Z attribute_okZ warning_clsr& r& r' Úbecame_legacy_20¡ s2
|
ÿýþÿ
|
ýÿ rZ zTuple[str, str])Úspecsr" c s^ i i i ¡ D ]*\}\}}||< t| |< tj|< qddd 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."
|
)
|
|
)
|
|
r rB c s t | ¡}|jd k r\tt|jt|jt|j d
|jt ¡t ¡n:|j
|
d k r|j
|
t ¡t ¡n dt|j t ddddd fdd }| j d k rÔ| j pÖd}|rôt|dd ¡ D }|| }||_ |S )
|
Nr& r r ©rC r, Úkwargsr" c sÐ D ]T}| d kr || d k s<| d k r|| | krt | | | dd q krt| ¡r d k s|tt dd D ](}||krt | | | dd q| ||S ©Nr) r$ )r( ÚsetÚ
|
differencerD )rC r, r] Úm)Ú check_any_kwÚcheck_defaultsÚcheck_kwÚdefaultsÚmessagesÚversion_warningsÚversionsr& r' Úwarnedû s>
|
ÿÿüÿ üüz3deprecated_params.<locals>.decorate.<locals>.warnedr3 c S s2 i | ]*\}\}}|d |dkr dn||p(df qS )r2 rJ z1.4r3 r& )Ú.0Úparamr r0 r& r& r' Ú
|
<dictcomp>! s
|
|
þ ÿz7deprecated_params.<locals>.decorate.<locals>.<dictcomp>)r Zinspect_getfullargspecre r9 Úzipr, Úlenr_ Ú intersectionr` ÚkwonlydefaultsÚvarkwr Ú__doc__r Úitems)rC Úspecri ÚdocÚ decorated©rf r[ rg rh )rb rc rd re r' r< à s<
|
|
þÿ
|
&!ýþz#deprecated_params.<locals>.decorate)rs Ú_sanitize_restructured_textr r* )r[ rk r r0 r< r& rw r' Údeprecated_paramsÇ s Kry )Útextr" c C s0 ddddd}t ddd | ¡} t d || ¡S )
|
Nz
|
Match[str]r )ra r" c S s$ | dd¡\}}|dkr |d7 }|S )Nr r )r7 rS z()©rW )ra r Únamer& r& r' Úrepl/ s z)_sanitize_restructured_text.<locals>.replz:ref:`(.+) <.*>`c S s d| d¡ S )Nz"%s"r r{ )ra r& r& r' Ú<lambda>5 ó z-_sanitize_restructured_text.<locals>.<lambda>z \:(\w+)\:`~?(?:_\w+)?\.?(.+?)`)rU Úsub)rz r} r& r& r' rx . s rx r4 )r5 r1 Úwtyper0 r Údocstring_headerr" c C s | j d k r| j pd}|d k rþ|d k r2|t|d; }t|tjrF|d7 }t||d}d }t| tkr®t| j}||d< | dd ¡ | dd ¡ t| j | j
|
|} |d k rÆ|| }n|| _ |d k rÆt | |}|d k rþ|d k sÚt |d k sæt t | |t||||d | S )Nr3 r6 ú@ (Background on SQLAlchemy 2.0 at: :ref:`migration_20_toplevel`)r rr Ú__dict__Ú __weakref__)rr r9 Ú
|
issubclassr ÚBase20DeprecationWarningr Útyper rX rF Ú __bases__ÚgetattrrD ÚsetattrrE ) r5 r1 r r0 r r ru Zconstructor_fnZclsdictr& r& r' r8 9 sH ÿ
|
|
|
ÿýr8 )r7 r r0 r r rA r" c
|
s¤ t ttjrd}nd}tddddd fdd }| jdk rP| jpRd}|dk r|t| jd ; }||7 }t||d
|
}|| } || _fd d | _ | S ) z=Wrap a function with a warnings.warn and augmented docstring.r r3 r r r\ c s0 p| dd¡}|s&tdd | ||S )NZ_sa_skip_warningFr) r$ )rX r( )rC r, r] Z skip_warning©rA r0 r r r& r' ri ~ s
|
ÿz&_decorate_with_warning.<locals>.warnedNr6 r c s t ddS r^ )r( r& )r0 r r r& r' r~ s
|
ÿz(_decorate_with_warning.<locals>.<lambda>)
|
rx r r r r rr r9 rF r Z_sa_warn)
|
r7 r r0 r r rA Zdoc_onlyri ru rv r& r r' rE j s
|
ÿ rE )N)r) N)r) N)r/ )NTNT)N)N)NT)&rr Ú
|
__future__r rU Útypingr r r r r r r r
|
r r r r3 r Z langhelpersr r r r r r r r r( r+ r. r= rH rL rZ ry rx r8 rE r& r& r& r' Ú<module> s^ û ÿ û ÿ û6 ÿ&g ú 6 ú
|
