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