PEP 702 (@deprecated): "normal" overloaded methods by tyralla · Pull Request #18477 · python/mypy

tyralla · 2025-01-15T20:40:24Z

It seems I covered overloaded functions, descriptors, and special methods so far but completely forgot about "normal" methods (thanks to @sobolevn for pointing this out). This addition should do the trick.

@sobolevn

Fixespython#18474 It seems I covered overloaded functions, descriptors, and special methods so far but completely forgot about "normal" methods (thanks to @sobolevn for pointing this out). This addition should do the trick.

for more information, see https://pre-commit.ci

sobolevn

Thanks! What about @staticmethod and @classmethod?

sobolevn · 2025-01-15T22:05:20Z

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


Suggested change
(nodeisNone)
and(memberisnotNone)
andisinstance(object_type, Instance)
and ((symbol:=object_type.type.names.get(member)) isnotNone)
nodeisNone
andmemberisnotNone
andisinstance(object_type, Instance)
and (symbol:=object_type.type.names.get(member)) isnotNone

I will have a look at it later.

It became a one-liner followed by a loop.

tyralla · 2025-01-16T06:03:39Z

Inheritance is also an issue: If the (overloaded) function is defined by a base class of object_type, object_type.type.names.get(member) cannot work.

The base class is not directly available. Going through the MRO might be necessary (at least for static methods).

