bpo-46434: Handle missing docstring in pdb help #30705

sparrowt · 2022-01-19T17:44:16Z

Proposed fix for https://bugs.python.org/issue46434

When using embeddable windows distribution of python, __doc__ strings are missing so help CMD in pdb explodes without this patch.

This is my first contribution, apologies I wasn't sure whether I should update Docs, Misc/ACKS or Misc/NEWS.d

https://bugs.python.org/issue46434

the-knights-who-say-ni · 2022-01-19T17:44:20Z

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).

CLA Missing

Our records indicate the following people have not signed the CLA:

@sparrowt

For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

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

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

zooba · 2022-01-19T19:39:03Z

If you click the "Details" link next to the failed check, it will help you add a NEWS entry. If you'd like to add yourself to ACKS, feel free to do it as part of this PR. I don't think we need a docs update for this.

zooba · 2022-01-20T14:25:52Z

Misc/NEWS.d/next/Library/2022-01-20-10-35-10.bpo-46434.geS-aP.rst

+pdb help now gracefully handles any case where __doc__ is missing, for
+example when run from a windows embeddable package


Suggested change

pdb help now gracefully handles any case where __doc__ is missing, for

example when run from a windows embeddable package

:mod:`pdb` now gracefully handles any case where :attr:`__doc__` is missing, for

example when run with pregenerated optimized ``.pyc`` files.

FYI, I found the special references by searching the Doc folder for other examples. These will turn them into links in the final doc.

Ah cool thank you, good to know! Maybe it's not important but should we retain a reference to help in there given it's the help command within pdb which has been fixed? Otherwise "any case" without the scope of 'help' feels like a bit of an overstatement (!)

Hopefully ba2053d is ok

Co-authored-by: Steve Dower <[email protected]>

miss-islington · 2022-01-21T17:00:51Z

Thanks @sparrowt for the PR, and @zooba for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖

miss-islington · 2022-01-21T17:00:54Z

Sorry @sparrowt and @zooba, I had trouble checking out the 3.10 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 60705cff70576482fea31dcafbf8a37cbb751ea5 3.10

bedevere-bot · 2022-01-21T17:01:07Z

GH-30754 is a backport of this pull request to the 3.9 branch.

miss-islington · 2022-01-21T17:01:10Z

Thanks @sparrowt for the PR, and @zooba for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9.
🐍🍒⛏🤖

miss-islington · 2022-01-21T17:01:10Z

Thanks @sparrowt for the PR, and @zooba for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

(cherry picked from commit 60705cf) Co-authored-by: Tom Sparrow <[email protected]>

bedevere-bot · 2022-01-21T17:15:11Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot ARM64 macOS 3.x has failed when building commit 60705cf.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/all/#builders/725/builds/789) and take a look at the build logs.
Check if the failure is related to this commit (60705cf) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/all/#builders/725/builds/789

Summary of the results of the build (if available):

== Tests result: ENV CHANGED ==

411 tests OK.

10 slowest tests:

test_concurrent_futures: 3 min 43 sec
test_multiprocessing_spawn: 2 min 31 sec
test_multiprocessing_forkserver: 1 min 46 sec
test_unparse: 1 min 28 sec
test_asyncio: 1 min 20 sec
test_tokenize: 1 min 14 sec
test_nntplib: 1 min 1 sec
test_lib2to3: 52.5 sec
test_capi: 50.2 sec
test_logging: 49.5 sec

1 test altered the execution environment:
test_ftplib

17 tests skipped:
test_dbm_gnu test_devpoll test_epoll test_gdb test_ioctl
test_msilib test_multiprocessing_fork test_ossaudiodev test_spwd
test_startfile test_tix test_tk test_ttk_guionly test_winconsoleio
test_winreg test_winsound test_zipfile64

Total duration: 8 min 41 sec

Click to see traceback logs

Traceback (most recent call last):
  File "/Users/buildbot/buildarea/3.x.pablogsal-macos-m1.macos-with-brew/build/Lib/asyncore.py", line 90, in read
    obj.handle_read_event()
    ^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/buildbot/buildarea/3.x.pablogsal-macos-m1.macos-with-brew/build/Lib/test/test_ftplib.py", line 384, in handle_read_event
    self._do_ssl_handshake()
    ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/buildbot/buildarea/3.x.pablogsal-macos-m1.macos-with-brew/build/Lib/test/test_ftplib.py", line 345, in _do_ssl_handshake
    self.socket.do_handshake()
    ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/buildbot/buildarea/3.x.pablogsal-macos-m1.macos-with-brew/build/Lib/ssl.py", line 1345, in do_handshake
    self._sslobj.do_handshake()
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^
ssl.SSLZeroReturnError: TLS/SSL connection has been closed (EOF) (_ssl.c:998)


