1use anyhow::{anyhow, Result};
2use async_trait::async_trait;
3use futures::StreamExt;
4use language::{LanguageServerName, LspAdapter, LspAdapterDelegate};
5use lsp::LanguageServerBinary;
6use node_runtime::NodeRuntime;
7use smol::fs;
8use std::{
9 any::Any,
10 ffi::OsString,
11 path::{Path, PathBuf},
12 sync::Arc,
13};
14use util::ResultExt;
15
16const SERVER_PATH: &'static str = "node_modules/pyright/langserver.index.js";
17
18fn server_binary_arguments(server_path: &Path) -> Vec<OsString> {
19 vec![server_path.into(), "--stdio".into()]
20}
21
22pub struct PythonLspAdapter {
23 node: Arc<NodeRuntime>,
24}
25
26impl PythonLspAdapter {
27 pub fn new(node: Arc<NodeRuntime>) -> Self {
28 PythonLspAdapter { node }
29 }
30}
31
32#[async_trait]
33impl LspAdapter for PythonLspAdapter {
34 async fn name(&self) -> LanguageServerName {
35 LanguageServerName("pyright".into())
36 }
37
38 fn short_name(&self) -> &'static str {
39 "pyright"
40 }
41
42 async fn fetch_latest_server_version(
43 &self,
44 _: &dyn LspAdapterDelegate,
45 ) -> Result<Box<dyn 'static + Any + Send>> {
46 Ok(Box::new(self.node.npm_package_latest_version("pyright").await?) as Box<_>)
47 }
48
49 async fn fetch_server_binary(
50 &self,
51 version: Box<dyn 'static + Send + Any>,
52 container_dir: PathBuf,
53 _: &dyn LspAdapterDelegate,
54 ) -> Result<LanguageServerBinary> {
55 let version = version.downcast::<String>().unwrap();
56 let server_path = container_dir.join(SERVER_PATH);
57
58 if fs::metadata(&server_path).await.is_err() {
59 self.node
60 .npm_install_packages(&container_dir, [("pyright", version.as_str())])
61 .await?;
62 }
63
64 Ok(LanguageServerBinary {
65 path: self.node.binary_path().await?,
66 arguments: server_binary_arguments(&server_path),
67 })
68 }
69
70 async fn cached_server_binary(
71 &self,
72 container_dir: PathBuf,
73 _: &dyn LspAdapterDelegate,
74 ) -> Option<LanguageServerBinary> {
75 get_cached_server_binary(container_dir, &self.node).await
76 }
77
78 async fn installation_test_binary(
79 &self,
80 container_dir: PathBuf,
81 ) -> Option<LanguageServerBinary> {
82 get_cached_server_binary(container_dir, &self.node).await
83 }
84
85 async fn process_completion(&self, item: &mut lsp::CompletionItem) {
86 // Pyright assigns each completion item a `sortText` of the form `XX.YYYY.name`.
87 // Where `XX` is the sorting category, `YYYY` is based on most recent usage,
88 // and `name` is the symbol name itself.
89 //
90 // Because the the symbol name is included, there generally are not ties when
91 // sorting by the `sortText`, so the symbol's fuzzy match score is not taken
92 // into account. Here, we remove the symbol name from the sortText in order
93 // to allow our own fuzzy score to be used to break ties.
94 //
95 // see https://github.com/microsoft/pyright/blob/95ef4e103b9b2f129c9320427e51b73ea7cf78bd/packages/pyright-internal/src/languageService/completionProvider.ts#LL2873
96 let Some(sort_text) = &mut item.sort_text else { return };
97 let mut parts = sort_text.split('.');
98 let Some(first) = parts.next() else { return };
99 let Some(second) = parts.next() else { return };
100 let Some(_) = parts.next() else { return };
101 sort_text.replace_range(first.len() + second.len() + 1.., "");
102 }
103
104 async fn label_for_completion(
105 &self,
106 item: &lsp::CompletionItem,
107 language: &Arc<language::Language>,
108 ) -> Option<language::CodeLabel> {
109 let label = &item.label;
110 let grammar = language.grammar()?;
111 let highlight_id = match item.kind? {
112 lsp::CompletionItemKind::METHOD => grammar.highlight_id_for_name("function.method")?,
113 lsp::CompletionItemKind::FUNCTION => grammar.highlight_id_for_name("function")?,
114 lsp::CompletionItemKind::CLASS => grammar.highlight_id_for_name("type")?,
115 lsp::CompletionItemKind::CONSTANT => grammar.highlight_id_for_name("constant")?,
116 _ => return None,
117 };
118 Some(language::CodeLabel {
119 text: label.clone(),
120 runs: vec![(0..label.len(), highlight_id)],
121 filter_range: 0..label.len(),
122 })
123 }
124
125 async fn label_for_symbol(
126 &self,
127 name: &str,
128 kind: lsp::SymbolKind,
129 language: &Arc<language::Language>,
130 ) -> Option<language::CodeLabel> {
131 let (text, filter_range, display_range) = match kind {
132 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
133 let text = format!("def {}():\n", name);
134 let filter_range = 4..4 + name.len();
135 let display_range = 0..filter_range.end;
136 (text, filter_range, display_range)
137 }
138 lsp::SymbolKind::CLASS => {
139 let text = format!("class {}:", name);
140 let filter_range = 6..6 + name.len();
141 let display_range = 0..filter_range.end;
142 (text, filter_range, display_range)
143 }
144 lsp::SymbolKind::CONSTANT => {
145 let text = format!("{} = 0", name);
146 let filter_range = 0..name.len();
147 let display_range = 0..filter_range.end;
148 (text, filter_range, display_range)
149 }
150 _ => return None,
151 };
152
153 Some(language::CodeLabel {
154 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
155 text: text[display_range].to_string(),
156 filter_range,
157 })
158 }
159}
160
161async fn get_cached_server_binary(
162 container_dir: PathBuf,
163 node: &NodeRuntime,
164) -> Option<LanguageServerBinary> {
165 (|| async move {
166 let mut last_version_dir = None;
167 let mut entries = fs::read_dir(&container_dir).await?;
168 while let Some(entry) = entries.next().await {
169 let entry = entry?;
170 if entry.file_type().await?.is_dir() {
171 last_version_dir = Some(entry.path());
172 }
173 }
174 let last_version_dir = last_version_dir.ok_or_else(|| anyhow!("no cached binary"))?;
175 let server_path = last_version_dir.join(SERVER_PATH);
176 if server_path.exists() {
177 Ok(LanguageServerBinary {
178 path: node.binary_path().await?,
179 arguments: server_binary_arguments(&server_path),
180 })
181 } else {
182 Err(anyhow!(
183 "missing executable in directory {:?}",
184 last_version_dir
185 ))
186 }
187 })()
188 .await
189 .log_err()
190}
191
192#[cfg(test)]
193mod tests {
194 use gpui::{ModelContext, TestAppContext};
195 use language::{language_settings::AllLanguageSettings, AutoindentMode, Buffer};
196 use settings::SettingsStore;
197 use std::num::NonZeroU32;
198
199 #[gpui::test]
200 async fn test_python_autoindent(cx: &mut TestAppContext) {
201 cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
202 let language =
203 crate::languages::language("python", tree_sitter_python::language(), None).await;
204 cx.update(|cx| {
205 cx.set_global(SettingsStore::test(cx));
206 language::init(cx);
207 cx.update_global::<SettingsStore, _, _>(|store, cx| {
208 store.update_user_settings::<AllLanguageSettings>(cx, |s| {
209 s.defaults.tab_size = NonZeroU32::new(2);
210 });
211 });
212 });
213
214 cx.add_model(|cx| {
215 let mut buffer = Buffer::new(0, "", cx).with_language(language, cx);
216 let append = |buffer: &mut Buffer, text: &str, cx: &mut ModelContext<Buffer>| {
217 let ix = buffer.len();
218 buffer.edit([(ix..ix, text)], Some(AutoindentMode::EachLine), cx);
219 };
220
221 // indent after "def():"
222 append(&mut buffer, "def a():\n", cx);
223 assert_eq!(buffer.text(), "def a():\n ");
224
225 // preserve indent after blank line
226 append(&mut buffer, "\n ", cx);
227 assert_eq!(buffer.text(), "def a():\n \n ");
228
229 // indent after "if"
230 append(&mut buffer, "if a:\n ", cx);
231 assert_eq!(buffer.text(), "def a():\n \n if a:\n ");
232
233 // preserve indent after statement
234 append(&mut buffer, "b()\n", cx);
235 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n ");
236
237 // preserve indent after statement
238 append(&mut buffer, "else", cx);
239 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else");
240
241 // dedent "else""
242 append(&mut buffer, ":", cx);
243 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else:");
244
245 // indent lines after else
246 append(&mut buffer, "\n", cx);
247 assert_eq!(
248 buffer.text(),
249 "def a():\n \n if a:\n b()\n else:\n "
250 );
251
252 // indent after an open paren. the closing paren is not indented
253 // because there is another token before it on the same line.
254 append(&mut buffer, "foo(\n1)", cx);
255 assert_eq!(
256 buffer.text(),
257 "def a():\n \n if a:\n b()\n else:\n foo(\n 1)"
258 );
259
260 // dedent the closing paren if it is shifted to the beginning of the line
261 let argument_ix = buffer.text().find('1').unwrap();
262 buffer.edit(
263 [(argument_ix..argument_ix + 1, "")],
264 Some(AutoindentMode::EachLine),
265 cx,
266 );
267 assert_eq!(
268 buffer.text(),
269 "def a():\n \n if a:\n b()\n else:\n foo(\n )"
270 );
271
272 // preserve indent after the close paren
273 append(&mut buffer, "\n", cx);
274 assert_eq!(
275 buffer.text(),
276 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n "
277 );
278
279 // manually outdent the last line
280 let end_whitespace_ix = buffer.len() - 4;
281 buffer.edit(
282 [(end_whitespace_ix..buffer.len(), "")],
283 Some(AutoindentMode::EachLine),
284 cx,
285 );
286 assert_eq!(
287 buffer.text(),
288 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n"
289 );
290
291 // preserve the newly reduced indentation on the next newline
292 append(&mut buffer, "\n", cx);
293 assert_eq!(
294 buffer.text(),
295 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n\n"
296 );
297
298 // reset to a simple if statement
299 buffer.edit([(0..buffer.len(), "if a:\n b(\n )")], None, cx);
300
301 // dedent "else" on the line after a closing paren
302 append(&mut buffer, "\n else:\n", cx);
303 assert_eq!(buffer.text(), "if a:\n b(\n )\nelse:\n ");
304
305 buffer
306 });
307 }
308}