…ed_overload_item` for static methods

…ods' into narrowing/overloaded_normal_methods # Conflicts: # mypy/checkexpr.py

tyralla · 2025-01-17T17:35:44Z

@sobolevn: classmethod already worked, staticmethod not (needed to skip bind_self). Inheritance now also works. Searching through the MRO makes it even nastier, in my opinion, but I found no other place where all information is directly available.

sobolevn

Thanks! Just two minor nitpicks :)

sobolevn · 2025-01-19T08:36:21Z

+
+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")


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.

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.)

(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).

Co-authored-by: sobolevn <mail@sobolevn.me>

…n analysing "normal" methods (like we do when in other cases).

sobolevn

There's a failing test now, please take a look. From the brief looks it is related to the Union type change.

It is unspecified in https://typing.readthedocs.io/en/latest/spec/directives.html#deprecated so we can ping @JelleZijlstra to see if that is correct.

tyralla · 2025-01-20T08:51:51Z

Yes, the test now fails intentionally (as written somewhere above). I will wait for Jelle's response and adjust either warn_deprecated_overload_item or the TestDeprecatedOverloadedInstanceMethods test case afterwards

hauntsaninja · 2025-01-26T08:57:22Z

I think it would make sense to issue the warning for the union, since that's the "sound" thing to do. I also checked against pyanalyze and pyright (since they were the reference impl's for PEP 702) and both of them issue a warning. pyanalyze is by Jelle, so that's probably his opinion on this

(If we do this, we should also add a test case for overloaded functions — mypy doesn't currently complain about passing a union that matches a deprecated overload and whatever we decide to do, we should be consistent)

JelleZijlstra · 2025-01-26T15:25:41Z

Just so I understand correctly, the question is about whether code like this should warn about the deprecation:

from typing import overload
from warnings import deprecated
@overload
@deprecated("use str")
def f(x: int) -> str: ...
@overload
def f(x: str) -> str: ...
def f(x: int | str) -> str:
return str(x)
def caller(x: int | str):
f(x)

And my answer is yes (as Shantanu surmised above). My rule of thumb is: if there would be an error if the deprecation was carried out (i.e., the int overload was removed), then there should be a deprecation warning now.

tyralla · 2025-01-26T21:19:23Z

Thank you very much for sharing your opinions on this. I will adjust warn_deprecated_overload_item tomorrow and add corresponding test cases for overloaded functions and descriptors.

tyralla · 2025-01-27T18:55:57Z

Hmm, things are a little different (and eventually more complicated) than I expected. I have to study the responses of check_overload_call in more detail to (hopefully) cover all possible cases. I removed the int_or_str tests so that we do not mix-up things and the current state can be merged (according the the first review) as is (and eventually be cherry-picked into Mypy 1.15?).

I hope to propose a fix for Unions in the next few days.

hauntsaninja · 2025-01-27T20:25:44Z

- 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):
+ for base in object_type.type.mro:


nit: I think we can use object_type.type.get(member)

You're right, I adjusted it.

github-actions · 2025-01-28T06:47:22Z

According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅

sobolevn

Thank you! Let's continue the Union work in the next PR.

@sobolevn

Fixespython#18474 It seems I covered overloaded functions, descriptors, and special methods so far but completely forgot about "normal" methods (thanks to @sobolevn for pointing this out). This addition should do the trick. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: sobolevn <mail@sobolevn.me>

tyrallaand others added 2 commits January 15, 2025 21:38

PEP 702 (@deprecated): "normal" overloaded methods
2461eff
Fixespython#18474 It seems I covered overloaded functions, descriptors, and special methods so far but completely forgot about "normal" methods (thanks to @sobolevn for pointing this out). This addition should do the trick.

[pre-commit.ci] auto fixes from pre-commit.com hooks
1ba5cf1
for more information, see https://pre-commit.ci

cdce8p added topic-pep-702 PEP 702, @deprecated topic-overloads labels Jan 15, 2025

This comment has been minimized.
Sign in to view

sobolevn reviewed Jan 15, 2025
View reviewed changes

tyralla added 3 commits January 17, 2025 18:08

fix inheritance
7f3d73c

Add tests for class methods and static methods and fix `warn_deprecat…
a0fcf31
…ed_overload_item` for static methods

Merge remote-tracking branch 'mypypy/narrowing/overloaded_normal_meth…
6599d2b
…ods' into narrowing/overloaded_normal_methods # Conflicts: # mypy/checkexpr.py

This comment has been minimized.
Sign in to view

tyralla requested a review from sobolevn January 17, 2025 17:53

sobolevn reviewed Jan 17, 2025
View reviewed changes

Comment threadtest-data/unit/check-deprecated.test Outdated
Comment threadtest-data/unit/check-deprecated.test

self --> cls for class methods
b4a9cd3

This comment has been minimized.
Sign in to view

tyralla requested a review from sobolevn January 19, 2025 06:54

sobolevn reviewed Jan 19, 2025
View reviewed changes

tyrallaand others added 3 commits January 19, 2025 21:40

less brackets
2ff8cf1
Co-authored-by: sobolevn <mail@sobolevn.me>

less brackets
6757391

additional test
cc7a915
Co-authored-by: sobolevn <mail@sobolevn.me>

This comment has been minimized.
Sign in to view

execute check_deprecated before warn_deprecated_overload_item whe…
c95f936
…n analysing "normal" methods (like we do when in other cases).

This comment has been minimized.
Sign in to view

tyralla requested a review from sobolevn January 20, 2025 06:09

sobolevn reviewed Jan 20, 2025
View reviewed changes

remove int_or_str tests
7522cb8

This comment has been minimized.
Sign in to view

tyralla requested a review from hauntsaninja January 27, 2025 18:56

hauntsaninja approved these changes Jan 27, 2025
View reviewed changes

refactor: type.get instead of loop
c758922

sobolevn approved these changes Jan 28, 2025
View reviewed changes

sobolevn merged commit 93d1ce4 into python:masterJan 28, 2025

tyralla mentioned this pull request Feb 16, 2025
PEP 702 (@deprecated): improve the handling of overloaded functions and methods #18682
Closed

-(nodeisNone)
-and(memberisnotNone)
-andisinstance(object_type, Instance)
-and ((symbol:=object_type.type.names.get(member)) isnotNone)
+nodeisNone
+andmemberisnotNone
+andisinstance(object_type, Instance)
+and (symbol:=object_type.type.names.get(member)) isnotNone

Uh oh!

Uh oh!

Conversation

tyralla commented Jan 15, 2025

Uh oh!

This comment has been minimized.

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

sobolevnJan 15, 2025

Choose a reason for hiding this comment

Uh oh!

tyrallaJan 16, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tyrallaJan 17, 2025

Choose a reason for hiding this comment

Uh oh!

tyralla commented Jan 16, 2025

Uh oh!

tyralla commented Jan 17, 2025

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

This comment has been minimized.

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sobolevnJan 19, 2025

Choose a reason for hiding this comment

Uh oh!

tyrallaJan 19, 2025

Choose a reason for hiding this comment

Uh oh!

tyrallaJan 19, 2025

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

tyralla commented Jan 20, 2025

Uh oh!

hauntsaninja commented Jan 26, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JelleZijlstra commented Jan 26, 2025

Uh oh!

tyralla commented Jan 26, 2025

Uh oh!

This comment has been minimized.

tyralla commented Jan 27, 2025

Uh oh!

hauntsaninjaJan 27, 2025

Choose a reason for hiding this comment

Uh oh!

tyrallaJan 28, 2025

Choose a reason for hiding this comment

Uh oh!

github-actionsBot commented Jan 28, 2025

Uh oh!

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tyrallaJan 16, 2025•
edited
Loading

hauntsaninja commented Jan 26, 2025•
edited
Loading