bpo-29940: Add follow_wrapped option to help() #12915

eamanu · 2019-04-22T20:25:07Z

When print the docstring using help builtin for an wrapper function
it doesn't correspond to the function wrapped. For avoid this
this PR add the follow_wrapped option to help() function.

https://bugs.python.org/issue29940

chrahunt · 2019-04-22T22:47:51Z

There are no tests. Can we find useful ones to add that will also demonstrate the reason for this change? e.g. showing correct help for functions wrapped with class-based decorators

I think that help may be better with follow_wrapped=True by default. It is meant to be used interactively as stated in the docs so the backwards-incompatibility may not be as big an issue.

chrahunt

Can we add some tests?

Lib/pydoc.py

incr cannot be larger than INT_MAX: downcast to int explicitly.

On Windows, fix asyncio recv_into() return value when the socket/pipe is closed (BrokenPipeError): return 0 rather than an empty byte string (b'').

…ythonGH-17536) Co-authored-by: Jeffrey Kintscher <websurfer@surf2c.net>

…21452)

…21727)

…han duplicating it in 'compile.c' (pythonGH-21714) Generate information about jumps from 'opcode.py' rather than duplicate it in 'compile.c'

…1479) See PEP 623 for detail.

…thonGH-20312)

Explicitly cast PyHKEYObject* to PyObject* to call _PyObject_Init().

…21743)

…ythonGH-21754)

…-21734)

Split newsize calculation into new function. dictresize() now accepts exact newsize.

PyUnicodeEncodeError_Create has been deprecated with `Py_DEPRECATED` macro. But it was not documented.

…21764)

…H-21768) gdb 9.2 on Fedora Rawhide is not reliable, see: * https://bugs.python.org/issue41473 * https://bugzilla.redhat.com/show_bug.cgi?id=1866884

…21772)

…to YAML files (pythonGH-21776)

the-knights-who-say-ni · 2020-09-22T10:27:09Z

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@nosamproductions

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

eamanu · 2020-09-22T10:27:32Z

oops. sorry!!!!!

eamanu · 2020-09-22T14:44:00Z

i am preparing a new pr for this... sorry for the nnoise.

taleinat · 2020-09-22T15:36:13Z

@eamanu, no problem and no need to apologize, it happens all too often with git.

Just in case you haven't, I recommend reading the "Lifecycle of a Pull Requst" section on the devguide, which may be helpful. You're also welcome to ask anything on the Python IRC and Zulip chat channels and get immediate help.

vsajip · 2020-09-22T15:58:51Z

I was under the impression that this happened only when rebasing/fast-forwarding with master - does it also happen when a merge is done?

taleinat · 2020-09-22T19:20:30Z

I was under the impression that this happened only when rebasing/fast-forwarding with master - does it also happen when a merge is done?

In this case it appears the @eamanu accidentally merged in another branch, which may have been similary re-based or based on a different commit.

eamanu · 2020-09-23T20:31:26Z

Hi I make this PR: #22390

I was under the impression that this happened only when rebasing/fast-forwarding with master - does it also happen when a merge is done?

