fix: do not treat a bracketed string literal as an attribute docstring - #364
Open
Sanjays2402 wants to merge 1 commit into
Open
fix: do not treat a bracketed string literal as an attribute docstring#364Sanjays2402 wants to merge 1 commit into
Sanjays2402 wants to merge 1 commit into
Conversation
is_attribute_docstring() returned True for any triple-quoted string that had
an '=' anywhere before it, so a string passed as a call argument or placed in
a list/dict literal after an assignment was classified as an attribute
docstring and reformatted. This corrupted non-docstring literals such as
textwrap.dedent("""..."""), collapsing multi-line scripts onto one line.
A string nested inside an unclosed bracket is an argument or a collection
element, never an attribute docstring, so the classifier now rejects it.
Adds a parametrized regression test covering call, dict and list nesting.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #344.
is_attribute_docstring()returned True for any triple-quoted string with an=anywhere before it, so a string passed as a call argument (or placed in a list/dict literal after an assignment) was classified as an attribute docstring and reformatted — collapsingtextwrap.dedent("""...""")scripts onto one line. A string nested inside an unclosed bracket is an argument or collection element, never an attribute docstring, so the classifier now rejects it.Regression test fails without the source change and passes with it; the rest of the suite is unchanged (same 29 pre-existing end-to-end errors before and after).