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