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