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 label_for_completion(
91 &self,
92 item: &lsp::CompletionItem,
93 language: &language::Language,
94 ) -> Option<language::CodeLabel> {
95 let label = &item.label;
96 let grammar = language.grammar()?;
97 let highlight_id = match item.kind? {
98 lsp::CompletionItemKind::METHOD => grammar.highlight_id_for_name("function.method")?,
99 lsp::CompletionItemKind::FUNCTION => grammar.highlight_id_for_name("function")?,
100 lsp::CompletionItemKind::CLASS => grammar.highlight_id_for_name("type")?,
101 lsp::CompletionItemKind::CONSTANT => grammar.highlight_id_for_name("constant")?,
102 _ => return None,
103 };
104 Some(language::CodeLabel {
105 text: label.clone(),
106 runs: vec![(0..label.len(), highlight_id)],
107 filter_range: 0..label.len(),
108 })
109 }
110
111 async fn label_for_symbol(
112 &self,
113 name: &str,
114 kind: lsp::SymbolKind,
115 language: &language::Language,
116 ) -> Option<language::CodeLabel> {
117 let (text, filter_range, display_range) = match kind {
118 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
119 let text = format!("def {}():\n", name);
120 let filter_range = 4..4 + name.len();
121 let display_range = 0..filter_range.end;
122 (text, filter_range, display_range)
123 }
124 lsp::SymbolKind::CLASS => {
125 let text = format!("class {}:", name);
126 let filter_range = 6..6 + name.len();
127 let display_range = 0..filter_range.end;
128 (text, filter_range, display_range)
129 }
130 lsp::SymbolKind::CONSTANT => {
131 let text = format!("{} = 0", name);
132 let filter_range = 0..name.len();
133 let display_range = 0..filter_range.end;
134 (text, filter_range, display_range)
135 }
136 _ => return None,
137 };
138
139 Some(language::CodeLabel {
140 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
141 text: text[display_range].to_string(),
142 filter_range,
143 })
144 }
145}
146
147#[cfg(test)]
148mod tests {
149 use gpui::{ModelContext, MutableAppContext};
150 use language::{AutoindentMode, Buffer};
151 use settings::Settings;
152 use std::sync::Arc;
153
154 #[gpui::test]
155 fn test_python_autoindent(cx: &mut MutableAppContext) {
156 cx.foreground().set_block_on_ticks(usize::MAX..=usize::MAX);
157 let language = crate::languages::language("python", tree_sitter_python::language(), None);
158 let mut settings = Settings::test(cx);
159 settings.editor_overrides.tab_size = Some(2.try_into().unwrap());
160 cx.set_global(settings);
161
162 cx.add_model(|cx| {
163 let mut buffer = Buffer::new(0, "", cx).with_language(Arc::new(language), cx);
164 let append = |buffer: &mut Buffer, text: &str, cx: &mut ModelContext<Buffer>| {
165 let ix = buffer.len();
166 buffer.edit([(ix..ix, text)], Some(AutoindentMode::EachLine), cx);
167 };
168
169 // indent after "def():"
170 append(&mut buffer, "def a():\n", cx);
171 assert_eq!(buffer.text(), "def a():\n ");
172
173 // preserve indent after blank line
174 append(&mut buffer, "\n ", cx);
175 assert_eq!(buffer.text(), "def a():\n \n ");
176
177 // indent after "if"
178 append(&mut buffer, "if a:\n ", cx);
179 assert_eq!(buffer.text(), "def a():\n \n if a:\n ");
180
181 // preserve indent after statement
182 append(&mut buffer, "b()\n", cx);
183 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n ");
184
185 // preserve indent after statement
186 append(&mut buffer, "else", cx);
187 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else");
188
189 // dedent "else""
190 append(&mut buffer, ":", cx);
191 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else:");
192
193 // indent lines after else
194 append(&mut buffer, "\n", cx);
195 assert_eq!(
196 buffer.text(),
197 "def a():\n \n if a:\n b()\n else:\n "
198 );
199
200 // indent after an open paren. the closing paren is not indented
201 // because there is another token before it on the same line.
202 append(&mut buffer, "foo(\n1)", cx);
203 assert_eq!(
204 buffer.text(),
205 "def a():\n \n if a:\n b()\n else:\n foo(\n 1)"
206 );
207
208 // dedent the closing paren if it is shifted to the beginning of the line
209 let argument_ix = buffer.text().find('1').unwrap();
210 buffer.edit(
211 [(argument_ix..argument_ix + 1, "")],
212 Some(AutoindentMode::EachLine),
213 cx,
214 );
215 assert_eq!(
216 buffer.text(),
217 "def a():\n \n if a:\n b()\n else:\n foo(\n )"
218 );
219
220 // preserve indent after the close paren
221 append(&mut buffer, "\n", cx);
222 assert_eq!(
223 buffer.text(),
224 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n "
225 );
226
227 // manually outdent the last line
228 let end_whitespace_ix = buffer.len() - 4;
229 buffer.edit(
230 [(end_whitespace_ix..buffer.len(), "")],
231 Some(AutoindentMode::EachLine),
232 cx,
233 );
234 assert_eq!(
235 buffer.text(),
236 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n"
237 );
238
239 // preserve the newly reduced indentation on the next newline
240 append(&mut buffer, "\n", cx);
241 assert_eq!(
242 buffer.text(),
243 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n\n"
244 );
245
246 // reset to a simple if statement
247 buffer.edit([(0..buffer.len(), "if a:\n b(\n )")], None, cx);
248
249 // dedent "else" on the line after a closing paren
250 append(&mut buffer, "\n else:\n", cx);
251 assert_eq!(buffer.text(), "if a:\n b(\n )\nelse:\n ");
252
253 buffer
254 });
255 }
256}