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