Merge pull request #495 from tdamsma/pylama

Pylama

Author: DonJayamanne

src/client/common/configSettings.ts

@@ -48,6 +48,8 @@ export interface ILintingSettings {
     pylintArgs: string[];
     pep8Enabled: boolean;
     pep8Args: string[];
+    pylamaEnabled: boolean;
+    pylamaArgs: string[];
     flake8Enabled: boolean;
     flake8Args: string[];
     pydocstyleEnabled: boolean;
@@ -59,6 +61,7 @@ export interface ILintingSettings {
     prospectorPath: string;
     pylintPath: string;
     pep8Path: string;
+    pylamaPath: string;
     flake8Path: string;
     pydocstylePath: string;
     outputWindow: string;
@@ -137,6 +140,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
             lintOnSave: false, lintOnTextChange: false, maxNumberOfProblems: 100,
             mypyArgs: [], mypyEnabled: false, mypyPath: 'mypy',
             outputWindow: 'python', pep8Args: [], pep8Enabled: false, pep8Path: 'pep8',
+            pylamaArgs: [], pylamaEnabled: false, pylamaPath: 'pylama',
             prospectorArgs: [], prospectorEnabled: false, prospectorPath: 'prospector',
             pydocstyleArgs: [], pydocstyleEnabled: false, pydocstylePath: 'pydocstyle',
             pylintArgs: [], pylintEnabled: false, pylintPath: 'pylint',
@@ -151,6 +155,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
         this.linting.pylintPath = getAbsolutePath(this.linting.pylintPath, workspaceRoot);
         this.linting.flake8Path = getAbsolutePath(this.linting.flake8Path, workspaceRoot);
         this.linting.pep8Path = getAbsolutePath(this.linting.pep8Path, workspaceRoot);
+        this.linting.pylamaPath = getAbsolutePath(this.linting.pylamaPath, workspaceRoot);
         this.linting.prospectorPath = getAbsolutePath(this.linting.prospectorPath, workspaceRoot);
         this.linting.pydocstylePath = getAbsolutePath(this.linting.pydocstylePath, workspaceRoot);
 

src/client/common/installer.ts

@@ -9,6 +9,7 @@ export enum Product {
     pylint,
     flake8,
     pep8,
+    pylama,
     prospector,
     pydocstyle,
     yapf,
@@ -23,14 +24,15 @@ ProductInstallScripts.set(Product.flake8, ['pip', 'install', 'flake8']);
 ProductInstallScripts.set(Product.mypy, ['pip', 'install', 'mypy-lang']);
 ProductInstallScripts.set(Product.nosetest, ['pip', 'install', 'nose']);
 ProductInstallScripts.set(Product.pep8, ['pip', 'install', 'pep8']);
+ProductInstallScripts.set(Product.pylama, ['pip', 'install', 'pylama']);
 ProductInstallScripts.set(Product.prospector, ['pip', 'install', 'prospector']);
 ProductInstallScripts.set(Product.pydocstyle, ['pip', 'install', 'pydocstyle']);
 ProductInstallScripts.set(Product.pylint, ['pip', 'install', 'pylint']);
 ProductInstallScripts.set(Product.pytest, ['pip', 'install', '-U', 'pytest']);
 ProductInstallScripts.set(Product.yapf, ['pip', 'install', 'yapf']);
 
 
-const Linters: Product[] = [Product.flake8, Product.pep8, Product.prospector, Product.pylint, Product.mypy, Product.pydocstyle];
+const Linters: Product[] = [Product.flake8, Product.pep8, Product.pylama, Product.prospector, Product.pylint, Product.mypy, Product.pydocstyle];
 const Formatters: Product[] = [Product.autopep8, Product.yapf];
 const TestFrameworks: Product[] = [Product.pytest, Product.nosetest, Product.unittest];
 
@@ -40,6 +42,7 @@ ProductNames.set(Product.flake8, 'flake8');
 ProductNames.set(Product.mypy, 'mypy');
 ProductNames.set(Product.nosetest, 'nosetest');
 ProductNames.set(Product.pep8, 'pep8');
+ProductNames.set(Product.pylama, 'pylama');
 ProductNames.set(Product.prospector, 'prospector');
 ProductNames.set(Product.pydocstyle, 'pydocstyle');
 ProductNames.set(Product.pylint, 'pylint');
@@ -52,6 +55,7 @@ SettingToDisableProduct.set(Product.flake8, 'linting.flake8Enabled');
 SettingToDisableProduct.set(Product.mypy, 'linting.mypyEnabled');
 SettingToDisableProduct.set(Product.nosetest, 'unitTest.nosetestsEnabled');
 SettingToDisableProduct.set(Product.pep8, 'linting.pep8Enabled');
+SettingToDisableProduct.set(Product.pylama, 'linting.pylamaEnabled');
 SettingToDisableProduct.set(Product.prospector, 'linting.prospectorEnabled');
 SettingToDisableProduct.set(Product.pydocstyle, 'linting.pydocstyleEnabled');
 SettingToDisableProduct.set(Product.pylint, 'linting.pylintEnabled');

src/client/linters/pylama.ts

@@ -0,0 +1,33 @@
+'use strict';
+
+import * as baseLinter from './baseLinter';
+import {OutputChannel} from 'vscode';
+import { Product } from '../common/installer';
+
+export class Linter extends baseLinter.BaseLinter {
+    constructor(outputChannel: OutputChannel, workspaceRootPath: string) {
+        super('pylama', Product.pylama, outputChannel, workspaceRootPath);
+    }
+
+    public isEnabled(): Boolean {
+        return this.pythonSettings.linting.pylamaEnabled;
+    }
+    public runLinter(filePath: string, txtDocumentLines: string[]): Promise<baseLinter.ILintMessage[]> {
+        if (!this.pythonSettings.linting.pylamaEnabled) {
+            return Promise.resolve([]);
+        }
+
+        let pylamaPath = this.pythonSettings.linting.pylamaPath;
+        let pylamaArgs = Array.isArray(this.pythonSettings.linting.pylamaArgs) ? this.pythonSettings.linting.pylamaArgs : [];
+        return new Promise<baseLinter.ILintMessage[]>(resolve => {
+            this.run(pylamaPath, pylamaArgs.concat(['--format=%(row)d,%(col)d,%(code)s,%(code)s:%(text)s', filePath]), filePath, txtDocumentLines, this.workspaceRootPath).then(messages => {
+                // All messages in pylama are treated as warnings for now
+                messages.forEach(msg => {
+                    msg.severity = baseLinter.LintMessageSeverity.Information;
+                });
+
+                resolve(messages);
+            });
+        });
+    }
+}

src/client/providers/lintProvider.ts

@@ -6,6 +6,7 @@ import * as linter from '../linters/baseLinter';
 import * as prospector from './../linters/prospector';
 import * as pylint from './../linters/pylint';
 import * as pep8 from './../linters/pep8Linter';
+import * as pylama from './../linters/pylama';
 import * as flake8 from './../linters/flake8';
 import * as pydocstyle from './../linters/pydocstyle';
 import * as mypy from './../linters/mypy';
@@ -71,6 +72,7 @@ export class LintProvider extends vscode.Disposable {
         this.linters.push(new prospector.Linter(this.outputChannel, this.workspaceRootPath));
         this.linters.push(new pylint.Linter(this.outputChannel, this.workspaceRootPath));
         this.linters.push(new pep8.Linter(this.outputChannel, this.workspaceRootPath));
+        this.linters.push(new pylama.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));