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