pylance-release icon indicating copy to clipboard operation
pylance-release copied to clipboard

switch to a different tool for python syntax highlighting

Open DetachHead opened this issue 1 year ago • 11 comments

MagicPython doesn't seem to have been updated in 2 years, meaning it doesn't support any of the new syntax in python 3.12:

  • https://github.com/MagicStack/MagicPython/issues/262
  • https://github.com/MagicStack/MagicPython/issues/265

it seems very odd that these new features came out 6 months ago and are still not supported properly in vscode.


there's also the issue with raw strings being incorrectly treated as regex which has been raised many times:

  • https://github.com/MagicStack/MagicPython/issues/259
  • https://github.com/MagicStack/MagicPython/issues/149
  • https://github.com/MagicStack/MagicPython/issues/155
  • https://github.com/MagicStack/MagicPython/issues/114
  • https://github.com/MagicStack/MagicPython/issues/82

i think this is a big source of confusion for users (as you can see from how many times it's been raised), and should be addressed. i think @gilbertohasnofb makes a good argument in https://github.com/MagicStack/MagicPython/issues/259#issuecomment-1879727479:

AFAIK this is not a standard defined in any PEP, and popular code formatter such as black will convert any R'' strings into r'' by default.

I get the reasoning behind this decision, and there were some arguments for it since TextMate and Sublime Text both highlight Python syntax this way by default, but with the widespread use of VSCode these days (which does not highlight raw strings in Python this way by default) this argument seems outdated. Ideally this idiosyncratic highlighting could be made optional, preferably off by default.

DetachHead avatar Apr 26 '24 11:04 DetachHead

Thanks for the issue. We actually have an internal issue already tracking this: https://github.com/microsoft/pyrx/issues/4026, but we can use this issue as the external facing problem.

rchiodo avatar Apr 29 '24 16:04 rchiodo

AFAIK this is not a standard defined in any PEP, and popular code formatter such as black will convert any R'' strings into r'' by default.

Just noting that this part isn't true; Black does not convert between R'' and r'', specifically because MagicPython syntax highlights them differently. I don't have a strong opinion on whether Pylance should continue to treat the two prefixes differently: on the one hand it's a surprising and non-obvious behavior, on the other hand it is nice to get a way to syntax-highlight regexes.

JelleZijlstra avatar Apr 30 '24 00:04 JelleZijlstra

i see this issue was moved to the pylance repo. from my understanding the syntax highlighting provided by magicpython is bundled with vscode and separate to the semantic highlighting provided by pylance. is the plan to remove that basic syntax highlighting entirely and instead have it handled entirely by pylance? if so, it would be a downgrade for users who are not using pylance (eg. vscodium/basedpyright users)

DetachHead avatar Apr 30 '24 00:04 DetachHead

The plan is to fix the colors of text in Python code. We haven't really started investigating how or where we'd implement such a thing, but we realize the textmate solution that uses MagicPython's tmlanguage isn't really working out.

rchiodo avatar Apr 30 '24 16:04 rchiodo

VS Code is exploring using Tree-sitter for syntax highlighting. If they move forward with that, the current thinking is that each language could choose either TextMate or Tree-sitter depending on which implementation is more up-to-date / better maintained -- https://github.com/microsoft/vscode/issues/210475

For internal people, there was a discussion about this work at the beginning of the 4/30 "Language Teams and LSP Weekly Sync" meeting.

debonte avatar Apr 30 '24 19:04 debonte

did we drop the idea of supplying textmate rule in pylance rather than using one supplied by vscode?

heejaechang avatar Apr 30 '24 19:04 heejaechang

did we drop the idea of supplying textmate rule in pylance rather than using one supplied by vscode?

No, I think that's still on the table. Although Dirk mentioned in the LSP sync that fixing bugs / enhancing existing TextMate grammars can be incredibly painful.

debonte avatar Apr 30 '24 19:04 debonte