stdlib: more deprecations #11009

JelleZijlstra · 2023-11-10T03:10:51Z

I went through the list in https://docs.python.org/3.12/whatsnew/3.12.html#deprecated and added @deprecated in all cases where it seemed practical. I hope this will give more useful input for #11002.

I'll comment below on the individual deprecations.

JelleZijlstra · 2023-11-10T03:11:19Z

stdlib/argparse.pyi

+            help: str | None = None,
+        ) -> None: ...
+        @overload
+        @deprecated("The `type`, `choices`, and `metavar` parameters are ignored and will be removed in Python 3.14.")


These apparently never did anything useful, so it seems fair to emit the warning on all versions.

JelleZijlstra · 2023-11-10T03:11:44Z

stdlib/argparse.pyi

        def __init__(
            self,
            option_strings: Sequence[str],
            dest: str,
-            default: _T | str | None = None,
+            default: bool | None = None,


It appears that a non-bool default doesn't really make sense on this action.

JelleZijlstra · 2023-11-10T03:12:22Z

stdlib/asyncio/events.pyi

@@ -599,8 +599,10 @@ class AbstractEventLoopPolicy:
    def new_event_loop(self) -> AbstractEventLoop: ...
    # Child processes handling (Unix only).
    @abstractmethod
+    @deprecated("Deprecated as of Python 3.12; will be removed in Python 3.14")


Wasn't sure about these child watchers as it's not clear to me what if anything they should be replaced with. Possibly we should emit the warning on 3.12+ only.

I haven't looked at this in detail, but in situations like this where we're not sure, I feel like we should probably err on the side of caution and only emit warnings on py312+. For this one, it would be good to ping an asyncio expert and see what they think, though.

Changed this to warn only on 3.12+

JelleZijlstra · 2023-11-10T03:12:52Z

stdlib/builtins.pyi

@@ -937,6 +938,8 @@ class bool(int):
    @overload
    def __rxor__(self, __value: int) -> int: ...
    def __getnewargs__(self) -> tuple[int]: ...
+    @deprecated("Will throw an error in Python 3.14. Use `not` for logical negation of bools instead.")


This is ~True. It always behaved confusingly, so it seems fine to warn about it on all versions.

JelleZijlstra · 2023-11-10T03:13:24Z

stdlib/datetime.pyi

@@ -265,6 +265,7 @@ class datetime(date):
        def fromtimestamp(cls, __timestamp: float, tz: _TzInfo | None = ...) -> Self: ...

    @classmethod
+    @deprecated("Use timezone-aware objects to represent datetimes in UTC; e.g. by calling .fromtimestamp(datetime.UTC)")


This and utcnow() were always mildly discouraged and the replacement has always been available, so chose to deprecate across versions.

JelleZijlstra · 2023-11-10T03:14:49Z

stdlib/pkgutil.pyi

@@ -35,8 +36,10 @@ if sys.version_info < (3, 12):
    class ImpLoader:
        def __init__(self, fullname: str, file: IO[str], filename: str, etc: tuple[str, str, int]) -> None: ...

+@deprecated("Use importlib.util.find_spec() instead. Will be removed in Python 3.14.")


find_spec() is apparently available on all supported versions.

JelleZijlstra · 2023-11-10T03:15:11Z

stdlib/shutil.pyi

+            dir_fd: int | None = None,
+        ) -> None: ...
+        @overload
+        @deprecated("The `onerror` parameter is deprecated and will be removed in Python 3.14. Use `onexc` instead.")


Since the new parameter is only available on 3.12+, applied the warning on 3.12+ only.

JelleZijlstra · 2023-11-10T03:15:32Z

stdlib/tarfile.pyi

@@ -292,22 +292,45 @@ class TarFile:
    def list(self, verbose: bool = True, *, members: _list[TarInfo] | None = None) -> None: ...
    def next(self) -> TarInfo | None: ...
    if sys.version_info >= (3, 8):
+        @overload
+        @deprecated("Extracting tar archives without specifying `filter` is deprecated until Python 3.14, when 'data' filter will become the default.")


This was backported all the way back, so seems fair to also emit the warning.

JelleZijlstra · 2023-11-10T03:15:44Z

stdlib/types.pyi

-    def co_lnotab(self) -> bytes: ...
+    if sys.version_info >= (3, 10):
+        @property
+        @deprecated("Will be removed in Python 3.14. Use the co_lines() method instead.")


