plaid.utils.deprecation
=======================

.. py:module:: plaid.utils.deprecation

.. autoapi-nested-parse::

   Implementation of deprecation utilities.



Attributes
----------

.. autoapisummary::

   plaid.utils.deprecation.deprecated_builtin


Functions
---------

.. autoapisummary::

   plaid.utils.deprecation.deprecated
   plaid.utils.deprecation.deprecated_argument


Module Contents
---------------

.. py:data:: deprecated_builtin
   :value: None


.. py:function:: deprecated(reason: str, version: Optional[Union[str, packaging.version.Version]] = None, removal: Optional[Union[str, packaging.version.Version]] = None)

   Decorator to mark a function, method, or class as deprecated.

   Uses built-in `warnings.deprecated` when running on Python 3.13+,
   otherwise falls back to a custom warning wrapper.

   :param reason: Explanation and suggested replacement.
   :type reason: str
   :param version: Version since deprecation.
   :type version: Union[str,Version], optional
   :param removal: Planned removal version.
   :type removal: Union[str,Version], optional


.. py:function:: deprecated_argument(old_arg: str, new_arg: str, converter=lambda x: x, version: Optional[Union[str, packaging.version.Version]] = None, removal: Optional[Union[str, packaging.version.Version]] = None)

   Decorator to mark a function argument as deprecated and redirect it to a new argument.

   :param old_arg: Name of the old argument.
   :type old_arg: str
   :param new_arg: Name of the new argument.
   :type new_arg: str
   :param converter: Function to convert the old value into the new format.
   :type converter: callable
   :param version: Version since deprecation.
   :type version: Union[str,Version], optional
   :param removal: Planned removal version.
   :type removal: Union[str,Version], optional