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