1use super::installation::{npm_install_packages, npm_package_latest_version};
2use anyhow::{anyhow, Context, Result};
3use async_trait::async_trait;
4use client::http::HttpClient;
5use futures::StreamExt;
6use language::{LanguageServerName, LspAdapter};
7use smol::fs;
8use std::{any::Any, path::PathBuf, sync::Arc};
9use util::ResultExt;
10
11pub struct PythonLspAdapter;
12
13impl PythonLspAdapter {
14 const BIN_PATH: &'static str = "node_modules/pyright/langserver.index.js";
15}
16
17#[async_trait]
18impl LspAdapter for PythonLspAdapter {
19 async fn name(&self) -> LanguageServerName {
20 LanguageServerName("pyright".into())
21 }
22
23 async fn server_args(&self) -> Vec<String> {
24 vec!["--stdio".into()]
25 }
26
27 async fn fetch_latest_server_version(
28 &self,
29 _: Arc<dyn HttpClient>,
30 ) -> Result<Box<dyn 'static + Any + Send>> {
31 Ok(Box::new(npm_package_latest_version("pyright").await?) as Box<_>)
32 }
33
34 async fn fetch_server_binary(
35 &self,
36 version: Box<dyn 'static + Send + Any>,
37 _: Arc<dyn HttpClient>,
38 container_dir: PathBuf,
39 ) -> Result<PathBuf> {
40 let version = version.downcast::<String>().unwrap();
41 let version_dir = container_dir.join(version.as_str());
42 fs::create_dir_all(&version_dir)
43 .await
44 .context("failed to create version directory")?;
45 let binary_path = version_dir.join(Self::BIN_PATH);
46
47 if fs::metadata(&binary_path).await.is_err() {
48 npm_install_packages([("pyright", version.as_str())], &version_dir).await?;
49
50 if let Some(mut entries) = fs::read_dir(&container_dir).await.log_err() {
51 while let Some(entry) = entries.next().await {
52 if let Some(entry) = entry.log_err() {
53 let entry_path = entry.path();
54 if entry_path.as_path() != version_dir {
55 fs::remove_dir_all(&entry_path).await.log_err();
56 }
57 }
58 }
59 }
60 }
61
62 Ok(binary_path)
63 }
64
65 async fn cached_server_binary(&self, container_dir: PathBuf) -> Option<PathBuf> {
66 (|| async move {
67 let mut last_version_dir = None;
68 let mut entries = fs::read_dir(&container_dir).await?;
69 while let Some(entry) = entries.next().await {
70 let entry = entry?;
71 if entry.file_type().await?.is_dir() {
72 last_version_dir = Some(entry.path());
73 }
74 }
75 let last_version_dir = last_version_dir.ok_or_else(|| anyhow!("no cached binary"))?;
76 let bin_path = last_version_dir.join(Self::BIN_PATH);
77 if bin_path.exists() {
78 Ok(bin_path)
79 } else {
80 Err(anyhow!(
81 "missing executable in directory {:?}",
82 last_version_dir
83 ))
84 }
85 })()
86 .await
87 .log_err()
88 }
89
90 async fn process_completion(&self, item: &mut lsp::CompletionItem) {
91 // Pyright assigns each completion item a `sortText` of the form `XX.YYYY.name`.
92 // Where `XX` is the sorting category, `YYYY` is based on most recent usage,
93 // and `name` is the symbol name itself.
94 //
95 // Because the the symbol name is included, there generally are not ties when
96 // sorting by the `sortText`, so the symbol's fuzzy match score is not taken
97 // into account. Here, we remove the symbol name from the sortText in order
98 // to allow our own fuzzy score to be used to break ties.
99 //
100 // see https://github.com/microsoft/pyright/blob/95ef4e103b9b2f129c9320427e51b73ea7cf78bd/packages/pyright-internal/src/languageService/completionProvider.ts#LL2873
101 let Some(sort_text) = &mut item.sort_text else { return };
102 let mut parts = sort_text.split('.');
103 let Some(first) = parts.next() else { return };
104 let Some(second) = parts.next() else { return };
105 let Some(_) = parts.next() else { return };
106 sort_text.replace_range(first.len() + second.len() + 1.., "");
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
166#[cfg(test)]
167mod tests {
168 use gpui::{ModelContext, MutableAppContext};
169 use language::{AutoindentMode, Buffer};
170 use settings::Settings;
171
172 #[gpui::test]
173 fn test_python_autoindent(cx: &mut MutableAppContext) {
174 cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
175 let language = crate::languages::language("python", tree_sitter_python::language(), None);
176 let mut settings = Settings::test(cx);
177 settings.editor_overrides.tab_size = Some(2.try_into().unwrap());
178 cx.set_global(settings);
179
180 cx.add_model(|cx| {
181 let mut buffer = Buffer::new(0, "", cx).with_language(language, cx);
182 let append = |buffer: &mut Buffer, text: &str, cx: &mut ModelContext<Buffer>| {
183 let ix = buffer.len();
184 buffer.edit([(ix..ix, text)], Some(AutoindentMode::EachLine), cx);
185 };
186
187 // indent after "def():"
188 append(&mut buffer, "def a():\n", cx);
189 assert_eq!(buffer.text(), "def a():\n ");
190
191 // preserve indent after blank line
192 append(&mut buffer, "\n ", cx);
193 assert_eq!(buffer.text(), "def a():\n \n ");
194
195 // indent after "if"
196 append(&mut buffer, "if a:\n ", cx);
197 assert_eq!(buffer.text(), "def a():\n \n if a:\n ");
198
199 // preserve indent after statement
200 append(&mut buffer, "b()\n", cx);
201 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n ");
202
203 // preserve indent after statement
204 append(&mut buffer, "else", cx);
205 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else");
206
207 // dedent "else""
208 append(&mut buffer, ":", cx);
209 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else:");
210
211 // indent lines after else
212 append(&mut buffer, "\n", cx);
213 assert_eq!(
214 buffer.text(),
215 "def a():\n \n if a:\n b()\n else:\n "
216 );
217
218 // indent after an open paren. the closing paren is not indented
219 // because there is another token before it on the same line.
220 append(&mut buffer, "foo(\n1)", cx);
221 assert_eq!(
222 buffer.text(),
223 "def a():\n \n if a:\n b()\n else:\n foo(\n 1)"
224 );
225
226 // dedent the closing paren if it is shifted to the beginning of the line
227 let argument_ix = buffer.text().find('1').unwrap();
228 buffer.edit(
229 [(argument_ix..argument_ix + 1, "")],
230 Some(AutoindentMode::EachLine),
231 cx,
232 );
233 assert_eq!(
234 buffer.text(),
235 "def a():\n \n if a:\n b()\n else:\n foo(\n )"
236 );
237
238 // preserve indent after the close paren
239 append(&mut buffer, "\n", cx);
240 assert_eq!(
241 buffer.text(),
242 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n "
243 );
244
245 // manually outdent the last line
246 let end_whitespace_ix = buffer.len() - 4;
247 buffer.edit(
248 [(end_whitespace_ix..buffer.len(), "")],
249 Some(AutoindentMode::EachLine),
250 cx,
251 );
252 assert_eq!(
253 buffer.text(),
254 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n"
255 );
256
257 // preserve the newly reduced indentation on the next newline
258 append(&mut buffer, "\n", cx);
259 assert_eq!(
260 buffer.text(),
261 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n\n"
262 );
263
264 // reset to a simple if statement
265 buffer.edit([(0..buffer.len(), "if a:\n b(\n )")], None, cx);
266
267 // dedent "else" on the line after a closing paren
268 append(&mut buffer, "\n else:\n", cx);
269 assert_eq!(buffer.text(), "if a:\n b(\n )\nelse:\n ");
270
271 buffer
272 });
273 }
274}