Traceback (most recent call last):
  File "/Users/buildbot/buildarea/3.x.pablogsal-macos-m1.macos-with-brew/build/Lib/multiprocessing/resource_tracker.py", line 209, in main
    cache[rtype].remove(name)
    ^^^^^^^^^^^^^^^^^^^^^^^^^
KeyError: '/psm_604fa827'


Traceback (most recent call last):
  File "/Users/buildbot/buildarea/3.x.pablogsal-macos-m1.macos-with-brew/build/Lib/multiprocessing/resource_tracker.py", line 209, in main
    cache[rtype].remove(name)
    ^^^^^^^^^^^^^^^^^^^^^^^^^
KeyError: '/psm_6027030c'


Traceback (most recent call last):
  File "/Users/buildbot/buildarea/3.x.pablogsal-macos-m1.macos-with-brew/build/Lib/threading.py", line 1031, in _bootstrap_inner
    self.run()
    ^^^^^^^^^^
  File "/Users/buildbot/buildarea/3.x.pablogsal-macos-m1.macos-with-brew/build/Lib/test/test_ftplib.py", line 298, in run
    asyncore.loop(timeout=0.1, count=1)
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/buildbot/buildarea/3.x.pablogsal-macos-m1.macos-with-brew/build/Lib/asyncore.py", line 214, in loop
    poll_fun(timeout, map)
    ^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/buildbot/buildarea/3.x.pablogsal-macos-m1.macos-with-brew/build/Lib/asyncore.py", line 157, in poll
    read(obj)
    ^^^^^^^^^
  File "/Users/buildbot/buildarea/3.x.pablogsal-macos-m1.macos-with-brew/build/Lib/asyncore.py", line 94, in read
    obj.handle_error()
    ^^^^^^^^^^^^^^^^^^
  File "/Users/buildbot/buildarea/3.x.pablogsal-macos-m1.macos-with-brew/build/Lib/test/test_ftplib.py", line 421, in handle_error
    raise Exception
    ^^^^^^^^^^^^^^^
Exception
k

(cherry picked from commit 60705cf) Co-authored-by: Tom Sparrow <[email protected]>

miss-islington · 2022-01-21T19:03:47Z

Thanks @sparrowt for the PR, and @zooba for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

miss-islington · 2022-01-21T19:05:30Z

Thanks @sparrowt for the PR, and @zooba for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

bedevere-bot · 2022-01-21T19:06:41Z

GH-30759 is a backport of this pull request to the 3.10 branch.

(cherry picked from commit 60705cf) Co-authored-by: Tom Sparrow <[email protected]>

sparrowt added 2 commits January 19, 2022 17:37

bpo-46434: TDD for missing docstring in pdb help

8dea9ab

bpo-46434: Improve handling of missing docstring in pdb help

39616c1

the-knights-who-say-ni added the CLA not signed label Jan 19, 2022

bedevere-bot added the awaiting review label Jan 19, 2022

zooba added needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Jan 19, 2022

sparrowt added 2 commits January 20, 2022 10:35

bpo-46434: update NEWS and ACKS

ebe9c4c

bpo-46434: consistent indentation

676b9fa

zooba reviewed Jan 20, 2022

View reviewed changes

bpo-46434: improved NEWS entry

ba2053d

Co-authored-by: Steve Dower <[email protected]>

zooba removed the CLA not signed label Jan 20, 2022

the-knights-who-say-ni added CLA not signed and removed CLA not signed labels Jan 20, 2022

sparrowt requested a review from zooba January 21, 2022 13:25

zooba merged commit 60705cf into python:main Jan 21, 2022

bedevere-bot removed the awaiting review label Jan 21, 2022

miss-islington assigned zooba Jan 21, 2022

zooba removed the needs backport to 3.10 only security fixes label Jan 21, 2022

bedevere-bot removed the needs backport to 3.9 only security fixes label Jan 21, 2022

