U #i_2@sddlZddlZddlZddlZddlmZddlmZdZddddd gZ d Z Gd dde Z Gd d d e Z dddZddZdS)N)version)datez2.1.0 deprecatedmessage_locationfail_if_not_removedDeprecatedWarningUnsupportedWarningZbottomcs*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__//tmp/pip-unpacked-wheel-jw9ffvn4/deprecation.pyr5szDeprecatedWarning.__init__cCstt}|j|d<|jr(d|j|d<|jrPdt|jtrBdnd|j|d<t |j|j|j grld|d <|j rd |j |d <d |S) Nr z as of %srz and will be removed {} {}oninremoved.Zperiod %sr zH%(function)s is deprecated%(deprecated)s%(removed)s%(period)s%(details)s) collections defaultdictstrr r r format isinstanceranyr rpartsrrr__str__@s  zDeprecatedWarning.__str__)r )__name__ __module__ __qualname____doc__rr" __classcell__rrrrr"s c@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<|jr2d|j|d<d|S)Nr rrr z9%(function)s is unsupported as of %(removed)s.%(details)s)rrrr r r r rrrr"^s   zUnsupportedWarning.__str__N)r#r$r%r&r"rrrrrTs r csdkrdk rtdd}dttrBtkr._function_wrapper.._inner) r&rrrsplitlentextwrapdedentinsertrjoin functoolswraps)r Zexisting_docstringr!Zdeprecation_notelocZ string_listr7r r r5r r6)r r_function_wrappers4         z%deprecated.._function_wrapper) TypeErrorrrtodayrparser)r r current_versionr Z is_deprecatedrBrrArrjs,,      Kcstfdd}|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. c sZtjdd}td||}W5QRX|D]$}|jtkr0tdt|jfq0|S)NT)recordalwaysz-%s uses a function that should be removed: %s)r/catch_warnings simplefilterr-rAssertionErrorrmessage)r2r3Zcaught_warningsrvwarningmethodrr test_inners   z'fail_if_not_removed..test_inner)r>r?)rPrQrrOrr s  )NNNr )rr>r:r/ packagingrdatetimer __version____all__rr1rrrrrrrr s$  2