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