python-language-server/pyls/python_ls.py at develop · deepnote/python-language-server · GitHub

History

473 lines (385 loc) · 19.2 KB

Raw

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

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

import json

import logging

import os

import socketserver

import threading

from functools import partial

from hashlib import sha256

from pyls_jsonrpc.dispatchers import MethodDispatcher

from pyls_jsonrpc.endpoint import Endpoint

from pyls_jsonrpc.streams import JsonRpcStreamReader, JsonRpcStreamWriter

from . import lsp, _utils, uris

from .config import config

from .workspace import Workspace

log = logging.getLogger(__name__)

LINT_DEBOUNCE_S = 0.5 # 500 ms

PARENT_PROCESS_WATCH_INTERVAL = 10 # 10 s

MAX_WORKERS = 64

PYTHON_FILE_EXTENSIONS = ('.py', '.pyi')

CONFIG_FILEs = ('pycodestyle.cfg', 'setup.cfg', 'tox.ini', '.flake8')

class _StreamHandlerWrapper(socketserver.StreamRequestHandler, object):

"""A wrapper class that is used to construct a custom handler class."""

delegate = None

def setup(self):

super(_StreamHandlerWrapper, self).setup()

# pylint: disable=no-member

self.delegate = self.DELEGATE_CLASS(self.rfile, self.wfile)

def handle(self):

self.auth(self.delegate.start)

# pylint: disable=no-member

self.SHUTDOWN_CALL()

def auth(self, cb):

token = ''

if "JUPYTER_TOKEN" in os.environ:

token = os.environ["JUPYTER_TOKEN"]

else:

log.warn('! Missing jupyter token !')

data = self.rfile.readline()

try:

auth_req = json.loads(data.decode().split('\n')[0])

except:

log.error('Error parsing authentication message')

auth_error_msg = { 'msg': 'AUTH_ERROR' }

self.wfile.write(json.dumps(auth_error_msg).encode())

return

hashed_token = sha256(token.encode()).hexdigest()

if auth_req.get('token') == hashed_token:

auth_success_msg = { 'msg': 'AUTH_SUCCESS' }

self.wfile.write(json.dumps(auth_success_msg).encode())

cb()

else:

log.info('Failed to authenticate: invalid credentials')

auth_invalid_msg = { 'msg': 'AUTH_INVALID_CRED' }

self.wfile.write(json.dumps(auth_invalid_msg).encode())

def start_tcp_lang_server(bind_addr, port, check_parent_process, handler_class):

if not issubclass(handler_class, PythonLanguageServer):

raise ValueError('Handler class must be an instance of PythonLanguageServer')

def shutdown_server(check_parent_process, *args):

# pylint: disable=unused-argument

if check_parent_process:

log.debug('Shutting down server')

# Shutdown call must be done on a thread, to prevent deadlocks

stop_thread = threading.Thread(target=server.shutdown)

stop_thread.start()

# Construct a custom wrapper class around the user's handler_class

wrapper_class = type(

handler_class.__name__ + 'Handler',

(_StreamHandlerWrapper,),

{'DELEGATE_CLASS': partial(handler_class,

check_parent_process=check_parent_process),

'SHUTDOWN_CALL': partial(shutdown_server, check_parent_process)}

)

server = socketserver.TCPServer((bind_addr, port), wrapper_class, bind_and_activate=False)

server.allow_reuse_address = True

try:

server.server_bind()

server.server_activate()

log.info('Serving %s on (%s, %s)', handler_class.__name__, bind_addr, port)

server.serve_forever()

finally:

log.info('Shutting down')

server.server_close()

def start_io_lang_server(rfile, wfile, check_parent_process, handler_class):

if not issubclass(handler_class, PythonLanguageServer):

raise ValueError('Handler class must be an instance of PythonLanguageServer')

log.info('Starting %s IO language server', handler_class.__name__)

server = handler_class(rfile, wfile, check_parent_process)

server.start()

class PythonLanguageServer(MethodDispatcher):

""" Implementation of the Microsoft VSCode Language Server Protocol

https://github.com/Microsoft/language-server-protocol/blob/master/versions/protocol-1-x.md

"""

# pylint: disable=too-many-public-methods,redefined-builtin

def __init__(self, rx, tx, check_parent_process=False):

self.workspace = None

self.config = None

self.root_uri = None

self.watching_thread = None

