mypy support

Author: DonJayamanne

package.json

@@ -469,6 +469,11 @@
  "default": false,
  "description": "Whether to lint Python files using pydocstyle"
  },
+ "python.linting.mypyEnabled": {
+ "type": "boolean",
+ "default": false,
+ "description": "Whether to lint Python files using mypy."
+ },
  "python.linting.lintOnTextChange": {
  "type": "boolean",
  "default": true,
@@ -564,6 +569,11 @@
  "default": "pydocstyle",
  "description": "Path to pydocstyle, you can use a custom version of pydocstyle by modifying this setting to include the full path."
  },
+ "python.linting.mypyPath": {
+ "type": "string",
+ "default": "mypy",
+ "description": "Path to mypy, you can use a custom version of pylint by modifying this setting to include the full path."
+ },
  "python.linting.prospectorArgs": {
  "type": "array",
  "description": "Arguments passed in. Each argument is a separate item in the array.",
@@ -604,6 +614,14 @@
  "type": "string"
  }
  },
+ "python.linting.mypyArgs": {
+ "type": "array",
+ "description": "Arguments passed in. Each argument is a separate item in the array.",
+ "default": [],
+ "items": {
+ "type": "string"
+ }
+ },
  "python.linting.outputWindow": {
  "type": "string",
  "default": "Python",

src/client/common/configSettings.ts

@@ -55,6 +55,9 @@ export interface ILintingSettings {
  flake8Path: string;
  pydocStylePath: string;
  outputWindow: string;
+ mypyEnabled: boolean;
+ mypyArgs: string[];
+ mypyPath: string;
 }
 export interface IFormattingSettings {
  provider: string;

src/client/linters/baseLinter.ts

@@ -79,21 +79,23 @@ export abstract class BaseLinter {
  match.line = Number(<any>match.line);
  match.column = Number(<any>match.column);
 
- let sourceLine = txtDocumentLines[match.line - 1];
- let sourceStart = sourceLine.substring(match.column - 1);
- let endCol = txtDocumentLines[match.line - 1].length;
-
- // try to get the first word from the startig position
- let possibleProblemWords = sourceStart.match(/\w+/g);
  let possibleWord: string;
- if (possibleProblemWords != null && possibleProblemWords.length > 0 && sourceStart.startsWith(possibleProblemWords[0])) {
- possibleWord = possibleProblemWords[0];
+ if (!isNaN(match.column)) {
+ let sourceLine = txtDocumentLines[match.line - 1];
+ let sourceStart = sourceLine.substring(match.column - 1);
+ let endCol = txtDocumentLines[match.line - 1].length;
+
+ // try to get the first word from the startig position
+ let possibleProblemWords = sourceStart.match(/\w+/g);
+ if (possibleProblemWords != null && possibleProblemWords.length > 0 && sourceStart.startsWith(possibleProblemWords[0])) {
+ possibleWord = possibleProblemWords[0];
+ }
  }
 
  diagnostics.push({
  code: match.code,
  message: match.message,
- column: match.column,
+ column: isNaN(match.column) ? 0 : match.column,
  line: match.line,
  possibleWord: possibleWord,
  type: match.type,

src/client/linters/mypy.ts

@@ -0,0 +1,48 @@
+'use strict';
+
+import * as path from 'path';
+import * as baseLinter from './baseLinter';
+import {OutputChannel, workspace} from 'vscode';
+
+const REGEX = '(?<file>.py):(?<line>\\d+): (?<type>\\w+): (?<message>.*)\\r?(\\n|$)';
+
+export class Linter extends baseLinter.BaseLinter {
+ constructor(outputChannel: OutputChannel, workspaceRootPath: string) {
+ super('mypy', outputChannel, workspaceRootPath);
+ }
+ private parseMessagesSeverity(category: string): baseLinter.LintMessageSeverity {
+ switch (category) {
+ case 'error': {
+ return baseLinter.LintMessageSeverity.Error;
+ }
+ case 'note': {
+ return baseLinter.LintMessageSeverity.Hint;
+ }
+ default: {
+ return baseLinter.LintMessageSeverity.Information;
+ }
+ }
+ }
+
+ public isEnabled(): Boolean {
+ return this.pythonSettings.linting.mypyEnabled;
+ }
+ public runLinter(filePath: string, txtDocumentLines: string[]): Promise<baseLinter.ILintMessage[]> {
+ if (!this.pythonSettings.linting.mypyEnabled) {
+ return Promise.resolve([]);
+ }
+
+ let mypyPath = this.pythonSettings.linting.mypyPath;
+ let mypyArgs = Array.isArray(this.pythonSettings.linting.mypyArgs) ? this.pythonSettings.linting.mypyArgs : [];
+ return new Promise<baseLinter.ILintMessage[]>((resolve, reject) => {
+ this.run(mypyPath, mypyArgs.concat([filePath]), filePath, txtDocumentLines, this.workspaceRootPath, REGEX).then(messages => {
+ messages.forEach(msg => {
+ msg.severity = this.parseMessagesSeverity(msg.type);
+ msg.code = msg.type;
+ });
+
+ resolve(messages);
+ }, reject);
+ });
+ }
+}

src/client/providers/lintProvider.ts

@@ -8,6 +8,7 @@ import * as pylint from './../linters/pylint';
 import * as pep8 from './../linters/pep8Linter';
 import * as flake8 from './../linters/flake8';
 import * as pydocstyle from './../linters/pydocstyle';
+import * as mypy from './../linters/mypy';
 import * as settings from '../common/configSettings';
 import * as telemetryHelper from '../common/telemetry';
 import * as telemetryContracts from '../common/telemetryContracts';
@@ -67,6 +68,7 @@ export class LintProvider extends vscode.Disposable {
  this.linters.push(new pep8.Linter(this.outputChannel, this.workspaceRootPath));
  this.linters.push(new flake8.Linter(this.outputChannel, this.workspaceRootPath));
  this.linters.push(new pydocstyle.Linter(this.outputChannel, this.workspaceRootPath));
+ this.linters.push(new mypy.Linter(this.outputChannel, this.workspaceRootPath));
 
  let disposable = vscode.workspace.onDidSaveTextDocument((e) => {
  if (e.languageId !== 'python' || !this.settings.linting.enabled || !this.settings.linting.lintOnSave) {