co_lines() is only in 3.10+.

JelleZijlstra · 2023-11-10T03:16:08Z

stdlib/xml/etree/ElementTree.pyi

@@ -124,6 +124,8 @@ class Element:
    def __setitem__(self, __key: SupportsIndex, __value: Element) -> None: ...
    @overload
    def __setitem__(self, __key: slice, __value: Iterable[Element]) -> None: ...
+    @deprecated("Testing an element's truth value is deprecated.")


This always behaved confusingly (and raised a FutureWarning under some circumstances), so seems fine to always warn.

JelleZijlstra · 2023-11-10T03:20:52Z

Seems like I managed to crash stubtest, I'll have to debug

hauntsaninja · 2023-11-10T03:25:34Z

stubtest doesn't have great decorator support, it just hardcodes a few decorators. And looks like because it hardcoded overload, it expects to know how overload works

AlexWaygood · 2023-11-10T08:43:35Z

Seems like I managed to crash stubtest, I'll have to debug

Same traceback as python/mypy#14950

AlexWaygood · 2023-11-10T08:45:09Z

Looks like deprecating a property also breaks pytype :/

AlexWaygood · 2023-11-10T09:30:47Z

stdlib/datetime.pyi

@@ -278,6 +279,7 @@ class datetime(date):
        def now(cls, tz: _TzInfo) -> datetime: ...

    @classmethod
+    @deprecated("Use timezone-aware objects to represent datetimes in UTC; e.g. by calling .now(datetime.UTC)")


Not sure about this one. It may have always been discouraged to use this method, but I think the deprecation has been pretty disruptive — see https://discuss.python.org/t/deprecating-utcnow-and-utcfromtimestamp/26221/12?u=alexwaygood. For Python 3.8 users, the method is still going to be around for a while; do we need to bother them with this warning just yet? (On the other hand: if the method is widely used, perhaps it's all the more important to make sure the word gets out that it's deprecated...)

I think it's worth it. Work had a bug just this week because someone was using these (and spoiler, we're not on 3.12).

Also I think it will be like eight years before CPython removes it, I'd definitely oppose removing it in 3.14

AlexWaygood

The substantive changes look pretty good to me; just have some qualms about datetime and asyncio

We should probably lean into the type checker harder here Fixes python#14950 Fixes python/typeshed#11009 (comment)

AlexWaygood

LGTM. The ones that combine @overload with @deprecated will probably have to wait until mypy 1.8 is released, though, due to the stubtest crashes

JelleZijlstra · 2023-11-18T20:34:15Z

Ah right, forgot we already fixed that. There is also at least one other pytype crash. I might open another PR with the simpler ones and keep this one open to merge later.

This reverts commit c313169.

This reverts commit 367104a.

AlexWaygood · 2023-12-22T01:54:42Z

This is no longer deferred; stubtest no longer crashes on this with the latest mypy. There are still a few "regular" stubtest failures, however

github-actions · 2024-02-18T14:49:32Z

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

JelleZijlstra and others added 2 commits November 9, 2023 19:09

stdlib: more deprecations

620109c

[pre-commit.ci] auto fixes from pre-commit.com hooks

60119d6

JelleZijlstra commented Nov 10, 2023

View reviewed changes

This comment has been minimized.

Sign in to view

JelleZijlstra mentioned this pull request Nov 10, 2023

PEP 702: Missing warnings for implicit calls to dunders microsoft/pyright#6412

Closed

JelleZijlstra mentioned this pull request Nov 10, 2023

How should we add @deprecated to objects in the standard library? #11002

Closed

AlexWaygood reviewed Nov 10, 2023

View reviewed changes

hauntsaninja added a commit to hauntsaninja/mypy that referenced this pull request Nov 11, 2023

stubtest: special case final and deprecated

92cce1f

We should probably lean into the type checker harder here Fixes python#14950 Fixes python/typeshed#11009 (comment)

hauntsaninja mentioned this pull request Nov 11, 2023

stubtest: special case final and deprecated python/mypy#16457

Merged

ilevkivskyi closed this in python/mypy#16457 Nov 11, 2023

hauntsaninja reopened this Nov 11, 2023

This comment has been minimized.

Sign in to view

hauntsaninja closed this in hauntsaninja/mypy@8ae84ed Nov 12, 2023

hauntsaninja reopened this Nov 12, 2023

