Add support for attribute docstring in the semantic model #11315
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.
Summary
This PR adds updates the semantic model to detect attribute docstring.
Refer to PEP 258 for the definition of an attribute docstring.
This PR doesn't add full support for it but only considers string literals as attribute docstring for the following cases:
For an assignment statement, it's considered an attribute docstring only if the target expression is a name expression (
x = 1
). So, chained assignment, multiple assignment or unpacking, and starred expression, which are all valid in the target position, aren't considered here.In
__init__
method, an assignment to theself
variable likeself.x = 1
is also a candidate for an attribute docstring. This PR does not support this position.Test Plan
I used the following source code along with a print statement to verify that the attribute docstring detection is correct.
Source code to test against:
I'll add this in the follow-up PR (#11302) which uses this method.