Unit testing, debugger fix and flake8

Author: DonJayamanne

.vscode/launch.json

@@ -21,6 +21,21 @@
  "request": "attach",
  "sourceMaps": true,
  "port": 6004
+ },
+ {
+ "name": "Attach to python debug server",
+ "type": "node",
+ "request": "launch",
+ "runtimeArgs": [
+ "--harmony"
+ ],
+ "program": "./out/client/debugger/main.js",
+ "stopOnEntry": false,
+ "args": [
+ "--server=4711"
+ ],
+ "sourceMaps": true,
+ "outDir": "./out/client"
  }
  ]
 }

README.md

@@ -1,19 +1,20 @@
 # Python
-Linting, Debugging, Intellisense, auto-completion, code formatting, snippets, and more.
+Linting, Debugging, Intellisense, auto-completion, code formatting, snippets, unit testing, and more.
 Works on both Windows and Mac.
 
 ##Features
-* Linting (PyLint, Pep8 with support for config files)
+* Linting (PyLint, Pep8, Flake8 with config files)
 * Intellisense and autocompletion
-* Code formatting (autopep8, yapf, with support for config files)
+* Code formatting (autopep8, yapf, with config files)
 * Renaming, Viewing references, Going to definitions, Go to Symbols
 * View signature and similar by hovering over a function or method
 * Debugging with support for local & global variables, arguments, expressions, watch window, stack information, break points
+* Unit testing (unittests and nosetests, with config files)
 * Sorting imports
 * Snippets
 
