z i<HSrSSKJr SSKrSSKrSSKrSSKJr SSKJ r J r SSSSSS S .SS jjr SSSSSSSS .SS jjr SSjr SSjr\"1Sk5rSSjrg)zDeprecation utilities) annotationsN)Callable)AnyTypeFQiskitz/no earlier than 3 months after the release date)additional_msgpending package_nameremoval_timeline is_property stacklevelc,^^^^^^^UUUUUUU4SjnU$)agDecorator to indicate a function has been deprecated. It should be placed beneath other decorators like `@staticmethod` and property decorators. When deprecating a class, set this decorator on its `__init__` function. Args: since: The version the deprecation started at. If the deprecation is pending, set the version to when that started; but later, when switching from pending to deprecated, update ``since`` to the new version. additional_msg: Put here any additional information, such as what to use instead. For example, "Instead, use the function ``new_func`` from the module ``.``, which is similar but uses GPU acceleration." pending: Set to ``True`` if the deprecation is still pending. package_name: The package name shown in the deprecation message (e.g. the PyPI package name). removal_timeline: How soon can this deprecation be removed? Expects a value like "no sooner than 6 months after the latest release" or "in release 9.99". is_property: If the deprecated function is a `@property`, set this to True so that the generated message correctly describes it as such. (This isn't necessary for property setters, as their docstring is ignored by Python.) stacklevel: Stack level passed to :func:`warnings.warn`. Returns: Callable: The decorated callable. c b>^^^TRnTRnT (a SUSUS3nOBSU;a3TRS:XaUS[S5*nSUSUS3nOSUSUS3nO S USUS3n[ UT T T TT S 9umm[ R "T5UUUU4S j5n[UTT T S 9 U$) NzThe property ``.``__init__z .__init__z The class ``z The method ``z()``zThe function ``deprecated_entityr sincer r r c@>[R"TTTS9 T"U0UD6$)Ncategoryr)warningswarn)argskwargsrfuncmsgrs R/home/james-whalen/.local/lib/python3.13/site-packages/qiskit/utils/deprecation.pywrapper2deprecate_func..decorator..wrapper^s# MM#Z H(( (rr ) __qualname__ __module____name__len_write_deprecation_msg functoolswrapsadd_deprecation_to_docstring)rqualnamemod_namercls_namer!rrr r r r r rrs` @@r decorator!deprecate_func..decorator;s$$?? #2(1XJb I H_}} *#$7s;'7&78&28*AhZr$J!&3H:Qxj$M!"1(1XJd K ./%)-  X   )  ) %WcPr#)rr r r r r rr0s``````` r deprecate_funcr3sF))V r#)r deprecation_descriptionr r new_alias predicater c 4^^^^^^^^^UUUUUUUUU4 Sjn U $)a\Decorator to indicate an argument has been deprecated in some way. This decorator may be used multiple times on the same function, once per deprecated argument. It should be placed beneath other decorators like ``@staticmethod`` and property decorators. Args: name: The name of the deprecated argument. since: The version the deprecation started at. If the deprecation is pending, set the version to when that started; but later, when switching from pending to deprecated, update `since` to the new version. deprecation_description: What is being deprecated? E.g. "Setting my_func()'s `my_arg` argument to `None`." If not set, will default to "{func_name}'s argument `{name}`". additional_msg: Put here any additional information, such as what to use instead (if new_alias is not set). For example, "Instead, use the argument `new_arg`, which is similar but does not impact the circuit's setup." pending: Set to `True` if the deprecation is still pending. package_name: The package name shown in the deprecation message (e.g. the PyPI package name). new_alias: If the arg has simply been renamed, set this to the new name. The decorator will dynamically update the `kwargs` so that when the user sets the old arg, it will be passed in as the `new_alias` arg. predicate: Only log the runtime warning if the predicate returns True. This is useful to deprecate certain values or types for an argument, e.g. `lambda my_arg: isinstance(my_arg, dict)`. Regardless of if a predicate is set, the runtime warning will only log when the user specifies the argument. removal_timeline: How soon can this deprecation be removed? Expects a value like "no sooner than 6 months after the latest release" or "in release 9.99". Returns: Callable: The decorated callable. c > ^^^^^ TRSTRS3mT =(d STST S3nT (aST S3nT (aUST 3nOUnOT n[UTTTUTS9umm[R"T5UUUUU U UU 4S j5m [ TS 5(aTR T lOTRRT l[R"T5RR5Vs1sHoDRiM nn[RRU;a [!S 5e[#T TTTS 9 T $s snf) Nrz()rz``'s argument ``zInstead, use the argument ``z``, which behaves identically.z. rc J>[UUTT RTTTTTS9 T"U0UD6$)N) func_nameoriginal_func_co_varnames old_arg_namer5 warning_msgrr6)_maybe_warn_and_rename_kwarg__original_func_co_varnames) rrrrr:rnamer5r6r!s r r!1deprecate_arg..decorator..wrappers> (#*1*M*M!#!# (( (r#r?zl@deprecate_arg cannot be used with functions that take variable *args. Use warnings.warn() directly instead.r$)r&r%r)r*r+hasattrr?__code__ co_varnamesinspect signature parametersvalueskind ParameterVAR_POSITIONAL ValueErrorr,)rr alias_msgfinal_additional_msgparam param_kindsrr:rr!r r4r@r5r r r6r rs` @@@@r r0 deprecate_arg..decoratorsW'q):):(;2> 3_I;FVW[V\\^7_ 6ykA_`I*3B~6F'G$'0$#1 ./%/-  X   ) )  )& 46 7 7262R2RG /26--2K2KG /3:3D3DT3J3U3U3\3\3^_3^%::3^K_  //;> 8 %WcP`s;E r2) r@rr r4r r r5r6r r0s ````````` r deprecate_argrRisV77r r#c([X5V V s0sHupX_M n n n U RU5 XK;agU(aX[;a[USUSUS35eXn U(aU"U 5(dg[R"XgSS9 UbXU'ggs sn n f)Nz received both z and z (deprecated).r)zipupdate TypeErrorrr) rrr:r;r<r5r=rr6valr@arg_names_to_valuess r r>r>s7:$6Z[6Z496Z[v&.Y59+_YKu\NR`abb  +C3 MM+Q?y\sBc U(a[nSnSU3nO [nSnSU3nUSUSUSUSUS 3 n U(aU SU3- n X4$) Nzpending deprecationz8marked deprecated in a future release, and then removed deprecatedzremoved z is z as of  z . It will be r)PendingDeprecationWarningDeprecationWarning) rr rr r r rdeprecation_status removal_descrs r r)r)s % 3QRbQcd %)!"2!34   T"4!5W\N!E7S"^1 & >"## =r#>tip:args:hint:note:todo:warn:error:notes:warns:yield:danger:raises:return:yields:caution:example:returns:warning: examples: see also: warnings: arguments: attention: important: attributes: parameters: references: keyword args:other parameters:keyword arguments:cSU;a[SURS35eUcSnOU(aUS3OUnSnSnUR(aURR5nSn[ U5HupU R 5n U(d9U S :wa3U (a,[ U 5[ U R55- n S U -nS nU R5[;dMoU nU(d[S URS 35e O O/nUUSU3USU3U/n U(a XUS- US- &OURU 5 SRU5Ulg)zDynamically insert the deprecation message into ``func``'s docstring. Args: func: The function to modify. msg: The full deprecation message. since: The version the deprecation started at. pending: Is the deprecation still pending?  zNDeprecation messages cannot contain new lines (`\n`), but the deprecation for aY had them. Usually this happens when using `"""` multiline strings; instead, use string concatenation. This is a simplification to facilitate deprecation messages being added to the documentation. If you have a compelling reason to need new lines, feel free to improve this function or open a request at https://github.com/Qiskit/qiskit/issues.Nunknown_pendingFrr\Tzadd_deprecation_to_docstring cannot currently handle when a Napoleon metadata line like 'Args' is the very first line of docstring, e.g. `"""Args:`. So, it cannot process zF. Instead, move the metadata line to the second line, e.g.: """ Args:z.. deprecated:: z ) rLr%__doc__ splitlines enumeratestripr(lstriplower_NAPOLEON_META_LINESextendjoin)rrrr version_strindent meta_indexoriginal_linescontent_encounteredilinestrippednum_leading_spaces new_liness r r,r,6s{ s{ ]  !"7 7   } ,3x( FJ ||002# 0GAzz|H '16h%(YT[[]1C%C"11&*#~~#77 *$BBFBSBSATUYZ-10  (";-0 ("SE I:CzA~ Q7i(99^,DLr#)rstrr str | Noner boolr rr rr rrint)r@rrrr rr4rr rr rr5rr6Callable[[Any], bool] | Noner r)rztuple[Any, ...]rzdict[str, Any]r:rr;ztuple[str, ...]r<rr5rr=rrz Type[Warning]r6rreturnNone)rrr rrrr rr rr rrzFtuple[str, Type[DeprecationWarning] | Type[PendingDeprecationWarning]]) rrrrrrr rrr)r __future__rr*rErcollections.abcrtypingrrr3rRr>r) frozensetrr,r2r#r rs"$ "& MN NN N  N  NNNj"&*.  .2Md d d d ( d  ddd,ddN     /       ,   D      L@!!HH- H-H-(2H-=AH- H-r#