PR: Fix Inline comments including text with import cause functions/classes to disappear when under cells in the Outline explorer

[jsbautista]

Fix Inline comments including text with import cause functions/classes to disappear when under cells in the Outline explorer

[krassowski]

Thank you for opening the PR @jsbautista!

The proposed change makes sense, but I think it misses a few cases:

• from . import something
• from ..module import something
• from module import (a, b)

It will also fail with multi-line imports, but after all the existing code is not handling multi-line imports well either.

Would you mind adding a test for the various cases in:

python-lsp-server/test/plugins/test_symbols.py

Lines 51 to 80 in 04fa3e5

	def test_symbols(config, workspace):
	doc = Document(DOC_URI, workspace, DOC)
	config.update({"plugins": {"jedi_symbols": {"all_scopes": False}}})
	symbols = pylsp_document_symbols(config, doc)
	# All four symbols (import sys, a, B, main)
	# y is not in the root scope, it shouldn't be returned
	assert len(symbols) == 5
	def sym(name):
	return [s for s in symbols if s["name"] == name][0]
	# Check we have some sane mappings to VSCode constants
	assert sym("a")["kind"] == SymbolKind.Variable
	assert sym("B")["kind"] == SymbolKind.Class
	assert sym("main")["kind"] == SymbolKind.Function
	# Not going to get too in-depth here else we're just testing Jedi
	assert sym("a")["location"]["range"]["start"] == {"line": 2, "character": 0}
	# Ensure that the symbol range spans the whole definition
	assert sym("main")["location"]["range"]["start"] == {"line": 9, "character": 0}
	assert sym("main")["location"]["range"]["end"] == {"line": 12, "character": 0}
	def test_symbols_all_scopes(config, workspace) -> None:
	doc = Document(DOC_URI, workspace, DOC)
	symbols = pylsp_document_symbols(config, doc)
	helper_check_symbols_all_scope(symbols)

An alternative to using a regular expression would be using the ast module which should properly parse import expressions and ignore comments.

[krassowski]

If you would like to take advantage of compiling it once, you should move the pattern definition up, prior to the function definition, otherwise it will just compile it every time.