Merge branch 'master' into traff/zip_helpers
[idea/community.git] / python / src / com / jetbrains / python / documentation / docstrings / PyStructuredDocstringFormatter.java
1 /*
2  * Copyright 2000-2014 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.jetbrains.python.documentation.docstrings;
17
18 import com.google.common.collect.Lists;
19 import com.intellij.execution.process.ProcessOutput;
20 import com.intellij.openapi.diagnostic.Logger;
21 import com.intellij.openapi.module.Module;
22 import com.intellij.openapi.module.ModuleManager;
23 import com.intellij.openapi.module.ModuleUtilCore;
24 import com.intellij.openapi.projectRoots.Sdk;
25 import com.intellij.openapi.util.text.StringUtil;
26 import com.intellij.openapi.vfs.encoding.EncodingProjectManager;
27 import com.intellij.psi.PsiElement;
28 import com.jetbrains.python.HelperPackage;
29 import com.jetbrains.python.PythonHelper;
30 import com.jetbrains.python.documentation.PyDocumentationBuilder;
31 import com.jetbrains.python.psi.StructuredDocString;
32 import com.jetbrains.python.sdk.PySdkUtil;
33 import com.jetbrains.python.sdk.PythonEnvUtil;
34 import com.jetbrains.python.sdk.PythonSdkType;
35 import com.jetbrains.python.toolbox.Substring;
36 import org.jetbrains.annotations.NotNull;
37 import org.jetbrains.annotations.Nullable;
38
39 import java.io.File;
40 import java.nio.ByteBuffer;
41 import java.nio.charset.Charset;
42 import java.util.ArrayList;
43 import java.util.HashMap;
44 import java.util.List;
45 import java.util.Map;
46
47 /**
48  * @author yole
49  */
50 public class PyStructuredDocstringFormatter {
51   private static final Logger LOG = Logger.getInstance(PyStructuredDocstringFormatter.class);
52
53   private PyStructuredDocstringFormatter() {
54   }
55
56   @Nullable
57   public static List<String> formatDocstring(@NotNull final PsiElement element, @NotNull final String docstring) {
58     Module module = ModuleUtilCore.findModuleForPsiElement(element);
59     if (module == null) {
60       final Module[] modules = ModuleManager.getInstance(element.getProject()).getModules();
61       if (modules.length == 0) return Lists.newArrayList();
62       module = modules[0];
63     }
64     if (module == null) return Lists.newArrayList();
65     final List<String> result = new ArrayList<String>();
66
67     final String[] lines = PyDocumentationBuilder.removeCommonIndentation(docstring);
68     final String preparedDocstring = StringUtil.join(lines, "\n");
69
70     final HelperPackage formatter;
71     final StructuredDocString structuredDocString;
72     final DocStringFormat format = DocStringUtil.guessDocStringFormat(preparedDocstring, element);
73     if (format == DocStringFormat.GOOGLE) {
74       formatter = PythonHelper.GOOGLE_FORMATTER;
75       structuredDocString = DocStringUtil.parseDocString(DocStringFormat.GOOGLE, preparedDocstring);
76     }
77     else if (format == DocStringFormat.NUMPY) {
78       formatter = PythonHelper.NUMPY_FORMATTER;
79       structuredDocString = DocStringUtil.parseDocString(DocStringFormat.NUMPY, preparedDocstring);
80     }
81     else if (format == DocStringFormat.EPYTEXT) {
82       formatter = PythonHelper.EPYDOC_FORMATTER;
83       structuredDocString = DocStringUtil.parseDocString(DocStringFormat.EPYTEXT, preparedDocstring);
84       result.add(formatStructuredDocString(structuredDocString));
85     }
86     else if (format == DocStringFormat.REST) {
87       formatter = PythonHelper.REST_FORMATTER;
88       structuredDocString = DocStringUtil.parseDocString(DocStringFormat.REST, preparedDocstring);
89     }
90
91     else {
92       return null;
93     }
94
95     final String output = runExternalTool(module, formatter, docstring);
96     if (output != null) {
97       result.add(0, output);
98     }
99     else {
100       result.add(0, structuredDocString.getDescription());
101     }
102
103     return result;
104   }
105
106   @Nullable
107   private static String runExternalTool(@NotNull final Module module,
108                                         @NotNull final HelperPackage formatter,
109                                         @NotNull final String docstring) {
110     final Sdk sdk = PythonSdkType.findPython2Sdk(module);
111     if (sdk == null) return null;
112
113     final String sdkHome = sdk.getHomePath();
114     if (sdkHome == null) return null;
115
116     final Charset charset = EncodingProjectManager.getInstance(module.getProject()).getDefaultCharset();
117
118     final ByteBuffer encoded = charset.encode(docstring);
119     final byte[] data = new byte[encoded.limit()];
120     encoded.get(data);
121
122     final Map<String, String> env = new HashMap<String, String>();
123     PythonEnvUtil.setPythonDontWriteBytecode(env);
124
125     final ProcessOutput output = PySdkUtil.getProcessOutput(formatter.newCommandLine(sdkHome, Lists.<String>newArrayList()),
126                                                             new File(sdkHome).getParent(),
127                                                             env, 5000, data, true);
128     if (output.isTimeout()) {
129       LOG.info("timeout when calculating docstring");
130       return null;
131     }
132     else if (output.getExitCode() != 0) {
133       final String error = "error when calculating docstring: " + output.getStderr();
134       LOG.info(error);
135       return null;
136     }
137     return output.getStdout();
138   }
139
140   private static String formatStructuredDocString(@NotNull final StructuredDocString docString) {
141     final StringBuilder result = new StringBuilder();
142
143     final String attributeDescription = docString.getAttributeDescription();
144     if (attributeDescription != null) {
145       result.append(attributeDescription);
146       final String attrType = docString.getParamType(null);
147       if (attrType != null) {
148         result.append(" <i>Type: ").append(attrType).append("</i>");
149       }
150     }
151
152     formatParameterDescriptions(docString, result, false);
153     formatParameterDescriptions(docString, result, true);
154
155     final String returnDescription = docString.getReturnDescription();
156     final String returnType = docString.getReturnType();
157     if (returnDescription != null || returnType != null) {
158       result.append("<br><b>Return value:</b><br>");
159       if (returnDescription != null) {
160         result.append(returnDescription);
161       }
162       if (returnType != null) {
163         result.append(" <i>Type: ").append(returnType).append("</i>");
164       }
165     }
166
167     final List<String> raisedException = docString.getRaisedExceptions();
168     if (raisedException.size() > 0) {
169       result.append("<br><b>Raises:</b><br>");
170       for (String s : raisedException) {
171         result.append("<b>").append(s).append("</b> - ").append(docString.getRaisedExceptionDescription(s)).append("<br>");
172       }
173     }
174
175     if (docString instanceof TagBasedDocString) {
176       final TagBasedDocString taggedDocString = (TagBasedDocString)docString;
177       final List<String> additionalTags = taggedDocString.getAdditionalTags();
178       if (!additionalTags.isEmpty()) {
179         result.append("<br/><br/><b>Additional:</b><br/>");
180         result.append("<table>");
181         for (String tagName : additionalTags) {
182           final List<Substring> args = taggedDocString.getTagArguments(tagName);
183           for (Substring arg : args) {
184             final String s = arg.toString();
185             result.append("<tr><td align=\"right\"><b>").append(tagName);
186             result.append(" ").append(s).append(":</b>");
187             result.append("</td><td>").append(taggedDocString.getTagValue(tagName, s)).append("</td></tr>");
188           }
189           result.append("</table>");
190         }
191       }
192     }
193     return result.toString();
194   }
195
196   private static void formatParameterDescriptions(@NotNull final StructuredDocString docString,
197                                                   @NotNull final StringBuilder result,
198                                                   boolean keyword) {
199     final List<String> parameters = keyword ? docString.getKeywordArguments() : docString.getParameters();
200     if (parameters.size() > 0) {
201       result.append("<br><b>").append(keyword ? "Keyword arguments:" : "Parameters").append("</b><br>");
202       for (String parameter : parameters) {
203         final String description = keyword ? docString.getKeywordArgumentDescription(parameter) : docString.getParamDescription(parameter);
204         result.append("<b>");
205         result.append(parameter);
206         result.append("</b>: ");
207         if (description != null) {
208           result.append(description);
209         }
210         final String paramType = docString.getParamType(parameter);
211         if (paramType != null) {
212           result.append(" <i>Type: ").append(paramType).append("</i>");
213         }
214         result.append("<br>");
215       }
216     }
217   }
218 }