1use anyhow::Result;
2use async_trait::async_trait;
3use language::{ContextProvider, LanguageServerName, LspAdapter, LspAdapterDelegate};
4use lsp::LanguageServerBinary;
5use node_runtime::NodeRuntime;
6use std::{
7 any::Any,
8 borrow::Cow,
9 ffi::OsString,
10 path::{Path, PathBuf},
11 sync::Arc,
12};
13use task::{TaskTemplate, TaskTemplates, VariableName};
14use util::ResultExt;
15
16const SERVER_PATH: &str = "node_modules/pyright/langserver.index.js";
17
18fn server_binary_arguments(server_path: &Path) -> Vec<OsString> {
19 vec![server_path.into(), "--stdio".into()]
20}
21
22pub struct PythonLspAdapter {
23 node: Arc<dyn NodeRuntime>,
24}
25
26impl PythonLspAdapter {
27 pub fn new(node: Arc<dyn NodeRuntime>) -> Self {
28 PythonLspAdapter { node }
29 }
30}
31
32#[async_trait(?Send)]
33impl LspAdapter for PythonLspAdapter {
34 fn name(&self) -> LanguageServerName {
35 LanguageServerName("pyright".into())
36 }
37
38 async fn fetch_latest_server_version(
39 &self,
40 _: &dyn LspAdapterDelegate,
41 ) -> Result<Box<dyn 'static + Any + Send>> {
42 Ok(Box::new(self.node.npm_package_latest_version("pyright").await?) as Box<_>)
43 }
44
45 async fn fetch_server_binary(
46 &self,
47 latest_version: Box<dyn 'static + Send + Any>,
48 container_dir: PathBuf,
49 _: &dyn LspAdapterDelegate,
50 ) -> Result<LanguageServerBinary> {
51 let latest_version = latest_version.downcast::<String>().unwrap();
52 let server_path = container_dir.join(SERVER_PATH);
53 let package_name = "pyright";
54
55 let should_install_language_server = self
56 .node
57 .should_install_npm_package(package_name, &server_path, &container_dir, &latest_version)
58 .await;
59
60 if should_install_language_server {
61 self.node
62 .npm_install_packages(&container_dir, &[(package_name, latest_version.as_str())])
63 .await?;
64 }
65
66 Ok(LanguageServerBinary {
67 path: self.node.binary_path().await?,
68 env: None,
69 arguments: server_binary_arguments(&server_path),
70 })
71 }
72
73 async fn cached_server_binary(
74 &self,
75 container_dir: PathBuf,
76 _: &dyn LspAdapterDelegate,
77 ) -> Option<LanguageServerBinary> {
78 get_cached_server_binary(container_dir, &*self.node).await
79 }
80
81 async fn installation_test_binary(
82 &self,
83 container_dir: PathBuf,
84 ) -> Option<LanguageServerBinary> {
85 get_cached_server_binary(container_dir, &*self.node).await
86 }
87
88 async fn process_completions(&self, items: &mut [lsp::CompletionItem]) {
89 // Pyright assigns each completion item a `sortText` of the form `XX.YYYY.name`.
90 // Where `XX` is the sorting category, `YYYY` is based on most recent usage,
91 // and `name` is the symbol name itself.
92 //
93 // Because the symbol name is included, there generally are not ties when
94 // sorting by the `sortText`, so the symbol's fuzzy match score is not taken
95 // into account. Here, we remove the symbol name from the sortText in order
96 // to allow our own fuzzy score to be used to break ties.
97 //
98 // see https://github.com/microsoft/pyright/blob/95ef4e103b9b2f129c9320427e51b73ea7cf78bd/packages/pyright-internal/src/languageService/completionProvider.ts#LL2873
99 for item in items {
100 let Some(sort_text) = &mut item.sort_text else {
101 continue;
102 };
103 let mut parts = sort_text.split('.');
104 let Some(first) = parts.next() else { continue };
105 let Some(second) = parts.next() else { continue };
106 let Some(_) = parts.next() else { continue };
107 sort_text.replace_range(first.len() + second.len() + 1.., "");
108 }
109 }
110
111 async fn label_for_completion(
112 &self,
113 item: &lsp::CompletionItem,
114 language: &Arc<language::Language>,
115 ) -> Option<language::CodeLabel> {
116 let label = &item.label;
117 let grammar = language.grammar()?;
118 let highlight_id = match item.kind? {
119 lsp::CompletionItemKind::METHOD => grammar.highlight_id_for_name("function.method")?,
120 lsp::CompletionItemKind::FUNCTION => grammar.highlight_id_for_name("function")?,
121 lsp::CompletionItemKind::CLASS => grammar.highlight_id_for_name("type")?,
122 lsp::CompletionItemKind::CONSTANT => grammar.highlight_id_for_name("constant")?,
123 _ => return None,
124 };
125 Some(language::CodeLabel {
126 text: label.clone(),
127 runs: vec![(0..label.len(), highlight_id)],
128 filter_range: 0..label.len(),
129 })
130 }
131
132 async fn label_for_symbol(
133 &self,
134 name: &str,
135 kind: lsp::SymbolKind,
136 language: &Arc<language::Language>,
137 ) -> Option<language::CodeLabel> {
138 let (text, filter_range, display_range) = match kind {
139 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
140 let text = format!("def {}():\n", name);
141 let filter_range = 4..4 + name.len();
142 let display_range = 0..filter_range.end;
143 (text, filter_range, display_range)
144 }
145 lsp::SymbolKind::CLASS => {
146 let text = format!("class {}:", name);
147 let filter_range = 6..6 + name.len();
148 let display_range = 0..filter_range.end;
149 (text, filter_range, display_range)
150 }
151 lsp::SymbolKind::CONSTANT => {
152 let text = format!("{} = 0", name);
153 let filter_range = 0..name.len();
154 let display_range = 0..filter_range.end;
155 (text, filter_range, display_range)
156 }
157 _ => return None,
158 };
159
160 Some(language::CodeLabel {
161 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
162 text: text[display_range].to_string(),
163 filter_range,
164 })
165 }
166}
167
168async fn get_cached_server_binary(
169 container_dir: PathBuf,
170 node: &dyn NodeRuntime,
171) -> Option<LanguageServerBinary> {
172 let server_path = container_dir.join(SERVER_PATH);
173 if server_path.exists() {
174 Some(LanguageServerBinary {
175 path: node.binary_path().await.log_err()?,
176 env: None,
177 arguments: server_binary_arguments(&server_path),
178 })
179 } else {
180 log::error!("missing executable in directory {:?}", server_path);
181 None
182 }
183}
184
185pub(crate) struct PythonContextProvider;
186
187const PYTHON_UNITTEST_TARGET_TASK_VARIABLE: VariableName =
188 VariableName::Custom(Cow::Borrowed("PYTHON_UNITTEST_TARGET"));
189
190impl ContextProvider for PythonContextProvider {
191 fn build_context(
192 &self,
193 variables: &task::TaskVariables,
194 _location: &project::Location,
195 _cx: &mut gpui::AppContext,
196 ) -> Result<task::TaskVariables> {
197 let python_module_name = python_module_name_from_relative_path(
198 variables.get(&VariableName::RelativeFile).unwrap_or(""),
199 );
200 let unittest_class_name =
201 variables.get(&VariableName::Custom(Cow::Borrowed("_unittest_class_name")));
202 let unittest_method_name = variables.get(&VariableName::Custom(Cow::Borrowed(
203 "_unittest_method_name",
204 )));
205
206 let unittest_target_str = match (unittest_class_name, unittest_method_name) {
207 (Some(class_name), Some(method_name)) => {
208 format!("{}.{}.{}", python_module_name, class_name, method_name)
209 }
210 (Some(class_name), None) => format!("{}.{}", python_module_name, class_name),
211 (None, None) => python_module_name,
212 (None, Some(_)) => return Ok(task::TaskVariables::default()), // should never happen, a TestCase class is the unit of testing
213 };
214
215 let unittest_target = (
216 PYTHON_UNITTEST_TARGET_TASK_VARIABLE.clone(),
217 unittest_target_str,
218 );
219
220 Ok(task::TaskVariables::from_iter([unittest_target]))
221 }
222
223 fn associated_tasks(&self) -> Option<TaskTemplates> {
224 Some(TaskTemplates(vec![
225 TaskTemplate {
226 label: "execute selection".to_owned(),
227 command: "python3".to_owned(),
228 args: vec!["-c".to_owned(), VariableName::SelectedText.template_value()],
229 ..TaskTemplate::default()
230 },
231 TaskTemplate {
232 label: format!("run '{}'", VariableName::File.template_value()),
233 command: "python3".to_owned(),
234 args: vec![VariableName::File.template_value()],
235 ..TaskTemplate::default()
236 },
237 TaskTemplate {
238 label: format!("unittest '{}'", VariableName::File.template_value()),
239 command: "python3".to_owned(),
240 args: vec![
241 "-m".to_owned(),
242 "unittest".to_owned(),
243 VariableName::File.template_value(),
244 ],
245 ..TaskTemplate::default()
246 },
247 TaskTemplate {
248 label: "unittest $ZED_CUSTOM_PYTHON_UNITTEST_TARGET".to_owned(),
249 command: "python3".to_owned(),
250 args: vec![
251 "-m".to_owned(),
252 "unittest".to_owned(),
253 "$ZED_CUSTOM_PYTHON_UNITTEST_TARGET".to_owned(),
254 ],
255 tags: vec![
256 "python-unittest-class".to_owned(),
257 "python-unittest-method".to_owned(),
258 ],
259 ..TaskTemplate::default()
260 },
261 ]))
262 }
263}
264
265fn python_module_name_from_relative_path(relative_path: &str) -> String {
266 let path_with_dots = relative_path.replace('/', ".");
267 path_with_dots
268 .strip_suffix(".py")
269 .unwrap_or(&path_with_dots)
270 .to_string()
271}
272
273#[cfg(test)]
274mod tests {
275 use gpui::{BorrowAppContext, Context, ModelContext, TestAppContext};
276 use language::{language_settings::AllLanguageSettings, AutoindentMode, Buffer};
277 use settings::SettingsStore;
278 use std::num::NonZeroU32;
279
280 #[gpui::test]
281 async fn test_python_autoindent(cx: &mut TestAppContext) {
282 cx.executor().set_block_on_ticks(usize::MAX..=usize::MAX);
283 let language = crate::language("python", tree_sitter_python::language());
284 cx.update(|cx| {
285 let test_settings = SettingsStore::test(cx);
286 cx.set_global(test_settings);
287 language::init(cx);
288 cx.update_global::<SettingsStore, _>(|store, cx| {
289 store.update_user_settings::<AllLanguageSettings>(cx, |s| {
290 s.defaults.tab_size = NonZeroU32::new(2);
291 });
292 });
293 });
294
295 cx.new_model(|cx| {
296 let mut buffer = Buffer::local("", cx).with_language(language, cx);
297 let append = |buffer: &mut Buffer, text: &str, cx: &mut ModelContext<Buffer>| {
298 let ix = buffer.len();
299 buffer.edit([(ix..ix, text)], Some(AutoindentMode::EachLine), cx);
300 };
301
302 // indent after "def():"
303 append(&mut buffer, "def a():\n", cx);
304 assert_eq!(buffer.text(), "def a():\n ");
305
306 // preserve indent after blank line
307 append(&mut buffer, "\n ", cx);
308 assert_eq!(buffer.text(), "def a():\n \n ");
309
310 // indent after "if"
311 append(&mut buffer, "if a:\n ", cx);
312 assert_eq!(buffer.text(), "def a():\n \n if a:\n ");
313
314 // preserve indent after statement
315 append(&mut buffer, "b()\n", cx);
316 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n ");
317
318 // preserve indent after statement
319 append(&mut buffer, "else", cx);
320 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else");
321
322 // dedent "else""
323 append(&mut buffer, ":", cx);
324 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else:");
325
326 // indent lines after else
327 append(&mut buffer, "\n", cx);
328 assert_eq!(
329 buffer.text(),
330 "def a():\n \n if a:\n b()\n else:\n "
331 );
332
333 // indent after an open paren. the closing paren is not indented
334 // because there is another token before it on the same line.
335 append(&mut buffer, "foo(\n1)", cx);
336 assert_eq!(
337 buffer.text(),
338 "def a():\n \n if a:\n b()\n else:\n foo(\n 1)"
339 );
340
341 // dedent the closing paren if it is shifted to the beginning of the line
342 let argument_ix = buffer.text().find('1').unwrap();
343 buffer.edit(
344 [(argument_ix..argument_ix + 1, "")],
345 Some(AutoindentMode::EachLine),
346 cx,
347 );
348 assert_eq!(
349 buffer.text(),
350 "def a():\n \n if a:\n b()\n else:\n foo(\n )"
351 );
352
353 // preserve indent after the close paren
354 append(&mut buffer, "\n", cx);
355 assert_eq!(
356 buffer.text(),
357 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n "
358 );
359
360 // manually outdent the last line
361 let end_whitespace_ix = buffer.len() - 4;
362 buffer.edit(
363 [(end_whitespace_ix..buffer.len(), "")],
364 Some(AutoindentMode::EachLine),
365 cx,
366 );
367 assert_eq!(
368 buffer.text(),
369 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n"
370 );
371
372 // preserve the newly reduced indentation on the next newline
373 append(&mut buffer, "\n", cx);
374 assert_eq!(
375 buffer.text(),
376 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n\n"
377 );
378
379 // reset to a simple if statement
380 buffer.edit([(0..buffer.len(), "if a:\n b(\n )")], None, cx);
381
382 // dedent "else" on the line after a closing paren
383 append(&mut buffer, "\n else:\n", cx);
384 assert_eq!(buffer.text(), "if a:\n b(\n )\nelse:\n ");
385
386 buffer
387 });
388 }
389}