Execute prospector as a module (using -m)

* 🔨 run prospector as a module (with -m)
* 🔥 remove unwanted settings
* 🔥 remove redundant class and fix tests
* 🔨 remove versions
* 📝 news entry

Author: DonJayamanne

news/3 Code Health/982.md

@@ -0,0 +1 @@
+Execute prospector as a module (using -m).

requirements.txt

@@ -1,10 +1,10 @@
-autopep8==1.2.1
-yapf==0.6.2
-pylint==1.8.2
-pep8==1.7.0
-prospector==0.11.7
-flake8==2.6.0
-pydocstyle==1.0.0
+autopep8
+yapf
+pylint
+pep8
+prospector
+flake8
+pydocstyle
 nose
 pytest
 fabric

src/client/common/installer/installer.ts

@@ -61,6 +61,9 @@ abstract class BaseInstaller {
     }
 
     public async isInstalled(product: Product, resource?: Uri): Promise<boolean | undefined> {
+        if (product === Product.unittest) {
+            return true;
+        }
         let moduleName: string | undefined;
         try {
             moduleName = translateProductToModule(product, ModuleNamePurpose.run);
@@ -71,14 +74,12 @@ abstract class BaseInstaller {
         const executableName = this.getExecutableNameFromSettings(product, resource);
 
         const isModule = typeof moduleName === 'string' && moduleName.length > 0 && path.basename(executableName) === executableName;
-        // Prospector is an exception, it can be installed as a module, but not run as one.
-        if (product !== Product.prospector && isModule) {
+        if (isModule) {
             const pythonProcess = await this.serviceContainer.get<IPythonExecutionFactory>(IPythonExecutionFactory).create(resource);
             return pythonProcess.isModuleInstalled(executableName);
         } else {
             const process = this.serviceContainer.get<IProcessService>(IProcessService);
-            const prospectorPath = this.configService.getSettings(resource).linting.prospectorPath;
-            return process.exec(prospectorPath, ['--version'], { mergeStdOutErr: true })
+            return process.exec(executableName, ['--version'], { mergeStdOutErr: true })
                 .then(() => true)
                 .catch(() => false);
         }

src/client/common/installer/productInstaller.ts

@@ -39,7 +39,6 @@ export class FormatterHelper implements IFormatterHelper {
         let moduleName: string | undefined;
 
         // If path information is not available, then treat it as a module,
-        // except for prospector as that needs to be run as an executable (it's a Python package).
         if (path.basename(execPath) === execPath) {
             moduleName = execPath;
         }

src/client/formatters/helper.ts

@@ -60,7 +60,6 @@ export class LinterInfo implements ILinterInfo {
         let moduleName: string | undefined;
 
         // If path information is not available, then treat it as a module,
-        // Except for prospector as that needs to be run as an executable (its a python package).
         if (path.basename(execPath) === execPath) {
             moduleName = execPath;
         }

src/client/linters/linterInfo.ts

@@ -11,10 +11,8 @@
         "-p",
         "*test*.py"
     ],
-    "python.formatting.formatOnSave": false,
     "python.sortImports.args": [],
     "python.linting.lintOnSave": false,
-    "python.linting.lintOnTextChange": false,
     "python.linting.enabled": true,
     "python.linting.pep8Enabled": false,
     "python.linting.prospectorEnabled": false,
@@ -23,4 +21,4 @@
     "python.linting.mypyEnabled": false,
     "python.formatting.provider": "yapf",
     "python.linting.pylintUseMinimalCheckers": false
-}
+}

src/test/.vscode/settings.json

@@ -75,9 +75,6 @@ suite('Installer', () => {
             if (args.length > 1 && args[0] === '-c' && args[1] === `import ${moduleName}`) {
                 checkInstalledDef.resolve(true);
             }
-            if (product === Product.prospector && args.length > 0 && args[0] === '--version') {
-                checkInstalledDef.resolve(true);
-            }
             callback({ stdout: '' });
         });
         await installer.isInstalled(product, resource);

src/test/common/installer.test.ts

@@ -6,7 +6,6 @@ import * as chaiAsPromised from 'chai-as-promised';
 import * as TypeMoq from 'typemoq';
 import { Disposable, OutputChannel, Uri } from 'vscode';
 import { EnumEx } from '../../../client/common/enumUtils';
-import { Installer } from '../../../client/common/installer/installer';
 import { ProductInstaller } from '../../../client/common/installer/productInstaller';
 import { IInstallationChannelManager, IModuleInstaller } from '../../../client/common/installer/types';
 import { IDisposableRegistry, ILogger, InstallerResponse, ModuleNamePurpose, Product } from '../../../client/common/types';
@@ -19,16 +18,15 @@ suite('Module Installerx', () => {
     [undefined, Uri.file('resource')].forEach(resource => {
         EnumEx.getNamesAndValues<Product>(Product).forEach(product => {
             let disposables: Disposable[] = [];
-            let installer: Installer;
+            let installer: ProductInstaller;
             let installationChannel: TypeMoq.IMock<IInstallationChannelManager>;
             let moduleInstaller: TypeMoq.IMock<IModuleInstaller>;
             let serviceContainer: TypeMoq.IMock<IServiceContainer>;
-            let productInstallerFactory: ProductInstaller;
             setup(() => {
                 serviceContainer = TypeMoq.Mock.ofType<IServiceContainer>();
                 const outputChannel = TypeMoq.Mock.ofType<OutputChannel>();
 
-                installer = new Installer(serviceContainer.object, outputChannel.object);
+                installer = new ProductInstaller(serviceContainer.object, outputChannel.object);
 
                 disposables = [];
                 serviceContainer.setup(c => c.get(TypeMoq.It.isValue(IDisposableRegistry), TypeMoq.It.isAny())).returns(() => disposables);
@@ -41,8 +39,6 @@ suite('Module Installerx', () => {
                 moduleInstaller.setup((x: any) => x.then).returns(() => undefined);
                 installationChannel.setup(i => i.getInstallationChannel(TypeMoq.It.isAny(), TypeMoq.It.isAny())).returns(() => Promise.resolve(moduleInstaller.object));
                 installationChannel.setup(i => i.getInstallationChannel(TypeMoq.It.isAny())).returns(() => Promise.resolve(moduleInstaller.object));
-
-                productInstallerFactory = new ProductInstaller(serviceContainer.object, outputChannel.object);
             });
             teardown(() => {
                 disposables.forEach(disposable => {
@@ -91,7 +87,7 @@ suite('Module Installerx', () => {
                         moduleInstaller.setup(m => m.installModule(TypeMoq.It.isValue(moduleName), TypeMoq.It.isValue(resource))).returns(() => Promise.reject(new Error('UnitTesting')));
 
                         try {
-                            await productInstallerFactory.install(product.value, resource);
+                            await installer.install(product.value, resource);
                         } catch (ex) {
                             moduleInstaller.verify(m => m.installModule(TypeMoq.It.isValue(moduleName), TypeMoq.It.isValue(resource)), TypeMoq.Times.once());
                         }

src/test/common/installer/installer.test.ts

@@ -5,9 +5,9 @@ import { ConfigurationTarget, Uri } from 'vscode';
 import { PythonSettings } from '../../client/common/configSettings';
 import { ConfigurationService } from '../../client/common/configuration/service';
 import { CondaInstaller } from '../../client/common/installer/condaInstaller';
-import { Installer } from '../../client/common/installer/installer';
 import { PipEnvInstaller } from '../../client/common/installer/pipEnvInstaller';
 import { PipInstaller } from '../../client/common/installer/pipInstaller';
+import { ProductInstaller } from '../../client/common/installer/productInstaller';
 import { IModuleInstaller } from '../../client/common/installer/types';
 import { Logger } from '../../client/common/logger';
 import { PersistentStateFactory } from '../../client/common/persistentState';
@@ -59,7 +59,7 @@ suite('Module Installer', () => {
 
         ioc.serviceManager.addSingleton<IPersistentStateFactory>(IPersistentStateFactory, PersistentStateFactory);
         ioc.serviceManager.addSingleton<ILogger>(ILogger, Logger);
-        ioc.serviceManager.addSingleton<IInstaller>(IInstaller, Installer);
+        ioc.serviceManager.addSingleton<IInstaller>(IInstaller, ProductInstaller);
 
         mockTerminalService = TypeMoq.Mock.ofType<ITerminalService>();
         const mockTerminalFactory = TypeMoq.Mock.ofType<ITerminalServiceFactory>();