gh-150076: Document the public attributes of warnings.deprecated#153879
Open
fedonman wants to merge 2 commits into
Open
gh-150076: Document the public attributes of warnings.deprecated#153879fedonman wants to merge 2 commits into
warnings.deprecated#153879fedonman wants to merge 2 commits into
Conversation
The documentation described only the ``__deprecated__`` attribute set on the decorated object, and did not mention that ``deprecated`` is a class whose instances expose the constructor arguments (``message``, ``category`` and ``stacklevel``) as attributes of the same names -- a part of the API that downstream projects rely on. Document these attributes, and rename the first parameter in the signature from ``msg`` to ``message`` to match the implementation and the attribute.
Documentation build overview
|
Member
|
Documenting this like that makes it an implementation-detail IMO. For context, can you look at the related PEP (there seems to be one) please? and check for past discussions. Exposing an implementation details opens cans of worms that we usually want to keep closed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs for
warnings.deprecatedonly mention the__deprecated__attribute set on the decorated object. They don't mention thatdeprecatedis a class whose instances expose their constructor arguments as attributes with the same names (message,categoryandstacklevel). That is part of the public API, and downstream projects like Pydantic rely on it.This documents those three attributes inside the existing decorator entry, using the same bullet-list style already used for the
catch_warningsrecorded-object attributes. It also renames the first parameter in the documented signature frommsgtomessage, to match the implementation (where it is positional-only) and the attribute being documented.I kept the directive as
.. decorator::instead of switching to.. class::so the existingwarnings.deprecatedreferences inDoc/whatsnew/3.13.rststill resolve.Checked with a nitpicky docs build (
sphinx-build -n -D nitpicky=1): no new warnings.warnings.deprecatedpublic API #150076