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
|
import dataclasses
import os.path
import subprocess
from typing import List, Optional, TypeVar
from collections.abc import Callable, Sequence
from debian.debian_support import Version
from debputy.util import _error
@dataclasses.dataclass(slots=True, frozen=True)
class LSPSelfCheck:
feature: str
test: Callable[[], bool]
problem: str
how_to_fix: str
is_mandatory: bool = False
LSP_CHECKS: list[LSPSelfCheck] = []
C = TypeVar("C", bound="Callable")
def lsp_import_check(
packages: Sequence[str],
*,
feature_name: str | None = None,
is_mandatory: bool = False,
) -> Callable[[C], C]:
def _wrapper(func: C) -> C:
def _impl():
try:
r = func()
except ImportError:
return False
return r is None or bool(r)
suffix = "fix this issue" if is_mandatory else "enable this feature"
LSP_CHECKS.append(
LSPSelfCheck(
_feature_name(feature_name, func),
_impl,
"Missing dependencies",
f"Run `apt satisfy '{', '.join(packages)}'` to {suffix}",
is_mandatory=is_mandatory,
)
)
return func
return _wrapper
def lsp_generic_check(
problem: str,
how_to_fix: str,
*,
feature_name: str | None = None,
is_mandatory: bool = False,
) -> Callable[[C], C]:
def _wrapper(func: C) -> C:
LSP_CHECKS.append(
LSPSelfCheck(
_feature_name(feature_name, func),
func,
problem,
how_to_fix,
is_mandatory=is_mandatory,
)
)
return func
return _wrapper
def _feature_name(feature: str | None, func: Callable[[], None]) -> str:
if feature is not None:
return feature
return func.__name__.replace("_", " ")
@lsp_import_check(["python3-lsprotocol", "python3-pygls"], is_mandatory=True)
def minimum_requirements() -> bool:
import pygls.server
# The hasattr is mostly irrelevant; but it avoids the import being flagged as redundant.
return hasattr(pygls.server, "LanguageServer")
@lsp_import_check(["python3-levenshtein"])
def typo_detection() -> bool:
import Levenshtein
# The hasattr is mostly irrelevant; but it avoids the import being flagged as redundant.
return hasattr(Levenshtein, "distance")
@lsp_import_check(["hunspell-en-us", "python3-hunspell"])
def spell_checking() -> bool:
import hunspell
# The hasattr is mostly irrelevant; but it avoids the import being flagged as redundant.
return hasattr(hunspell, "HunSpell") and os.path.exists(
"/usr/share/hunspell/en_US.dic"
)
@lsp_generic_check(
feature_name="extra dh support",
problem="Missing dependencies",
how_to_fix="Run `apt satisfy debhelper (>= 13.16~)` to enable this feature",
)
def check_dh_version() -> bool:
try:
output = subprocess.check_output(
[
"dpkg-query",
"-W",
"--showformat=${Version} ${db:Status-Status}\n",
"debhelper",
]
).decode("utf-8")
except (FileNotFoundError, subprocess.CalledProcessError):
return False
else:
parts = output.split()
if len(parts) != 2:
return False
if parts[1] != "installed":
return False
return Version(parts[0]) >= Version("13.16~")
@lsp_generic_check(
feature_name="apt cache packages",
problem="Missing apt or empty apt cache",
how_to_fix="",
)
def check_apt_cache() -> bool:
try:
output = subprocess.check_output(
[
"apt-get",
"indextargets",
"--format",
"$(IDENTIFIER)",
]
).decode("utf-8")
except (FileNotFoundError, subprocess.CalledProcessError):
return False
for line in output.splitlines():
if line.strip() == "Packages":
return True
return False
def assert_can_start_lsp() -> None:
for self_check in LSP_CHECKS:
if self_check.is_mandatory and not self_check.test():
_error(
f"Cannot start the language server. {self_check.problem}. {self_check.how_to_fix}"
)
|