Repository navigation
Expand file tree
/
Copy pathworkspace.py
More file actions
701 lines (584 loc) · 22.2 KB
/
Copy pathworkspace.py
File metadata and controls
701 lines (584 loc) · 22.2 KB
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
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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
# Copyright 2017-2020 Palantir Technologies, Inc.
# Copyright 2021- Python Language Server Contributors.
import io
import logging
from contextlib import contextmanager
import os
import re
import uuid
import functools
from typing import Literal, Optional, Generator, Callable, List
from threading import RLock
import jedi
from . import lsp, uris, _utils
log = logging.getLogger(__name__)
DEFAULT_AUTO_IMPORT_MODULES = ["numpy"]
# TODO: this is not the best e.g. we capture numbers
RE_START_WORD = re.compile("[A-Za-z_0-9]*$")
RE_END_WORD = re.compile("^[A-Za-z_0-9]*")
def lock(method):
"""Define an atomic region over a method."""
@functools.wraps(method)
def wrapper(self, *args, **kwargs):
with self._lock:
return method(self, *args, **kwargs)
return wrapper
class Workspace:
# pylint: disable=too-many-public-methods
M_PUBLISH_DIAGNOSTICS = "textDocument/publishDiagnostics"
M_PROGRESS = "$/progress"
M_INITIALIZE_PROGRESS = "window/workDoneProgress/create"
M_APPLY_EDIT = "workspace/applyEdit"
M_SHOW_MESSAGE = "window/showMessage"
def __init__(self, root_uri, endpoint, config=None):
self._config = config
self._root_uri = root_uri
self._endpoint = endpoint
self._root_uri_scheme = uris.urlparse(self._root_uri)[0]
self._root_path = uris.to_fs_path(self._root_uri)
self._docs = {}
# Cache jedi environments
self._environments = {}
# Whilst incubating, keep rope private
self.__rope = None
self.__rope_config = None
# We have a sperate AutoImport object for each feature to avoid sqlite errors
# from accessing the same database from multiple threads.
# An upstream fix discussion is here: https://github.com/python-rope/rope/issues/713
self.__rope_autoimport = (
{}
) # Type: Dict[Literal["completions", "code_actions"], rope.contrib.autoimport.sqlite.AutoImport]
def _rope_autoimport(
self,
rope_config: Optional,
memory: bool = False,
feature: Literal["completions", "code_actions"] = "completions",
):
# pylint: disable=import-outside-toplevel
from rope.contrib.autoimport.sqlite import AutoImport
if feature not in ["completions", "code_actions"]:
raise ValueError(f"Unknown feature {feature}")
if self.__rope_autoimport.get(feature, None) is None:
project = self._rope_project_builder(rope_config)
self.__rope_autoimport[feature] = AutoImport(project, memory=memory)
return self.__rope_autoimport[feature]
def _rope_project_builder(self, rope_config):
# pylint: disable=import-outside-toplevel
from rope.base.project import Project
# TODO: we could keep track of dirty files and validate only those
if self.__rope is None or self.__rope_config != rope_config:
rope_folder = rope_config.get("ropeFolder")
if rope_folder:
self.__rope = Project(self._root_path, ropefolder=rope_folder)
else:
self.__rope = Project(self._root_path)
self.__rope.prefs.set(
"extension_modules", rope_config.get("extensionModules", [])
)
self.__rope.prefs.set("ignore_syntax_errors", True)
self.__rope.prefs.set("ignore_bad_imports", True)
self.__rope.validate()
return self.__rope
@property
def documents(self):
return self._docs
@property
def root_path(self):
return self._root_path
@property
def root_uri(self):
return self._root_uri
def is_local(self):
return (self._root_uri_scheme in ["", "file"]) and os.path.exists(
self._root_path
)
def get_document(self, doc_uri):
"""Return a managed document if-present, else create one pointing at disk.
See https://github.com/Microsoft/language-server-protocol/issues/177
"""
return self._docs.get(doc_uri) or self._create_document(doc_uri)
def get_cell_document(self, doc_uri):
return self._docs.get(doc_uri)
def get_maybe_document(self, doc_uri):
return self._docs.get(doc_uri)
def put_document(self, doc_uri, source, version=None):
self._docs[doc_uri] = self._create_document(
doc_uri, source=source, version=version
)
def put_notebook_document(
self, doc_uri, notebook_type, cells, version=None, metadata=None
):
self._docs[doc_uri] = self._create_notebook_document(
doc_uri, notebook_type, cells, version, metadata
)
@contextmanager
def temp_document(self, source, path=None):
if path is None:
path = self.root_path
uri = uris.from_fs_path(os.path.join(path, str(uuid.uuid4())))
try:
self.put_document(uri, source)
yield uri
finally:
self.rm_document(uri)
def add_notebook_cells(self, doc_uri, cells, start):
self._docs[doc_uri].add_cells(cells, start)
def remove_notebook_cells(self, doc_uri, start, delete_count):
self._docs[doc_uri].remove_cells(start, delete_count)
def update_notebook_metadata(self, doc_uri, metadata):
self._docs[doc_uri].metadata = metadata
def put_cell_document(
self, doc_uri, notebook_uri, language_id, source, version=None
):
self._docs[doc_uri] = self._create_cell_document(
doc_uri, notebook_uri, language_id, source, version
)
def rm_document(self, doc_uri):
self._docs.pop(doc_uri)
def update_document(self, doc_uri, change, version=None):
self._docs[doc_uri].apply_change(change)
self._docs[doc_uri].version = version
def update_config(self, settings):
self._config.update((settings or {}).get("pylsp", {}))
for doc_uri in self.documents:
if isinstance(document := self.get_document(doc_uri), Notebook):
# Notebook documents don't have a config. The config is
# handled at the cell level.
return
document.update_config(settings)
def apply_edit(self, edit):
return self._endpoint.request(self.M_APPLY_EDIT, {"edit": edit})
def publish_diagnostics(self, doc_uri, diagnostics):
self._endpoint.notify(
self.M_PUBLISH_DIAGNOSTICS,
params={"uri": doc_uri, "diagnostics": diagnostics},
)
@contextmanager
def report_progress(
self,
title: str,
message: Optional[str] = None,
percentage: Optional[int] = None,
skip_token_initialization: bool = False,
) -> Generator[Callable[[str, Optional[int]], None], None, None]:
"""
Report progress to the editor / client.
``skip_token_initialization` is necessary due to some current
limitations of our LSP implementation. When `report_progress`
is used from a synchronous LSP handler, the token initialization
will time out because we can't receive the response.
Many editors will still correctly show the progress messages though, which
is why we are giving progress users the option to skip the initialization
of the progress token.
"""
if self._config:
client_supports_progress_reporting = self._config.capabilities.get(
"window", {}
).get("workDoneProgress", False)
else:
client_supports_progress_reporting = False
if client_supports_progress_reporting:
token = self._progress_begin(
title, message, percentage, skip_token_initialization
)
def progress_message(
message: str, percentage: Optional[int] = None
) -> None:
self._progress_report(token, message, percentage)
try:
yield progress_message
finally:
self._progress_end(token)
return
# FALLBACK:
# If the client doesn't support progress reporting, we have a dummy method
# for the caller to use.
def dummy_progress_message(
message: str, percentage: Optional[int] = None
) -> None:
# pylint: disable=unused-argument
pass
yield dummy_progress_message
def _progress_begin(
self,
title: str,
message: Optional[str] = None,
percentage: Optional[int] = None,
skip_token_initialization: bool = False,
) -> str:
token = str(uuid.uuid4())
if not skip_token_initialization:
try:
self._endpoint.request(
self.M_INITIALIZE_PROGRESS, {"token": token}
).result(timeout=1.0)
except Exception: # pylint: disable=broad-exception-caught
log.warning(
"There was an error while trying to initialize progress reporting."
"Likely progress reporting was used in a synchronous LSP handler, "
"which is not supported by progress reporting yet. "
"To prevent waiting for the timeout you can set "
"`skip_token_initialization=True`. "
"Not every editor will show progress then, but many will.",
exc_info=True,
)
value = {
"kind": "begin",
"title": title,
}
if message is not None:
value["message"] = message
if percentage is not None:
value["percentage"] = percentage
self._endpoint.notify(
self.M_PROGRESS,
params={
"token": token,
"value": value,
},
)
return token
def _progress_report(
self,
token: str,
message: Optional[str] = None,
percentage: Optional[int] = None,
) -> None:
value = {
"kind": "report",
}
if message:
value["message"] = message
if percentage:
value["percentage"] = percentage
self._endpoint.notify(
self.M_PROGRESS,
params={
"token": token,
"value": value,
},
)
def _progress_end(self, token: str, message: Optional[str] = None) -> None:
value = {
"kind": "end",
}
if message:
value["message"] = message
self._endpoint.notify(
self.M_PROGRESS,
params={
"token": token,
"value": value,
},
)
def show_message(self, message, msg_type=lsp.MessageType.Info):
self._endpoint.notify(
self.M_SHOW_MESSAGE, params={"type": msg_type, "message": message}
)
def source_roots(self, document_path):
"""Return the source roots for the given document."""
files = (
_utils.find_parents(
self._root_path, document_path, ["setup.py", "pyproject.toml"]
)
or []
)
return list({os.path.dirname(project_file) for project_file in files}) or [
self._root_path
]
def _create_document(self, doc_uri, source=None, version=None):
path = uris.to_fs_path(doc_uri)
return Document(
doc_uri,
self,
source=source,
version=version,
extra_sys_path=self.source_roots(path),
rope_project_builder=self._rope_project_builder,
)
def _create_notebook_document(
self, doc_uri, notebook_type, cells, version=None, metadata=None
):
return Notebook(
doc_uri,
notebook_type,
self,
cells=cells,
version=version,
metadata=metadata,
)
def _create_cell_document(
self, doc_uri, notebook_uri, language_id, source=None, version=None
):
# TODO: remove what is unnecessary here.
path = uris.to_fs_path(doc_uri)
return Cell(
doc_uri,
notebook_uri=notebook_uri,
language_id=language_id,
workspace=self,
source=source,
version=version,
extra_sys_path=self.source_roots(path),
rope_project_builder=self._rope_project_builder,
)
def close(self):
for _, autoimport in self.__rope_autoimport.items():
autoimport.close()
class Document:
def __init__(
self,
uri,
workspace,
source=None,
version=None,
local=True,
extra_sys_path=None,
rope_project_builder=None,
):
self.uri = uri
self.version = version
self.path = uris.to_fs_path(uri)
self.dot_path = _utils.path_to_dot_name(self.path)
self.filename = os.path.basename(self.path)
self.shared_data = {}
self._config = workspace._config
self._workspace = workspace
self._local = local
self._source = source
self._extra_sys_path = extra_sys_path or []
self._rope_project_builder = rope_project_builder
self._lock = RLock()
def __str__(self):
return str(self.uri)
def _rope_resource(self, rope_config):
# pylint: disable=import-outside-toplevel
from rope.base import libutils
return libutils.path_to_resource(
self._rope_project_builder(rope_config), self.path
)
@property
@lock
def lines(self):
return self.source.splitlines(True)
@property
@lock
def source(self):
if self._source is None:
with io.open(self.path, "r", encoding="utf-8") as f:
return f.read()
return self._source
def update_config(self, settings):
self._config.update((settings or {}).get("pylsp", {}))
@lock
def apply_change(self, change):
"""Apply a change to the document."""
text = change["text"]
change_range = change.get("range")
if not change_range:
# The whole file has changed
self._source = text
return
start_line = change_range["start"]["line"]
start_col = change_range["start"]["character"]
end_line = change_range["end"]["line"]
end_col = change_range["end"]["character"]
# Check for an edit occuring at the very end of the file
if start_line == len(self.lines):
self._source = self.source + text
return
new = io.StringIO()
# Iterate over the existing document until we hit the edit range,
# at which point we write the new text, then loop until we hit
# the end of the range and continue writing.
for i, line in enumerate(self.lines):
if i < start_line:
new.write(line)
continue
if i > end_line:
new.write(line)
continue
if i == start_line:
new.write(line[:start_col])
new.write(text)
if i == end_line:
new.write(line[end_col:])
self._source = new.getvalue()
def offset_at_position(self, position):
"""Return the byte-offset pointed at by the given position."""
return position["character"] + len("".join(self.lines[: position["line"]]))
def word_at_position(self, position):
"""Get the word under the cursor returning the start and end positions."""
if position["line"] >= len(self.lines):
return ""
line = self.lines[position["line"]]
i = position["character"]
# Split word in two
start = line[:i]
end = line[i:]
# Take end of start and start of end to find word
# These are guaranteed to match, even if they match the empty string
m_start = RE_START_WORD.findall(start)
m_end = RE_END_WORD.findall(end)
return m_start[0] + m_end[-1]
@lock
def jedi_names(self, all_scopes=False, definitions=True, references=False):
script = self.jedi_script()
return script.get_names(
all_scopes=all_scopes, definitions=definitions, references=references
)
@lock
def jedi_script(self, position=None, use_document_path=False):
extra_paths = []
environment_path = None
env_vars = None
if self._config:
jedi_settings = self._config.plugin_settings(
"jedi", document_path=self.path
)
jedi.settings.auto_import_modules = jedi_settings.get(
"auto_import_modules", DEFAULT_AUTO_IMPORT_MODULES
)
environment_path = jedi_settings.get("environment")
# Jedi itself cannot deal with homedir-relative paths.
# On systems, where it is expected, expand the home directory.
if environment_path and os.name != "nt":
environment_path = os.path.expanduser(environment_path)
extra_paths = jedi_settings.get("extra_paths") or []
env_vars = jedi_settings.get("env_vars")
# Drop PYTHONPATH from env_vars before creating the environment because that makes
# Jedi throw an error.
if env_vars is None:
env_vars = os.environ.copy()
env_vars.pop("PYTHONPATH", None)
environment = (
self.get_enviroment(environment_path, env_vars=env_vars)
if environment_path
else None
)
sys_path = self.sys_path(environment_path, env_vars=env_vars) + extra_paths
project_path = self._workspace.root_path
# Extend sys_path with document's path if requested
if use_document_path:
sys_path += [os.path.normpath(os.path.dirname(self.path))]
kwargs = {
"code": self.source,
"path": self.path,
"environment": environment,
"project": jedi.Project(path=project_path, sys_path=sys_path),
}
if position:
# Deprecated by Jedi to use in Script() constructor
kwargs += _utils.position_to_jedi_linecolumn(self, position)
return jedi.Script(**kwargs)
def get_enviroment(self, environment_path=None, env_vars=None):
# TODO(gatesn): #339 - make better use of jedi environments, they seem pretty powerful
if environment_path is None:
environment = jedi.api.environment.get_cached_default_environment()
else:
if environment_path in self._workspace._environments:
environment = self._workspace._environments[environment_path]
else:
environment = jedi.api.environment.create_environment(
path=environment_path, safe=False, env_vars=env_vars
)
self._workspace._environments[environment_path] = environment
return environment
def sys_path(self, environment_path=None, env_vars=None):
# Copy our extra sys path
# TODO: when safe to break API, use env_vars explicitly to pass to create_environment
path = list(self._extra_sys_path)
environment = self.get_enviroment(
environment_path=environment_path, env_vars=env_vars
)
path.extend(environment.get_sys_path())
return path
class Notebook:
"""Represents a notebook."""
def __init__(
self, uri, notebook_type, workspace, cells=None, version=None, metadata=None
):
self.uri = uri
self.notebook_type = notebook_type
self.workspace = workspace
self.version = version
self.cells = cells or []
self.metadata = metadata or {}
self._lock = RLock()
def __str__(self):
return "Notebook with URI '%s'" % str(self.uri)
def add_cells(self, new_cells: List, start: int) -> None:
self.cells[start:start] = new_cells
def remove_cells(self, start: int, delete_count: int) -> None:
del self.cells[start : start + delete_count]
def cell_data(self):
"""Extract current cell data.
Returns a dict (ordered by cell position) where the key is the cell uri and the
value is a dict with line_start, line_end, and source attributes.
"""
cell_data = {}
offset = 0
for cell in self.cells:
cell_uri = cell["document"]
cell_document = self.workspace.get_cell_document(cell_uri)
num_lines = cell_document.line_count
cell_data[cell_uri] = {
"line_start": offset,
"line_end": offset + num_lines - 1,
"source": cell_document.source,
}
offset += num_lines
return cell_data
@lock
def jedi_names(
self,
up_to_cell_uri: Optional[str] = None,
all_scopes=False,
definitions=True,
references=False,
):
"""
Get the names in the notebook up to a certain cell.
Parameters
----------
up_to_cell_uri: str, optional
The cell uri to stop at. If None, all cells are considered.
"""
names = set()
for cell in self.cells:
cell_uri = cell["document"]
cell_document = self.workspace.get_cell_document(cell_uri)
names.update(cell_document.jedi_names(all_scopes, definitions, references))
if cell_uri == up_to_cell_uri:
break
return set(name.name for name in names)
class Cell(Document):
"""
Represents a cell in a notebook.
Notes
-----
We inherit from Document for now to get the same API. However, a cell document differs from text documents in that
they have a language id.
"""
def __init__(
self,
uri,
notebook_uri,
language_id,
workspace,
source=None,
version=None,
local=True,
extra_sys_path=None,
rope_project_builder=None,
):
super().__init__(
uri, workspace, source, version, local, extra_sys_path, rope_project_builder
)
self.language_id = language_id
self.notebook_uri = notebook_uri
@property
@lock
def line_count(self):
""" "Return the number of lines in the cell document."""
return len(self.source.split("\n"))