Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PEP 702 (@deprecated): "normal" overloaded methods #18477

Merged
merged 12 commits into from
Jan 28, 2025
Merged

PEP 702 (@deprecated): "normal" overloaded methods #18477

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
2461eff
PEP 702 (@deprecated): "normal" overloaded methods
tyralla Jan 15, 2025
1ba5cf1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 15, 2025
7f3d73c
fix inheritance
tyralla Jan 17, 2025
a0fcf31
Add tests for class methods and static methods and fix `warn_deprecat…
tyralla Jan 17, 2025
6599d2b
Merge remote-tracking branch 'mypypy/narrowing/overloaded_normal_meth…
tyralla Jan 17, 2025
b4a9cd3
`self` --> `cls` for class methods
tyralla Jan 17, 2025
2ff8cf1
less brackets
tyralla Jan 19, 2025
6757391
less brackets
tyralla Jan 19, 2025
cc7a915
additional test
tyralla Jan 19, 2025
c95f936
execute `check_deprecated` before `warn_deprecated_overload_item` whe…
tyralla Jan 19, 2025
7522cb8
remove `int_or_str` tests
tyralla Jan 27, 2025
c758922
refactor: `type.get` instead of loop
tyralla Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion mypy/checkexpr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1485,7 +1485,17 @@ def check_call_expr_with_callee_type(
)
proper_callee = get_proper_type(callee_type)
if isinstance(e.callee, (NameExpr, MemberExpr)):
self.chk.warn_deprecated_overload_item(e.callee.node, e, target=callee_type)
node = e.callee.node
if (
(node is None)
and (member is not None)
and isinstance(object_type, Instance)
and ((symbol := object_type.type.names.get(member)) is not None)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
(node is None)
and (member is not None)
and isinstance(object_type, Instance)
and ((symbol := object_type.type.names.get(member)) is not None)
node is None
and member is not None
and isinstance(object_type, Instance)
and (symbol := object_type.type.names.get(member)) is not None

Copy link
Collaborator Author

@tyralla tyralla Jan 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will have a look at it later.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It became a one-liner followed by a loop.

):
node = symbol.node
self.chk.warn_deprecated_overload_item(
node, e, target=callee_type, selftype=object_type
)
if isinstance(e.callee, RefExpr) and isinstance(proper_callee, CallableType):
# Cache it for find_isinstance_check()
if proper_callee.type_guard is not None:
Expand Down
39 changes: 39 additions & 0 deletions test-data/unit/check-deprecated.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,45 @@ for i in a: # E: function __main__.A.__iter__ is deprecated: no iteration
[builtins fixtures/tuple.pyi]


[case testDeprecatedOverloadedMethods]
# flags: --enable-error-code=deprecated

from typing import Iterator, Union
from typing_extensions import deprecated, overload

class A:
@overload
@deprecated("pass `str` instead")
def f(self, v: int) -> None: ...
@overload
def f(self, v: str) -> None: ...
def f(self, v: Union[int, str]) -> None: ...

@overload
def g(self, v: int) -> None: ...
@overload
@deprecated("pass `int` instead")
def g(self, v: str) -> None: ...
def g(self, v: Union[int, str]) -> None: ...

@overload
def h(self, v: int) -> A: ...
@overload
def h(self, v: str) -> A: ...
@deprecated("use `h2` instead")
def h(self, v: Union[int, str]) -> A: ...

a = A()
a.f(1) # E: overload def (self: __main__.A, v: builtins.int) of function __main__.A.f is deprecated: pass `str` instead
a.f("x")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also test this case:

Suggested change
a.f("x")
a.f("x")
int_or_str: Union[int, str]
a.f(int_or_str)

It should not raise if all is good.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does not raise a warning, but why do you think it should not?

(There is not even a warning for a.h, where the implementation is marked as deprecated, which is inconsistent with how functions are handled.)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(There is not even a warning for a.h, where the implementation is marked as deprecated, which is inconsistent with how functions are handled.)

I made it consistent in c95f936. However, I added the in my opinion missing warnings to the test case, to prevent us from merging this too early by accident. I am curious to hear why you think the current behaviour is correct. (regarding int_or_str).

a.g(1)
a.g("x") # E: overload def (self: __main__.A, v: builtins.str) of function __main__.A.g is deprecated: pass `int` instead
a.h(1) # E: function __main__.A.h is deprecated: use `h2` instead
a.h("x") # E: function __main__.A.h is deprecated: use `h2` instead

[builtins fixtures/tuple.pyi]


[case testDeprecatedOverloadedSpecialMethods]
# flags: --enable-error-code=deprecated

Expand Down
Loading