o /h_2@sddlZddlZddlZddlZddlmZddlmZdZgdZ dZ Gddde Z Gd d d e Z  dd d ZddZdS)N)version)datez2.1.0) deprecatedmessage_locationfail_if_not_removedDeprecatedWarningUnsupportedWarningbottomcs*eZdZdZdfdd ZddZZS)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. cs2||_||_||_||_tt|||||dS)N)function deprecated_in removed_indetailssuperr__init__)selfr r r r __class__D/var/www/html/govbot/env/lib/python3.10/site-packages/deprecation.pyr5szDeprecatedWarning.__init__cCstt}|j|d<|jrd|j|d<|jr(dt|jtr!dnd|j|d<t |j|j|j gr6d|d <|j r@d |j |d <d |S) 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 r r format isinstanceranyrrpartsrrr__str__@s  zDeprecatedWarning.__str__)r )__name__ __module__ __qualname____doc__rr$ __classcell__rrrrr"s rc@seZdZdZddZdS)raA 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. cCs:tt}|j|d<|j|d<|jrd|j|d<d|S)Nr rrrz9%(function)s is unsupported as of %(removed)s.%(details)s)rrrr r rr"rrrr$^s   zUnsupportedWarning.__str__N)r%r&r'r(r$rrrrrTs rr csdur dur tdd}dttr!tkrdn$d}n!|r@t|}r4|tkr4dnr?|tkr?d}nd}t|gfdd}|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_inFTcsrejpd}r dndrdttrdndndr$dndd}djdi|}d}|d d}t|dkrSt|d|d<||d t d krSd }|||||d d |_t fd d}|S)Nr rz This will be removed {} {}.rr)r r rz3.. deprecated::{deprecated_in}{removed_in}{details} topz cs@rrt}nt}|j}tj|tdd|i|S)N)category stacklevel)rrr%warningswarnDeprecationWarning)argskwargscls the_warning)r rr is_unsupportedr should_warnrr_innersz5deprecated.._function_wrapper.._innerr) r(rr rsplitlentextwrapdedentinsertrjoin functoolswraps)r existing_docstringr#deprecation_noteloc string_listr:r rr8r r9)r r_function_wrappers8          z%deprecated.._function_wrapper) TypeErrorr rtodayrparser!)r r current_versionr is_deprecatedrHrrGrrjs*,    Krcstfdd}|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. csrtjdd}td|i|}Wdn1swY|D]}|jtkr6tdt|jfq$|S)NT)recordalwaysz-%s uses a function that should be removed: %s)r1catch_warnings simplefilterr/rAssertionErrorrmessage)r4r5caught_warningsrvwarningmethodrr test_inners   z'fail_if_not_removed..test_inner)rArB)rXrYrrWrr s  r)NNNr )rrAr=r1 packagingrdatetimer __version____all__rr3rrrrrrrrs    2