-
-
Notifications
You must be signed in to change notification settings - Fork 30.8k
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
bpo-28814: Undeprecate inadvertantly deprecated inspect function. #122
Conversation
I did not touch the code but I'll be happy to move these 2 functions into the "stack frame extraction" section of |
Doc/whatsnew/3.5.rst
Outdated
.. note:: | ||
|
||
Function :func:`~inspect.getargvalues` and :func:`~inspect.formatargvalues` | ||
where inadvertantly marked as deprecated with with the release of Python 3.5.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Accidentally doubled word here: s/with with/with/
Thanks! This mostly looks good to me, just one accidentally doubled word to fix before it can be merged. |
Doc/library/inspect.rst
Outdated
:ref:`Signature Object <inspect-signature-object>`, which provide a | ||
better introspecting API for callables. | ||
.. note:: | ||
This function was inadvertantly marked as deprecated in Python 3.5. Ignore |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: inadvertently
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Ignore previous deprecation notice." is superfluous and can be deleted in my opinion.
Doc/whatsnew/3.5.rst
Outdated
|
||
.. note:: | ||
|
||
Function :func:`~inspect.getargvalues` and :func:`~inspect.formatargvalues` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Function -> Functions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indentation should use 3 or 4 spaces:
.. note::
Functions [...]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or start with:
:func:`~inspect.getargvalues` and :func:`~inspect.formatargvalues` functions were inadvertently [...]
I'm not a native speaker so I hope @ncoghlan will chime in here :)
Doc/whatsnew/3.5.rst
Outdated
.. note:: | ||
|
||
Function :func:`~inspect.getargvalues` and :func:`~inspect.formatargvalues` | ||
where inadvertantly marked as deprecated with with the release of Python 3.5.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: inadvertantly -> inadvertently
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add a dot at the end of the sentence.
Thanks ! Comments addressed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty good to me, just left two minor comments :)
Doc/whatsnew/3.5.rst
Outdated
.. note:: | ||
|
||
:func:`~inspect.getargvalues` and :func:`~inspect.formatargvalues` functions | ||
were inadvertently marked as deprecated with the release of Python 3.5.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You forgot to end the sentence with a full stop :)
Doc/whatsnew/3.5.rst
Outdated
deprecated in favor of the :func:`inspect.signature` API. (Contributed by Yury | ||
Selivanov in :issue:`20438`.) | ||
|
||
.. note:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking at this again, I think using a note directive is not needed in 3.5 whatsnew page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean removing the .. note::
altogether along with the text, or just demote the text to a plain paragraph ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I wasn't clear in my earlier comment. I meant the latter one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, Done. And full stop added at the end.
Nick Coghlan said on bpo-28814: > inspect.getargvalues() and inspect.formatargvalues() were deprecated > in Python 3.5 as part of implementing bpo-20438 > This is incorrect, as these are *frame* introspection related functions, > not callable introspection ones. The documentation and implementation > layout is confusing though, as they're interleaved with the callable > introspection operation So un-deprecate in the doc, and leave a note to ignore previous deprecation notice.
Thanks! |
Thanks as well. |
…ython#122) Nick Coghlan said on bpo-28814: > inspect.getargvalues() and inspect.formatargvalues() were deprecated > in Python 3.5 as part of implementing bpo-20438 > This is incorrect, as these are *frame* introspection related functions, > not callable introspection ones. The documentation and implementation > layout is confusing though, as they're interleaved with the callable > introspection operation This commit undeprecates these functions and adds a note to ignore previous deprecation notices. (cherry picked from commit 0899b98)
…ython#122) Nick Coghlan said on bpo-28814: > inspect.getargvalues() and inspect.formatargvalues() were deprecated > in Python 3.5 as part of implementing bpo-20438 > This is incorrect, as these are *frame* introspection related functions, > not callable introspection ones. The documentation and implementation > layout is confusing though, as they're interleaved with the callable > introspection operation This commit undeprecates these functions and adds a note to ignore previous deprecation notices. (cherry picked from commit 0899b98)
@berkerpeksag Thanks, you picked up several things I missed :) |
) (#243) Nick Coghlan said on bpo-28814: > inspect.getargvalues() and inspect.formatargvalues() were deprecated > in Python 3.5 as part of implementing bpo-20438 > This is incorrect, as these are *frame* introspection related functions, > not callable introspection ones. The documentation and implementation > layout is confusing though, as they're interleaved with the callable > introspection operation This commit undeprecates these functions and adds a note to ignore previous deprecation notices. (cherry picked from commit 0899b98)
) (#244) Nick Coghlan said on bpo-28814: > inspect.getargvalues() and inspect.formatargvalues() were deprecated > in Python 3.5 as part of implementing bpo-20438 > This is incorrect, as these are *frame* introspection related functions, > not callable introspection ones. The documentation and implementation > layout is confusing though, as they're interleaved with the callable > introspection operation This commit undeprecates these functions and adds a note to ignore previous deprecation notices. (cherry picked from commit 0899b98)
The cache caused false block leak errors from test suite --huntrleaks / -R runs. The performance penalty is irrelevant in debug builds. https://bitbucket.org/stackless-dev/stackless/issues/122
Nick Coghlan said on bpo-28814:
So un-deprecate in the doc, and leave a note to ignore previous
deprecation notice.