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
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040"""Implementation of the LSP server for Ruff."""
from __future__ import annotations
import asyncio
import enum
import json
import logging
import os
import re
import shutil
import sys
import sysconfig
from collections.abc import Iterable, Mapping
from dataclasses import dataclass
from pathlib import Path
from typing import Any, List, NamedTuple, Sequence, Union, cast
from lsprotocol.types import (
CODE_ACTION_RESOLVE,
INITIALIZE,
NOTEBOOK_DOCUMENT_DID_CHANGE,
NOTEBOOK_DOCUMENT_DID_CLOSE,
NOTEBOOK_DOCUMENT_DID_OPEN,
NOTEBOOK_DOCUMENT_DID_SAVE,
TEXT_DOCUMENT_CODE_ACTION,
TEXT_DOCUMENT_DID_CHANGE,
TEXT_DOCUMENT_DID_CLOSE,
TEXT_DOCUMENT_DID_OPEN,
TEXT_DOCUMENT_DID_SAVE,
TEXT_DOCUMENT_FORMATTING,
TEXT_DOCUMENT_HOVER,
TEXT_DOCUMENT_RANGE_FORMATTING,
AnnotatedTextEdit,
ClientCapabilities,
CodeAction,
CodeActionKind,
CodeActionOptions,
CodeActionParams,
CodeDescription,
Diagnostic,
DiagnosticSeverity,
DiagnosticTag,
DidChangeNotebookDocumentParams,
DidChangeTextDocumentParams,
DidCloseNotebookDocumentParams,
DidCloseTextDocumentParams,
DidOpenNotebookDocumentParams,
DidOpenTextDocumentParams,
DidSaveNotebookDocumentParams,
DidSaveTextDocumentParams,
DocumentFormattingParams,
DocumentRangeFormattingParams,
DocumentRangeFormattingRegistrationOptions,
Hover,
HoverParams,
InitializeParams,
MarkupContent,
MarkupKind,
MessageType,
NotebookCell,
NotebookCellKind,
NotebookDocument,
NotebookDocumentSyncOptions,
NotebookDocumentSyncOptionsNotebookSelectorType2,
NotebookDocumentSyncOptionsNotebookSelectorType2CellsType,
OptionalVersionedTextDocumentIdentifier,
Position,
PositionEncodingKind,
Range,
TextDocumentEdit,
TextDocumentFilter_Type1,
TextEdit,
WorkspaceEdit,
)
from packaging.specifiers import SpecifierSet, Version
from pygls import server, uris, workspace
from pygls.workspace.position_codec import PositionCodec
from typing_extensions import Literal, Self, TypedDict, assert_never
from ruff_lsp import __version__, utils
from ruff_lsp.settings import (
Run,
UserSettings,
WorkspaceSettings,
lint_args,
lint_enable,
lint_run,
)
from ruff_lsp.utils import RunResult
logger = logging.getLogger(__name__)
RUFF_LSP_DEBUG = bool(os.environ.get("RUFF_LSP_DEBUG", False))
if RUFF_LSP_DEBUG:
log_file = Path(__file__).parent.parent.joinpath("ruff-lsp.log")
logging.basicConfig(filename=log_file, filemode="w", level=logging.DEBUG)
logger.info("RUFF_LSP_DEBUG is active")
if sys.platform == "win32" and sys.version_info < (3, 8):
# The ProactorEventLoop is required for subprocesses on Windows.
# It's the default policy in Python 3.8, but not in Python 3.7.
asyncio.set_event_loop_policy(asyncio.WindowsProactorEventLoopPolicy())
GLOBAL_SETTINGS: UserSettings = {}
WORKSPACE_SETTINGS: dict[str, WorkspaceSettings] = {}
INTERPRETER_PATHS: dict[str, str] = {}
class VersionModified(NamedTuple):
version: Version
"""Last modified of the executable"""
modified: float
EXECUTABLE_VERSIONS: dict[str, VersionModified] = {}
CLIENT_CAPABILITIES: dict[str, bool] = {
CODE_ACTION_RESOLVE: True,
}
MAX_WORKERS = 5
LSP_SERVER = server.LanguageServer(
name="Ruff",
version=__version__,
max_workers=MAX_WORKERS,
notebook_document_sync=NotebookDocumentSyncOptions(
notebook_selector=[
NotebookDocumentSyncOptionsNotebookSelectorType2(
cells=[
NotebookDocumentSyncOptionsNotebookSelectorType2CellsType(
language="python"
)
]
)
],
save=True,
),
)
TOOL_MODULE = "ruff.exe" if sys.platform == "win32" else "ruff"
TOOL_DISPLAY = "Ruff"
# Require at least Ruff v0.0.291 for formatting, but allow older versions for linting.
VERSION_REQUIREMENT_FORMATTER = SpecifierSet(">=0.0.291")
VERSION_REQUIREMENT_LINTER = SpecifierSet(">=0.0.189")
VERSION_REQUIREMENT_RANGE_FORMATTING = SpecifierSet(">=0.2.1")
# Version requirement for use of the `--output-format` option
VERSION_REQUIREMENT_OUTPUT_FORMAT = SpecifierSet(">=0.0.291")
# Version requirement after which Ruff avoids writing empty output for excluded files.
VERSION_REQUIREMENT_EMPTY_OUTPUT = SpecifierSet(">=0.1.6")
# Arguments provided to every Ruff invocation.
CHECK_ARGS = [
"check",
"--force-exclude",
"--no-cache",
"--no-fix",
"--quiet",
"--output-format",
"json",
"-",
]
# Arguments that are not allowed to be passed to `ruff check`.
UNSUPPORTED_CHECK_ARGS = [
# Arguments that enforce required behavior. These can be ignored with a warning.
"--force-exclude",
"--no-cache",
"--no-fix",
"--quiet",
# Arguments that contradict the required behavior. These can be ignored with a
# warning.
"--diff",
"--exit-non-zero-on-fix",
"-e",
"--exit-zero",
"--fix",
"--fix-only",
"-h",
"--help",
"--no-force-exclude",
"--show-files",
"--show-fixes",
"--show-settings",
"--show-source",
"--silent",
"--statistics",
"--verbose",
"-w",
"--watch",
# Arguments that are not supported at all, and will error when provided.
# "--stdin-filename",
# "--output-format",
]
# Arguments that are not allowed to be passed to `ruff format`.
UNSUPPORTED_FORMAT_ARGS = [
# Arguments that enforce required behavior. These can be ignored with a warning.
"--force-exclude",
"--quiet",
# Arguments that contradict the required behavior. These can be ignored with a
# warning.
"-h",
"--help",
"--no-force-exclude",
"--silent",
"--verbose",
# Arguments that are not supported at all, and will error when provided.
# "--stdin-filename",
]
# Standard code action kinds, scoped to Ruff.
SOURCE_FIX_ALL_RUFF = f"{CodeActionKind.SourceFixAll.value}.ruff"
SOURCE_ORGANIZE_IMPORTS_RUFF = f"{CodeActionKind.SourceOrganizeImports.value}.ruff"
# Notebook code action kinds.
NOTEBOOK_SOURCE_FIX_ALL = f"notebook.{CodeActionKind.SourceFixAll.value}"
NOTEBOOK_SOURCE_ORGANIZE_IMPORTS = (
f"notebook.{CodeActionKind.SourceOrganizeImports.value}"
)
# Notebook code action kinds, scoped to Ruff.
NOTEBOOK_SOURCE_FIX_ALL_RUFF = f"notebook.{CodeActionKind.SourceFixAll.value}.ruff"
NOTEBOOK_SOURCE_ORGANIZE_IMPORTS_RUFF = (
f"notebook.{CodeActionKind.SourceOrganizeImports.value}.ruff"
)
###
# Document
###
def _uri_to_fs_path(uri: str) -> str:
"""Convert a URI to a file system path."""
path = uris.to_fs_path(uri)
if path is None:
# `pygls` raises a `Exception` as well in `workspace.TextDocument`.
raise ValueError(f"Unable to convert URI to file path: {uri}")
return path
@enum.unique
class DocumentKind(enum.Enum):
"""The kind of document."""
Text = enum.auto()
"""A Python file."""
Notebook = enum.auto()
"""A Notebook Document."""
Cell = enum.auto()
"""A cell in a Notebook Document."""
@dataclass(frozen=True)
class Document:
"""A document representing either a Python file, a Notebook cell, or a Notebook."""
uri: str
path: str
source: str
kind: DocumentKind
version: int | None
@classmethod
def from_text_document(cls, text_document: workspace.TextDocument) -> Self:
"""Create a `Document` from the given Text Document."""
return cls(
uri=text_document.uri,
path=text_document.path,
kind=DocumentKind.Text,
source=text_document.source,
version=text_document.version,
)
@classmethod
def from_notebook_document(cls, notebook_document: NotebookDocument) -> Self:
"""Create a `Document` from the given Notebook Document."""
return cls(
uri=notebook_document.uri,
path=_uri_to_fs_path(notebook_document.uri),
kind=DocumentKind.Notebook,
source=_create_notebook_json(notebook_document),
version=notebook_document.version,
)
@classmethod
def from_notebook_cell(cls, notebook_cell: NotebookCell) -> Self:
"""Create a `Document` from the given Notebook cell."""
return cls(
uri=notebook_cell.document,
path=_uri_to_fs_path(notebook_cell.document),
kind=DocumentKind.Cell,
source=_create_single_cell_notebook_json(
LSP_SERVER.workspace.get_text_document(notebook_cell.document).source
),
version=None,
)
@classmethod
def from_cell_or_text_uri(cls, uri: str) -> Self:
"""Create a `Document` representing either a Python file or a Notebook cell from
the given URI.
The function will try to get the Notebook cell first, and if there's no cell
with the given URI, it will fallback to the text document.
"""
notebook_document = LSP_SERVER.workspace.get_notebook_document(cell_uri=uri)
if notebook_document is not None:
notebook_cell = next(
(
notebook_cell
for notebook_cell in notebook_document.cells
if notebook_cell.document == uri
),
None,
)
if notebook_cell is not None:
return cls.from_notebook_cell(notebook_cell)
# Fall back to the Text Document representing a Python file.
text_document = LSP_SERVER.workspace.get_text_document(uri)
return cls.from_text_document(text_document)
@classmethod
def from_uri(cls, uri: str) -> Self:
"""Create a `Document` representing either a Python file or a Notebook from
the given URI.
The URI can be a file URI, a notebook URI, or a cell URI. The function will
try to get the notebook document first, and if there's no notebook document
with the given URI, it will fallback to the text document.
"""
# First, try to get the Notebook Document assuming the URI is a Cell URI.
notebook_document = LSP_SERVER.workspace.get_notebook_document(cell_uri=uri)
if notebook_document is None:
# If that fails, try to get the Notebook Document assuming the URI is a
# Notebook URI.
notebook_document = LSP_SERVER.workspace.get_notebook_document(
notebook_uri=uri
)
if notebook_document:
return cls.from_notebook_document(notebook_document)
# Fall back to the Text Document representing a Python file.
text_document = LSP_SERVER.workspace.get_text_document(uri)
return cls.from_text_document(text_document)
def is_stdlib_file(self) -> bool:
"""Return True if the document belongs to standard library."""
return utils.is_stdlib_file(self.path)
SourceValue = Union[str, List[str]]
class CodeCell(TypedDict):
"""A code cell in a Jupyter notebook."""
cell_type: Literal["code"]
metadata: Any
outputs: list[Any]
source: SourceValue
class MarkdownCell(TypedDict):
"""A markdown cell in a Jupyter notebook."""
cell_type: Literal["markdown"]
metadata: Any
source: SourceValue
class Notebook(TypedDict):
"""The JSON representation of a Notebook Document."""
metadata: Any
nbformat: int
nbformat_minor: int
cells: list[CodeCell | MarkdownCell]
def _create_notebook_json(notebook_document: NotebookDocument) -> str:
"""Create a JSON representation of the given Notebook Document."""
cells: list[CodeCell | MarkdownCell] = []
for notebook_cell in notebook_document.cells:
cell_document = LSP_SERVER.workspace.get_text_document(notebook_cell.document)
if notebook_cell.kind is NotebookCellKind.Code:
cells.append(
{
"cell_type": "code",
"metadata": {},
"outputs": [],
"source": cell_document.source,
}
)
else:
cells.append(
{
"cell_type": "markdown",
"metadata": {},
"source": cell_document.source,
}
)
return json.dumps(
{
"metadata": {},
"nbformat": 4,
"nbformat_minor": 5,
"cells": cells,
}
)
def _create_single_cell_notebook_json(source: str) -> str:
"""Create a JSON representation of a single cell Notebook Document containing
the given source."""
return json.dumps(
{
"metadata": {},
"nbformat": 4,
"nbformat_minor": 5,
"cells": [
{
"cell_type": "code",
"metadata": None,
"outputs": [],
"source": source,
}
],
}
)
###
# Linting.
###
@LSP_SERVER.feature(TEXT_DOCUMENT_DID_OPEN)
async def did_open(params: DidOpenTextDocumentParams) -> None:
"""LSP handler for textDocument/didOpen request."""
document = Document.from_text_document(
LSP_SERVER.workspace.get_text_document(params.text_document.uri)
)
settings = _get_settings_by_document(document.path)
if not lint_enable(settings):
return None
diagnostics = await _lint_document_impl(document, settings)
LSP_SERVER.publish_diagnostics(document.uri, diagnostics)
@LSP_SERVER.feature(TEXT_DOCUMENT_DID_CLOSE)
def did_close(params: DidCloseTextDocumentParams) -> None:
"""LSP handler for textDocument/didClose request."""
text_document = LSP_SERVER.workspace.get_text_document(params.text_document.uri)
# Publishing empty diagnostics to clear the entries for this file.
LSP_SERVER.publish_diagnostics(text_document.uri, [])
@LSP_SERVER.feature(TEXT_DOCUMENT_DID_SAVE)
async def did_save(params: DidSaveTextDocumentParams) -> None:
"""LSP handler for textDocument/didSave request."""
text_document = LSP_SERVER.workspace.get_text_document(params.text_document.uri)
settings = _get_settings_by_document(text_document.path)
if not lint_enable(settings):
return None
if lint_run(settings) in (
Run.OnType,
Run.OnSave,
):
document = Document.from_text_document(text_document)
diagnostics = await _lint_document_impl(document, settings)
LSP_SERVER.publish_diagnostics(document.uri, diagnostics)
@LSP_SERVER.feature(TEXT_DOCUMENT_DID_CHANGE)
async def did_change(params: DidChangeTextDocumentParams) -> None:
"""LSP handler for textDocument/didChange request."""
text_document = LSP_SERVER.workspace.get_text_document(params.text_document.uri)
settings = _get_settings_by_document(text_document.path)
if not lint_enable(settings):
return None
if lint_run(settings) == Run.OnType:
document = Document.from_text_document(text_document)
diagnostics = await _lint_document_impl(document, settings)
LSP_SERVER.publish_diagnostics(document.uri, diagnostics)
@LSP_SERVER.feature(NOTEBOOK_DOCUMENT_DID_OPEN)
async def did_open_notebook(params: DidOpenNotebookDocumentParams) -> None:
"""LSP handler for notebookDocument/didOpen request."""
notebook_document = LSP_SERVER.workspace.get_notebook_document(
notebook_uri=params.notebook_document.uri
)
if notebook_document is None:
log_warning(f"No notebook document found for {params.notebook_document.uri!r}")
return None
document = Document.from_notebook_document(notebook_document)
settings = _get_settings_by_document(document.path)
if not lint_enable(settings):
return None
diagnostics = await _lint_document_impl(document, settings)
# Publish diagnostics for each cell.
for cell_idx, diagnostics in _group_diagnostics_by_cell(diagnostics).items():
LSP_SERVER.publish_diagnostics(
# The cell indices are 1-based in Ruff.
params.notebook_document.cells[cell_idx - 1].document,
diagnostics,
)
@LSP_SERVER.feature(NOTEBOOK_DOCUMENT_DID_CLOSE)
def did_close_notebook(params: DidCloseNotebookDocumentParams) -> None:
"""LSP handler for notebookDocument/didClose request."""
# Publishing empty diagnostics to clear the entries for all the cells in this
# Notebook Document.
for cell_text_document in params.cell_text_documents:
LSP_SERVER.publish_diagnostics(cell_text_document.uri, [])
@LSP_SERVER.feature(NOTEBOOK_DOCUMENT_DID_SAVE)
async def did_save_notebook(params: DidSaveNotebookDocumentParams) -> None:
"""LSP handler for notebookDocument/didSave request."""
await _did_change_or_save_notebook(
params.notebook_document.uri, run_types=[Run.OnSave, Run.OnType]
)
@LSP_SERVER.feature(NOTEBOOK_DOCUMENT_DID_CHANGE)
async def did_change_notebook(params: DidChangeNotebookDocumentParams) -> None:
"""LSP handler for notebookDocument/didChange request."""
await _did_change_or_save_notebook(
params.notebook_document.uri, run_types=[Run.OnType]
)
def _group_diagnostics_by_cell(
diagnostics: Iterable[Diagnostic],
) -> Mapping[int, list[Diagnostic]]:
"""Group diagnostics by cell index.
The function will return a mapping from cell number to a list of diagnostics for
that cell. The mapping will be empty if the diagnostic doesn't contain the cell
information.
"""
cell_diagnostics: dict[int, list[Diagnostic]] = {}
for diagnostic in diagnostics:
cell = cast(DiagnosticData, diagnostic.data).get("cell")
if cell is not None:
cell_diagnostics.setdefault(cell, []).append(diagnostic)
return cell_diagnostics
async def _did_change_or_save_notebook(
notebook_uri: str, *, run_types: Sequence[Run]
) -> None:
"""Handle notebookDocument/didChange and notebookDocument/didSave requests."""
notebook_document = LSP_SERVER.workspace.get_notebook_document(
notebook_uri=notebook_uri
)
if notebook_document is None:
log_warning(f"No notebook document found for {notebook_uri!r}")
return None
document = Document.from_notebook_document(notebook_document)
settings = _get_settings_by_document(document.path)
if not lint_enable(settings):
return None
if lint_run(settings) in run_types:
cell_diagnostics = _group_diagnostics_by_cell(
await _lint_document_impl(document, settings)
)
# Publish diagnostics for every code cell, replacing the previous diagnostics.
# This is required here because a cell containing diagnostics in the first run
# might not contain any diagnostics in the second run. In that case, we need to
# clear the diagnostics for that cell which is done by publishing empty
# diagnostics.
for cell_idx, cell in enumerate(notebook_document.cells):
if cell.kind is not NotebookCellKind.Code:
continue
LSP_SERVER.publish_diagnostics(
cell.document,
# The cell indices are 1-based in Ruff.
cell_diagnostics.get(cell_idx + 1, []),
)
async def _lint_document_impl(
document: Document, settings: WorkspaceSettings
) -> list[Diagnostic]:
result = await _run_check_on_document(document, settings)
if result is None:
return []
# For `ruff check`, 0 indicates successful completion with no remaining
# diagnostics, 1 indicates successful completion with remaining diagnostics,
# and 2 indicates an error.
if result.exit_code not in (0, 1):
if result.stderr:
show_error(f"Ruff: Lint failed ({result.stderr.decode('utf-8')})")
return []
return (
_parse_output(result.stdout, settings.get("showSyntaxErrors", True))
if result.stdout
else []
)
def _parse_fix(content: Fix | LegacyFix | None) -> Fix | None:
"""Parse the fix from the Ruff output."""
if content is None:
return None
if content.get("edits") is None:
# Prior to v0.0.260, Ruff returned a single edit.
legacy_fix = cast(LegacyFix, content)
return {
"applicability": None,
"message": legacy_fix.get("message"),
"edits": [
{
"content": legacy_fix["content"],
"location": legacy_fix["location"],
"end_location": legacy_fix["end_location"],
}
],
}
else:
# Since v0.0.260, Ruff returns a list of edits.
fix = cast(Fix, content)
# Since v0.0.266, Ruff returns one based column indices
if fix.get("applicability") is not None:
for edit in fix["edits"]:
edit["location"]["column"] = edit["location"]["column"] - 1
edit["end_location"]["column"] = edit["end_location"]["column"] - 1
return fix
def _parse_output(content: bytes, show_syntax_errors: bool) -> list[Diagnostic]:
"""Parse Ruff's JSON output."""
diagnostics: list[Diagnostic] = []
# Ruff's output looks like:
# [
# {
# "cell": null,
# "code": "F841",
# "message": "Local variable `x` is assigned to but never used",
# "location": {
# "row": 2,
# "column": 5
# },
# "end_location": {
# "row": 2,
# "column": 6
# },
# "fix": {
# "applicability": "Unspecified",
# "message": "Remove assignment to unused variable `x`",
# "edits": [
# {
# "content": "",
# "location": {
# "row": 2,
# "column": 1
# },
# "end_location": {
# "row": 3,
# "column": 1
# }
# }
# ]
# },
# "filename": "/path/to/test.py",
# "noqa_row": 2
# },
# ...
# ]
#
# Input:
# ```python
# def a():
# x = 0
# print()
# ```
#
# Cell represents the cell number in a Notebook Document. It is null for normal
# Python files.
for check in json.loads(content):
if not show_syntax_errors and check["code"] is None:
continue
start = Position(
line=max([int(check["location"]["row"]) - 1, 0]),
character=int(check["location"]["column"]) - 1,
)
end = Position(
line=max([int(check["end_location"]["row"]) - 1, 0]),
character=int(check["end_location"]["column"]) - 1,
)
diagnostic = Diagnostic(
range=Range(start=start, end=end),
message=check.get("message"),
code=check["code"],
code_description=_get_code_description(check.get("url")),
severity=_get_severity(check["code"]),
source=TOOL_DISPLAY,
data=DiagnosticData(
fix=_parse_fix(check.get("fix")),
# Available since Ruff v0.0.253.
noqa_row=check.get("noqa_row"),
# Available since Ruff v0.1.0.
cell=check.get("cell"),
),
tags=_get_tags(check["code"]),
)
diagnostics.append(diagnostic)
return diagnostics
def _get_code_description(url: str | None) -> CodeDescription | None:
if url is None:
return None
else:
return CodeDescription(href=url)
def _get_tags(code: str) -> list[DiagnosticTag] | None:
if code in {
"F401", # `module` imported but unused
"F841", # local variable `name` is assigned to but never used
}:
return [DiagnosticTag.Unnecessary]
return None
def _get_severity(code: str) -> DiagnosticSeverity:
if code in {
"F821", # undefined name `name`
"E902", # `IOError`
"E999", # `SyntaxError`
None, # `SyntaxError` as of Ruff v0.5.0
}:
return DiagnosticSeverity.Error
else:
return DiagnosticSeverity.Warning
NOQA_REGEX = re.compile(
r"(?i:# (?:(?:ruff|flake8): )?(?P<noqa>noqa))"
r"(?::\s?(?P<codes>([A-Z]+[0-9]+(?:[,\s]+)?)+))?"
)
CODE_REGEX = re.compile(r"[A-Z]+[0-9]+")
@LSP_SERVER.feature(TEXT_DOCUMENT_HOVER)
async def hover(params: HoverParams) -> Hover | None:
"""LSP handler for textDocument/hover request.
This works for both Python files and Notebook Documents. For Notebook Documents,
the hover works at the cell level.
"""
document = LSP_SERVER.workspace.get_text_document(params.text_document.uri)
match = NOQA_REGEX.search(document.lines[params.position.line])
if not match:
return None
codes = match.group("codes")
if not codes:
return None
codes_start = match.start("codes")
for match in CODE_REGEX.finditer(codes):
start, end = match.span()
start += codes_start
end += codes_start
if start <= params.position.character < end:
code = match.group()
result = await _run_subcommand_on_document(
document, VERSION_REQUIREMENT_LINTER, args=["--explain", code]
)
if result.stdout:
return Hover(
contents=MarkupContent(
kind=MarkupKind.Markdown,
value=result.stdout.decode("utf-8").strip(),
)
)
return None
###
# Code Actions.
###
class TextDocument(TypedDict):
uri: str
version: int
class Location(TypedDict):
row: int
column: int
class Edit(TypedDict):
content: str
location: Location
end_location: Location
class Fix(TypedDict):
"""A fix for a diagnostic, represented as a list of edits."""
applicability: str | None
message: str | None
edits: list[Edit]
class DiagnosticData(TypedDict, total=False):
fix: Fix | None
noqa_row: int | None
cell: int | None
class LegacyFix(TypedDict):
"""A fix for a diagnostic, represented as a single edit.
Matches Ruff's output prior to v0.0.260.
"""
message: str | None
content: str
location: Location
end_location: Location
@LSP_SERVER.feature(
TEXT_DOCUMENT_CODE_ACTION,
CodeActionOptions(
code_action_kinds=[
# Standard code action kinds.
CodeActionKind.QuickFix,
CodeActionKind.SourceFixAll,
CodeActionKind.SourceOrganizeImports,
# Standard code action kinds, scoped to Ruff.
SOURCE_FIX_ALL_RUFF,
SOURCE_ORGANIZE_IMPORTS_RUFF,
# Notebook code action kinds.
NOTEBOOK_SOURCE_FIX_ALL,
NOTEBOOK_SOURCE_ORGANIZE_IMPORTS,
# Notebook code action kinds, scoped to Ruff.
NOTEBOOK_SOURCE_FIX_ALL_RUFF,
NOTEBOOK_SOURCE_ORGANIZE_IMPORTS_RUFF,
],
resolve_provider=True,
),
)
async def code_action(params: CodeActionParams) -> list[CodeAction] | None:
"""LSP handler for textDocument/codeAction request.
Code actions work at a text document level which is either a Python file or a
cell in a Notebook document. The function will try to get the Notebook cell
first, and if there's no cell with the given URI, it will fallback to the text
document.
"""
def document_from_kind(uri: str, kind: str) -> Document:
if kind in (
# For `notebook`-scoped actions, use the Notebook Document instead of
# the cell, despite being passed the URI of the first cell.
# See: https://github.com/microsoft/vscode/issues/193120
NOTEBOOK_SOURCE_FIX_ALL,
NOTEBOOK_SOURCE_ORGANIZE_IMPORTS,
NOTEBOOK_SOURCE_FIX_ALL_RUFF,
NOTEBOOK_SOURCE_ORGANIZE_IMPORTS_RUFF,
):
return Document.from_uri(uri)
else:
return Document.from_cell_or_text_uri(uri)
document_path = _uri_to_fs_path(params.text_document.uri)
settings = _get_settings_by_document(document_path)
if settings.get("ignoreStandardLibrary", True) and utils.is_stdlib_file(
document_path
):
# Don't format standard library files.
# Publishing empty list clears the entry.
return None
if settings["organizeImports"]:
# Generate the "Ruff: Organize Imports" edit
for kind in (
CodeActionKind.SourceOrganizeImports,
SOURCE_ORGANIZE_IMPORTS_RUFF,
NOTEBOOK_SOURCE_ORGANIZE_IMPORTS,
NOTEBOOK_SOURCE_ORGANIZE_IMPORTS_RUFF,
):
if (
params.context.only
and len(params.context.only) == 1
and kind in params.context.only
):
workspace_edit = await _fix_document_impl(
document_from_kind(params.text_document.uri, kind),
settings,
only=["I001", "I002"],
)
if workspace_edit:
return [
CodeAction(
title="Ruff: Organize Imports",
kind=kind,
data=params.text_document.uri,
edit=workspace_edit,
diagnostics=[],
)
]
else:
return []
# If the linter is enabled, generate the "Ruff: Fix All" edit.
if lint_enable(settings) and settings["fixAll"]:
for kind in (
CodeActionKind.SourceFixAll,
SOURCE_FIX_ALL_RUFF,
NOTEBOOK_SOURCE_FIX_ALL,
NOTEBOOK_SOURCE_FIX_ALL_RUFF,
):
if (
params.context.only
and len(params.context.only) == 1
and kind in params.context.only
):
workspace_edit = await _fix_document_impl(
document_from_kind(params.text_document.uri, kind),
settings,
)
if workspace_edit:
return [
CodeAction(
title="Ruff: Fix All",
kind=kind,
data=params.text_document.uri,
edit=workspace_edit,
diagnostics=[
diagnostic
for diagnostic in params.context.diagnostics
if diagnostic.source == "Ruff"
and cast(DiagnosticData, diagnostic.data).get("fix")
is not None
],
),
]
else:
return []
actions: list[CodeAction] = []
# If the linter is enabled, add "Ruff: Autofix" for every fixable diagnostic.
if lint_enable(settings) and settings.get("codeAction", {}).get(
"fixViolation", {}
).get("enable", True):
if not params.context.only or CodeActionKind.QuickFix in params.context.only:
# This is a text document representing either a Python file or a
# Notebook cell.
text_document = LSP_SERVER.workspace.get_text_document(
params.text_document.uri
)
for diagnostic in params.context.diagnostics:
if diagnostic.source == "Ruff":
fix = cast(DiagnosticData, diagnostic.data).get("fix")
if fix is not None:
title: str
if fix.get("message"):
title = f"Ruff ({diagnostic.code}): {fix['message']}"
elif diagnostic.code:
title = f"Ruff: Fix {diagnostic.code}"
else:
title = "Ruff: Fix"
actions.append(
CodeAction(
title=title,
kind=CodeActionKind.QuickFix,
data=params.text_document.uri,
edit=_create_workspace_edit(
text_document.uri, text_document.version, fix
),
diagnostics=[diagnostic],
),
)
# If the linter is enabled, add "Disable for this line" for every diagnostic.
if lint_enable(settings) and settings.get("codeAction", {}).get(
"disableRuleComment", {}
).get("enable", True):
if not params.context.only or CodeActionKind.QuickFix in params.context.only:
# This is a text document representing either a Python file or a
# Notebook cell.
text_document = LSP_SERVER.workspace.get_text_document(
params.text_document.uri
)
lines: list[str] | None = None
for diagnostic in params.context.diagnostics:
if diagnostic.source == "Ruff":
noqa_row = cast(DiagnosticData, diagnostic.data).get("noqa_row")
if noqa_row is not None:
if lines is None:
lines = text_document.lines
line = lines[noqa_row - 1].rstrip("\r\n")
match = NOQA_REGEX.search(line)
if match and match.group("codes") is not None:
# `foo # noqa: OLD` -> `foo # noqa: OLD,NEW`
codes = match.group("codes") + f", {diagnostic.code}"
start, end = match.start("codes"), match.end("codes")
new_line = line[:start] + codes + line[end:]
elif match:
# `foo # noqa` -> `foo # noqa: NEW`
end = match.end("noqa")
new_line = line[:end] + f": {diagnostic.code}" + line[end:]
else:
# `foo` -> `foo # noqa: NEW`
new_line = f"{line} # noqa: {diagnostic.code}"
fix = Fix(
message=None,
applicability=None,
edits=[
Edit(
content=new_line,
location=Location(
row=noqa_row,
column=0,
),
end_location=Location(
row=noqa_row,
column=len(line),
),
)
],
)
title = f"Ruff ({diagnostic.code}): Disable for this line"
actions.append(
CodeAction(
title=title,
kind=CodeActionKind.QuickFix,
data=params.text_document.uri,
edit=_create_workspace_edit(
text_document.uri, text_document.version, fix
),
diagnostics=[diagnostic],
),
)
if settings["organizeImports"]:
# Add "Ruff: Organize Imports" as a supported action.
if not params.context.only or (
CodeActionKind.SourceOrganizeImports in params.context.only
):
if CLIENT_CAPABILITIES[CODE_ACTION_RESOLVE]:
actions.append(
CodeAction(
title="Ruff: Organize Imports",
kind=CodeActionKind.SourceOrganizeImports,
data=params.text_document.uri,
edit=None,
diagnostics=[],
),
)
else:
workspace_edit = await _fix_document_impl(
Document.from_cell_or_text_uri(params.text_document.uri),
settings,
only=["I001", "I002"],
)
if workspace_edit:
actions.append(
CodeAction(
title="Ruff: Organize Imports",
kind=CodeActionKind.SourceOrganizeImports,
data=params.text_document.uri,
edit=workspace_edit,
diagnostics=[],
),
)
# If the linter is enabled, add "Ruff: Fix All" as a supported action.
if lint_enable(settings) and settings["fixAll"]:
if not params.context.only or (
CodeActionKind.SourceFixAll in params.context.only
):
if CLIENT_CAPABILITIES[CODE_ACTION_RESOLVE]:
actions.append(
CodeAction(
title="Ruff: Fix All",
kind=CodeActionKind.SourceFixAll,
data=params.text_document.uri,
edit=None,
diagnostics=[],
),
)
else:
workspace_edit = await _fix_document_impl(
Document.from_cell_or_text_uri(params.text_document.uri),
settings,
)
if workspace_edit:
actions.append(
CodeAction(
title="Ruff: Fix All",
kind=CodeActionKind.SourceFixAll,
data=params.text_document.uri,
edit=workspace_edit,
diagnostics=[
diagnostic
for diagnostic in params.context.diagnostics
if diagnostic.source == "Ruff"
and cast(DiagnosticData, diagnostic.data).get("fix")
is not None
],
),
)
return actions if actions else None
@LSP_SERVER.feature(CODE_ACTION_RESOLVE)
async def resolve_code_action(params: CodeAction) -> CodeAction:
"""LSP handler for codeAction/resolve request."""
# We set the `data` field to the document URI during codeAction request.
document = Document.from_cell_or_text_uri(cast(str, params.data))
settings = _get_settings_by_document(document.path)
if (
settings["organizeImports"]
and params.kind == CodeActionKind.SourceOrganizeImports
):
# Generate the "Organize Imports" edit
params.edit = await _fix_document_impl(
document, settings, only=["I001", "I002"]
)
elif (
lint_enable(settings)
and settings["fixAll"]
and params.kind == CodeActionKind.SourceFixAll
):
# Generate the "Fix All" edit.
params.edit = await _fix_document_impl(document, settings)
return params
@LSP_SERVER.command("ruff.applyAutofix")
async def apply_autofix(arguments: tuple[TextDocument]):
uri = arguments[0]["uri"]
document = Document.from_uri(uri)
settings = _get_settings_by_document(document.path)
if not lint_enable(settings):
return None
workspace_edit = await _fix_document_impl(document, settings)
if workspace_edit is None:
return None
LSP_SERVER.apply_edit(workspace_edit, "Ruff: Fix all auto-fixable problems")
@LSP_SERVER.command("ruff.applyOrganizeImports")
async def apply_organize_imports(arguments: tuple[TextDocument]):
uri = arguments[0]["uri"]
document = Document.from_uri(uri)
settings = _get_settings_by_document(document.path)
workspace_edit = await _fix_document_impl(document, settings, only=["I001", "I002"])
if workspace_edit is None:
return None
LSP_SERVER.apply_edit(workspace_edit, "Ruff: Format imports")
@LSP_SERVER.command("ruff.applyFormat")
async def apply_format(arguments: tuple[TextDocument]):
uri = arguments[0]["uri"]
document = Document.from_uri(uri)
settings = _get_settings_by_document(document.path)
result = await _run_format_on_document(document, settings)
if result is None:
return None
# For `ruff format`, 0 indicates successful completion, non-zero indicates an error.
if result.exit_code != 0:
if result.stderr:
show_error(f"Ruff: Format failed ({result.stderr.decode('utf-8')})")
return None
workspace_edit = _result_to_workspace_edit(document, result)
if workspace_edit is None:
return None
LSP_SERVER.apply_edit(workspace_edit, "Ruff: Format document")
@LSP_SERVER.feature(TEXT_DOCUMENT_FORMATTING)
async def format_document(params: DocumentFormattingParams) -> list[TextEdit] | None:
return await _format_document_impl(params, None)
@LSP_SERVER.feature(
TEXT_DOCUMENT_RANGE_FORMATTING,
DocumentRangeFormattingRegistrationOptions(
document_selector=[
TextDocumentFilter_Type1(language="python", scheme="file"),
TextDocumentFilter_Type1(language="python", scheme="untitled"),
],
ranges_support=False,
work_done_progress=False,
),
)
async def format_document_range(
params: DocumentRangeFormattingParams,
) -> list[TextEdit] | None:
return await _format_document_impl(
DocumentFormattingParams(
params.text_document, params.options, params.work_done_token
),
params.range,
)
async def _format_document_impl(
params: DocumentFormattingParams, range: Range | None
) -> list[TextEdit] | None:
# For a Jupyter Notebook, this request can only format a single cell as the
# request itself can only act on a text document. A cell in a Notebook is
# represented as a text document. The "Notebook: Format notebook" action calls
# this request for every cell.
document = Document.from_cell_or_text_uri(params.text_document.uri)
settings = _get_settings_by_document(document.path)
# We don't support range formatting of notebooks yet but VS Code
# doesn't seem to respect the document filter. For now, format the entire cell.
range = None if document.kind is DocumentKind.Cell else range
result = await _run_format_on_document(document, settings, range)
if result is None:
return None
# For `ruff format`, 0 indicates successful completion, non-zero indicates an error.
if result.exit_code != 0:
if result.stderr:
show_error(f"Ruff: Format failed ({result.stderr.decode('utf-8')})")
return None
if not VERSION_REQUIREMENT_EMPTY_OUTPUT.contains(
result.executable.version, prereleases=True
):
if not result.stdout and document.source.strip():
return None
if document.kind is DocumentKind.Cell:
return _result_single_cell_notebook_to_edits(document, result)
else:
return _fixed_source_to_edits(
original_source=document.source, fixed_source=result.stdout.decode("utf-8")
)
async def _fix_document_impl(
document: Document,
settings: WorkspaceSettings,
*,
only: Sequence[str] | None = None,
) -> WorkspaceEdit | None:
result = await _run_check_on_document(
document,
settings,
extra_args=["--fix"],
only=only,
)
if result is None:
return None
# For `ruff check`, 0 indicates successful completion with no remaining
# diagnostics, 1 indicates successful completion with remaining diagnostics,
# and 2 indicates an error.
if result.exit_code not in (0, 1):
if result.stderr:
show_error(f"Ruff: Fix failed ({result.stderr.decode('utf-8')})")
return None
return _result_to_workspace_edit(document, result)
def _result_to_workspace_edit(
document: Document, result: ExecutableResult | None
) -> WorkspaceEdit | None:
"""Converts a run result to a WorkspaceEdit."""
if result is None:
return None
if not VERSION_REQUIREMENT_EMPTY_OUTPUT.contains(
result.executable.version, prereleases=True
):
if not result.stdout and document.source.strip():
return None
if document.kind is DocumentKind.Text:
edits = _fixed_source_to_edits(
original_source=document.source, fixed_source=result.stdout.decode("utf-8")
)
return WorkspaceEdit(
document_changes=[
_create_text_document_edit(document.uri, document.version, edits)
]
)
elif document.kind is DocumentKind.Notebook:
notebook_document = LSP_SERVER.workspace.get_notebook_document(
notebook_uri=document.uri
)
if notebook_document is None:
log_warning(f"No notebook document found for {document.uri!r}")
return None
output_notebook_cells = cast(
Notebook, json.loads(result.stdout.decode("utf-8"))
)["cells"]
if len(output_notebook_cells) != len(notebook_document.cells):
log_warning(
f"Number of cells in the output notebook doesn't match the number of "
f"cells in the input notebook. Input: {len(notebook_document.cells)}, "
f"Output: {len(output_notebook_cells)}"
)
return None
cell_document_changes: list[TextDocumentEdit] = []
for cell_idx, cell in enumerate(notebook_document.cells):
if cell.kind is not NotebookCellKind.Code:
continue
cell_document = LSP_SERVER.workspace.get_text_document(cell.document)
edits = _fixed_source_to_edits(
original_source=cell_document.source,
fixed_source=output_notebook_cells[cell_idx]["source"],
)
cell_document_changes.append(
_create_text_document_edit(
cell_document.uri,
cell_document.version,
edits,
)
)
return WorkspaceEdit(document_changes=list(cell_document_changes))
elif document.kind is DocumentKind.Cell:
text_edits = _result_single_cell_notebook_to_edits(document, result)
if text_edits is None:
return None
return WorkspaceEdit(
document_changes=[
_create_text_document_edit(document.uri, document.version, text_edits)
]
)
else:
assert_never(document.kind)
def _result_single_cell_notebook_to_edits(
document: Document, result: ExecutableResult
) -> list[TextEdit] | None:
"""Converts a run result to a list of TextEdits.
The result is expected to be a single cell Notebook Document.
"""
output_notebook = cast(Notebook, json.loads(result.stdout.decode("utf-8")))
# The input notebook contained only one cell, so the output notebook should
# also contain only one cell.
output_cell = next(iter(output_notebook["cells"]), None)
if output_cell is None or output_cell["cell_type"] != "code":
log_warning(
f"Unexpected output working with a notebook cell: {output_notebook}"
)
return None
# We can't use the `document.source` here because it's in the Notebook format
# i.e., it's a JSON string containing a single cell with the source.
original_source = LSP_SERVER.workspace.get_text_document(document.uri).source
return _fixed_source_to_edits(
original_source=original_source, fixed_source=output_cell["source"]
)
def _fixed_source_to_edits(
*, original_source: str, fixed_source: str | list[str]
) -> list[TextEdit]:
"""Converts the fixed source to a list of TextEdits.
If the fixed source is a list of strings, it is joined together to form a single
string with an assumption that the line endings are part of the strings itself.
"""
if isinstance(fixed_source, list):
fixed_source = "".join(fixed_source)
new_source = _match_line_endings(original_source, fixed_source)
if new_source == original_source:
return []
# Reduce the text edit by omitting the common suffix and postfix (lines)
# from the text edit. I chose this basic diffing because "proper" diffing has
# the downside that it can be very slow in some cases. Black uses a diffing approach
# that takes time into consideration, but it requires spawning a thread to stop
# the diffing after a given time, which feels very heavy weight.
# This basic "diffing" has a guaranteed `O(n)` runtime and is sufficient to
# prevent transmitting the entire source document when formatting a range
# or formatting a document where most of the code remains unchanged.
#
# https://github.com/microsoft/vscode-black-formatter/blob/main/bundled/tool/lsp_edit_utils.py
new_lines = new_source.splitlines(True)
original_lines = original_source.splitlines(True)
start_offset = 0
end_offset = 0
for new_line, original_line in zip(new_lines, original_lines):
if new_line == original_line:
start_offset += 1
else:
break
for new_line, original_line in zip(
reversed(new_lines[start_offset:]), reversed(original_lines[start_offset:])
):
if new_line == original_line:
end_offset += 1
else:
break
trimmed_new_source = "".join(new_lines[start_offset : len(new_lines) - end_offset])
return [
TextEdit(
range=Range(
start=Position(line=start_offset, character=0),
end=Position(line=len(original_lines) - end_offset, character=0),
),
new_text=trimmed_new_source,
)
]
def _create_text_document_edit(
uri: str, version: int | None, edits: Sequence[TextEdit | AnnotatedTextEdit]
) -> TextDocumentEdit:
return TextDocumentEdit(
text_document=OptionalVersionedTextDocumentIdentifier(
uri=uri,
version=0 if version is None else version,
),
edits=list(edits),
)
def _create_workspace_edit(uri: str, version: int | None, fix: Fix) -> WorkspaceEdit:
return WorkspaceEdit(
document_changes=[
TextDocumentEdit(
text_document=OptionalVersionedTextDocumentIdentifier(
uri=uri,
version=0 if version is None else version,
),
edits=[
TextEdit(
range=Range(
start=Position(
line=edit["location"]["row"] - 1,
character=edit["location"]["column"],
),
end=Position(
line=edit["end_location"]["row"] - 1,
character=edit["end_location"]["column"],
),
),
new_text=edit["content"],
)
for edit in fix["edits"]
],
)
],
)
def _get_line_endings(text: str) -> str | None:
"""Returns line endings used in the text."""
for i in range(len(text)):
if text[i] == "\r":
if i < len(text) - 1 and text[i + 1] == "\n":
return "\r\n" # CLRF
else:
return "\r" # CR
elif text[i] == "\n":
return "\n" # LF
return None # No line ending found
def _match_line_endings(original_source: str, fixed_source: str) -> str:
"""Ensures that the edited text line endings matches the document line endings."""
expected = _get_line_endings(original_source)
actual = _get_line_endings(fixed_source)
if actual is None or expected is None or actual == expected:
return fixed_source
return fixed_source.replace(actual, expected)
async def run_path(
program: str,
argv: Sequence[str],
*,
source: str,
cwd: str | None = None,
) -> RunResult:
"""Runs as an executable."""
log_to_output(f"Running Ruff with: {program} {argv}")
process = await asyncio.create_subprocess_exec(
program,
*argv,
stdout=asyncio.subprocess.PIPE,
stderr=asyncio.subprocess.PIPE,
stdin=asyncio.subprocess.PIPE,
cwd=cwd,
)
result = RunResult(
*await process.communicate(input=source.encode("utf-8")),
exit_code=await process.wait(),
)
if result.stderr:
log_to_output(result.stderr.decode("utf-8"))
return result
###
# Lifecycle.
###
@LSP_SERVER.feature(INITIALIZE)
def initialize(params: InitializeParams) -> None:
"""LSP handler for initialize request."""
# Extract client capabilities.
CLIENT_CAPABILITIES[CODE_ACTION_RESOLVE] = _supports_code_action_resolve(
params.capabilities
)
# Extract `settings` from the initialization options.
workspace_settings: list[WorkspaceSettings] | WorkspaceSettings | None = (
params.initialization_options or {}
).get(
"settings",
)
global_settings: UserSettings | None = (params.initialization_options or {}).get(
"globalSettings", {}
)
log_to_output(
f"Workspace settings: "
f"{json.dumps(workspace_settings, indent=4, ensure_ascii=False)}"
)
log_to_output(
f"Global settings: "
f"{json.dumps(global_settings, indent=4, ensure_ascii=False)}"
)
# Preserve any "global" settings.
if global_settings:
GLOBAL_SETTINGS.update(global_settings)
elif isinstance(workspace_settings, dict):
# In Sublime Text, Neovim, and probably others, we're passed a single
# `settings`, which we'll treat as defaults for any future files.
GLOBAL_SETTINGS.update(workspace_settings)
# Update workspace settings.
settings: list[WorkspaceSettings]
if isinstance(workspace_settings, dict):
settings = [workspace_settings]
elif isinstance(workspace_settings, list):
# In VS Code, we're passed a list of `settings`, one for each workspace folder.
settings = workspace_settings
else:
settings = []
_update_workspace_settings(settings)
def _supports_code_action_resolve(capabilities: ClientCapabilities) -> bool:
"""Returns True if the client supports codeAction/resolve request for edits."""
if capabilities.text_document is None:
return False
if capabilities.text_document.code_action is None:
return False
if capabilities.text_document.code_action.resolve_support is None:
return False
return "edit" in capabilities.text_document.code_action.resolve_support.properties
###
# Settings.
###
def _get_global_defaults() -> UserSettings:
settings: UserSettings = {
"codeAction": GLOBAL_SETTINGS.get("codeAction", {}),
"fixAll": GLOBAL_SETTINGS.get("fixAll", True),
"format": GLOBAL_SETTINGS.get("format", {}),
"ignoreStandardLibrary": GLOBAL_SETTINGS.get("ignoreStandardLibrary", True),
"importStrategy": GLOBAL_SETTINGS.get("importStrategy", "fromEnvironment"),
"interpreter": GLOBAL_SETTINGS.get("interpreter", [sys.executable]),
"lint": GLOBAL_SETTINGS.get("lint", {}),
"logLevel": GLOBAL_SETTINGS.get("logLevel", "error"),
"organizeImports": GLOBAL_SETTINGS.get("organizeImports", True),
"path": GLOBAL_SETTINGS.get("path", []),
}
# Deprecated: use `lint.args` instead.
if "args" in GLOBAL_SETTINGS:
settings["args"] = GLOBAL_SETTINGS["args"]
# Deprecated: use `lint.run` instead.
if "run" in GLOBAL_SETTINGS:
settings["run"] = GLOBAL_SETTINGS["run"]
return settings
def _update_workspace_settings(settings: list[WorkspaceSettings]) -> None:
if not settings:
workspace_path = os.getcwd()
WORKSPACE_SETTINGS[workspace_path] = {
**_get_global_defaults(), # type: ignore[misc]
"cwd": workspace_path,
"workspacePath": workspace_path,
"workspace": uris.from_fs_path(workspace_path),
}
return None
for setting in settings:
if "workspace" in setting:
workspace_path = uris.to_fs_path(setting["workspace"])
WORKSPACE_SETTINGS[workspace_path] = {
**_get_global_defaults(), # type: ignore[misc]
**setting,
"cwd": workspace_path,
"workspacePath": workspace_path,
"workspace": setting["workspace"],
}
else:
workspace_path = os.getcwd()
WORKSPACE_SETTINGS[workspace_path] = {
**_get_global_defaults(), # type: ignore[misc]
**setting,
"cwd": workspace_path,
"workspacePath": workspace_path,
"workspace": uris.from_fs_path(workspace_path),
}
def _get_document_key(document_path: str) -> str | None:
document_workspace = Path(document_path)
workspaces = {s["workspacePath"] for s in WORKSPACE_SETTINGS.values()}
while document_workspace != document_workspace.parent:
if str(document_workspace) in workspaces:
return str(document_workspace)
document_workspace = document_workspace.parent
return None
def _get_settings_by_document(document_path: str) -> WorkspaceSettings:
key = _get_document_key(document_path)
if key is None:
# This is either a non-workspace file or there is no workspace.
workspace_path = os.fspath(Path(document_path).parent)
return {
**_get_global_defaults(), # type: ignore[misc]
"cwd": None,
"workspacePath": workspace_path,
"workspace": uris.from_fs_path(workspace_path),
}
return WORKSPACE_SETTINGS[str(key)]
###
# Internal execution APIs.
###
class Executable(NamedTuple):
path: str
"""The path to the executable."""
version: Version
"""The version of the executable."""
class ExecutableResult(NamedTuple):
executable: Executable
"""The executable."""
stdout: bytes
"""The stdout of running the executable."""
stderr: bytes
"""The stderr of running the executable."""
exit_code: int
"""The exit code of running the executable."""
def _find_ruff_binary(
settings: WorkspaceSettings, version_requirement: SpecifierSet | None
) -> Executable:
"""Returns the executable along with its version.
If the executable doesn't meet the version requirement, raises a RuntimeError and
displays an error message.
"""
path = _find_ruff_binary_path(settings)
version = _executable_version(path)
if version_requirement and not version_requirement.contains(
version, prereleases=True
):
message = f"Ruff {version_requirement} required, but found {version} at {path}"
show_error(message)
raise RuntimeError(message)
log_to_output(f"Found ruff {version} at {path}")
return Executable(path, version)
def _find_ruff_binary_path(settings: WorkspaceSettings) -> str:
"""Returns the path to the executable."""
bundle = get_bundle()
if settings["path"]:
# 'path' setting takes priority over everything.
paths = settings["path"]
if isinstance(paths, str):
paths = [paths]
for path in paths:
path = os.path.expanduser(os.path.expandvars(path))
if os.path.exists(path):
log_to_output(f"Using 'path' setting: {path}")
return path
else:
log_to_output(f"Could not find executable in 'path': {settings['path']}")
if settings["importStrategy"] == "useBundled" and bundle:
# If we're loading from the bundle, use the absolute path.
log_to_output(f"Using bundled executable: {bundle}")
return bundle
if settings["interpreter"] and not utils.is_current_interpreter(
settings["interpreter"][0]
):
# If there is a different interpreter set, find its script path.
if settings["interpreter"][0] not in INTERPRETER_PATHS:
INTERPRETER_PATHS[settings["interpreter"][0]] = utils.scripts(
os.path.expanduser(os.path.expandvars(settings["interpreter"][0]))
)
path = os.path.join(INTERPRETER_PATHS[settings["interpreter"][0]], TOOL_MODULE)
else:
path = os.path.join(sysconfig.get_path("scripts"), TOOL_MODULE)
# First choice: the executable in the current interpreter's scripts directory.
if os.path.exists(path):
log_to_output(f"Using interpreter executable: {path}")
return path
else:
log_to_output(f"Interpreter executable ({path}) not found")
# Second choice: the executable in the global environment.
environment_path = shutil.which("ruff")
if environment_path:
log_to_output(f"Using environment executable: {environment_path}")
return environment_path
# Third choice: bundled executable.
if bundle:
log_to_output(f"Falling back to bundled executable: {bundle}")
return bundle
# Last choice: just return the expected path for the current interpreter.
log_to_output(f"Unable to find interpreter executable: {path}")
return path
def _executable_version(executable: str) -> Version:
"""Returns the version of the executable."""
# If the user change the file (e.g. `pip install -U ruff`), invalidate the cache
modified = Path(executable).stat().st_mtime
if (
executable not in EXECUTABLE_VERSIONS
or EXECUTABLE_VERSIONS[executable].modified != modified
):
version = utils.version(executable)
log_to_output(f"Inferred version {version} for: {executable}")
EXECUTABLE_VERSIONS[executable] = VersionModified(version, modified)
return EXECUTABLE_VERSIONS[executable].version
async def _run_check_on_document(
document: Document,
settings: WorkspaceSettings,
*,
extra_args: Sequence[str] = [],
only: Sequence[str] | None = None,
) -> ExecutableResult | None:
"""Runs the Ruff `check` subcommand on the given document source."""
if settings.get("ignoreStandardLibrary", True) and document.is_stdlib_file():
log_warning(f"Skipping standard library file: {document.path}")
return None
executable = _find_ruff_binary(settings, VERSION_REQUIREMENT_LINTER)
argv: list[str] = CHECK_ARGS + list(extra_args)
skip_next_arg = False
for arg in lint_args(settings):
if skip_next_arg:
skip_next_arg = False
continue
if arg in UNSUPPORTED_CHECK_ARGS:
log_to_output(f"Ignoring unsupported argument: {arg}")
continue
# If we're trying to run a single rule, we need to make sure to skip any of the
# arguments that would override it.
if only is not None:
# Case 1: Option and its argument as separate items
# (e.g. `["--select", "F821"]`).
if arg in ("--select", "--extend-select", "--ignore", "--extend-ignore"):
# Skip the following argument assuming it's a list of rules.
skip_next_arg = True
continue
# Case 2: Option and its argument as a single item
# (e.g. `["--select=F821"]`).
elif arg.startswith(
("--select=", "--extend-select=", "--ignore=", "--extend-ignore=")
):
continue
argv.append(arg)
# If the Ruff version is not sufficiently recent, use the deprecated `--format`
# argument instead of `--output-format`.
if not VERSION_REQUIREMENT_OUTPUT_FORMAT.contains(
executable.version, prereleases=True
):
index = argv.index("--output-format")
argv.pop(index)
argv.insert(index, "--format")
# If we're trying to run a single rule, add it to the command line.
if only is not None:
for rule in only:
argv += ["--select", rule]
# Provide the document filename.
argv += ["--stdin-filename", document.path]
return ExecutableResult(
executable,
*await run_path(
executable.path,
argv,
cwd=settings["cwd"],
source=document.source,
),
)
async def _run_format_on_document(
document: Document, settings: WorkspaceSettings, format_range: Range | None = None
) -> ExecutableResult | None:
"""Runs the Ruff `format` subcommand on the given document source."""
if settings.get("ignoreStandardLibrary", True) and document.is_stdlib_file():
log_warning(f"Skipping standard library file: {document.path}")
return None
version_requirement = (
VERSION_REQUIREMENT_FORMATTER
if format_range is None
else VERSION_REQUIREMENT_RANGE_FORMATTING
)
executable = _find_ruff_binary(settings, version_requirement)
argv: list[str] = [
"format",
"--force-exclude",
"--quiet",
"--stdin-filename",
document.path,
]
if format_range:
codec = PositionCodec(PositionEncodingKind.Utf16)
format_range = codec.range_from_client_units(
document.source.splitlines(True), format_range
)
argv.extend(
[
"--range",
f"{format_range.start.line + 1}:{format_range.start.character + 1}-{format_range.end.line + 1}:{format_range.end.character + 1}", # noqa: E501
]
)
for arg in settings.get("format", {}).get("args", []):
if arg in UNSUPPORTED_FORMAT_ARGS:
log_to_output(f"Ignoring unsupported argument: {arg}")
else:
argv.append(arg)
return ExecutableResult(
executable,
*await run_path(
executable.path,
argv,
cwd=settings["cwd"],
source=document.source,
),
)
async def _run_subcommand_on_document(
document: workspace.TextDocument,
version_requirement: SpecifierSet,
*,
args: Sequence[str],
) -> ExecutableResult:
"""Runs the tool subcommand on the given document."""
settings = _get_settings_by_document(document.path)
executable = _find_ruff_binary(settings, version_requirement)
argv: list[str] = list(args)
return ExecutableResult(
executable,
*await run_path(
executable.path,
argv,
cwd=settings["cwd"],
source=document.source,
),
)
###
# Logging.
###
def log_to_output(message: str) -> None:
LSP_SERVER.show_message_log(message, MessageType.Log)
def show_error(message: str) -> None:
"""Show a pop-up with an error. Only use for critical errors."""
LSP_SERVER.show_message_log(message, MessageType.Error)
LSP_SERVER.show_message(message, MessageType.Error)
def log_warning(message: str) -> None:
LSP_SERVER.show_message_log(message, MessageType.Warning)
if os.getenv("LS_SHOW_NOTIFICATION", "off") in ["onWarning", "always"]:
LSP_SERVER.show_message(message, MessageType.Warning)
def log_always(message: str) -> None:
LSP_SERVER.show_message_log(message, MessageType.Info)
if os.getenv("LS_SHOW_NOTIFICATION", "off") in ["always"]:
LSP_SERVER.show_message(message, MessageType.Info)
###
# Bundled mode.
###
_BUNDLED_PATH: str | None = None
def set_bundle(path: str) -> None:
"""Sets the path to the bundled Ruff executable."""
global _BUNDLED_PATH
_BUNDLED_PATH = path
def get_bundle() -> str | None:
"""Returns the path to the bundled Ruff executable."""
return _BUNDLED_PATH
###
# Start up.
###
def start() -> None:
LSP_SERVER.start_io()
if __name__ == "__main__":
start()