PY-15240 Surround "self" with spaces if code style settings require it

This commit is contained in:
Mikhail Golubev
2017-10-02 13:58:42 +03:00
parent 609bcefea3
commit b70a2112cc
6 changed files with 61 additions and 7 deletions
@@ -27,9 +27,13 @@ import com.intellij.openapi.util.TextRange;
import com.intellij.psi.PsiDocumentManager;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFile;
import com.intellij.psi.codeStyle.CodeStyleSettings;
import com.intellij.psi.codeStyle.CodeStyleSettingsManager;
import com.intellij.psi.codeStyle.CommonCodeStyleSettings;
import com.jetbrains.python.PyNames;
import com.jetbrains.python.PyTokenTypes;
import com.jetbrains.python.PythonFileType;
import com.jetbrains.python.PythonLanguage;
import com.jetbrains.python.psi.PyFunction;
import com.jetbrains.python.psi.PyUtil;
import com.jetbrains.python.psi.impl.PyPsiUtils;
@@ -79,23 +83,41 @@ public class PyMethodNameTypedHandler extends TypedHandlerDelegate {
if (flags != null) {
// we're in a method
// TODO: all string constants go to Settings
String pname = flags.isClassMethod() || flags.isMetaclassMethod() ? "cls" : "self";
String paramName = flags.isClassMethod() || flags.isMetaclassMethod() ? "cls" : "self";
final boolean isNew = PyNames.NEW.equals(func.getName());
if (flags.isMetaclassMethod() && isNew) {
pname = "typ";
paramName = "typ";
}
else if (flags.isClassMethod() || isNew) {
pname = "cls";
paramName = "cls";
}
else if (flags.isStaticMethod()) {
paramName = "";
}
else if (flags.isStaticMethod()) pname = "";
// TODO: only print the ")" if Settings require it
final CodeStyleSettings settingsManager = CodeStyleSettingsManager.getSettings(project);
final CommonCodeStyleSettings settings = settingsManager.getCommonSettings(PythonLanguage.getInstance());
final StringBuilder textToType = new StringBuilder();
textToType.append("(");
if (!paramName.isEmpty()) {
if (settings.SPACE_WITHIN_METHOD_PARENTHESES) {
textToType.append(" ");
}
textToType.append(paramName);
if (settings.SPACE_WITHIN_METHOD_PARENTHESES) {
textToType.append(" ");
}
}
else if (settings.SPACE_WITHIN_EMPTY_METHOD_PARENTHESES) {
textToType.append(" ");
}
textToType.append(")");
final int caretOffset = editor.getCaretModel().getOffset();
String textToType = "(" + pname + ")";
final CharSequence chars = editor.getDocument().getCharsSequence();
if (caretOffset == chars.length() || chars.charAt(caretOffset) != ':') {
textToType += ':';
textToType.append(':');
}
EditorModificationUtil.insertStringAtCaret(editor, textToType, true, 1 + pname.length()); // right after param name
EditorModificationUtil.insertStringAtCaret(editor, textToType.toString(), true, 1 + paramName.length()); // right after param name
return Result.STOP;
}
}
@@ -0,0 +1,5 @@
class C:
def method(self):
@staticmethod
def static( ):
@@ -0,0 +1,5 @@
class C:
def method<caret>
@staticmethod
def static<caret>
@@ -0,0 +1,5 @@
class C:
def method( self ):
@staticmethod
def static():
@@ -0,0 +1,5 @@
class C:
def method<caret>
@staticmethod
def static<caret>
@@ -552,6 +552,18 @@ public class PyEditingTest extends PyTestCase {
doTypingTest('(');
}
// PY-15240
public void testFirstParamSpacesInsideParentheses() {
getCommonCodeStyleSettings().SPACE_WITHIN_METHOD_PARENTHESES = true;
doTypingTest('(');
}
// PY-15240
public void testFirstParamSpacesInsideEmptyParentheses() {
getCommonCodeStyleSettings().SPACE_WITHIN_EMPTY_METHOD_PARENTHESES = true;
doTypingTest('(');
}
// PY-21289
public void testPairedParenthesesMultipleCalls() {
doTypingTest('(');