From 03a333871af9e6b822fee070c458c940a5139c12 Mon Sep 17 00:00:00 2001 From: Eric Traut Date: Mon, 10 Aug 2020 13:32:35 -0700 Subject: [PATCH] Added stubs for deprecated package (#4423) Co-authored-by: Eric Traut --- third_party/2and3/deprecated/__init__.pyi | 1 + third_party/2and3/deprecated/classic.pyi | 18 +++++++++++++++ third_party/2and3/deprecated/sphinx.pyi | 28 +++++++++++++++++++++++ 3 files changed, 47 insertions(+) create mode 100644 third_party/2and3/deprecated/__init__.pyi create mode 100644 third_party/2and3/deprecated/classic.pyi create mode 100644 third_party/2and3/deprecated/sphinx.pyi diff --git a/third_party/2and3/deprecated/__init__.pyi b/third_party/2and3/deprecated/__init__.pyi new file mode 100644 index 000000000..25df24324 --- /dev/null +++ b/third_party/2and3/deprecated/__init__.pyi @@ -0,0 +1 @@ +from .classic import deprecated as deprecated diff --git a/third_party/2and3/deprecated/classic.pyi b/third_party/2and3/deprecated/classic.pyi new file mode 100644 index 000000000..492f6cfe8 --- /dev/null +++ b/third_party/2and3/deprecated/classic.pyi @@ -0,0 +1,18 @@ +from typing import Any, Callable, Optional, Type, TypeVar + +_T = TypeVar("_T", bound=Callable[..., Any]) + +class ClassicAdapter: + reason: str + version: str + action: Optional[str] + category: Type[DeprecationWarning] + def __init__( + self, reason: str = ..., version: str = ..., action: Optional[str] = ..., category: Type[DeprecationWarning] = ..., + ) -> None: ... + def get_deprecated_msg(self, wrapped: Callable[..., Any], instance: object) -> str: ... + def __call__(self, wrapped: _T) -> Callable[[_T], _T]: ... + +def deprecated( + *, reason: str = ..., version: str = ..., action: Optional[str] = ..., category: Optional[Type[DeprecationWarning]] = ..., +) -> Callable[[_T], _T]: ... diff --git a/third_party/2and3/deprecated/sphinx.pyi b/third_party/2and3/deprecated/sphinx.pyi new file mode 100644 index 000000000..0aa9f47d6 --- /dev/null +++ b/third_party/2and3/deprecated/sphinx.pyi @@ -0,0 +1,28 @@ +from typing import Any, Callable, Optional, Type, TypeVar +from typing_extensions import Literal + +from .classic import ClassicAdapter + +_T = TypeVar("_T", bound=Callable[..., Any]) + +class SphinxAdapter(ClassicAdapter): + directive: Literal["versionadded", "versionchanged", "deprecated"] + reason: str + version: str + action: Optional[str] + category: Type[DeprecationWarning] + def __init__( + self, + directive: Literal["versionadded", "versionchanged", "deprecated"], + reason: str = ..., + version: str = ..., + action: Optional[str] = ..., + category: Type[DeprecationWarning] = ..., + ) -> None: ... + def __call__(self, wrapped: _T) -> Callable[[_T], _T]: ... + +def versionadded(reason: str = ..., version: str = ...) -> Callable[[_T], _T]: ... +def versionchanged(reason: str = ..., version: str = ...) -> Callable[[_T], _T]: ... +def deprecated( + *, reason: str = ..., version: str = ..., action: Optional[str] = ..., category: Optional[Type[DeprecationWarning]] = ..., +) -> Callable[[_T], _T]: ...