BUG: Make docscrape ParseError Python 3 compatible. #91
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
Fix `__str__` for `ParseError` in Python 3, which was resulting in error messages with `numpydoc.docscrape.ParseError: <unprintable ParseError object>` instead of the intended descriptive message. Use `args[0]` instead of `Exception`'s `message` member, which had been removed in Python 3. `args` is available to both Python 2 and 3. The `__str__` method had been failing on an `AttributeError` when using `self.message`, resulting in an unprintable Exception, which occluded the offending typo in a function name which triggered the`ParseError`.
|
I'm probably not the right person to review this. @Carreau, can you give a hand? |
|
LGTM, merged. Thanks @ehebert |
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.
Fix
__str__forParseErrorin Python 3, which was resulting in errormessages with
numpydoc.docscrape.ParseError: <unprintable ParseError object>instead of the intended descriptive message.
Use
args[0]instead ofException'smessagemember, which had been removedin Python 3.
argsis available to both Python 2 and 3. The__str__methodhad been failing on an
AttributeErrorwhen usingself.message, resulting inan unprintable Exception, which occluded the offending typo in a function name
which triggered the
ParseError.