/
plugin.py
412 lines (357 loc) · 16.2 KB
/
plugin.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
# -*- coding: utf-8 -*-
#
# Copyright © Spyder Project Contributors
# Licensed under the terms of the MIT License
# (see spyder/__init__.py for details)
"""
Manager for all LSP clients connected to the servers defined
in our Preferences.
"""
# Standard library imports
import logging
import os
import os.path as osp
import functools
# Third-party imports
from qtpy.QtCore import Slot
from qtpy.QtWidgets import QMessageBox
# Local imports
from spyder.config.base import _, get_conf_path, running_under_pytest
from spyder.config.lsp import PYTHON_CONFIG
from spyder.config.manager import CONF
from spyder.api.completion import SpyderCompletionPlugin
from spyder.utils.misc import check_connection_port, getcwd_or_home
from spyder.plugins.completion.languageserver import LSP_LANGUAGES
from spyder.plugins.completion.languageserver.client import LSPClient
from spyder.plugins.completion.languageserver.confpage import (
LanguageServerConfigPage)
logger = logging.getLogger(__name__)
class LanguageServerPlugin(SpyderCompletionPlugin):
"""Language Server Protocol manager."""
CONF_SECTION = 'lsp-server'
CONF_FILE = False
COMPLETION_CLIENT_NAME = 'lsp'
STOPPED = 'stopped'
RUNNING = 'running'
LOCALHOST = ['127.0.0.1', 'localhost']
CONFIGWIDGET_CLASS = LanguageServerConfigPage
def __init__(self, parent):
SpyderCompletionPlugin.__init__(self, parent)
self.clients = {}
self.requests = set({})
self.register_queue = {}
self.update_configuration()
def register_file(self, language, filename, codeeditor):
if language in self.clients:
language_client = self.clients[language]['instance']
if language_client is None:
self.register_queue[language].append((filename, codeeditor))
else:
language_client.register_file(filename, codeeditor)
def get_languages(self):
"""
Get the list of languages we need to start servers and create
clients for.
"""
languages = ['python']
all_options = CONF.options(self.CONF_SECTION)
for option in all_options:
if option in [l.lower() for l in LSP_LANGUAGES]:
languages.append(option)
return languages
def get_language_config(self, language):
"""Get language configuration options from our config system."""
if language == 'python':
return self.generate_python_config()
else:
return self.get_option(language)
def get_root_path(self, language):
"""
Get root path to pass to the LSP servers.
This can be the current project path or the output of
getcwd_or_home (except for Python, see below).
"""
path = None
# Get path of the current project
if self.main and self.main.projects:
path = self.main.projects.get_active_project_path()
if not path:
# We can't use getcwd_or_home for LSP servers because if it
# returns home and you have a lot of files on it
# then computing completions takes a long time
# and blocks the LSP server.
# Instead we use an empty directory inside our config one,
# just like we did for Rope in Spyder 3.
path = get_conf_path('lsp_root_path')
if not osp.exists(path):
os.mkdir(path)
return path
@Slot()
def project_path_update(self, project_path, update_kind):
"""
Send a new initialize message to each LSP server when the project
path has changed so they can update the respective server root paths.
"""
self.main.projects.stop_lsp_services()
for language in self.clients:
language_client = self.clients[language]
if language_client['status'] == self.RUNNING:
self.main.editor.stop_completion_services(language)
folder = self.get_root_path(language)
instance = language_client['instance']
instance.folder = folder
instance.initialize()
@Slot(str)
def report_server_error(self, error):
"""Report server errors in our error report dialog."""
self.main.console.exception_occurred(error, is_traceback=True,
is_pyls_error=True)
def report_no_external_server(self, host, port, language):
"""
Report that connection couldn't be established with
an external server.
"""
QMessageBox.critical(
self.main,
_("Error"),
_("It appears there is no {language} language server listening "
"at address:"
"<br><br>"
"<tt>{host}:{port}</tt>"
"<br><br>"
"Therefore, completion and linting for {language} will not "
"work during this session."
"<br><br>"
"To fix this, please verify that your firewall or antivirus "
"allows Python processes to open ports in your system, or the "
"settings you introduced in our Preferences to connect to "
"external LSP servers.").format(host=host, port=port,
language=language.capitalize())
)
def start_client(self, language):
"""Start an LSP client for a given language."""
started = False
if language in self.clients:
language_client = self.clients[language]
queue = self.register_queue[language]
# Don't start LSP services when testing unless we demand
# them.
if running_under_pytest():
if not os.environ.get('SPY_TEST_USE_INTROSPECTION'):
return started
# Start client
started = language_client['status'] == self.RUNNING
if language_client['status'] == self.STOPPED:
config = language_client['config']
# If we're trying to connect to an external server,
# verify that it's listening before creating a
# client for it.
if config['external']:
host = config['host']
port = config['port']
response = check_connection_port(host, port)
if not response:
self.report_no_external_server(host, port, language)
return False
language_client['instance'] = LSPClient(
parent=self,
server_settings=config,
folder=self.get_root_path(language),
language=language
)
self.register_client_instance(language_client['instance'])
logger.info("Starting LSP client for {}...".format(language))
language_client['instance'].start()
language_client['status'] = self.RUNNING
for entry in queue:
language_client['instance'].register_file(*entry)
self.register_queue[language] = []
return started
def register_client_instance(self, instance):
"""Register signals emmited by a client instance."""
if self.main:
if self.main.editor:
instance.sig_initialize.connect(
self.main.editor.register_completion_server_settings)
if self.main.console:
instance.sig_server_error.connect(self.report_server_error)
if self.main.projects:
instance.sig_initialize.connect(
self.main.projects.register_lsp_server_settings)
def shutdown(self):
logger.info("Shutting down LSP manager...")
for language in self.clients:
self.close_client(language)
def update_configuration(self):
for language in self.get_languages():
client_config = {'status': self.STOPPED,
'config': self.get_language_config(language),
'instance': None}
if language not in self.clients:
self.clients[language] = client_config
self.register_queue[language] = []
else:
current_lang_config = self.clients[language]['config']
new_lang_config = client_config['config']
restart_diff = ['cmd', 'args', 'host',
'port', 'external', 'stdio']
restart = any([current_lang_config[x] != new_lang_config[x]
for x in restart_diff])
if restart:
logger.debug("Restart required for {} client!".format(
language))
if self.clients[language]['status'] == self.STOPPED:
# If we move from an external non-working server to
# an internal one, we need to start a new client.
if (current_lang_config['external'] and
not new_lang_config['external']):
self.restart_client(language, client_config)
else:
self.clients[language] = client_config
elif self.clients[language]['status'] == self.RUNNING:
self.restart_client(language, client_config)
else:
if self.clients[language]['status'] == self.RUNNING:
client = self.clients[language]['instance']
client.send_plugin_configurations(
new_lang_config['configurations'])
def restart_client(self, language, config):
"""Restart a client."""
self.main.editor.stop_completion_services(language)
self.main.projects.stop_lsp_services()
self.close_client(language)
self.clients[language] = config
self.start_client(language)
def update_client_status(self, active_set):
for language in self.clients:
if language not in active_set:
self.close_client(language)
def close_client(self, language):
if language in self.clients:
language_client = self.clients[language]
if language_client['status'] == self.RUNNING:
logger.info("Stopping LSP client for {}...".format(language))
# language_client['instance'].shutdown()
# language_client['instance'].exit()
language_client['instance'].stop()
language_client['status'] = self.STOPPED
def receive_response(self, response_type, response, language, req_id):
if req_id in self.requests:
self.requests.discard(req_id)
self.sig_response_ready.emit(
self.COMPLETION_CLIENT_NAME, req_id, response)
def send_request(self, language, request, params, req_id):
if language in self.clients:
language_client = self.clients[language]
if language_client['status'] == self.RUNNING:
self.requests.add(req_id)
client = self.clients[language]['instance']
params['response_callback'] = functools.partial(
self.receive_response, language=language, req_id=req_id)
client.perform_request(request, params)
return
self.sig_response_ready.emit(self.COMPLETION_CLIENT_NAME,
req_id, {})
def send_notification(self, language, request, params):
if language in self.clients:
language_client = self.clients[language]
if language_client['status'] == self.RUNNING:
client = self.clients[language]['instance']
client.perform_request(request, params)
def broadcast_notification(self, request, params):
"""Send notification/request to all available LSP servers."""
language = params.pop('language', None)
if language:
self.send_notification(language, request, params)
else:
for language in self.clients:
self.send_notification(language, request, params)
def generate_python_config(self):
"""
Update Python server configuration with the options saved in our
config system.
"""
python_config = PYTHON_CONFIG.copy()
# Server options
cmd = self.get_option('advanced/module')
host = self.get_option('advanced/host')
port = self.get_option('advanced/port')
# Pycodestyle
cs_exclude = self.get_option('pycodestyle/exclude').split(',')
cs_filename = self.get_option('pycodestyle/filename').split(',')
cs_select = self.get_option('pycodestyle/select').split(',')
cs_ignore = self.get_option('pycodestyle/ignore').split(',')
cs_max_line_length = self.get_option('pycodestyle/max_line_length')
pycodestyle = {
'enabled': self.get_option('pycodestyle'),
'exclude': [exclude.strip() for exclude in cs_exclude if exclude],
'filename': [filename.strip()
for filename in cs_filename if filename],
'select': [select.strip() for select in cs_select if select],
'ignore': [ignore.strip() for ignore in cs_ignore if ignore],
'hangClosing': False,
'maxLineLength': cs_max_line_length
}
# Linting - Pyflakes
pyflakes = {
'enabled': self.get_option('pyflakes')
}
# Pydocstyle
convention = self.get_option('pydocstyle/convention')
if convention == 'Custom':
ds_ignore = self.get_option('pydocstyle/ignore').split(',')
ds_select = self.get_option('pydocstyle/select').split(',')
ds_add_ignore = []
ds_add_select = []
else:
ds_ignore = []
ds_select = []
ds_add_ignore = self.get_option('pydocstyle/ignore').split(',')
ds_add_select = self.get_option('pydocstyle/select').split(',')
pydocstyle = {
'enabled': self.get_option('pydocstyle'),
'convention': convention,
'addIgnore': [ignore.strip()
for ignore in ds_add_ignore if ignore],
'addSelect': [select.strip()
for select in ds_add_select if select],
'ignore': [ignore.strip() for ignore in ds_ignore if ignore],
'select': [select.strip() for select in ds_select if select],
'match': self.get_option('pydocstyle/match'),
'matchDir': self.get_option('pydocstyle/match_dir')
}
# Code completion
jedi_completion = {
'enabled': self.get_option('code_completion'),
'include_params': self.get_option('code_snippets')
}
jedi_signature_help = {
'enabled': self.get_option('jedi_signature_help')
}
jedi_definition = {
'enabled': self.get_option('jedi_definition'),
'follow_imports': self.get_option('jedi_definition/follow_imports')
}
# Advanced
external_server = self.get_option('advanced/external')
stdio = self.get_option('advanced/stdio')
# Setup options in json
python_config['cmd'] = cmd
if host in self.LOCALHOST and not stdio:
python_config['args'] = ('--host {host} --port {port} --tcp '
'--check-parent-process')
else:
python_config['args'] = '--check-parent-process'
python_config['external'] = external_server
python_config['stdio'] = stdio
python_config['host'] = host
python_config['port'] = port
plugins = python_config['configurations']['pyls']['plugins']
plugins['pycodestyle'] = pycodestyle
plugins['pyflakes'] = pyflakes
plugins['pydocstyle'] = pydocstyle
plugins['jedi_completion'] = jedi_completion
plugins['jedi_signature_help'] = jedi_signature_help
plugins['preload']['modules'] = self.get_option('preload_modules')
plugins['jedi_definition'] = jedi_definition
return python_config