Skip to content

typing docs: Use soft deprecation #132941

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.

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

Open
JelleZijlstra opened this issue Apr 25, 2025 · 6 comments
Open

typing docs: Use soft deprecation #132941

JelleZijlstra opened this issue Apr 25, 2025 · 6 comments
Labels
docs Documentation in the Doc dir topic-typing

Comments

@JelleZijlstra
Copy link
Member

A while ago we introduced the concept of "soft deprecation" in PEP 387 (https://peps.python.org/pep-0387/#soft-deprecation): for things that we no longer recommend using, but which we aren't planning to remove in the near future.

The typing docs already list four classes of objects that are deprecated without a scheduled removal (https://docs.python.org/3.14/library/typing.html#deprecation-timeline-of-major-features):

  • Pre-PEP-585 generic aliases (e.g. List)
  • Text
  • Hashable and Sized
  • TypeAlias

I'd like to also soft-deprecate the following:

  • Optional (obviated by PEP-604)
  • NoReturn (prefer Never)
  • typing.ForwardRef (deprecated alias for annotationlib.ForwardRef)
  • types.UnionType (deprecated alias for typing.Union)
  • Creating a Union using subscripting (Union[A, B] instead of A | B) (PEP-604)
  • Creating a TypeVar, ParamSpec, or TypeVarTuple using the constructor directly (PEP-695)
  • Directly inheriting from Generic (PEP-695)

None of those will be removable for many years if ever, but I think it's useful to have a clear statement in the docs that the newer syntax is preferred.

@AlexWaygood AlexWaygood added docs Documentation in the Doc dir topic-typing labels Apr 25, 2025
@AA-Turner
Copy link
Member

types.UnionType (deprecated alias for typing.Union)

I had assumed that merging the two types would mean the types name becomes preferred (as it's an interpreter type). I agree it would be useful to clarify which (or both) of the names to use. I've very likely missed prior discussion on this, though!

A

@JelleZijlstra
Copy link
Member Author

In general I see types as the place for interpreter types that don't have a better home. Other typing-related interpreter types (TypeVar, ParamSpec, TypeVarTuple, TypeAliasType) also live in typing not types.

@srittau
Copy link
Contributor

srittau commented Apr 28, 2025

I'm generally in favor, except for blanket deprecating NoReturn. This should stay non-deprecated for return types, similar to what is currently suggested by the Modernizing Superseded Typing Features document (written by me, so not a third opinion). I see no reason to deprecate NoReturn in this case, especially as I find it more readable. I don't have a very strong opinion on this, though.

@sobolevn
Copy link
Member

I would like to soft deprecate NoReturn, because right now it is easy for me to explain the difference like: "NoReturn is just an old deprecated name for Never". It would be much harder to explain if there are any nuances.

@AlexWaygood
Copy link
Member

AlexWaygood commented Apr 28, 2025

I have no strong opinion on NoReturn. To me it reads slightly better than Never in return annotations. But I can also see the arguments that it's better to have only one preferred way of doing things. I also understand the argument that it's confusing to beginners who think that functions which have no return statements in them "never return", not realising that None is a more appropriate annotation for these functions.

The other proposed soft deprecations all sound reasonable to me. I'm not wild about using the term "soft deprecation" in documentation, as I don't think it's self-evident to users what it means for something to be "soft-deprecated": you almost always need some explanation of what some specific soft deprecation actually means, practically, if you want users to have clarity about what API is good to use and what isn't. (The existing soft deprecations in typing have slightly different policies laid out in the docs to other soft deprecations in the stdlib!)

But that's just about how we describe the soft deprecations in the docs, not about whether we do them or not.

@carljm
Copy link
Member

carljm commented Apr 28, 2025

FWIW I agree with soft-deprecating NoReturn and recommending Never in all cases. I don't think NoReturn has any advantage in readability that justifies two aliases for the same thing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir topic-typing
Projects
Status: Todo
Development

No branches or pull requests

6 participants