j_2ddlZddlZddlZddlZddlmZddlmZdZgdZ dZ Gdde Z Gd d e Z dd Zd ZdS)N)version)datez2.1.0) deprecatedmessage_locationfail_if_not_removedDeprecatedWarningUnsupportedWarningbottomc*eZdZdZdfd ZdZxZS)rawA warning class for deprecated methods This is a specialization of the built-in :class:`DeprecationWarning`, adding parameters that allow us to get information into the __str__ that ends up being sent through the :mod:`warnings` system. The attributes aren't able to be retrieved after the warning gets raised and passed through the system as only the class--not the instance--and message are what gets preserved. :param function: The function being deprecated. :param deprecated_in: The version that ``function`` is deprecated in :param removed_in: The version or :class:`datetime.date` specifying when ``function`` gets removed. :param details: Optional details about the deprecation. Most often this will include directions on what to use instead of the now deprecated code. c||_||_||_||_t t |||||dS)N)function deprecated_in removed_indetailssuperr__init__)selfrrrr __class__s V/DATA/AppData/hermes/projects/honcho/.venv/lib/python3.11/site-packages/deprecation.pyrzDeprecatedWarning.__init__5s]! *$  &&//-0:G E E E E Ecptjt}|j|d<|jr d|jz|d<|jr:dt|jtrdnd|j|d<t|j|j|j grd|d <|j r d |j z|d <d |zS) Nrz as of %srz and will be removed {} {}oninremoved.period %srzH%(function)s is deprecated%(deprecated)s%(removed)s%(period)s%(details)s) collections defaultdictstrrrrformat isinstanceranyrrpartss r__str__zDeprecatedWarning.__str__@s',, Mj   C"-0B"BE,  ? T;BB:VZVegkKlKlCv44rvCG? T TE)  "DOT\B C C "!E(O < 4$t|3E) (+02 3r)r )__name__ __module__ __qualname____doc__rr' __classcell__)rs@rrr"s\$ E E E E E E3333333rrceZdZdZdZdS)r aA warning class for methods to be removed This is a subclass of :class:`~deprecation.DeprecatedWarning` and is used to output a proper message about a function being unsupported. Additionally, the :func:`~deprecation.fail_if_not_removed` decorator will handle this warning and cause any tests to fail if the system under test uses code that raises this warning. ctjt}|j|d<|j|d<|jr d|jz|d<d|zS)Nrrrrz9%(function)s is unsupported as of %(removed)s.%(details)s)rr r!rrrr%s rr'zUnsupportedWarning.__str__^sW',, Mj?i < 4$t|3E) !&( )rN)r(r)r*r+r'rrr r Ts- ) ) ) ) )rr r cztdd}dttrtjkrdnUd}nR|rNt j|}r|t jkrdnr|t jkrd}nd}t |gfd}|S)a Decorate a function to signify its deprecation This function wraps a method that will soon be removed and does two things: * The docstring of the method will be modified to include a notice about deprecation, e.g., "Deprecated since 0.9.11. Use foo instead." * Raises a :class:`~deprecation.DeprecatedWarning` via the :mod:`warnings` module, which is a subclass of the built-in :class:`DeprecationWarning`. Note that built-in :class:`DeprecationWarning`s are ignored by default, so for users to be informed of said warnings they will need to enable them--see the :mod:`warnings` module documentation for more details. :param deprecated_in: The version at which the decorated method is considered deprecated. This will usually be the next version to be released when the decorator is added. The default is **None**, which effectively means immediate deprecation. If this is not specified, then the `removed_in` and `current_version` arguments are ignored. :param removed_in: The version or :class:`datetime.date` when the decorated method will be removed. The default is **None**, specifying that the function is not currently planned to be removed. Note: This parameter cannot be set to a value if `deprecated_in=None`. :param current_version: The source of version information for the currently running code. This will usually be a `__version__` attribute on your library. The default is `None`. When `current_version=None` the automation to determine if the wrapped function is actually in a period of deprecation or time for removal does not work, causing a :class:`~deprecation.DeprecatedWarning` to be raised in all cases. :param details: Extra details to be added to the method docstring and warning. For example, the details may point users to a replacement method, such as "Use the foo_bar method instead". By default there are no details. NzCCannot set removed_in to a value without also setting deprecated_inFTcl r jpd}rdznd r-dt trdnd ndrdzndd}djdi|}d}|d d}t |dkr@t j|d|d<||d td krd }|||||d d |_tj  fd }|S)Nr rz This will be removed {} {}.rr)rrrz3.. deprecated::{deprecated_in}{removed_in}{details} topz c r@rt}nt}|j}tj|t d|i|S)N)category stacklevel)r rr(warningswarnDeprecationWarning) argskwargscls the_warningrrris_unsupportedr should_warns r_innerz5deprecated.._function_wrapper.._innerst ,!,,CC+C!c("3]",g77  k4F)*,,,,8T,V,, ,rr/) r+r"r#rsplitlentextwrapdedentinsertrjoin functoolswraps) rexisting_docstringr&deprecation_noteloc string_listrCrrrArrBs ` r_function_wrapperz%deprecated.._function_wrappers 9 4!)!1!7R .;BEM))NX`6==jQ[]aFbFb>lddhl>HJJJ]_'.6EGOOB88E!?!88>!H!HAF!H!H C-224;;K;!##"*Q!@!@ A""3---$u,,C   s$4 5 5 5   sF + + +!ww{33H   " " - - - - - - - - - # " - r) TypeErrorr#rtodayrparser$)rrcurrent_versionr is_deprecatedrPrArBs`` ` @@rrrjs!X!7=>> >MN *d## :<<: % %!NN MM !-88  !#w}Z'@'@@@!NN !!W]=%A%AAA M  }n566KJJJJJJJJJV rcFtjfd}|S)aDecorate a test method to track removal of deprecated code This decorator catches :class:`~deprecation.UnsupportedWarning` warnings that occur during testing and causes unittests to fail, making it easier to keep track of when code should be removed. :raises: :class:`AssertionError` if an :class:`~deprecation.UnsupportedWarning` is raised while running the test method. ctjd5}tjd|i|}dddn #1swxYwY|D]8}|jtkr&t dt |j9|S)NT)recordalwaysz) uses a function that should be removed: )r:catch_warnings simplefilterr8r AssertionErrorr!message)r=r>caught_warningsrvwarningmethods r test_innerz'fail_if_not_removed..test_inners  $D 1 1 1 )_  !( + + +(((B ) ) ) ) ) ) ) ) ) ) ) ) ) ) )' 6 6G#555$ffc'/22246666 sAAA)rJrK)rarbs` rrr s;_V      r)NNNr )rrJrFr: packagingrdatetimer __version____all__rr<rr rrr/rrrgs  6 6 6/3/3/3/3/3*/3/3/3d)))))*))),EI\\\\~r