completed signature parser with cleanup

Author: DonJayamanne

src/client/jedi/parsers/HoverParser.ts

@@ -4,6 +4,10 @@ import { highlightCode } from '../../providers/jediHelpers';
 import { EOL } from 'os';
 export class HoverParser {
     public static parse(data: proxy.IHoverResult, currentWord: string): Hover {
+        if (!data || !Array.isArray(data.items) || data.items.length === 0) {
+            return new Hover([]);
+        }
+
         let results = [];
         let capturedInfo: string[] = [];
         data.items.forEach(item => {

src/client/jedi/parsers/LocationParser.ts

@@ -1,6 +1,23 @@
-import { Location } from 'vscode';
+import { Location, Range, Uri } from 'vscode';
+import * as proxy from '../../providers/jediProxy';
 export class LocationParser {
-    public static parse(data: Object): Location[] {
-        return [];
+    public static parse(data: proxy.IReferenceResult): Location[] {
+        if (!data || !Array(data.references) || data.references.length === 0) {
+            return [];
+        }
+        var references = data.references.filter(ref => {
+            if (!ref || typeof ref.columnIndex !== 'number' || typeof ref.lineIndex !== 'number'
+                || typeof ref.fileName !== 'string' || ref.columnIndex === -1 || ref.lineIndex === -1 || ref.fileName.length === 0) {
+                return false;
+            }
+            return true;
+        }).map(ref => {
+            var definitionResource = Uri.file(ref.fileName);
+
+            var range = new Range(ref.lineIndex, ref.columnIndex, ref.lineIndex, ref.columnIndex);
+            return new Location(definitionResource, range);
+        });
+
+        return references;
     }
-}
+}

src/client/jedi/parsers/SignatureHelpParser.ts

@@ -1,6 +1,73 @@
 import { SignatureHelp } from 'vscode';
+import * as vscode from "vscode";
+import * as proxy from "../../providers/jediProxy";
+
+const DOCSTRING_PARAM_PATTERNS = [
+    "\\s*:type\\s*PARAMNAME:\\s*([^\\n, ]+)", // Sphinx
+    "\\s*:param\\s*(\\w?)\\s*PARAMNAME:[^\\n]+",  // Sphinx param with type
+    "\\s*@type\\s*PARAMNAME:\\s*([^\\n, ]+)"  // Epydoc
+];
+
+/**
+ * Extrct the documentation for parameters from a given docstring
+ * 
+ * @param {string} paramName Name of the parameter
+ * @param {string} docString The docstring for the function
+ * @returns {string} Docstring for the parameter
+ */
+function extractParamDocString(paramName: string, docString: string): string {
+    let paramDocString = "";
+    // In docstring the '*' is escaped with a backslash
+    paramName = paramName.replace(new RegExp("\\*", "g"), "\\\\\\*");
+
+    DOCSTRING_PARAM_PATTERNS.forEach(pattern => {
+        if (paramDocString.length > 0) {
+            return;
+        }
+        pattern = pattern.replace("PARAMNAME", paramName);
+        let regExp = new RegExp(pattern);
+        let matches = regExp.exec(docString);
+        if (matches && matches.length > 0) {
+            paramDocString = matches[0];
+            if (paramDocString.indexOf(":") >= 0) {
+                paramDocString = paramDocString.substring(paramDocString.indexOf(":") + 1);
+            }
+            if (paramDocString.indexOf(":") >= 0) {
+                paramDocString = paramDocString.substring(paramDocString.indexOf(":") + 1);
+            }
+        }
+    });
+
+    return paramDocString.trim();
+}
 export class SignatureHelpParser {
-    public static parse(data: Object): SignatureHelp {
-        return null;
+    public static parse(data: proxy.IArgumentsResult): SignatureHelp {
+        if (!data || !Array.isArray(data.definitions) || data.definitions.length === 0) {
+            return new SignatureHelp();
+        }
+        let signature = new SignatureHelp();
+        signature.activeSignature = 0;
+
+        data.definitions.forEach(def => {
+            signature.activeParameter = def.paramindex;
+            // Don't display the documentation, as vs code doesn't format the docmentation
+            // i.e. line feeds are not respected, long content is stripped
+            let sig = <vscode.SignatureInformation>{
+                // documentation: def.docstring,
+                label: def.description,
+                parameters: []
+            };
+            sig.parameters = def.params.map(arg => {
+                if (arg.docstring.length === 0) {
+                    arg.docstring = extractParamDocString(arg.name, def.docstring);
+                }
+                return <vscode.ParameterInformation>{
+                    documentation: arg.docstring.length > 0 ? arg.docstring : arg.description,
+                    label: arg.description.length > 0 ? arg.description : arg.name
+                };
+            });
+            signature.signatures.push(sig);
+        });
+        return signature;
     }
 }

src/client/providers/signatureProvider.ts

@@ -1,9 +1,8 @@
 "use strict";
 
 import * as vscode from "vscode";
-import { TextDocument, Position, CancellationToken, SignatureHelp, ExtensionContext } from "vscode";
+import { TextDocument, Position, CancellationToken, SignatureHelp } from "vscode";
 import * as proxy from "./jediProxy";
-import * as telemetryContracts from "../common/telemetryContracts";
 
 const DOCSTRING_PARAM_PATTERNS = [
     "\\s*:type\\s*PARAMNAME:\\s*([^\\n, ]+)", // Sphinx