I need practice my git skills. I don't like the rebase (or I don't understand yet) and I did an rebase from master, and then I did (and I think that was my error) git pull [bpo-29940](https://bugs.python.org/issue29940) and that merge my old github's branch

the-knights-who-say-ni added the CLA signed label Apr 22, 2019

bedevere-bot added the awaiting review label Apr 22, 2019

chrahunt suggested changes Apr 26, 2019

View reviewed changes

Lib/pydoc.py Outdated Show resolved Hide resolved

Lib/pydoc.py Outdated Show resolved Hide resolved

bedevere-bot added awaiting core review and removed awaiting review labels Apr 26, 2019

taleinat reviewed May 27, 2019

View reviewed changes

Lib/pydoc.py Outdated Show resolved Hide resolved

vstinner and others added 23 commits August 4, 2020 02:38

bpo-38156: Fix compiler warning in PyOS_StdioReadline() (pythonGH-21721)

bde48fd

incr cannot be larger than INT_MAX: downcast to int explicitly.

bpo-41467: Fix asyncio recv_into() on Windows (pythonGH-21720)

602a971

On Windows, fix asyncio recv_into() return value when the socket/pipe is closed (BrokenPipeError): return 0 rather than an empty byte string (b'').

bpo-41431: Optimize dict_merge for copy (pythonGH-21674)

db6d9a5

bpo-36982: Add support for extended color functions in ncurses 6.1 (p…

da4e09f

…ythonGH-17536) Co-authored-by: Jeffrey Kintscher <websurfer@surf2c.net>

bpo-40275: Use new test.support helper submodules in tests (pythonGH-…

604bba1

…21452)

bpo-40275: Use new test.support helper submodules in tests (pythonGH-…

c7decc2

…21727)

bpo-41463: Generate information about jumps from 'opcode.py' rather t…

582aaf1

…han duplicating it in 'compile.c' (pythonGH-21714) Generate information about jumps from 'opcode.py' rather than duplicate it in 'compile.c'

bpo-36346: Doc: Update removal schedule of legacy Unicode (pythonGH-2…

270b4ad

…1479) See PEP 623 for detail.

bpo-40726: handle uninitalized end_lineno on ast.increment_lineno (py…

8f4380d

…thonGH-20312)

bpo-40989: Fix compiler warning in winreg.c (pythonGH-21722)

15edaec

Explicitly cast PyHKEYObject* to PyObject* to call _PyObject_Init().

bpo-41482: Fix error in ipaddress.IPv4Network docstring (pythonGH-21736)

52f9842

bpo-40275: Use new test.support helper submodules in tests (pythonGH-…

79bb2c9

…21743)

bpo-41492: Fixes the description appearing in UAC prompts on Windows (p…

777b611

…ythonGH-21754)

bpo-41371: Handle lzma lib import error in test_zoneinfo.py (pythonGH…

5f0769a

…-21734)

bpo-41493: Refactoring dictresize (pythonGH-21751)

d9323a8

Split newsize calculation into new function. dictresize() now accepts exact newsize.

bpo-41440: add os.cpu_count() support for VxWorks RTOS (pythonGH-21685)

3405e05

bpo-39871: Fix an error in a news entry (pythonGH-21749)

5463635

bpo-41098: Doc: Add missing deprecated directives (pythonGH-21162)

46e19b6

PyUnicodeEncodeError_Create has been deprecated with `Py_DEPRECATED` macro. But it was not documented.

bpo-40275: Use new test.support helper submodules in tests (pythonGH-…

598a951

…21764)

bpo-41477: Make ctypes optional in test_genericalias (pythonGH-21766)

f44693e

bpo-41473: Skip test_gdb with gdb 9.2 to work around gdb bug (pythonG…

e27a51c

…H-21768) gdb 9.2 on Fedora Rawhide is not reliable, see: * https://bugs.python.org/issue41473 * https://bugzilla.redhat.com/show_bug.cgi?id=1866884

bpo-40275: Use new test.support helper submodules in tests (pythonGH-…

fcce8c6

…21772)

Update Azure Pipelines build to use Ubuntu 18.04 and move triggers in…

102b498

…to YAML files (pythonGH-21776)

eamanu requested review from ethanfurman, ezio-melotti, gpshead, gvanrossum, ilevkivskyi, lysnikolaou, methane, ncoghlan, pablogsal, pganssle, rhettinger, terryjreedy, tiran, vsajip, warsaw and a team as code owners September 22, 2020 10:26

the-knights-who-say-ni added CLA not signed and removed CLA signed labels Sep 22, 2020

eamanu closed this Sep 22, 2020

eamanu deleted the bpo-29940 branch September 22, 2020 10:28

eamanu mentioned this pull request Sep 23, 2020

bpo-29940: Add follow_wrapped option to help() #22390

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bpo-29940: Add follow_wrapped option to help() #12915

bpo-29940: Add follow_wrapped option to help() #12915

eamanu commented Apr 22, 2019 •

edited by bedevere-bot

chrahunt commented Apr 22, 2019

chrahunt left a comment

the-knights-who-say-ni commented Sep 22, 2020

eamanu commented Sep 22, 2020

eamanu commented Sep 22, 2020

taleinat commented Sep 22, 2020 •

edited

vsajip commented Sep 22, 2020

taleinat commented Sep 22, 2020 •

edited

eamanu commented Sep 23, 2020 •

edited by bedevere-bot

Navigation Menu

bpo-29940: Add follow_wrapped option to help() #12915

bpo-29940: Add follow_wrapped option to help() #12915

Conversation

eamanu commented Apr 22, 2019 • edited by bedevere-bot

chrahunt commented Apr 22, 2019

chrahunt left a comment

Choose a reason for hiding this comment

the-knights-who-say-ni commented Sep 22, 2020

Recognized GitHub username

eamanu commented Sep 22, 2020

eamanu commented Sep 22, 2020

taleinat commented Sep 22, 2020 • edited

vsajip commented Sep 22, 2020

taleinat commented Sep 22, 2020 • edited

eamanu commented Sep 23, 2020 • edited by bedevere-bot

eamanu commented Apr 22, 2019 •

edited by bedevere-bot

taleinat commented Sep 22, 2020 •

edited

taleinat commented Sep 22, 2020 •

edited

eamanu commented Sep 23, 2020 •

edited by bedevere-bot