self.workspaces = {}

self.uri_workspace_mapper = {}

self._jsonrpc_stream_reader = JsonRpcStreamReader(rx)

self._jsonrpc_stream_writer = JsonRpcStreamWriter(tx)

self._check_parent_process = check_parent_process

self._endpoint = Endpoint(self, self._jsonrpc_stream_writer.write, max_workers=MAX_WORKERS)

self._dispatchers = []

self._shutdown = False

def start(self):

"""Entry point for the server."""

self._jsonrpc_stream_reader.listen(self._endpoint.consume)

def __getitem__(self, item):

"""Override getitem to fallback through multiple dispatchers."""

if self._shutdown and item != 'exit':

# exit is the only allowed method during shutdown

log.debug("Ignoring non-exit method during shutdown: %s", item)

raise KeyError

try:

return super(PythonLanguageServer, self).__getitem__(item)

except KeyError:

# Fallback through extra dispatchers

for dispatcher in self._dispatchers:

try:

return dispatcher[item]

except KeyError:

continue

raise KeyError()

def m_shutdown(self, **_kwargs):

self._shutdown = True

return None

def m_exit(self, **_kwargs):

self._endpoint.shutdown()

self._jsonrpc_stream_reader.close()

self._jsonrpc_stream_writer.close()

def _match_uri_to_workspace(self, uri):

workspace_uri = _utils.match_uri_to_workspace(uri, self.workspaces)

return self.workspaces.get(workspace_uri, self.workspace)

def _hook(self, hook_name, doc_uri=None, **kwargs):

"""Calls hook_name and returns a list of results from all registered handlers"""

workspace = self._match_uri_to_workspace(doc_uri)

doc = workspace.get_document(doc_uri) if doc_uri else None

hook_handlers = self.config.plugin_manager.subset_hook_caller(hook_name, self.config.disabled_plugins)

return hook_handlers(config=self.config, workspace=workspace, document=doc, **kwargs)

def capabilities(self):

