Feature/add_type_information #63
Conversation
9y2070m
force-pushed
the
feature/add_type_information
branch
4 times, most recently
from
0193c91
to
f16d2d0
Compare
9y2070m
force-pushed
the
feature/add_type_information
branch
from
f16d2d0
to
b502d61
Compare
| removed_in: Union[str, datetime.date, version.Version, None] = ..., | ||
| current_version: Union[str, datetime.date, version.Version, None] = ..., | ||
| details: str = ..., | ||
| ) -> Callable: ... |
There was a problem hiding this comment.
Consider using a TypeVar for the wrapped function so that the decorator's type hints preserve the function's signature. Pylance (in VS Code) manages to display the signature without this (perhaps due to the implementation's use of @functools.wraps?), but mypy shows Any if I use reveal_type on a deprecated function.
Example: https://github.com/python/typeshed/blob/main/stdlib/contextlib.pyi#L34
_F = TypeVar("_F", bound=Callable[..., Any])
def deprecated(...) -> Callable[[_F], _F]: ...
def fail_if_not_removed(method: _F) -> _F: ...
| deprecated_in: Union[datetime.date, version.Version, None] | ||
| removed_in: Union[datetime.date, version.Version, None] | ||
| details: Union[datetime.date, version.Version, None] |
There was a problem hiding this comment.
The examples in the readme pass str for deprecated_in, removed_in, and details. I don't think details is ever a date/version.
There was a problem hiding this comment.
It looks like the code supports datetime.date.
There was a problem hiding this comment.
Yes, removed_in can be a date. I don't see any indication that the other two fields can be a date.
Based on the code and docstrings, it looks like:
deprecated_in: version, str, or Noneremoved_in: date, version, str, or Nonedetails: str or None
resolves #56
Solution to add types to package using a stubs file
deprecation.pyi)py.typedmarker file to indicate that package has type hintspy.typedand__init__.py@briancurtin