| 12345678910111213141516171819202122232425262728293031323334353637383940 |
- import textwrap
- from collections.abc import Callable
- from typing import Any, TypeVar
- _BACK_COMPAT_OBJECTS: dict[Any, None] = {}
- _MARKED_WITH_COMPATIBILITY: dict[Any, None] = {}
- _T = TypeVar("_T")
- def compatibility(is_backward_compatible: bool) -> Callable[[_T], _T]:
- if is_backward_compatible:
- def mark_back_compat(fn: _T) -> _T:
- docstring = textwrap.dedent(getattr(fn, "__doc__", None) or "")
- docstring += """
- .. note::
- Backwards-compatibility for this API is guaranteed.
- """
- fn.__doc__ = docstring
- _BACK_COMPAT_OBJECTS.setdefault(fn)
- _MARKED_WITH_COMPATIBILITY.setdefault(fn)
- return fn
- return mark_back_compat
- else:
- def mark_not_back_compat(fn: _T) -> _T:
- docstring = textwrap.dedent(getattr(fn, "__doc__", None) or "")
- docstring += """
- .. warning::
- This API is experimental and is *NOT* backward-compatible.
- """
- fn.__doc__ = docstring
- _MARKED_WITH_COMPATIBILITY.setdefault(fn)
- return fn
- return mark_not_back_compat
|
