Improvements

Author: njqdev

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 nj2534
+Copyright (c) 2020 nj-q
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,6 +1,6 @@
 # Python Type Hint
 
-Provides type hint auto-completion for Python.
+Provides type hint auto-completion for Python, with completion items for built-in types, classes and the typing module.
 
 ![](demo.gif)
 
@@ -12,14 +12,20 @@ Provides type hint auto-completion for Python.
 
 * Can provide completion items for the typing module if it is imported.
 
+## Settings
+
+| Name | Description | Default
+|---|---|---|
+| workspace.search.limit | _(number)_ The maximum number of files searched when estimating types for a parameter.
+
+If 0, only the current editor document is searched, which increases speed but can reduce estimation accuracy. | 20
+
 ## Installation
 
-Get this extension from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=).
+Get this extension from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=vscode-python-typehint).
 
 ## Known Issues
 
 * The difference between function and class constructor calls when detecting types is determined by the first letter being upper case (unless the class or function is defined in the currently edited document).
 
-* Up to 20 files within in the workspace are searched at a time. The limit is by design to keep the extension light weight, but there's probably a better solution.
-
 -------------------------------------------------------------------------------------------

demo.gif

@@ -2,12 +2,12 @@
 	"name": "vscode-python-typehint",
     "displayName": "Python Type Hint",
     "version": "1.0.0",
