mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-06 12:20:52 +01:00
abbd71d29d
Reproduce command: ```bash ghstack checkout https://github.com/pytorch/pytorch/pull/138443 git checkout HEAD~1 torch/ lintrunner -a --take "PYFMT" --all-files ``` Pull Request resolved: https://github.com/pytorch/pytorch/pull/138443 Approved by: https://github.com/ezyang
40 lines
1.1 KiB
Python
40 lines
1.1 KiB
Python
import textwrap
|
|
from typing import Any, Callable, Dict, 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
|