֚j_2ddlZddlZddlZddlZddlmZddlmZdZgdZ dZ Gdde Z Gd d e Z d d Zd Zy)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. cj||_||_||_||_tt |||||y)N)function deprecated_in removed_indetailssuperr__init__)selfr rrr __class__s B/var/www/html/GAP/venv/lib/python3.12/site-packages/deprecation.pyrzDeprecatedWarning.__init__5s<! *$  /-0:G Ectjt}|j|d<|jrd|jz|d<|j r;dj t|j trdnd|j |d<t|j|j |jgrd|d <|jrd |jz|d <d |zS) Nr z as of %srz and will be removed {} {}oninremoved.period %srzH%(function)s is deprecated%(deprecated)s%(removed)s%(period)s%(details)s) collections defaultdictstrr rrformat isinstanceranyrrpartss r__str__zDeprecatedWarning.__str__@s'', MMj   "-0B0B"BE,  ??;BB:VZVeVegkKl4rvCG?? TE)  ""DOOT\\B C!E(O <<$t||3E) (+02 3r))__name__ __module__ __qualname____doc__rr& __classcell__)rs@rrr"s$ E3rrceZdZdZdZy)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<|j rd|j z|d<d|zS)Nr rrrz9%(function)s is unsupported as of %(removed)s.%(details)s)rrr r rrr$s rr&zUnsupportedWarning.__str__^sZ'', MMj??i <<$t||3E) !&( )rN)r(r)r*r+r&rrr r Ts  )rr cb  tdd}dttrtjk\rdnVd}nS|rOt j |}r|t j k\rdnr|t j k\rd}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. zCCannot set removed_in to a value without also setting deprecated_inFTc2 rjxsd}rdznd r$djt trdnd ndrdzndd}djdi|}d}|j d d}t |dkDr8t j|d|d<|j|d td k7rd }|j|||j|d dj|_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_warningrrr is_unsupportedr should_warns r_innerz5deprecated.._function_wrapper.._innersR!,C+C!("3"3]",g7  k4F)*,T,V, ,rr/) r+r!r"rsplitlentextwrapdedentinsertrjoin functoolswraps) r existing_docstringr%deprecation_noteloc string_listrCrrrArrBs ` r_function_wrapperz%deprecated.._function_wrappersB !)!1!1!7R .;EM)NX7==jQ[]aFbdhl>HJ]_'.EGOB8E!?!88>!HAF!H C-224;K;!#"*Q!@ A""3-$u,C   s$4 5   sF +!ww{3H   " - - # - r) TypeErrorr"rtodayrparser#)rrcurrent_versionr is_deprecatedrPrArBs`` ` @@rrrjsX!7=> >MN *d# ::<: %!N M !--8 #w}}Z'@@!N!W]]=%AA M  }n56KJJV rcBtjfd}|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|}dddD]8}|jtk(st dt |jS#1swYHxYw)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 )_  ! !( +((B )' 6G#55$c'//2466 6   ) )s A==B)rJrK)rarbs` rrr s(__V   r)NNNr')rrJrFr: packagingrdatetimer __version____all__rr<rr rrr/rrrgs^  6/3*/3d)*),EI\~r