-    "publisher": "nj2532",
+    "publisher": "nj-q",
     "description": "Type hint completion for Python.",
     "icon": "images/icon.png",
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/nj2532/vscode-python-typehint"
+		"url": "https://github.com/nj-q/vscode-python-typehint"
 	},
     "license": "MIT",
 	"categories": [
@@ -43,10 +43,10 @@
         "configuration": {
             "title": "Python Type Hint",
             "properties": {
-              "pyTypehint.search.limit": {
+              "workspace.search.limit": {
                 "type": "number",
-                "default": 30,
-                "description": "When providing type hint items, the number of files searched will be limited by this setting."
+                "default": 20,
+                "description": "The maximum number of files searched when estimating types for a parameter. If 0, only the current editor document is searched, which increases speed but can reduce estimation accuracy."
               }
             }
         }

images/icon.png

@@ -7,10 +7,11 @@ import {
     CompletionItemProvider,
     Position,
     TextLine,
-    TextDocument
+    TextDocument,
+    Range
 } from "vscode";
 import { TypeHintProvider } from "./typeHintProvider";
-import { paramHintTrigger, returnHintTrigger, PythonType } from "./python";
+import { paramHintTrigger, returnHintTrigger, PythonType, anyClassOrFunctionName } from "./python";
 import { TypeHint, labelFor } from "./typeHint";
 import { TypeHintSettings } from "./settings";
 
@@ -49,12 +50,13 @@ export class ParamHintCompletionProvider extends CompletionProvider implements C
         if (context.triggerCharacter === paramHintTrigger) {
             const items: CompletionItem[] = [];
             const line = doc.lineAt(pos);
-    
-            if (this.shouldProvideItems(line, pos)) {
-                const param = this.findParam(line, pos);
+            const precedingText = line.text.substring(0, pos.character - 1).trim();
+
+            if (this.shouldProvideItems(precedingText, pos, doc)) {
+                const param: string = this.findParam(precedingText, pos);
                 const provider = new TypeHintProvider(doc, this.settings);
 
-                if (param && param.length > 0) {
+                if (param.length > 0) {
                     try {
                         this.pushEstimationsToItems(await provider.getTypeHints(param), items); 
                     } catch (error) {
@@ -70,17 +72,21 @@ export class ParamHintCompletionProvider extends CompletionProvider implements C
     /**
      * Finds the parameter which is about to be type hinted.
      * 
-     * @param line The active line.
+     * @param precedingText Text preceding the active position.
      * @param pos The active position.
+     * @returns The parameter.
      */
-    private findParam(line: TextLine, pos: Position): string | null {
-        let param = null;
-        let split = line.text.substr(0, pos.character).split(new RegExp("[,(]"));
-        if (split.length > 1) {
-            param = split[split.length - 1].trim();
-            param = param.substr(0, param.length - 1);
+    private findParam(precedingText: string, pos: Position): string {
+        let param = "";
+
+        let i = precedingText.length - 1;
+        let last = precedingText[i];
+        while (last !== "," && last !== "(" && i >= 0) {
+            param = precedingText[i] + param;
+            i--;
+            last = precedingText[i];
         }
-        return param;
+        return param.trim();
     }
 
     private pushEstimationsToItems(typeHints: TypeHint[], items: CompletionItem[]) {
@@ -100,17 +106,36 @@ export class ParamHintCompletionProvider extends CompletionProvider implements C
                 item.insertText = typeHints[i].insertText;
                 items.push(item);
             }       
-
         }
     }
 
-    private shouldProvideItems(line: TextLine, pos: Position): boolean {
+    private shouldProvideItems(precedingText: string, activePos: Position, doc: TextDocument): boolean {
+
+        if (activePos.character > 0 && !this.isInvalid(precedingText)) {
+            let provide = new RegExp("^[ \t]*def", "m").test(precedingText);
 
-        if (pos.character > 0) {
-            return new RegExp("^[ \t]*def", "m").test(line.text);
+            if (!provide) {
+                const nLinesToCheck = activePos.character > 4 ? 4 : activePos.line;
+                const range = new Range(doc.lineAt(activePos.line - nLinesToCheck).range.start, activePos);
+                provide = new RegExp(
+                    `^[ \t]*def(?![\s\S]+(\\):|-> *${anyClassOrFunctionName}:))`,
+                    "m"
+                ).test(doc.getText(range));
+            }
+            return provide;
         }
         return false;
     }
+
+    /**
+     * The text is invalid if it is a comment, dict or the end of the function definition.
+     */
+    private isInvalid(precedingText: string): boolean {
+        if (precedingText) {
+            return new RegExp("#|\\)$|{ *[a-zA-Z0-9.+*/\\(\\)-]+$").test(precedingText);
+        }
+        return true;
+    }
 }
 
 /**
@@ -139,8 +164,8 @@ export class ReturnHintCompletionProvider extends CompletionProvider implements
     private shouldProvideItems(line: TextLine, pos: Position): boolean {
 
         if (pos.character > 0 && line.text.substr(pos.character - 2, 2) === "->") {
-            
-            return new RegExp("^[ \t]*def.*\\) *->[: ]*$", "m").test(line.text);
+
+            return new RegExp("\\) *->[: ]*$", "m").test(line.text);
         }
         return false;
     }

package.json

@@ -6,11 +6,6 @@ import { TypeHintSettings } from './settings';
 // Called when the extension is activated.
 export function activate(context: vscode.ExtensionContext) {
 
-    // Not used yet
-	function registerCommand(commandId: string, func: (...args: any[]) => void): void {
-		context.subscriptions.push(vscode.commands.registerCommand(commandId, func));
-    }
-
     const settings = new TypeHintSettings();
 
     context.subscriptions.push(

src/completionProvider.ts

@@ -4,6 +4,9 @@ export const anyClassOrFunctionName: string = "[a-zA-Z_][a-zA-Z0-9_.]*";
 export const paramHintTrigger: string = ":";
 export const returnHintTrigger: string = ">";
 
+/**
+ * A built-in Python type.
+ */
 export class DataType {
     name: PythonType;
     category: TypeCategory;
@@ -34,15 +37,7 @@ export const getDataTypeContainer = (): DataTypeContainer => {
 };
 
 /**
- * Ways a variable can be initialized.
- */
-export enum Initialization {
-    WithValue,
-    WithCall
-}
-
-/**
- * Built-in Python types.
+ * Names of built-in Python types.
  */
 export enum PythonType {
     Bool = "bool",

src/extension.ts

@@ -2,7 +2,7 @@ import { workspace, Event, EventEmitter, window } from "vscode";
 
 export class TypeHintSettings {
 
-    private searchLimit = 50;
+    private searchLimit = 20;
 
     public get fileSearchLimit() {
         return this.searchLimit;
@@ -24,9 +24,9 @@ export class TypeHintSettings {
     }
 
     private initialize() {
-        const searchLimit: number | undefined = workspace.getConfiguration('pyTypehint.search').get('limit');
+        const searchLimit: number | undefined = workspace.getConfiguration('workspace.search').get('limit');
         if (searchLimit) {
-            this.searchLimit = searchLimit;
+            this.searchLimit = Number.isInteger(searchLimit) ? searchLimit : Math.round(searchLimit);
         }
     }