Custom Pylint Message Template

[EriKWDev]

Background

I came across this stackoverflow question concluding that vs-code overwrites the pylint message format. It opened #382.
#382 wondered why this is and it's because vs-code needs a specific format in order to parse information from pylint.
This was addressed in #495 when the pylint message was changed to show the human-friendly version of the E/F/W/C/R code. While a discussion was held and a feature almost implemented allowing for a custom message format, the feature was never merged and, in the end, outdated and closed.

Feature

In the discussion, the general opinion came to be that an option for a custom message should be available to allow for more flexible workflow (/ compatible with already established workflows):

"python.linting.pylintMsgTemplate": {
	"type": "string",
	"description": "Controls the message template for linting results, as a new-style python format string. The provided value will be appended to '{line},{column},{category},', which is required by VSCode. The previous message format, using numeric message codes, can be restored by setting this to '{msg_id}:{msg}'. Available fields are described at https://pylint.readthedocs.io/en/latest/user_guide/output.html.",
	"default": "{msg} ({symbol})",
 	"scope": "resource"
},

Where the message could then be customized ny the user in the settings.json like:

"python.linting.pylintMsgTemplate": "[{msg_id}] {msg} ({symbol})", // just an example...

The custom message (default: "{msg} ({symbol})") would then be concatenated after the message required for vs-code to parse the pylint message, and the user would be happy to have more control over.

Discussion

While this is a minor feature, I believe it is in the spirit of vs-code being flexible and customizable. I was shocked when I found out a custom pylint-message was not already supported since I took it for granted already being implemented.
I think the solution to this problem would be general enough to maybe allow for custom message-templates for the other linters as well.
Any thoughts? :)

[brettcannon]

Thank you for the suggestion! We have marked this issue as "needs decision" to make sure we have a conversation about your idea. We plan to leave this feature request open for at least a month to see how many 👍 votes your idea gets to help us make our decision.

[garu57]

Could be possible to have included as text at least the category and msg_id?

[garu57]

Sorry, I intended the letter indicating the category.

[Zuckme]

Thanks @EriKWDev! I lost 6 hours to finally understand that "custom pylint-message was not already supported in vscode".
vscode is so close to perfection....

I am fighting against this one:
Module name "Checkin_Main" doesn't conform to snake_case naming style
and I can't find the reason for it... unfortunately here no luck to find that "snake" message.

I also tried this in setting.jason:
"python.linting.pylintArgs": ["--extension-pkg-whitelist=wx", "--msg-template={path}:{line}: [{msg_id}({symbol}), {obj} {msg}"]
but it does not work.

So much was already done here, I hope they will work on this feature soon.
thanks to all vs code developers, you guys rocks!

[EchEdward]

Hello. Today I've met the same problem like author of the issue. And for me was surprise that user can't change default "msg-template". I think if that functionality will not be added, default "msg-template" has to contain code of error (msg_id) necessarily like for flake8, because in order to I can add some error in disable(ignore) I should look for error code in google by error message what is not so convenient. I believe that in the near future you will find the best way to decide this problem.

[PurpleSwords]

The output format can’t add {msg_id} so I can’t stand it, so I would rather use shell to add {msg_id} using pylint.

[karthiknadig]

We now a prototype for linting using pylint over Language server protocol. Please try out the prototype and provide feedback. Instructions here pylint-dev/pylint#5796 (comment) . Let me know if this helps with your issue.