zooba added needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Jan 21, 2022

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 21, 2022

bpo-46434: Handle missing docstrings in pdb help (pythonGH-30705)

0f5eb91

(cherry picked from commit 60705cf) Co-authored-by: Tom Sparrow <[email protected]>

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 21, 2022

bpo-46434: Handle missing docstrings in pdb help (pythonGH-30705)

342f900

(cherry picked from commit 60705cf) Co-authored-by: Tom Sparrow <[email protected]>

miss-islington added a commit that referenced this pull request Jan 21, 2022

bpo-46434: Handle missing docstrings in pdb help (GH-30705)

c3ad850

(cherry picked from commit 60705cf) Co-authored-by: Tom Sparrow <[email protected]>

zooba added needs backport to 3.10 only security fixes and removed needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Jan 21, 2022

zooba added needs backport to 3.10 only security fixes and removed needs backport to 3.10 only security fixes labels Jan 21, 2022

bedevere-bot removed the needs backport to 3.10 only security fixes label Jan 21, 2022

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 21, 2022

bpo-46434: Handle missing docstrings in pdb help (pythonGH-30705)

8d09216

(cherry picked from commit 60705cf) Co-authored-by: Tom Sparrow <[email protected]>

miss-islington added a commit that referenced this pull request Jan 21, 2022

bpo-46434: Handle missing docstrings in pdb help (GH-30705)

05063fa

(cherry picked from commit 60705cf) Co-authored-by: Tom Sparrow <[email protected]>

hello-adam pushed a commit to hello-adam/cpython that referenced this pull request Jun 2, 2022

bpo-46434: Handle missing docstrings in pdb help (pythonGH-30705)

30dcd0b

(cherry picked from commit 60705cf) Co-authored-by: Tom Sparrow <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

bpo-46434: Handle missing docstring in pdb help #30705

bpo-46434: Handle missing docstring in pdb help #30705

Uh oh!

sparrowt commented Jan 19, 2022 •

edited by bedevere-bot

Loading

Uh oh!

the-knights-who-say-ni commented Jan 19, 2022

Uh oh!

zooba commented Jan 19, 2022

Uh oh!

zooba Jan 20, 2022

Uh oh!

sparrowt Jan 20, 2022 •

edited

Loading

Uh oh!

sparrowt Jan 20, 2022 •

edited

Loading

Uh oh!

miss-islington commented Jan 21, 2022

Uh oh!

miss-islington commented Jan 21, 2022

Uh oh!

bedevere-bot commented Jan 21, 2022

Uh oh!

miss-islington commented Jan 21, 2022

Uh oh!

miss-islington commented Jan 21, 2022

Uh oh!

bedevere-bot commented Jan 21, 2022

Uh oh!

miss-islington commented Jan 21, 2022

Uh oh!

miss-islington commented Jan 21, 2022

Uh oh!

bedevere-bot commented Jan 21, 2022

Uh oh!

Uh oh!

		pdb help now gracefully handles any case where __doc__ is missing, for
		example when run from a windows embeddable package

Uh oh!

bpo-46434: Handle missing docstring in pdb help #30705

bpo-46434: Handle missing docstring in pdb help #30705

Uh oh!

Conversation

sparrowt commented Jan 19, 2022 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

the-knights-who-say-ni commented Jan 19, 2022

CLA Missing

Uh oh!

zooba commented Jan 19, 2022

Uh oh!

zooba Jan 20, 2022

Choose a reason for hiding this comment

Uh oh!

sparrowt Jan 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sparrowt Jan 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

miss-islington commented Jan 21, 2022

Uh oh!

miss-islington commented Jan 21, 2022

Uh oh!

bedevere-bot commented Jan 21, 2022

Uh oh!

miss-islington commented Jan 21, 2022

Uh oh!

miss-islington commented Jan 21, 2022

Uh oh!

bedevere-bot commented Jan 21, 2022

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Uh oh!

miss-islington commented Jan 21, 2022

Uh oh!

miss-islington commented Jan 21, 2022

Uh oh!

bedevere-bot commented Jan 21, 2022

Uh oh!

Uh oh!

sparrowt commented Jan 19, 2022 •

edited by bedevere-bot

Loading

sparrowt Jan 20, 2022 •

edited

Loading

sparrowt Jan 20, 2022 •

edited

Loading