gh-102799: Let pydoc use the exception instead of sys.exc_info #102830
Conversation
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
terryjreedy
reviewed
Mar 20, 2023
Lib/pydoc.py
Outdated
Comment on lines
392
to
396
| if not isinstance(exc_info, tuple): | ||
| assert isinstance(exc_info, BaseException) | ||
| exc_info = type(exc_info), exc_info, exc_info.__traceback__ | ||
| self.filename = filename | ||
| self.exc, self.value, self.tb = exc_info |
There was a problem hiding this comment.
Separate suggestions:
- Keep handling of two args in order. First first and second second. Handling first in middle of second is unnecessary confusion.
- Handle two cases of second separately. Don't create tuple just to unpack. Unpacking makes it slightly more obvious that same attributes are defined, but pack/unpack makes it harder to see what object is assigned to each attribute.
Suggested change
| if not isinstance(exc_info, tuple): | |
| assert isinstance(exc_info, BaseException) | |
| exc_info = type(exc_info), exc_info, exc_info.__traceback__ | |
| self.filename = filename | |
| self.exc, self.value, self.tb = exc_info | |
| self.filename = filename | |
| if isinstance(exc_info, tuple): | |
| self.exc, self.value, self.tb = exc_info | |
| else: | |
| assert isinstance(exc_info, BaseException) | |
| self.exc = type(exc_info) | |
| self.value = exc_info | |
| self.tb = exc_info.__traceback__ |
I am tempted to think that no user will ever raise this exception. pydoc is only documented as a command-line app, not as importable library. But this is not idlelib. Can/should we emit a DeprecationWarning in the isinstance clause? It could then be removed someday. Since there is no doc of the module content, no changed notice is needed.
Lib/pydoc.py
Outdated
| @@ -440,21 +443,20 @@ def safeimport(path, forceload=0, cache={}): | ||
| cache[key] = sys.modules[key] | ||
| del sys.modules[key] | ||
| module = __import__(path) | ||
| except: | ||
| except BaseException as e: |
There was a problem hiding this comment.
I personally prefer 'err' to 'e'. I have no idea of any general consensus.
iritkatriel
commented
Mar 20, 2023
Fidget-Spinner
pushed a commit
to Fidget-Spinner/cpython
that referenced
this pull request
Mar 27, 2023
warsaw
pushed a commit
to warsaw/cpython
that referenced
this pull request
Apr 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Uh oh!
There was an error while loading. Please reload this page.