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 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 env: None,
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: &dyn NodeRuntime,
166) -> Option<LanguageServerBinary> {
167 let server_path = container_dir.join(SERVER_PATH);
168 if server_path.exists() {
169 Some(LanguageServerBinary {
170 path: node.binary_path().await.log_err()?,
171 env: None,
172 arguments: server_binary_arguments(&server_path),
173 })
174 } else {
175 log::error!("missing executable in directory {:?}", server_path);
176 None
177 }
178}
179
180#[cfg(test)]
181mod tests {
182 use gpui::{Context, ModelContext, TestAppContext};
183 use language::{language_settings::AllLanguageSettings, AutoindentMode, Buffer};
184 use settings::SettingsStore;
185 use std::num::NonZeroU32;
186 use text::BufferId;
187
188 #[gpui::test]
189 async fn test_python_autoindent(cx: &mut TestAppContext) {
190 cx.executor().set_block_on_ticks(usize::MAX..=usize::MAX);
191 let language = crate::language("python", tree_sitter_python::language(), None).await;
192 cx.update(|cx| {
193 let test_settings = SettingsStore::test(cx);
194 cx.set_global(test_settings);
195 language::init(cx);
196 cx.update_global::<SettingsStore, _>(|store, cx| {
197 store.update_user_settings::<AllLanguageSettings>(cx, |s| {
198 s.defaults.tab_size = NonZeroU32::new(2);
199 });
200 });
201 });
202
203 cx.new_model(|cx| {
204 let mut buffer = Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), "")
205 .with_language(language, cx);
206 let append = |buffer: &mut Buffer, text: &str, cx: &mut ModelContext<Buffer>| {
207 let ix = buffer.len();
208 buffer.edit([(ix..ix, text)], Some(AutoindentMode::EachLine), cx);
209 };
210
211 // indent after "def():"
212 append(&mut buffer, "def a():\n", cx);
213 assert_eq!(buffer.text(), "def a():\n ");
214
215 // preserve indent after blank line
216 append(&mut buffer, "\n ", cx);
217 assert_eq!(buffer.text(), "def a():\n \n ");
218
219 // indent after "if"
220 append(&mut buffer, "if a:\n ", cx);
221 assert_eq!(buffer.text(), "def a():\n \n if a:\n ");
222
223 // preserve indent after statement
224 append(&mut buffer, "b()\n", cx);
225 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n ");
226
227 // preserve indent after statement
228 append(&mut buffer, "else", cx);
229 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else");
230
231 // dedent "else""
232 append(&mut buffer, ":", cx);
233 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else:");
234
235 // indent lines after else
236 append(&mut buffer, "\n", cx);
237 assert_eq!(
238 buffer.text(),
239 "def a():\n \n if a:\n b()\n else:\n "
240 );
241
242 // indent after an open paren. the closing paren is not indented
243 // because there is another token before it on the same line.
244 append(&mut buffer, "foo(\n1)", cx);
245 assert_eq!(
246 buffer.text(),
247 "def a():\n \n if a:\n b()\n else:\n foo(\n 1)"
248 );
249
250 // dedent the closing paren if it is shifted to the beginning of the line
251 let argument_ix = buffer.text().find('1').unwrap();
252 buffer.edit(
253 [(argument_ix..argument_ix + 1, "")],
254 Some(AutoindentMode::EachLine),
255 cx,
256 );
257 assert_eq!(
258 buffer.text(),
259 "def a():\n \n if a:\n b()\n else:\n foo(\n )"
260 );
261
262 // preserve indent after the close paren
263 append(&mut buffer, "\n", cx);
264 assert_eq!(
265 buffer.text(),
266 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n "
267 );
268
269 // manually outdent the last line
270 let end_whitespace_ix = buffer.len() - 4;
271 buffer.edit(
272 [(end_whitespace_ix..buffer.len(), "")],
273 Some(AutoindentMode::EachLine),
274 cx,
275 );
276 assert_eq!(
277 buffer.text(),
278 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n"
279 );
280
281 // preserve the newly reduced indentation on the next newline
282 append(&mut buffer, "\n", cx);
283 assert_eq!(
284 buffer.text(),
285 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n\n"
286 );
287
288 // reset to a simple if statement
289 buffer.edit([(0..buffer.len(), "if a:\n b(\n )")], None, cx);
290
291 // dedent "else" on the line after a closing paren
292 append(&mut buffer, "\n else:\n", cx);
293 assert_eq!(buffer.text(), "if a:\n b(\n )\nelse:\n ");
294
295 buffer
296 });
297 }
298}