This comment has been minimized.

Sign in to view

Make asyncio deprecation conditional

c23c876

JelleZijlstra mentioned this pull request Nov 18, 2023

Crash on @property + @deprecated google/pytype#1531

Closed

JelleZijlstra added 2 commits November 18, 2023 12:22

drop deprecated @Property

367104a

Merge remote-tracking branch 'upstream/main' into deprecations

372fa73

This comment has been minimized.

Sign in to view

AlexWaygood approved these changes Nov 18, 2023

View reviewed changes

Undo argparse to see if pytype becomes happier

c313169

This comment has been minimized.

Sign in to view

JelleZijlstra added 2 commits November 18, 2023 12:50

Revert "Undo argparse to see if pytype becomes happier"

25cf5a7

This reverts commit c313169.

Revert "drop deprecated @Property"

c338052

This reverts commit 367104a.

JelleZijlstra added the status: deferred Issue or PR deferred until some precondition is fixed label Nov 18, 2023

JelleZijlstra mentioned this pull request Nov 18, 2023

stdlib: Apply some simple deprecations #11044

Merged

This comment has been minimized.

Sign in to view

Merge branch 'main' into deprecations

158773e

This comment has been minimized.

Sign in to view

Merge branch 'main' into deprecations

592a5f3

AlexWaygood removed the status: deferred Issue or PR deferred until some precondition is fixed label Dec 22, 2023

This comment has been minimized.

Sign in to view

Merge branch 'main' into deprecations

e451001

This comment has been minimized.

Sign in to view

Appease stubtest

62853a8

JelleZijlstra merged commit bba8cbd into python:main Feb 18, 2024
65 checks passed

JelleZijlstra deleted the deprecations branch February 18, 2024 14:50

Viicos mentioned this pull request Feb 27, 2024

Pyright shows datetime.utcnow and datetime.utcfromtimestamp as deprecated for python versions lower than 3.12 microsoft/pyright#7353

Closed

JelleZijlstra restored the deprecations branch September 10, 2024 23:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

stdlib: more deprecations #11009

stdlib: more deprecations #11009

JelleZijlstra commented Nov 10, 2023

JelleZijlstra Nov 10, 2023

JelleZijlstra Nov 10, 2023

JelleZijlstra Nov 10, 2023

AlexWaygood Nov 10, 2023 •

edited

Loading

JelleZijlstra Nov 18, 2023

JelleZijlstra Nov 10, 2023

JelleZijlstra Nov 10, 2023

JelleZijlstra Nov 10, 2023

JelleZijlstra Nov 10, 2023

JelleZijlstra Nov 10, 2023

JelleZijlstra Nov 10, 2023

JelleZijlstra Nov 10, 2023

JelleZijlstra commented Nov 10, 2023

This comment has been minimized.

hauntsaninja commented Nov 10, 2023 •

edited

Loading

AlexWaygood commented Nov 10, 2023

AlexWaygood commented Nov 10, 2023

AlexWaygood Nov 10, 2023

hauntsaninja Nov 10, 2023 •

edited

Loading

AlexWaygood left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

AlexWaygood left a comment •

edited

Loading

JelleZijlstra commented Nov 18, 2023

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

AlexWaygood commented Dec 22, 2023

This comment has been minimized.

github-actions bot commented Feb 18, 2024

stdlib: more deprecations #11009

stdlib: more deprecations #11009

Conversation

JelleZijlstra commented Nov 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AlexWaygood Nov 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JelleZijlstra commented Nov 10, 2023

This comment has been minimized.

hauntsaninja commented Nov 10, 2023 • edited Loading

AlexWaygood commented Nov 10, 2023

AlexWaygood commented Nov 10, 2023

Choose a reason for hiding this comment

hauntsaninja Nov 10, 2023 • edited Loading

Choose a reason for hiding this comment

AlexWaygood left a comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

AlexWaygood left a comment • edited Loading

Choose a reason for hiding this comment

JelleZijlstra commented Nov 18, 2023

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

AlexWaygood commented Dec 22, 2023

This comment has been minimized.

github-actions bot commented Feb 18, 2024

AlexWaygood Nov 10, 2023 •

edited

Loading

hauntsaninja commented Nov 10, 2023 •

edited

Loading

hauntsaninja Nov 10, 2023 •

edited

Loading

AlexWaygood left a comment •

edited

Loading