Function warn

src/telegram/_utils/warnings.py:34–56

Helper function used as a shortcut for warning with default values. .. versionadded:: 20.0 Args: message (:obj:`str` | :obj:`PTBUserWarning`): Specify the warnings message to pass to ``warnings.warn()``. .. versionchanged:: 21.2 Now als

(
    message: str | PTBUserWarning,
    category: type[Warning] = PTBUserWarning,
    stacklevel: int = 0,
)

def warn(
    message: str | PTBUserWarning,
    category: type[Warning] = PTBUserWarning,
    stacklevel: int = 0,
) -> None:
    """
    Helper function used as a shortcut for warning with default values.

    .. versionadded:: 20.0

    Args:
        message (:obj:`str` | :obj:`PTBUserWarning`): Specify the warnings message to pass to
            ``warnings.warn()``.

            .. versionchanged:: 21.2
                Now also accepts a :obj:`PTBUserWarning` instance.

        category (:obj:`type[Warning]`, optional): Specify the Warning class to pass to
            ``warnings.warn()``. Defaults to :class:`telegram.warnings.PTBUserWarning`.
        stacklevel (:obj:`int`, optional): Specify the stacklevel to pass to ``warnings.warn()``.
            Pass the same value as you'd pass directly to ``warnings.warn()``. Defaults to ``0``.
    """
    warnings.warn(message, category=category, stacklevel=stacklevel + 1)