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 {
97 return;
98 };
99 let mut parts = sort_text.split('.');
100 let Some(first) = parts.next() else { return };
101 let Some(second) = parts.next() else { return };
102 let Some(_) = parts.next() else { return };
103 sort_text.replace_range(first.len() + second.len() + 1.., "");
104 }
105
106 async fn label_for_completion(
107 &self,
108 item: &lsp::CompletionItem,
109 language: &Arc<language::Language>,
110 ) -> Option<language::CodeLabel> {
111 let label = &item.label;
112 let grammar = language.grammar()?;
113 let highlight_id = match item.kind? {
114 lsp::CompletionItemKind::METHOD => grammar.highlight_id_for_name("function.method")?,
115 lsp::CompletionItemKind::FUNCTION => grammar.highlight_id_for_name("function")?,
116 lsp::CompletionItemKind::CLASS => grammar.highlight_id_for_name("type")?,
117 lsp::CompletionItemKind::CONSTANT => grammar.highlight_id_for_name("constant")?,
118 _ => return None,
119 };
120 Some(language::CodeLabel {
121 text: label.clone(),
122 runs: vec![(0..label.len(), highlight_id)],
123 filter_range: 0..label.len(),
124 })
125 }
126
127 async fn label_for_symbol(
128 &self,
129 name: &str,
130 kind: lsp::SymbolKind,
131 language: &Arc<language::Language>,
132 ) -> Option<language::CodeLabel> {
133 let (text, filter_range, display_range) = match kind {
134 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
135 let text = format!("def {}():\n", name);
136 let filter_range = 4..4 + name.len();
137 let display_range = 0..filter_range.end;
138 (text, filter_range, display_range)
139 }
140 lsp::SymbolKind::CLASS => {
141 let text = format!("class {}:", name);
142 let filter_range = 6..6 + name.len();
143 let display_range = 0..filter_range.end;
144 (text, filter_range, display_range)
145 }
146 lsp::SymbolKind::CONSTANT => {
147 let text = format!("{} = 0", name);
148 let filter_range = 0..name.len();
149 let display_range = 0..filter_range.end;
150 (text, filter_range, display_range)
151 }
152 _ => return None,
153 };
154
155 Some(language::CodeLabel {
156 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
157 text: text[display_range].to_string(),
158 filter_range,
159 })
160 }
161}
162
163async fn get_cached_server_binary(
164 container_dir: PathBuf,
165 node: &NodeRuntime,
166) -> Option<LanguageServerBinary> {
167 (|| async move {
168 let mut last_version_dir = None;
169 let mut entries = fs::read_dir(&container_dir).await?;
170 while let Some(entry) = entries.next().await {
171 let entry = entry?;
172 if entry.file_type().await?.is_dir() {
173 last_version_dir = Some(entry.path());
174 }
175 }
176 let last_version_dir = last_version_dir.ok_or_else(|| anyhow!("no cached binary"))?;
177 let server_path = last_version_dir.join(SERVER_PATH);
178 if server_path.exists() {
179 Ok(LanguageServerBinary {
180 path: node.binary_path().await?,
181 arguments: server_binary_arguments(&server_path),
182 })
183 } else {
184 Err(anyhow!(
185 "missing executable in directory {:?}",
186 last_version_dir
187 ))
188 }
189 })()
190 .await
191 .log_err()
192}
193
194#[cfg(test)]
195mod tests {
196 use gpui::{ModelContext, TestAppContext};
197 use language::{language_settings::AllLanguageSettings, AutoindentMode, Buffer};
198 use settings::SettingsStore;
199 use std::num::NonZeroU32;
200
201 #[gpui::test]
202 async fn test_python_autoindent(cx: &mut TestAppContext) {
203 cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
204 let language =
205 crate::languages::language("python", tree_sitter_python::language(), None).await;
206 cx.update(|cx| {
207 cx.set_global(SettingsStore::test(cx));
208 language::init(cx);
209 cx.update_global::<SettingsStore, _, _>(|store, cx| {
210 store.update_user_settings::<AllLanguageSettings>(cx, |s| {
211 s.defaults.tab_size = NonZeroU32::new(2);
212 });
213 });
214 });
215
216 cx.add_model(|cx| {
217 let mut buffer = Buffer::new(0, cx.model_id() as u64, "").with_language(language, cx);
218 let append = |buffer: &mut Buffer, text: &str, cx: &mut ModelContext<Buffer>| {
219 let ix = buffer.len();
220 buffer.edit([(ix..ix, text)], Some(AutoindentMode::EachLine), cx);
221 };
222
223 // indent after "def():"
224 append(&mut buffer, "def a():\n", cx);
225 assert_eq!(buffer.text(), "def a():\n ");
226
227 // preserve indent after blank line
228 append(&mut buffer, "\n ", cx);
229 assert_eq!(buffer.text(), "def a():\n \n ");
230
231 // indent after "if"
232 append(&mut buffer, "if a:\n ", cx);
233 assert_eq!(buffer.text(), "def a():\n \n if a:\n ");
234
235 // preserve indent after statement
236 append(&mut buffer, "b()\n", cx);
237 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n ");
238
239 // preserve indent after statement
240 append(&mut buffer, "else", cx);
241 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else");
242
243 // dedent "else""
244 append(&mut buffer, ":", cx);
245 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else:");
246
247 // indent lines after else
248 append(&mut buffer, "\n", cx);
249 assert_eq!(
250 buffer.text(),
251 "def a():\n \n if a:\n b()\n else:\n "
252 );
253
254 // indent after an open paren. the closing paren is not indented
255 // because there is another token before it on the same line.
256 append(&mut buffer, "foo(\n1)", cx);
257 assert_eq!(
258 buffer.text(),
259 "def a():\n \n if a:\n b()\n else:\n foo(\n 1)"
260 );
261
262 // dedent the closing paren if it is shifted to the beginning of the line
263 let argument_ix = buffer.text().find('1').unwrap();
264 buffer.edit(
265 [(argument_ix..argument_ix + 1, "")],
266 Some(AutoindentMode::EachLine),
267 cx,
268 );
269 assert_eq!(
270 buffer.text(),
271 "def a():\n \n if a:\n b()\n else:\n foo(\n )"
272 );
273
274 // preserve indent after the close paren
275 append(&mut buffer, "\n", cx);
276 assert_eq!(
277 buffer.text(),
278 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n "
279 );
280
281 // manually outdent the last line
282 let end_whitespace_ix = buffer.len() - 4;
283 buffer.edit(
284 [(end_whitespace_ix..buffer.len(), "")],
285 Some(AutoindentMode::EachLine),
286 cx,
287 );
288 assert_eq!(
289 buffer.text(),
290 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n"
291 );
292
293 // preserve the newly reduced indentation on the next newline
294 append(&mut buffer, "\n", cx);
295 assert_eq!(
296 buffer.text(),
297 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n\n"
298 );
299
300 // reset to a simple if statement
301 buffer.edit([(0..buffer.len(), "if a:\n b(\n )")], None, cx);
302
303 // dedent "else" on the line after a closing paren
304 append(&mut buffer, "\n else:\n", cx);
305 assert_eq!(buffer.text(), "if a:\n b(\n )\nelse:\n ");
306
307 buffer
308 });
309 }
310}