NotificationsYou must be signed in to change notification settings
Fork32.1k
Star67.3k

bpo-42524: pdb: additional documentation on retval#27612

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

romuald wants to merge1 commit intopython:main

base:main

Choose a base branch

fromromuald:pdb-retval-doc

Open

bpo-42524: pdb: additional documentation on retval#27612

romuald wants to merge1 commit intopython:mainfromromuald:pdb-retval-doc

+6 −1

Conversation

Copy link

Contributor

romuald commentedAug 5, 2021•
edited by bedevere-bot
Loading

Add documentation onretvalstating that the return value itself can be
accessed via the__return__ local variable.

This is intended to let people know that they can access complex objects
using this variable (for example access__return__.thingy())

https://bugs.python.org/issue42524

bpo-42524: pdb: additional documentation on retval

81918c3

Add documentation on `retval`stating that the return value itself can beaccessed via the `__return__` local variable.This is intended to let people know that they can access complex objectsusing this variable (for example access `__return__.thingy()`)

the-knights-who-say-ni added the CLA signed label

Aug 5, 2021

bedevere-bot added the awaiting review label

Aug 5, 2021

iritkatriel reviewed

Aug 5, 2021

View reviewed changes

Lib/pdb.py

		@@ -1238,6 +1238,8 @@ def do_args(self, arg):
		def do_retval(self, arg):
		"""retval
		Print the return value for the last return of a function.
		Alternatively, the return value can be accessed with the local
		variable ``__return__``

Copy link

Member

iritkatrielAug 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Actually this sentence fits better in the documentation here:https://docs.python.org/3/library/pdb.html#pdbcommand-retval

For the docstring it's not really appropriate to point to an alternative.

iritkatriel added the skip news label

Aug 6, 2021

iritkatriel reviewed

Aug 26, 2021

View reviewed changes

Lib/test/test_pdb.py

		@@ -107,6 +107,7 @@ def test_pdb_basic_commands():
		... 'jump 8', # jump over second for loop
		... 'return', # return out of function
		... 'retval', # display return value
		... '__return__', # access the return value

Copy link

Member

iritkatrielAug 26, 2021•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Because the function returns a string, this test doesn't really check that__return__ is the value rather than the string representation of the value. It also doesn't check that you can assign it to a local and inspect it (in other words - the test doesn't show that there is a difference betweenretval and__return__).