MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-04-19 13:02:30 +07:00
Code Issues Packages Projects Releases Wiki Activity

PY-16760, PY-28549, PY-35743, PY-55609, PY-46654: Correct resolve of class attributes in docstrings

Browse Source 
Previously in docstrings we incorrectly recognized references in 'Attributes' section only as instance attribute references. It led to false positive 'Unresolved reference' on class attributes references in docstrings and wrong resolve when using class and instance attributes with the same names. Now we use ReferenceType.VARIABLE to identify both class and instance attribute references in 'Attributes' section and then resolve them with priority of instance attributes. Also fixed wrong resolve of attributes references to constructor parameters.

GitOrigin-RevId: ea10bfb092472c0ab14b77f06efd93093cfcd684
This commit is contained in:
Irina.Fediaeva
2022-07-27 00:12:26 +03:00
committed by intellij-monorepo-bot
parent ce84c71a5c
commit cce0ef17d5
32 changed files with 460 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
python/python-common-tests/com/jetbrains/python/PyCommonResolveTest.java
View File

@@ -1540,4 +1540,122 @@ public abstract class PyCommonResolveTest extends PyCommonResolveTestCase {
assertEquals("ModuleType", target.getContainingClass().getName());
assertEquals("types.pyi", target.getContainingFile().getName());
}
// PY-16760
public void testGoogleDocstringAttributeNameResolvesToClassAttribute() {
runWithDocStringFormat(DocStringFormat.GOOGLE, () -> assertResolvesTo(PyTargetExpression.class, "attr1"));
}
// PY-16760
public void testGoogleDocstringAttributeNameResolvesToInstanceAttributeOverClassAttribute() {
runWithDocStringFormat(DocStringFormat.GOOGLE, () -> {
PyTargetExpression definition = assertResolvesTo(PyTargetExpression.class, "attr1");
assertTrue(PyUtil.isInstanceAttribute(definition));
});
}
// PY-16760
public void testGoogleDocstringAttributeNameResolvesToInstanceAttributeOverInitParameter() {
runWithDocStringFormat(DocStringFormat.GOOGLE, () -> assertResolvesTo(PyTargetExpression.class, "attr1"));
}
// PY-16760
public void testNumpyDocstringAttributeNameResolvesToClassAttribute() {
runWithDocStringFormat(DocStringFormat.NUMPY, () -> assertResolvesTo(PyTargetExpression.class, "attr1"));
}
// PY-28549
public void testGoogleDocstringAttributeNameResolvesToDataclassClassAttribute() {
runWithDocStringFormat(DocStringFormat.GOOGLE, () -> assertResolvesTo(PyTargetExpression.class, "attr1"));
}
// PY-28549
public void testNumpyDocstringAttributeNameResolvesToDataclassClassAttribute() {
runWithDocStringFormat(DocStringFormat.NUMPY, () -> assertResolvesTo(PyTargetExpression.class, "attr1"));
}
// PY-28549
public void testNumpyDocstringParameterNameResolvesToDataclassClassAttributeWithoutInit() {
runWithDocStringFormat(DocStringFormat.NUMPY, () -> assertResolvesTo(PyTargetExpression.class, "attr1"));
}
// PY-28549
public void testNumpyDocstringParameterNameUnresolvedWithInit() {
runWithDocStringFormat(DocStringFormat.NUMPY, () -> assertUnresolved());
}
// PY-28549
public void testNumpyDocstringParameterNameResolvesToDataclassInitParameterOverClassAttribute() {
runWithDocStringFormat(DocStringFormat.NUMPY, () -> assertResolvesTo(PyNamedParameter.class, "attr1"));
}
// PY-35743
public void testGoogleDocstringAttributeNameResolvesToNamedTupleClassAttribute() {
runWithDocStringFormat(DocStringFormat.GOOGLE, () -> assertResolvesTo(PyTargetExpression.class, "attr1"));
}
// PY-35743
public void testNumpyDocstringAttributeNameResolvesToNamedTupleClassAttribute() {
runWithDocStringFormat(DocStringFormat.NUMPY, () -> assertResolvesTo(PyTargetExpression.class, "attr1"));
}
// PY-55609
public void testRestDocstringVarNameResolvesToInstanceAttributeOverInitParameter() {
runWithDocStringFormat(DocStringFormat.REST, () -> {
PyTargetExpression definition = assertResolvesTo(PyTargetExpression.class, "var1");
assertTrue(PyUtil.isInstanceAttribute(definition));
});
}
// PY-55609
public void testRestDocstringVarNameResolvesToInstanceAttributeOverClassAttribute() {
runWithDocStringFormat(DocStringFormat.REST, () -> {
PyTargetExpression definition = assertResolvesTo(PyTargetExpression.class, "var1");
assertTrue(PyUtil.isInstanceAttribute(definition));
});
}
// PY-55609
public void testRestDocstringIvarNameResolvesToInstanceAttributeOverInitParameter() {
runWithDocStringFormat(DocStringFormat.REST, () -> {
PyTargetExpression definition = assertResolvesTo(PyTargetExpression.class, "var1");
assertTrue(PyUtil.isInstanceAttribute(definition));
});
}
// PY-55609
public void testRestDocstringCvarNameResolvesToClassAttributeOverInitParameter() {
runWithDocStringFormat(DocStringFormat.REST, () -> {
PyTargetExpression definition = assertResolvesTo(PyTargetExpression.class, "var1");
assertTrue(PyUtil.isClassAttribute(definition));
});
}
// PY-55609
public void testRestDocstringCvarNameResolvesToClassAttributeOverInstanceAttribute() {
runWithDocStringFormat(DocStringFormat.REST, () -> {
PyTargetExpression definition = assertResolvesTo(PyTargetExpression.class, "var1");
assertTrue(PyUtil.isClassAttribute(definition));
});
}
// PY-55609
public void testRestDocstringVarNameResolvesToClassAttribute() {
runWithDocStringFormat(DocStringFormat.REST, () -> assertResolvesTo(PyTargetExpression.class, "var1"));
}
// PY-55609
public void testRestDocstringTypeOwnerNameResolvesToInitParameterOverClassAttribute() {
runWithDocStringFormat(DocStringFormat.REST, () -> assertResolvesTo(PyNamedParameter.class, "p"));
}
// PY-55609
public void testRestDocstringTypeOwnerNameResolvesToInitParameterOverInstanceAttribute() {
runWithDocStringFormat(DocStringFormat.REST, () -> assertResolvesTo(PyNamedParameter.class, "p"));
}
// PY-46654
public void testRestDocstringIvarNameResolvesToDataClassAttribute() {
runWithDocStringFormat(DocStringFormat.REST, () -> assertResolvesTo(PyTargetExpression.class, "var1"));
}
}

