U [hk5@s<dZddlZddlZddlZddlmZddlmZddlmZddlm Z ddlm Z dd lm Z d d lm Z d Z d aed ddkrdZ ejrdanedddkrdad0ddZddZd1ddZd2ddZd3ddZd4ddZd5d d!Zd6d"d#Zd$d%Zd7d&d'Zd(d)Zd*d+Zd8d,d-Zd9d.d/ZdS):zSHelpers related to deprecation of functions, methods, classes, other functionality.N)compat)_hash_limit_string)_warnings_warn) decorator)inject_docstring_text)inject_param_text)excFSQLALCHEMY_WARN_20false)trueyes1TZSQLALCHEMY_SILENCE_UBER_WARNINGcCsHt|tjr"ts"tst||dS|||d}||_t||dddS)Ncoder stacklevel) issubclassr Base20DeprecationWarningr SILENCE_UBER_WARNING_emit_uber_warningdeprecated_sincer)msgversiontype_rrwarnr@/tmp/pip-unpacked-wheel-joqu7d3y/sqlalchemy/util/deprecations.py_warn_with_version)s   rcCstrdSdatj}t|do2|o2tjddk}d}|rR|dddd d d }n|d d d d d d }||}t||d ddS)NTisattyTERMZdumba%(red)sDeprecated API features detected! These feature(s) are not compatible with SQLAlchemy 2.0. %(green)sTo prevent incompatible upgrades prior to updating applications, ensure requirements files are pinned to "sqlalchemy<2.0". %(cyan)sSet environment variable SQLALCHEMY_WARN_20=1 to show all deprecation warnings. Set environment variable SQLALCHEMY_SILENCE_UBER_WARNING=1 to silence this message.%(nocolor)szzzzz)ZredZcyanZgreenZmagentaZnocolorrr) rsysstderrhasattrr osenvirongetr)rrfile_Z use_colorrrrrrr9s8    rcCst||tj||ddSNr)rr SADeprecationWarning)rrrrrrrwarn_deprecatedlsr-cCs(|rt|d|}t||tj||ddS)zhIssue a deprecation warning with a parameterized string, limiting the number of registrations. rN)rrr r,)rargsrrrrrrwarn_deprecated_limitedrs r0cCst|tjjtj||ddSr+)rr RemovedIn20Warningr)rrrrrrwarn_deprecated_20~sr2__init__cs&dp dffdd}|S)N.. deprecated:: %s %sr"cst|tjtdS)Nfunc)_decorate_cls_with_warningr r,dictcls constructorheadermessagerrrdecorates z deprecated_cls..decorater)rr>r<r?rr;rdeprecated_clss r@csJd||s dndf|r$d|7|r0tjntjfdd}|S)Nzg.. deprecated:: 1.4 The %s class is considered legacy as of the 1.x series of SQLAlchemy and %s in 2.0.will be removedbecomes a legacy construct cst|jS)N)r7rr9r<r> warning_clsrrr?sz#deprecated_20_cls..decorate)r LegacyAPIWarningr1)Zclsname alternativer<becomes_legacyr?rrDrdeprecated_20_clss   rIcs|dkrdkrtjd|r0dp(dfnddkr@ddkrNtjtjk rdd7fdd }|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. 2.0N1.4r4r"z$Call to deprecated function %(func)sz (deprecated since: %s)cs t|t|jddS)Nr5)enable_warnings)_decorate_with_warningr8__name__)fnrLr=r>rwarningrrr?szdeprecated..decorate)r r1r,)rr>Zadd_deprecation_to_docstringrQrLr?rrPr deprecateds$   rRcKstd|tjd|S)NrJr>rQ)rJ)rRr ZMovedIn20Warning)r>kwrrrmoved_20srUc Kstd|}|r(dddd|d}nd}d|||s:d nd f}d |krt|d d }|st|dd ksttd||r|d|7}|rtj}ntj}t d||d|S)Nz^:(attr|func|meth): attributefunctionmethod)attrr6methrZ constructzPThe %s %s is considered legacy as of the 1.x series of SQLAlchemy and %s in 2.0.rArBz:attr:Zwarn_on_attribute_accessFrLzattribute %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.rCrJrS)rJ) rematchgrouppopr(AssertionErrorr rFr1rR) Zapi_namerGrHrTZtype_regrr>Z attribute_okrErrr deprecated_20s:     r`c sdiiiD]8\}\}}||<t||<|dkrBtjntj|<qfdd}|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." ) ) rJcst|}|jdk r\tt|jt|jt|jd|jtt n dt|j t fdd}|j dk r|j pd}|rt |ddD}||}||_ |S)NrcsD]T}|dkr ||dk s<|dk r|||krt|||ddqkrt|rtddD](}||krt|||ddq|||SNr*r)rset difference)rOr/kwargsm) check_any_kwcheck_defaultscheck_kwdefaultsmessagesversion_warningsversionsrrwarnedWs< z3deprecated_params..decorate..warnedr"cSs2i|]*\}\}}|d|dkr dn||p(dfqS)r4rJrKr"r).0paramrr>rrr }s  z7deprecated_params..decorate..)rZinspect_getfullargspecrir8zipr/lenrb intersectionrcvarkwr__doc__ritems)rOspecrmdoc decoratedrjspecsrkrl)rfrgrhrirr?Es4  !z#deprecated_params..decorate)rv_sanitize_restructured_textr r1r,)r{rorr>r?rrzrdeprecated_params(s Br}cCs(dd}tddd|}td||S)NcSs$|dd\}}|dkr |d7}|S)Nrr )r6rZz()r])rernamerrrreplsz)_sanitize_restructured_text..replz:ref:`(.+) <.*>`cSsd|dS)Nz"%s"rr~)rerrrz-_sanitize_restructured_text..z\:(\w+)\:`~?(?:_\w+)?\.?(.+?)`)r[sub)textrrrrr|sr|c Cs|jdk r|jpd}|dk r|dk r2|t|d;}t|tjrF|d7}t||d}t|tkrt|j}||d<|dd|ddt|j |j |}|dk r||}n||_|dk rt ||}|dk rt ||t ||||d|S)Nr"r5@ (Background on SQLAlchemy 2.0 at: :ref:`migration_20_toplevel`)rru__dict__ __weakref__)rur8rr rrtyperr^rN __bases__getattrsetattrrM) r:r<wtyper>rdocstring_headerrxZclsdictZconstructor_fnrrrr7sB        r7c stttjrd}nd}tfdd}|jdk rD|jpFd}|dk rt|t|jd;}||7}t||d}||} || _fdd | _ | S) z=Wrap a function with a warnings.warn and augmented docstring.rr"cs0 p|dd}|s&tdd|||S)NZ_sa_skip_warningFr*r)r^r)rOr/rdZ skip_warningrLr>rrrrrms z&_decorate_with_warning..warnedNr5rcstddSra)rr)r>rrrrrs z(_decorate_with_warning..) r|rr rrrur8rNrZ_sa_warn) r6rr>rrrLZdoc_onlyrmrxryrrrrMs   rM)N)r*N)r*N)r*N)r3)Nr3F)NTNT)NF)N)NT) rur&r[r#r"rZ langhelpersrrrrrr r rgetenvlowerZpy2krrr-r0r2r@rIrRrUr`r}r|r7rMrrrrsT        3   % = )b *