server_capabilities = {

'codeActionProvider': True,

'codeLensProvider': {

'resolveProvider': False, # We may need to make this configurable

'completionProvider': {

'resolveProvider': True,

'triggerCharacters': ['.']

'documentFormattingProvider': True,

'documentHighlightProvider': True,

'documentRangeFormattingProvider': True,

'documentSymbolProvider': True,

'definitionProvider': True,

'executeCommandProvider': {

'commands': flatten(self._hook('pyls_commands'))

'hoverProvider': True,

'referencesProvider': True,

'renameProvider': True,

'foldingRangeProvider': True,

'signatureHelpProvider': {

'triggerCharacters': ['(', ',', '=']

'textDocumentSync': {

'change': lsp.TextDocumentSyncKind.INCREMENTAL,

'save': {

'includeText': True,

'openClose': True,

'workspace': {

'workspaceFolders': {

'supported': True,

'changeNotifications': True

}

'experimental': merge(self._hook('pyls_experimental_capabilities'))

}

log.info('Server capabilities: %s', server_capabilities)

return server_capabilities

def m_initialize(self, processId=None, rootUri=None, rootPath=None, initializationOptions=None, **_kwargs):

log.debug('Language server initialized with %s %s %s %s', processId, rootUri, rootPath, initializationOptions)

if rootUri is None:

rootUri = uris.from_fs_path(rootPath) if rootPath is not None else ''

self.workspaces.pop(self.root_uri, None)

self.root_uri = rootUri

self.config = config.Config(rootUri, initializationOptions or {},

processId, _kwargs.get('capabilities', {}))

self.workspace = Workspace(rootUri, self._endpoint, self.config)

self.workspaces[rootUri] = self.workspace

self._dispatchers = self._hook('pyls_dispatchers')

self._hook('pyls_initialize')

if self._check_parent_process and processId is not None and self.watching_thread is None:

def watch_parent_process(pid):

# exit when the given pid is not alive

if not _utils.is_process_alive(pid):

log.info("parent process %s is not alive, exiting!", pid)

self.m_exit()

else:

threading.Timer(PARENT_PROCESS_WATCH_INTERVAL, watch_parent_process, args=[pid]).start()

self.watching_thread = threading.Thread(target=watch_parent_process, args=(processId,))

self.watching_thread.daemon = True

self.watching_thread.start()

# Get our capabilities

return {'capabilities': self.capabilities()}

def m_initialized(self, **_kwargs):

self._hook('pyls_initialized')

def code_actions(self, doc_uri, range, context):

return flatten(self._hook('pyls_code_actions', doc_uri, range=range, context=context))

def code_lens(self, doc_uri):

return flatten(self._hook('pyls_code_lens', doc_uri))

def completions(self, doc_uri, position):

completions = self._hook('pyls_completions', doc_uri, position=position)

return {

'isIncomplete': True,

'items': flatten(completions)

}

def completion_detail(self, item):

detail = self._hook('pyls_completion_detail', item=item)

return detail

def definitions(self, doc_uri, position):

return flatten(self._hook('pyls_definitions', doc_uri, position=position))

def document_symbols(self, doc_uri):

return flatten(self._hook('pyls_document_symbols', doc_uri))

def execute_command(self, command, arguments):

return self._hook('pyls_execute_command', command=command, arguments=arguments)

def format_document(self, doc_uri):

return self._hook('pyls_format_document', doc_uri)

def format_range(self, doc_uri, range):

return self._hook('pyls_format_range', doc_uri, range=range)

def highlight(self, doc_uri, position):

return flatten(self._hook('pyls_document_highlight', doc_uri, position=position)) or None

def hover(self, doc_uri, position):

return self._hook('pyls_hover', doc_uri, position=position) or {'contents': ''}

@_utils.debounce(LINT_DEBOUNCE_S, keyed_by='doc_uri')

def lint(self, doc_uri, is_saved):

# Since we're debounced, the document may no longer be open

workspace = self._match_uri_to_workspace(doc_uri)

textDocument = workspace.get_maybe_document(doc_uri)

if doc_uri in workspace.documents:

workspace.publish_diagnostics(

doc_uri,

flatten(self._hook('pyls_lint', doc_uri, is_saved=is_saved)),

textDocument.version if textDocument else None

)

def references(self, doc_uri, position, exclude_declaration):

return flatten(self._hook(

'pyls_references', doc_uri, position=position,

exclude_declaration=exclude_declaration

))

def rename(self, doc_uri, position, new_name):

return self._hook('pyls_rename', doc_uri, position=position, new_name=new_name)

def signature_help(self, doc_uri, position):

return self._hook('pyls_signature_help', doc_uri, position=position)

def folding(self, doc_uri):

return self._hook('pyls_folding_range', doc_uri)

def m_text_document__did_close(self, textDocument=None, **_kwargs):

workspace = self._match_uri_to_workspace(textDocument['uri'])

workspace.rm_document(textDocument['uri'])

def m_text_document__did_open(self, textDocument=None, **_kwargs):

workspace = self._match_uri_to_workspace(textDocument['uri'])

workspace.put_document(textDocument['uri'], textDocument['text'], version=textDocument.get('version'))

self._hook('pyls_document_did_open', textDocument['uri'])

self.lint(textDocument['uri'], is_saved=True)

def m_text_document__did_change(self, contentChanges=None, textDocument=None, **_kwargs):

workspace = self._match_uri_to_workspace(textDocument['uri'])

for change in contentChanges:

workspace.update_document(

textDocument['uri'],

change,

version=textDocument.get('version')

)

self.lint(textDocument['uri'], is_saved=False)

def m_text_document__did_save(self, textDocument=None, **_kwargs):

self.lint(textDocument['uri'], is_saved=True)

def m_text_document__code_action(self, textDocument=None, range=None, context=None, **_kwargs):

return self.code_actions(textDocument['uri'], range, context)

def m_text_document__code_lens(self, textDocument=None, **_kwargs):

return self.code_lens(textDocument['uri'])

def m_text_document__completion(self, textDocument=None, position=None, **_kwargs):

return self.completions(textDocument['uri'], position)

def m_completion_item__resolve(self, label=None, **_kwargs):

return self.completion_detail(label)

def m_text_document__definition(self, textDocument=None, position=None, **_kwargs):

return self.definitions(textDocument['uri'], position)

def m_text_document__document_highlight(self, textDocument=None, position=None, **_kwargs):

return self.highlight(textDocument['uri'], position)

def m_text_document__hover(self, textDocument=None, position=None, **_kwargs):

return self.hover(textDocument['uri'], position)

def m_text_document__document_symbol(self, textDocument=None, **_kwargs):

return self.document_symbols(textDocument['uri'])

def m_text_document__formatting(self, textDocument=None, _options=None, **_kwargs):

# For now we're ignoring formatting options.

return self.format_document(textDocument['uri'])

def m_text_document__rename(self, textDocument=None, position=None, newName=None, **_kwargs):

return self.rename(textDocument['uri'], position, newName)

def m_text_document__folding_range(self, textDocument=None, **_kwargs):

return self.folding(textDocument['uri'])

def m_text_document__range_formatting(self, textDocument=None, range=None, _options=None, **_kwargs):

# Again, we'll ignore formatting options for now.

return self.format_range(textDocument['uri'], range)

def m_text_document__references(self, textDocument=None, position=None, context=None, **_kwargs):

exclude_declaration = not context['includeDeclaration']

return self.references(textDocument['uri'], position, exclude_declaration)

def m_text_document__signature_help(self, textDocument=None, position=None, **_kwargs):

return self.signature_help(textDocument['uri'], position)

def m_workspace__did_change_configuration(self, settings=None):

self.config.update((settings or {}).get('pyls', {}))

for workspace_uri in self.workspaces:

workspace = self.workspaces[workspace_uri]

workspace.update_config(settings)

for doc_uri in workspace.documents:

self.lint(doc_uri, is_saved=False)

def m_workspace__did_change_workspace_folders(self, event=None, **_kwargs): # pylint: disable=too-many-locals

if event is None:

return

added = event.get('added', [])

removed = event.get('removed', [])

for removed_info in removed:

if 'uri' in removed_info:

removed_uri = removed_info['uri']

self.workspaces.pop(removed_uri, None)

for added_info in added:

if 'uri' in added_info:

added_uri = added_info['uri']

workspace_config = config.Config(

added_uri, self.config._init_opts,

self.config._process_id, self.config._capabilities)

workspace_config.update(self.config._settings)

self.workspaces[added_uri] = Workspace(

added_uri, self._endpoint, workspace_config)

root_workspace_removed = any(removed_info['uri'] == self.root_uri for removed_info in removed)

workspace_added = len(added) > 0 and 'uri' in added[0]

if root_workspace_removed and workspace_added:

added_uri = added[0]['uri']

self.root_uri = added_uri

new_root_workspace = self.workspaces[added_uri]

self.config = new_root_workspace._config

self.workspace = new_root_workspace

elif root_workspace_removed:

# NOTE: Removing the root workspace can only happen when the server

# is closed, thus the else condition of this if can never happen.

if self.workspaces:

log.debug('Root workspace deleted!')

available_workspaces = sorted(self.workspaces)

first_workspace = available_workspaces[0]

new_root_workspace = self.workspaces[first_workspace]

self.root_uri = first_workspace

self.config = new_root_workspace._config

self.workspace = new_root_workspace

# Migrate documents that are on the root workspace and have a better

# match now

doc_uris = list(self.workspace._docs.keys())

for uri in doc_uris:

doc = self.workspace._docs.pop(uri)

new_workspace = self._match_uri_to_workspace(uri)

new_workspace._docs[uri] = doc

def m_workspace__did_change_watched_files(self, changes=None, **_kwargs):

changed_py_files = set()

config_changed = False

for d in (changes or []):

if d['uri'].endswith(PYTHON_FILE_EXTENSIONS):

changed_py_files.add(d['uri'])

elif d['uri'].endswith(CONFIG_FILEs):

config_changed = True

if config_changed:

self.config.settings.cache_clear()

elif not changed_py_files:

# Only externally changed python files and lint configs may result in changed diagnostics.

return

for workspace_uri in self.workspaces:

workspace = self.workspaces[workspace_uri]

for doc_uri in workspace.documents:

# Changes in doc_uri are already handled by m_text_document__did_save

if doc_uri not in changed_py_files:

self.lint(doc_uri, is_saved=False)

def m_workspace__execute_command(self, command=None, arguments=None):

return self.execute_command(command, arguments)

def flatten(list_of_lists):

return [item for lst in list_of_lists for item in lst]

def merge(list_of_dicts):

return {k: v for dictionary in list_of_dicts for k, v in dictionary.items()}

python-language-server/pyls/python_ls.py at develop · deepnote/python-language-server · GitHub

Uh oh!

Expand file tree

Breadcrumbs

python_ls.py

Latest commit

History

Breadcrumbs

python_ls.py

File metadata and controls