mirror of
https://gitflic.ru/project/openide/openide.git
synced 2026-09-27 10:03:11 +07:00
added tests for generating docstrings in python
This commit is contained in:
@@ -9,10 +9,10 @@ import java.util.List;
|
||||
*/
|
||||
public class DocStringFormat {
|
||||
public static final String PLAIN = "Plain";
|
||||
public static final String EPYDOC = "Epytext";
|
||||
public static final String SPHINX = "Restructuredtext";
|
||||
public static final String EPYTEXT = "Epytext";
|
||||
public static final String REST = "Restructuredtext";
|
||||
|
||||
public static final List<String> ALL = ImmutableList.of(PLAIN, EPYDOC, SPHINX);
|
||||
public static final List<String> ALL = ImmutableList.of(PLAIN, EPYTEXT, REST);
|
||||
|
||||
private DocStringFormat() {
|
||||
}
|
||||
|
||||
@@ -17,16 +17,20 @@ public class PyDocumentationSettings implements PersistentStateComponent<PyDocum
|
||||
public String myDocStringFormat = DocStringFormat.PLAIN;
|
||||
|
||||
public boolean isEpydocFormat() {
|
||||
return DocStringFormat.EPYDOC.equals(myDocStringFormat);
|
||||
return DocStringFormat.EPYTEXT.equals(myDocStringFormat);
|
||||
}
|
||||
public boolean isReSTFormat() {
|
||||
return DocStringFormat.SPHINX.equals(myDocStringFormat);
|
||||
return DocStringFormat.REST.equals(myDocStringFormat);
|
||||
}
|
||||
|
||||
public static PyDocumentationSettings getInstance(Project project) {
|
||||
return ServiceManager.getService(project, PyDocumentationSettings.class);
|
||||
}
|
||||
|
||||
public void setFormat(String format) {
|
||||
myDocStringFormat = format;
|
||||
}
|
||||
|
||||
@Override
|
||||
public PyDocumentationSettings getState() {
|
||||
return this;
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
|
||||
def foo(a, b):
|
||||
"""<caret>
|
||||
pass
|
||||
|
||||
def foo1():
|
||||
"""
|
||||
:return :
|
||||
"""
|
||||
@@ -0,0 +1,13 @@
|
||||
|
||||
def foo(a, b):
|
||||
"""
|
||||
@param a:
|
||||
@param b:
|
||||
@return:
|
||||
"""
|
||||
pass
|
||||
|
||||
def foo1():
|
||||
"""
|
||||
:return :
|
||||
"""
|
||||
@@ -0,0 +1,9 @@
|
||||
|
||||
def foo(a, b):
|
||||
"""<caret>
|
||||
pass
|
||||
|
||||
def foo1():
|
||||
"""
|
||||
:return :
|
||||
"""
|
||||
@@ -0,0 +1,13 @@
|
||||
|
||||
def foo(a, b):
|
||||
"""
|
||||
:param a:
|
||||
:param b:
|
||||
:return:
|
||||
"""
|
||||
pass
|
||||
|
||||
def foo1():
|
||||
"""
|
||||
:return :
|
||||
"""
|
||||
@@ -1,11 +1,14 @@
|
||||
package com.jetbrains.python;
|
||||
|
||||
import com.intellij.codeInsight.CodeInsightSettings;
|
||||
import com.intellij.codeInsight.editorActions.smartEnter.SmartEnterProcessor;
|
||||
import com.intellij.codeInsight.editorActions.smartEnter.SmartEnterProcessors;
|
||||
import com.intellij.lang.Language;
|
||||
import com.intellij.openapi.application.Result;
|
||||
import com.intellij.openapi.command.WriteCommandAction;
|
||||
import com.intellij.openapi.editor.Editor;
|
||||
import com.jetbrains.python.documentation.DocStringFormat;
|
||||
import com.jetbrains.python.documentation.PyDocumentationSettings;
|
||||
import com.jetbrains.python.fixtures.PyLightFixtureTestCase;
|
||||
|
||||
import java.util.List;
|
||||
@@ -100,4 +103,20 @@ public class PySmartEnterTest extends PyLightFixtureTestCase {
|
||||
public void testPy3209() {
|
||||
doTest();
|
||||
}
|
||||
|
||||
public void testDocRest() {
|
||||
CodeInsightSettings codeInsightSettings = CodeInsightSettings.getInstance();
|
||||
codeInsightSettings.JAVADOC_STUB_ON_ENTER = true;
|
||||
PyDocumentationSettings documentationSettings = PyDocumentationSettings.getInstance(myFixture.getProject());
|
||||
documentationSettings.setFormat(DocStringFormat.REST);
|
||||
doTest();
|
||||
}
|
||||
|
||||
public void testDocEpytext() {
|
||||
CodeInsightSettings codeInsightSettings = CodeInsightSettings.getInstance();
|
||||
codeInsightSettings.JAVADOC_STUB_ON_ENTER = true;
|
||||
PyDocumentationSettings documentationSettings = PyDocumentationSettings.getInstance(myFixture.getProject());
|
||||
documentationSettings.setFormat(DocStringFormat.EPYTEXT);
|
||||
doTest();
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user