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_completions(&self, items: &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 for item in items {
98 let Some(sort_text) = &mut item.sort_text else {
99 continue;
100 };
101 let mut parts = sort_text.split('.');
102 let Some(first) = parts.next() else { continue };
103 let Some(second) = parts.next() else { continue };
104 let Some(_) = parts.next() else { continue };
105 sort_text.replace_range(first.len() + second.len() + 1.., "");
106 }
107 }
108
109 async fn label_for_completion(
110 &self,
111 item: &lsp::CompletionItem,
112 language: &Arc<language::Language>,
113 ) -> Option<language::CodeLabel> {
114 let label = &item.label;
115 let grammar = language.grammar()?;
116 let highlight_id = match item.kind? {
117 lsp::CompletionItemKind::METHOD => grammar.highlight_id_for_name("function.method")?,
118 lsp::CompletionItemKind::FUNCTION => grammar.highlight_id_for_name("function")?,
119 lsp::CompletionItemKind::CLASS => grammar.highlight_id_for_name("type")?,
120 lsp::CompletionItemKind::CONSTANT => grammar.highlight_id_for_name("constant")?,
121 _ => return None,
122 };
123 Some(language::CodeLabel {
124 text: label.clone(),
125 runs: vec![(0..label.len(), highlight_id)],
126 filter_range: 0..label.len(),
127 })
128 }
129
130 async fn label_for_symbol(
131 &self,
132 name: &str,
133 kind: lsp::SymbolKind,
134 language: &Arc<language::Language>,
135 ) -> Option<language::CodeLabel> {
136 let (text, filter_range, display_range) = match kind {
137 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
138 let text = format!("def {}():\n", name);
139 let filter_range = 4..4 + name.len();
140 let display_range = 0..filter_range.end;
141 (text, filter_range, display_range)
142 }
143 lsp::SymbolKind::CLASS => {
144 let text = format!("class {}:", name);
145 let filter_range = 6..6 + name.len();
146 let display_range = 0..filter_range.end;
147 (text, filter_range, display_range)
148 }
149 lsp::SymbolKind::CONSTANT => {
150 let text = format!("{} = 0", name);
151 let filter_range = 0..name.len();
152 let display_range = 0..filter_range.end;
153 (text, filter_range, display_range)
154 }
155 _ => return None,
156 };
157
158 Some(language::CodeLabel {
159 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
160 text: text[display_range].to_string(),
161 filter_range,
162 })
163 }
164}
165
166async fn get_cached_server_binary(
167 container_dir: PathBuf,
168 node: &dyn NodeRuntime,
169) -> Option<LanguageServerBinary> {
170 let server_path = container_dir.join(SERVER_PATH);
171 if server_path.exists() {
172 Some(LanguageServerBinary {
173 path: node.binary_path().await.log_err()?,
174 env: None,
175 arguments: server_binary_arguments(&server_path),
176 })
177 } else {
178 log::error!("missing executable in directory {:?}", server_path);
179 None
180 }
181}
182
183#[cfg(test)]
184mod tests {
185 use gpui::{BorrowAppContext, Context, ModelContext, TestAppContext};
186 use language::{language_settings::AllLanguageSettings, AutoindentMode, Buffer};
187 use settings::SettingsStore;
188 use std::num::NonZeroU32;
189
190 #[gpui::test]
191 async fn test_python_autoindent(cx: &mut TestAppContext) {
192 cx.executor().set_block_on_ticks(usize::MAX..=usize::MAX);
193 let language = crate::language("python", tree_sitter_python::language());
194 cx.update(|cx| {
195 let test_settings = SettingsStore::test(cx);
196 cx.set_global(test_settings);
197 language::init(cx);
198 cx.update_global::<SettingsStore, _>(|store, cx| {
199 store.update_user_settings::<AllLanguageSettings>(cx, |s| {
200 s.defaults.tab_size = NonZeroU32::new(2);
201 });
202 });
203 });
204
205 cx.new_model(|cx| {
206 let mut buffer = Buffer::local("", cx).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}