33
python/python-psi-impl/src/com/jetbrains/python/documentation/docstrings/DocStringParameterReference.java
View File

@@ -38,26 +38,23 @@ public class DocStringParameterReference extends PsiReferenceBase<PyStringLitera
return resolveParameter((PyFunction)owner);
}
if (owner instanceof PyClass) {
final PyFunction init = ((PyClass)owner).findMethodByName(PyNames.INIT, false, null);
if (init != null) {
PyElement element = resolveParameter(init);
if (element == null && (myType.equals(ReferenceType.CLASS_VARIABLE) || myType.equals(ReferenceType.PARAMETER_TYPE))) {
element = resolveClassVariable((PyClass)owner);
}
if (element == null && (myType.equals(ReferenceType.INSTANCE_VARIABLE) || myType.equals(ReferenceType.PARAMETER_TYPE))) {
element = resolveInstanceVariable((PyClass)owner);
}
return element;
PyClass pyClass = (PyClass)owner;
final PyFunction init = pyClass.findMethodByName(PyNames.INIT, false, null);
if (myType == ReferenceType.PARAMETER) {
return init != null ? resolveParameter(init) : resolveClassVariable(pyClass);
}
else {
PyElement element = null;
if (myType.equals(ReferenceType.CLASS_VARIABLE) || myType.equals(ReferenceType.PARAMETER_TYPE)) {
element = resolveClassVariable((PyClass)owner);
if (myType == ReferenceType.INSTANCE_VARIABLE || myType == ReferenceType.VARIABLE || myType == ReferenceType.PARAMETER_TYPE) {
if (myType == ReferenceType.PARAMETER_TYPE && init != null) {
PyNamedParameter parameter = resolveParameter(init);
if (parameter != null) {
return parameter;
}
}
if (element == null && (myType.equals(ReferenceType.INSTANCE_VARIABLE) || myType.equals(ReferenceType.PARAMETER_TYPE))) {
element = resolveInstanceVariable((PyClass)owner);
}
return element;
PyElement instanceAttr = resolveInstanceVariable(pyClass);
return instanceAttr != null ? instanceAttr : resolveClassVariable(pyClass);
}
if (myType == ReferenceType.CLASS_VARIABLE) {
return resolveClassVariable(pyClass);
}
}
if (owner instanceof PyFile && myType == ReferenceType.GLOBAL_VARIABLE) {

4
python/python-psi-impl/src/com/jetbrains/python/documentation/docstrings/DocStringReferenceProvider.java
View File

@@ -87,8 +87,8 @@ public class DocStringReferenceProvider extends PsiReferenceProvider {
final SectionBasedDocString sectioned = (SectionBasedDocString)docString;
result.addAll(referencesFromFields(expr, offset, sectioned.getParameterFields(), ReferenceType.PARAMETER));
result.addAll(referencesFromFields(expr, offset, sectioned.getKeywordArgumentFields(), ReferenceType.KEYWORD));
result.addAll(referencesFromFields(expr, offset, sectioned.getAttributeFields(),
PyUtil.isTopLevel(element) ? ReferenceType.GLOBAL_VARIABLE : ReferenceType.INSTANCE_VARIABLE));
result.addAll(referencesFromFields(expr, offset, sectioned.getAttributeFields(),
PyUtil.isTopLevel(element) ? ReferenceType.GLOBAL_VARIABLE : ReferenceType.VARIABLE));
result.addAll(referencesFromFields(expr, offset, sectioned.getReturnFields(), null));
}
return result.toArray(PsiReference.EMPTY_ARRAY);

7
python/testData/refactoring/rename/googleDocstringAttributeRenamesWithClassAttribute.py Normal file
View File

@@ -0,0 +1,7 @@
class MyClass:
"""Class description
Attributes:
at<caret>tr1: attr1 description
"""
attr1 = 1

7
python/testData/refactoring/rename/googleDocstringAttributeRenamesWithClassAttribute_after.py Normal file
View File

@@ -0,0 +1,7 @@
class MyClass:
"""Class description
Attributes:
bar: attr1 description
"""
bar = 1

10
python/testData/refactoring/rename/googleDocstringAttributeRenamesWithDataclassClassAttribute.py Normal file
View File

@@ -0,0 +1,10 @@
from dataclasses import dataclass
@dataclass
class MyClass:
"""Class description
Attributes:
at<caret>tr1: attr1 description
"""
attr1 = 1

10
python/testData/refactoring/rename/googleDocstringAttributeRenamesWithDataclassClassAttribute_after.py Normal file
View File

@@ -0,0 +1,10 @@
from dataclasses import dataclass
@dataclass
class MyClass:
"""Class description
Attributes:
bar: attr1 description
"""
bar = 1

12
python/testData/refactoring/rename/googleDocstringDataClassParameterRenamesWithClassAttribute.py Normal file
View File

@@ -0,0 +1,12 @@
from dataclasses import dataclass
@dataclass
class MyClass:
"""
Class description
Parameters:
at<caret>tr1: attribute description
"""
attr1 = 3

12
python/testData/refactoring/rename/googleDocstringDataClassParameterRenamesWithClassAttribute_after.py Normal file
View File

@@ -0,0 +1,12 @@
from dataclasses import dataclass
@dataclass
class MyClass:
"""
Class description
Parameters:
bar: attribute description
"""
bar = 3

15
python/testData/refactoring/rename/googleDocstringDataClassParameterRenamesWithInitParameterOverClassAttribute.py Normal file
View File

@@ -0,0 +1,15 @@
from dataclasses import dataclass
@dataclass
class MyClass:
"""
Class description
Parameters:
at<caret>tr1: attribute description
"""
attr1 = 3
def __init__(self, attr1):
pass

15
python/testData/refactoring/rename/googleDocstringDataClassParameterRenamesWithInitParameterOverClassAttribute_after.py Normal file
View File

@@ -0,0 +1,15 @@
from dataclasses import dataclass
@dataclass
class MyClass:
"""
Class description
Parameters:
bar: attribute description
"""
attr1 = 3
def __init__(self, bar):
pass

8
python/testData/resolve/GoogleDocstringAttributeNameResolvesToClassAttribute.py Normal file
View File

@@ -0,0 +1,8 @@
class MyClass:
"""Class description
Attributes:
attr1: attr1 description
<ref>
"""
attr1 = 1

11
python/testData/resolve/GoogleDocstringAttributeNameResolvesToDataclassClassAttribute.py Normal file
View File

@@ -0,0 +1,11 @@
from dataclasses import dataclass
@dataclass
class MyClass:
"""Class description
Attributes:
attr1: attr1 description
<ref>
"""
attr1 = 1

11
python/testData/resolve/GoogleDocstringAttributeNameResolvesToInstanceAttributeOverClassAttribute.py Normal file
View File

@@ -0,0 +1,11 @@
class MyClass:
"""Class description
Attributes:
attr1: attr1 description
<ref>
"""
attr1 = 1
def __init__(self):
self.attr1 = 0

10
python/testData/resolve/GoogleDocstringAttributeNameResolvesToInstanceAttributeOverInitParameter.py Normal file
View File

@@ -0,0 +1,10 @@
class MyClass:
"""Class description
Attributes:
attr1: attr1 description
<ref>
"""
def __init__(self, attr1):
self.attr1 = attr1

10
python/testData/resolve/GoogleDocstringAttributeNameResolvesToNamedTupleClassAttribute.py Normal file
View File

@@ -0,0 +1,10 @@
from typing import NamedTuple
class SomeObject(NamedTuple):
"""Class description
Attributes:
attr1: attr1 description
<ref>
"""
attr1 = 1

10
python/testData/resolve/NumpyDocstringAttributeNameResolvesToClassAttribute.py Normal file
View File

@@ -0,0 +1,10 @@
class MyClass:
"""Class description
Attributes
----------
attr1:
<ref>
attr1 description
"""
attr1 = 1

13
python/testData/resolve/NumpyDocstringAttributeNameResolvesToDataclassClassAttribute.py Normal file
View File

@@ -0,0 +1,13 @@
from dataclasses import dataclass
@dataclass
class MyClass:
"""Class description
Attributes
----------
attr1:
<ref>
attr1 description
"""
attr1 = 1

12
python/testData/resolve/NumpyDocstringAttributeNameResolvesToNamedTupleClassAttribute.py Normal file
View File

@@ -0,0 +1,12 @@
from typing import NamedTuple
class SomeObject(NamedTuple):
"""Class description
Attributes
---------
attr1:
<ref>
attr1 description
"""
attr1 = 1

13
python/testData/resolve/NumpyDocstringParameterNameResolvesToDataclassClassAttributeWithoutInit.py Normal file
View File

@@ -0,0 +1,13 @@
from dataclasses import dataclass
@dataclass
class MyClass:
"""Class description
Parameters
----------
attr1:
<ref>
attr1 description
"""
attr1 = 1

16
python/testData/resolve/NumpyDocstringParameterNameResolvesToDataclassInitParameterOverClassAttribute.py Normal file
View File

@@ -0,0 +1,16 @@
from dataclasses import dataclass
@dataclass
class MyClass:
"""Class description
Parameters
----------
attr1:
<ref>
attr1 description
"""
attr1 = 1
def __init__(self, attr1):
pass

16
python/testData/resolve/NumpyDocstringParameterNameUnresolvedWithInit.py Normal file
View File

@@ -0,0 +1,16 @@
from dataclasses import dataclass
@dataclass
class MyClass:
"""Class description
Parameters
----------
attr1:
<ref>
attr1 description
"""
attr1 = 1
def __init__(self):
pass

11
python/testData/resolve/RestDocstringCvarNameResolvesToClassAttributeOverInitParameter.py Normal file
View File

@@ -0,0 +1,11 @@
class MyClass:
"""Class description
:cvar var1: var1 description
<ref>
"""
var1 = 1
def __init__(self, var1):
pass

11
python/testData/resolve/RestDocstringCvarNameResolvesToClassAttributeOverInstanceAttribute.py Normal file
View File

@@ -0,0 +1,11 @@
class MyClass:
"""Class description
:cvar var1: var1 description
<ref>
"""
var1 = 1
def __init__(self):
self.var1 = 0

9
python/testData/resolve/RestDocstringIvarNameResolvesToDataClassAttribute.py Normal file
View File

@@ -0,0 +1,9 @@
from dataclasses import dataclass
@dataclass
class MyClass:
"""
:ivar var1: description
<ref>
"""
var1 = 0

9
python/testData/resolve/RestDocstringIvarNameResolvesToInstanceAttributeOverInitParameter.py Normal file
View File

@@ -0,0 +1,9 @@
class MyClass:
"""Class description
:ivar var1: var1 description
<ref>
"""
def __init__(self, var1):
self.var1 = var1

10
python/testData/resolve/RestDocstringTypeOwnerNameResolvesToInitParameterOverClassAttribute.py Normal file
View File

@@ -0,0 +1,10 @@
class MyClass:
"""
:param p: description
:type p: int
<ref>
"""
p = 0
def __init__(self, p):
pass

9
python/testData/resolve/RestDocstringTypeOwnerNameResolvesToInitParameterOverInstanceAttribute.py Normal file
View File

@@ -0,0 +1,9 @@
class MyClass:
"""
:param p: description
:type p: int
<ref>
"""
def __init__(self, p):
self.p = p

8
python/testData/resolve/RestDocstringVarNameResolvesToClassAttribute.py Normal file
View File

@@ -0,0 +1,8 @@
class MyClass:
"""Class description
:var var1: var1 description
<ref>
"""
var1 = 1

11
python/testData/resolve/RestDocstringVarNameResolvesToInstanceAttributeOverClassAttribute.py Normal file
View File

@@ -0,0 +1,11 @@
class MyClass:
"""Class description
:var var1: var1 description
<ref>
"""
var1 = 1
def __init__(self):
self.var1 = 0

9
python/testData/resolve/RestDocstringVarNameResolvesToInstanceAttributeOverInitParameter.py Normal file
View File

@@ -0,0 +1,9 @@
class MyClass:
"""Class description
:var var1: var1 description
<ref>
"""
def __init__(self, var1):
self.var1 = var1

20
python/testSrc/com/jetbrains/python/refactoring/PyRenameTest.java
View File

@@ -224,6 +224,26 @@ public class PyRenameTest extends PyTestCase {
renameWithDocStringFormat(DocStringFormat.NUMPY, "bar");
}
// PY-16760
public void testGoogleDocstringAttributeRenamesWithClassAttribute() {
renameWithDocStringFormat(DocStringFormat.GOOGLE, "bar");
}
// PY-28549
public void testGoogleDocstringAttributeRenamesWithDataclassClassAttribute() {
renameWithDocStringFormat(DocStringFormat.GOOGLE, "bar");
}
// PY-28549
public void testGoogleDocstringDataClassParameterRenamesWithClassAttribute() {
renameWithDocStringFormat(DocStringFormat.GOOGLE, "bar");
}
// PY-28549
public void testGoogleDocstringDataClassParameterRenamesWithInitParameterOverClassAttribute() {
renameWithDocStringFormat(DocStringFormat.GOOGLE, "bar");
}
// PY-2748
public void testFormatStringDictLiteral() {
doUnsupportedOperationTest();