-## Issues, Feedback and Suggestions
-[Gitbub Issues](https://github.com/DonJayamanne/pythonVSCode/issues)
+## Issues and Feature Requests
+[Github Issues](https://github.com/DonJayamanne/pythonVSCode/issues)
 
 ## Feature Details (with confiuration)
 * IDE Features
@@ -25,26 +26,30 @@ Works on both Windows and Mac.
 * Intellisense and Autocomplete
 * - Full intellisense
 * - Support for docstring
+* - Ability to include custom module paths (e.g. include paths for libraries like Google App Engine, etc)
+* - - Use the setting python.autoComplete.extraPaths = []
 * Code formatting
 * - Use either yapf or autopep8 for code formatting (defaults to autopep8)
 * - auutopep8 configuration files supported
 * - yapf configuration files supported
 * Linting
 * - It can be turned off (default is turn it on and use pylint)
-* - pylint can be turned off
-* - pyliny configuaration files supported
-* - pep8 can be turned off
-* - pep8 configuaration files supported
+* - pylint can be turned on/off (default is on), supports standard configuaration files
+* - pep8 can be turned on/off (default is off), supports standard configuaration files
+* - flake8 can be turned on/off (default is on), supports standard configuaration files
 * - Different categories of errors reported by pylint can be configured as warnings, errors, information or hits
-* - Path to pylint and pep8 can be configured
-* - Path to pep8 can be configured through config
+* - Path to pylint, pep8 and flake8 and pep8 can be configured
 * Debuggging
-* - Local and Global variables
-* - Arguments
 * - Watch window
 * - Evaluate Expressions
 * - Step through code (Step in, Step out, Continue)
 * - Add/remove break points
+* - Local variables, Global variables and arguments (experimental, still needs some polishing)
+* Unit Testing
+* - unittests (default is on)
+* - nosetests (default is off)
+* - Test resutls are displayed in the "Python" output window
+* - Future release will display results in a more structured manner integrated into the IDE
 * Snippets
 
 
@@ -56,19 +61,30 @@ Works on both Windows and Mac.
 
 ## Requirements
 * Python is installed on the current system
-* Pylint is installed for linting (optional, this can be turned off)
-* - Install Pylint as follows:
+* - Path to python can be configured
+* Pylint is installed for linting (optional)
 * - pip install pylint
-* Pep8 is installed for linting (optional, this can be turned off)
+* Pep8 is installed for linting (optional)
 * - pip install pep8
-* Autopep8 is installed for code formatting 
-* - Install AutoPep8 as follows (ensure pep8 is installed):
+* Flake8 is installed for linting (optional)
+* - pip install flake8
+* Autopep8 is installed for code formatting (optional) 
 * - pip install pep8
 * - pip install --upgrade autopep8
-
+* Yapf is installed for code formatting (optional)
+* - pip install yapf
+* nosetests for unit testing (optional)
+* - pip install nose
 
 ## Change Log
 
+### Version 0.1.1
+* Added support for linting using flake8
+* Added support for unit testing using unittest and nosetest
+* Added support for custom module paths for improved intellisense and autocomplete
+* Modifications to debugger to display console output (generated using 'print' and the like)
+* Modifications to debugger to accept arguments
+
 ### Version 0.1.0
 * Fixed linting of files on Mac
 * Added support for linting using pep8

package.json

@@ -30,7 +30,8 @@
  ],
  "activationEvents": [
  "onLanguage:python",
- "onCommand:python.sortImports"
+ "onCommand:python.sortImports",
+ "onCommand:python.runtests"
  ],
  "main": "./out/client/extension",
  "contributes": {
@@ -44,6 +45,10 @@
  {
  "command": "python.sortImports",
  "title": "Python: Sort Imports"
+ },
+ {
+ "command": "python.runtests",
+ "title": "Python: Run Unit Tests"
  }
  ],
  "debuggers": [
@@ -91,6 +96,11 @@
  "type": "object",
  "title": "Python Configuration",
  "properties": {
+ "python.pythonPath": {
+ "type": "string",
+ "default": "python",
+ "description": "Path to Python, you can use a custom version of Python by modifying this setting to include the full path."
+ },
  "python.linting.enabled": {
  "type": "boolean",
  "default": true,
@@ -106,6 +116,11 @@
  "default": false,
  "description": "Whether to lint Python files using pep8"
  },
+ "python.linting.flake8Enabled": {
+ "type": "boolean",
+ "default": false,
+ "description": "Whether to lint Python files using flake8"
+ },
  "python.linting.lintOnTextChange": {
  "type": "boolean",
  "default": true,
@@ -124,27 +139,57 @@
  "python.linting.pylintCategorySeverity.convention": {
  "type": "string",
  "default": "Hint",
- "description": "Severity of Pylint message type 'Convention/C'. Possible values include Error, Hint, Warning and Information."
+ "description": "Severity of Pylint message type 'Convention/C'.",
+ "enum": [
+ "Hint",
+ "Error",
+ "Information",
+ "Warning"
+ ]
  },
  "python.linting.pylintCategorySeverity.refactor": {
  "type": "string",
  "default": "Hint",
- "description": "Severity of Pylint message type 'Refactor/R'. Possible values include Error, Hint, Warning and Information."
+ "description": "Severity of Pylint message type 'Refactor/R'.",
+ "enum": [
+ "Hint",
+ "Error",
+ "Information",
+ "Warning"
+ ]
  },
  "python.linting.pylintCategorySeverity.warning": {
  "type": "string",
  "default": "Warning",
- "description": "Severity of Pylint message type 'Warning/W'. Possible values include Error, Hint, Warning and Information."
+ "description": "Severity of Pylint message type 'Warning/W'.",
+ "enum": [
+ "Hint",
+ "Error",
+ "Information",
+ "Warning"
+ ]
  },
  "python.linting.pylintCategorySeverity.error": {
  "type": "string",
  "default": "Error",
- "description": "Severity of Pylint message type 'Error/E'. Possible values include Error, Hint, Warning and Information."
+ "description": "Severity of Pylint message type 'Error/E'.",
+ "enum": [
+ "Hint",
+ "Error",
+ "Information",
+ "Warning"
+ ]
  },
  "python.linting.pylintCategorySeverity.fatal": {
  "type": "string",
  "default": "Error",
- "description": "Severity of Pylint message type 'Fatal/F'. Possible values include Error, Hint, Warning and Information."
+ "description": "Severity of Pylint message type 'Fatal/F'.",
+ "enum": [
+ "Hint",
+ "Error",
+ "Information",
+ "Warning"
+ ]
  },
  "python.linting.pylintPath": {
  "type": "string",
@@ -156,10 +201,19 @@
  "default": "pep8",
  "description": "Path to pep8, you can use a custom version of pep8 by modifying this setting to include the full path."
  },
+ "python.linting.flake8Path": {
+ "type": "string",
+ "default": "flake8",
+ "description": "Path to flake8, you can use a custom version of flake8 by modifying this setting to include the full path."
+ },
  "python.formatting.provider": {
  "type": "string",
  "default": "autopep8",
- "description": "Provider for formatting. Possible options include 'autopep8' and 'yapf'."
+ "description": "Provider for formatting. Possible options include 'autopep8' and 'yapf'.",
+ "enum": [
+ "autopep8",
+ "yapf"
+ ]
  },
  "python.formatting.autopep8Path": {
  "type": "string",
@@ -170,6 +224,26 @@
  "type": "string",
  "default": "",
  "description": "Path to yapf, you can use a custom version of yapf by modifying this setting to include the full path."
+ },
+ "python.autoComplete.extraPaths": {
+ "type": "array",
+ "default": [],
+ "description": "List of paths to libraries and the like that need to be imported by auto complete engine. E.g. when using Google App SDK, the paths are not in system path, hence need to be added into this list."
+ },
+ "python.unitTest.nosetestsEnabled": {
+ "type": "boolean",
+ "default": false,
+ "description": "Whether to enable or disable unit testing using nosetests."
+ },
+ "python.unitTest.nosetestPath": {
+ "type": "string",
+ "default": "nosetests",
+ "description": "Path to nosetests, you can use a custom version of nosetests by modifying this setting to include the full path."
+ },
+ "python.unitTest.unittestEnabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Whether to enable or disable unit testing using standard unittest (built into Python)."
  }
  }
  }

pythonFiles/unittest.py

@@ -0,0 +1,20 @@
+'use strict';
+
+import * as path from 'path';
+import * as fs from 'fs';
+import * as child_process from 'child_process';
+
+export function sendCommand(commandLine: string, cwd: string): Promise<string> {
+ return new Promise<string>((resolve, reject) => {
+
+ child_process.exec(commandLine, { cwd: cwd }, (error, stdout, stderr) => {
+ var hasErrors = (error && error.message.length > 0) || (stderr && stderr.length > 0);
+ if (hasErrors && (typeof stdout !== "string" || stdout.length === 0)) {
+ var errorMsg = (error && error.message) ? error.message : (stderr && stderr.length > 0 ? stderr.toString("utf-8") : "");
+ return reject(errorMsg);
+ }
+
+ resolve(stdout.toString('utf-8'));
+ });
+ });
+}

src/client/common/childProc.ts

@@ -0,0 +1,96 @@
+'use strict';
+
+import * as vscode from 'vscode';
+
+export interface IPythonSettings {
+ pythonPath: string;
+ linting: ILintingSettings;
+ formatting: IFormattingSettings;
+ unitTest: IUnitTestSettings;
+}
+export interface IUnitTestSettings {
+ nosetestsEnabled: boolean;
+ nosetestPath:string;
+ unittestEnabled: boolean;
+}
+export interface IPylintCategorySeverity {
+ convention: vscode.DiagnosticSeverity;
+ refactor: vscode.DiagnosticSeverity;
+ warning: vscode.DiagnosticSeverity;
+ error: vscode.DiagnosticSeverity;
+ fatal: vscode.DiagnosticSeverity;
+}
+export interface ILintingSettings {
+ enabled: boolean;
+ pylintEnabled: boolean;
+ pep8Enabled: boolean;
+ flake8Enabled: boolean;
+ lintOnTextChange: boolean;
+ lintOnSave: boolean;
+ maxNumberOfProblems: number;
+ pylintCategorySeverity: IPylintCategorySeverity;
+ pylintPath: string;
+ pep8Path: string;
+ flake8Path: string;
+}
+export interface IFormattingSettings {
+ provider: string;
+ autopep8Path: string;
+ yapfPath: string;
+}
+export interface IAutoCompeteSettings {
+ extraPaths: string[];
+}
+export class PythonSettings implements IPythonSettings {
+ constructor() {
+ vscode.workspace.onDidChangeConfiguration(() => {
+ this.initializeSettings();
+ });
+
+ this.initializeSettings();
+ }
+
+ private initializeSettings() {
+ var pythonSettings = vscode.workspace.getConfiguration("python");
+
+ this.pythonPath = pythonSettings.get<string>("pythonPath");
+
+ var lintingSettings = pythonSettings.get<ILintingSettings>("linting");
+ if (this.linting) {
+ Object.assign<ILintingSettings, ILintingSettings>(this.linting, lintingSettings);
+ }
+ else {
+ this.linting = lintingSettings;
+ }
+
+ var formattingSettings = pythonSettings.get<IFormattingSettings>("linting");
+ if (this.formatting) {
+ Object.assign<IFormattingSettings, IFormattingSettings>(this.formatting, formattingSettings);
+ }
+ else {
+ this.formatting = formattingSettings;
+ }
+
+ var autoCompleteSettings = pythonSettings.get<IAutoCompeteSettings>("autoComplete");
+ if (this.autoComplete) {
+ Object.assign<IAutoCompeteSettings, IAutoCompeteSettings>(this.autoComplete, autoCompleteSettings);
+ }
+ else {
+ this.autoComplete = autoCompleteSettings;
+ }
+
+ var unitTestSettings = pythonSettings.get<IUnitTestSettings>("unitTest");
+ if (this.unitTest) {
+ Object.assign<IUnitTestSettings, IUnitTestSettings>(this.unitTest, unitTestSettings);
+ }
+ else {
+ this.unitTest = unitTestSettings;
+ }
+ }
+
+ public pythonPath: string;
+ public linting: ILintingSettings;
+ public formatting: IFormattingSettings;
+ public autoComplete: IAutoCompeteSettings;
+ public unitTest: IUnitTestSettings;
+}