microsoft · jcdyer · Dec 29, 2017 · Jan 2, 2018 · Jan 10, 2018 · Jan 10, 2018
diff --git a/package.json b/package.json
@@ -1182,7 +1182,7 @@
 				},
 				"python.linting.pylintArgs": {
 					"type": "array",
-					"description": "Arguments passed in. Each argument is a separate item in the array.",
+					"description": "Arguments passed in. Each argument is a separate item in the array. --msg-template is set by VSCode and cannot be overridden here. Use python.linting.pylintMsgTemplate instead.",
 					"default": [],
 					"items": {
 						"type": "string"
@@ -1228,6 +1228,16 @@
 					},
 					"scope": "resource"
 				},
+				"python.linting.pylintMsgTemplate": {
+					"type": "string",
+					"description": "Controls the message template for linting results. Options are 'standard' and 'legacy'. 'standard' displays error codes as symbolic names like 'missing-docstring'. 'legacy' displays error codes as alphanumeric codes like 'C0111'.",
+					"default": "legacy",
+					"enum": [
+						"standard",
+						"legacy"
+					],
+					"scope": "resource"
+				},
 				"python.formatting.provider": {
 					"type": "string",
 					"default": "autopep8",

diff --git a/src/client/common/configSettings.ts b/src/client/common/configSettings.ts
@@ -77,6 +77,7 @@ export interface ILintingSettings {
     prospectorArgs: string[];
     pylintEnabled: boolean;
     pylintArgs: string[];
+    pylintMsgTemplate: string;
     pep8Enabled: boolean;
     pep8Args: string[];
     pylamaEnabled: boolean;
@@ -251,7 +252,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
             pylamaArgs: [], pylamaEnabled: false, pylamaPath: 'pylama',
             prospectorArgs: [], prospectorEnabled: false, prospectorPath: 'prospector',
             pydocstyleArgs: [], pydocstyleEnabled: false, pydocstylePath: 'pydocstyle',
-            pylintArgs: [], pylintEnabled: false, pylintPath: 'pylint',
+            pylintArgs: [], pylintEnabled: false, pylintPath: 'pylint', pylintMsgTemplate: 'legacy',
             pylintCategorySeverity: {
                 convention: vscode.DiagnosticSeverity.Hint,
                 error: vscode.DiagnosticSeverity.Error,

diff --git a/src/client/common/constants.ts b/src/client/common/constants.ts
@@ -49,6 +49,7 @@ export namespace Delays {
 export namespace LinterErrors {
     export namespace pylint {
         export const InvalidSyntax = 'E0001';
+        export const InvalidSyntaxSymbolic = 'invalid-syntax';
     }
     export namespace prospector {
         export const InvalidSyntax = 'F999';

diff --git a/src/client/linters/baseLinter.ts b/src/client/linters/baseLinter.ts
@@ -29,6 +29,7 @@ export interface ILintMessage {
     type: string;
     severity?: LintMessageSeverity;
     provider: string;
+    preformattedMessage?: boolean;
 }
 export enum LintMessageSeverity {
     Hint,
@@ -152,7 +153,8 @@ export abstract class BaseLinter {
             column: isNaN(match.column) || match.column === 0 ? 0 : match.column - this.columnOffset,
             line: match.line,
             type: match.type,
-            provider: this.Id
+            provider: this.Id,
+            preformattedMessage: false
         };
     }
     private parseLines(outputLines: string[], regEx: string): ILintMessage[] {

diff --git a/src/client/linters/prospector.ts b/src/client/linters/prospector.ts
@@ -52,7 +52,8 @@ export class Linter extends baseLinter.BaseLinter {
                     column: msg.location.character,
                     line: lineNumber,
                     type: msg.code,
-                    provider: `${this.Id} - ${msg.source}`
+                    provider: `${this.Id} - ${msg.source}`,
+                    messageContainsCode: false
                 };
             });
     }

diff --git a/src/client/linters/pylint.ts b/src/client/linters/pylint.ts
@@ -11,9 +11,23 @@ export class Linter extends baseLinter.BaseLinter {
     }
 
     protected async runLinter(document: TextDocument, cancellation: CancellationToken): Promise<baseLinter.ILintMessage[]> {
-        const messages = await this.run(['--msg-template=\'{line},{column},{category},{msg_id}:{msg}\'', '--reports=n', '--output-format=text', document.uri.fsPath], document, cancellation);
+        let msgBody;
+        let regex;
+        if (this.pythonSettings.linting.pylintMsgTemplate === 'legacy') {
+            msgBody = '{msg_id}:{msg}';
+        } else if (this.pythonSettings.linting.pylintMsgTemplate === 'standard') {
+            msgBody = '{msg} ({symbol})';
+            regex = '(?<line>\\d+),(?<column>\\d+),(?<type>\\w+),(?<code>[a-z-]+):(?<message>.*)\\r?(\\n|$)';
+        }
+        let codeVar = '{symbol}';
+        if (msgBody.includes('{msg_id}') && !msgBody.includes('{symbol}')) {
+            codeVar = '{msg_id}';
+        }
+        const msgTemplate = `'{line},{column},{category},${codeVar}:${msgBody}'`;
+        const messages = await this.run([`--msg-template=${msgTemplate}`, '--reports=n', '--output-format=text', document.uri.fsPath], document, cancellation, regex);
         messages.forEach(msg => {
             msg.severity = this.parseMessagesSeverity(msg.type, this.pythonSettings.linting.pylintCategorySeverity);
+            msg.preformattedMessage = true;
         });
 
         return messages;

diff --git a/src/client/providers/lintProvider.ts b/src/client/providers/lintProvider.ts
@@ -34,7 +34,13 @@ function createDiagnostics(message: linter.ILintMessage, document: vscode.TextDo
     const range = new vscode.Range(position, position);
 
     const severity = lintSeverityToVSSeverity.get(message.severity!)!;
-    const diagnostic = new vscode.Diagnostic(range, `${message.code}:${message.message}`, severity);
+    let formattedMessage;
+    if (message.preformattedMessage) {
+        formattedMessage = message.message;
+    } else {
+        formattedMessage = `${message.code}:${message.message}`;
+    }
+    const diagnostic = new vscode.Diagnostic(range, formattedMessage, severity);
     diagnostic.code = message.code;
     diagnostic.source = message.provider;
     return diagnostic;
@@ -218,6 +224,7 @@ export class LintProvider implements vscode.Disposable {
                             // Ignore magic commands from jupyter.
                             if (hasJupyterCodeCells && document.lineAt(d.line - 1).text.trim().startsWith('%') &&
                                 (d.code === LinterErrors.pylint.InvalidSyntax ||
+                                    d.code === LinterErrors.pylint.InvalidSyntaxSymbolic ||
                                     d.code === LinterErrors.prospector.InvalidSyntax ||
                                     d.code === LinterErrors.flake8.InvalidSyntax)) {
                                 return;

diff --git a/src/test/.vscode/settings.json b/src/test/.vscode/settings.json
@@ -1,5 +1,5 @@
 {
-    "python.linting.pylintEnabled": false,
+    "python.linting.pylintEnabled": true,
     "python.linting.flake8Enabled": false,
     "python.workspaceSymbols.enabled": false,
     "python.unitTest.nosetestArgs": [],

diff --git a/src/test/common.ts b/src/test/common.ts
@@ -9,7 +9,7 @@ export const rootWorkspaceUri = getWorkspaceRoot();
 
 export type PythonSettingKeys = 'workspaceSymbols.enabled' | 'pythonPath' |
     'linting.lintOnSave' |
-    'linting.enabled' | 'linting.pylintEnabled' |
+    'linting.enabled' | 'linting.pylintEnabled' | 'linting.pylintMsgTemplate' |
     'linting.flake8Enabled' | 'linting.pep8Enabled' | 'linting.pylamaEnabled' |
     'linting.prospectorEnabled' | 'linting.pydocstyleEnabled' | 'linting.mypyEnabled' |
     'unitTest.nosetestArgs' | 'unitTest.pyTestArgs' | 'unitTest.unittestArgs' |

diff --git a/src/test/debugger/portAndHost.test.ts b/src/test/debugger/portAndHost.test.ts
@@ -84,23 +84,23 @@ suite('Standard Debugging', () => {
         await debugClient.waitForEvent('terminated');
     }
 
-    test('Confirm debuggig works if both port and host are not provided', async () => {
+    test('Confirm debugging works if both port and host are not provided', async () => {
         await testDebuggingWithProvidedPort();
     });
 
-    test('Confirm debuggig works if port=0', async () => {
+    test('Confirm debugging works if port=0', async () => {
         await testDebuggingWithProvidedPort(0, 'localhost');
     });
 
-    test('Confirm debuggig works if port=0 or host=localhost', async () => {
+    test('Confirm debugging works if port=0 or host=localhost', async () => {
         await testDebuggingWithProvidedPort(0, 'localhost');
     });
 
-    test('Confirm debuggig works if port=0 or host=127.0.0.1', async () => {
+    test('Confirm debugging works if port=0 or host=127.0.0.1', async () => {
         await testDebuggingWithProvidedPort(0, '127.0.0.1');
     });
 
-    test('Confirm debuggig fails when an invalid host is provided', async () => {
+    test('Confirm debugging fails when an invalid host is provided', async () => {
         const promise = testDebuggingWithProvidedPort(0, 'xyz123409924ple_ewf');
         let exception: Error | undefined;
         try {
@@ -110,7 +110,7 @@ suite('Standard Debugging', () => {
         }
         expect(exception!.message).contains('ENOTFOUND', 'Debugging failed for some other reason');
     });
-    test('Confirm debuggig fails when provided port is in use', async () => {
+    test('Confirm debugging fails when provided port is in use', async () => {
         // tslint:disable-next-line:no-empty
         const server = net.createServer((s) => { });
         const port = await new Promise<number>((resolve, reject) => server.listen({ host: 'localhost', port: 0 }, () => resolve(server.address().port)));