1use anyhow::{Context as _, ensure};
2use anyhow::{Result, anyhow};
3use async_trait::async_trait;
4use collections::HashMap;
5use futures::{AsyncBufReadExt, StreamExt as _};
6use gpui::{App, AsyncApp, SharedString, Task};
7use http_client::github::{AssetKind, GitHubLspBinaryVersion, latest_github_release};
8use language::language_settings::language_settings;
9use language::{ContextLocation, LanguageToolchainStore, LspInstaller};
10use language::{ContextProvider, LspAdapter, LspAdapterDelegate};
11use language::{LanguageName, ManifestName, ManifestProvider, ManifestQuery};
12use language::{Toolchain, ToolchainList, ToolchainLister, ToolchainMetadata};
13use lsp::LanguageServerBinary;
14use lsp::LanguageServerName;
15use node_runtime::{NodeRuntime, VersionStrategy};
16use pet_core::Configuration;
17use pet_core::os_environment::Environment;
18use pet_core::python_environment::{PythonEnvironment, PythonEnvironmentKind};
19use pet_virtualenv::is_virtualenv_dir;
20use project::Fs;
21use project::lsp_store::language_server_settings;
22use serde_json::{Value, json};
23use smol::lock::OnceCell;
24use std::cmp::Ordering;
25use std::env::consts;
26use util::fs::{make_file_executable, remove_matching};
27use util::rel_path::RelPath;
28
29use http_client::github_download::{GithubBinaryMetadata, download_server_binary};
30use parking_lot::Mutex;
31use std::str::FromStr;
32use std::{
33 borrow::Cow,
34 fmt::Write,
35 path::{Path, PathBuf},
36 sync::Arc,
37};
38use task::{ShellKind, TaskTemplate, TaskTemplates, VariableName};
39use util::{ResultExt, maybe};
40
41pub(crate) struct PyprojectTomlManifestProvider;
42
43impl ManifestProvider for PyprojectTomlManifestProvider {
44 fn name(&self) -> ManifestName {
45 SharedString::new_static("pyproject.toml").into()
46 }
47
48 fn search(
49 &self,
50 ManifestQuery {
51 path,
52 depth,
53 delegate,
54 }: ManifestQuery,
55 ) -> Option<Arc<RelPath>> {
56 for path in path.ancestors().take(depth) {
57 let p = path.join(RelPath::unix("pyproject.toml").unwrap());
58 if delegate.exists(&p, Some(false)) {
59 return Some(path.into());
60 }
61 }
62
63 None
64 }
65}
66
67enum TestRunner {
68 UNITTEST,
69 PYTEST,
70}
71
72impl FromStr for TestRunner {
73 type Err = ();
74
75 fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
76 match s {
77 "unittest" => Ok(Self::UNITTEST),
78 "pytest" => Ok(Self::PYTEST),
79 _ => Err(()),
80 }
81 }
82}
83
84/// Pyright assigns each completion item a `sortText` of the form `XX.YYYY.name`.
85/// Where `XX` is the sorting category, `YYYY` is based on most recent usage,
86/// and `name` is the symbol name itself.
87///
88/// The problem with it is that Pyright adjusts the sort text based on previous resolutions (items for which we've issued `completion/resolve` call have their sortText adjusted),
89/// which - long story short - makes completion items list non-stable. Pyright probably relies on VSCode's implementation detail.
90/// see https://github.com/microsoft/pyright/blob/95ef4e103b9b2f129c9320427e51b73ea7cf78bd/packages/pyright-internal/src/languageService/completionProvider.ts#LL2873
91fn process_pyright_completions(items: &mut [lsp::CompletionItem]) {
92 for item in items {
93 item.sort_text.take();
94 }
95}
96
97pub struct TyLspAdapter {
98 fs: Arc<dyn Fs>,
99}
100
101#[cfg(target_os = "macos")]
102impl TyLspAdapter {
103 const GITHUB_ASSET_KIND: AssetKind = AssetKind::TarGz;
104 const ARCH_SERVER_NAME: &str = "apple-darwin";
105}
106
107#[cfg(target_os = "linux")]
108impl TyLspAdapter {
109 const GITHUB_ASSET_KIND: AssetKind = AssetKind::TarGz;
110 const ARCH_SERVER_NAME: &str = "unknown-linux-gnu";
111}
112
113#[cfg(target_os = "freebsd")]
114impl TyLspAdapter {
115 const GITHUB_ASSET_KIND: AssetKind = AssetKind::TarGz;
116 const ARCH_SERVER_NAME: &str = "unknown-freebsd";
117}
118
119#[cfg(target_os = "windows")]
120impl TyLspAdapter {
121 const GITHUB_ASSET_KIND: AssetKind = AssetKind::Zip;
122 const ARCH_SERVER_NAME: &str = "pc-windows-msvc";
123}
124
125impl TyLspAdapter {
126 const SERVER_NAME: LanguageServerName = LanguageServerName::new_static("ty");
127
128 pub fn new(fs: Arc<dyn Fs>) -> TyLspAdapter {
129 TyLspAdapter { fs }
130 }
131
132 fn build_asset_name() -> Result<(String, String)> {
133 let arch = match consts::ARCH {
134 "x86" => "i686",
135 _ => consts::ARCH,
136 };
137 let os = Self::ARCH_SERVER_NAME;
138 let suffix = match consts::OS {
139 "windows" => "zip",
140 _ => "tar.gz",
141 };
142 let asset_name = format!("ty-{arch}-{os}.{suffix}");
143 let asset_stem = format!("ty-{arch}-{os}");
144 Ok((asset_stem, asset_name))
145 }
146}
147
148#[async_trait(?Send)]
149impl LspAdapter for TyLspAdapter {
150 fn name(&self) -> LanguageServerName {
151 Self::SERVER_NAME
152 }
153
154 async fn workspace_configuration(
155 self: Arc<Self>,
156 delegate: &Arc<dyn LspAdapterDelegate>,
157 toolchain: Option<Toolchain>,
158 cx: &mut AsyncApp,
159 ) -> Result<Value> {
160 let mut ret = cx
161 .update(|cx| {
162 language_server_settings(delegate.as_ref(), &self.name(), cx)
163 .and_then(|s| s.settings.clone())
164 })?
165 .unwrap_or_else(|| json!({}));
166 if let Some(toolchain) = toolchain.and_then(|toolchain| {
167 serde_json::from_value::<PythonEnvironment>(toolchain.as_json).ok()
168 }) {
169 _ = maybe!({
170 let uri = url::Url::from_file_path(toolchain.executable?).ok()?;
171 let sys_prefix = toolchain.prefix.clone()?;
172 let environment = json!({
173 "executable": {
174 "uri": uri,
175 "sysPrefix": sys_prefix
176 }
177 });
178 ret.as_object_mut()?
179 .entry("pythonExtension")
180 .or_insert_with(|| json!({ "activeEnvironment": environment }));
181 Some(())
182 });
183 }
184 Ok(json!({"ty": ret}))
185 }
186}
187
188impl LspInstaller for TyLspAdapter {
189 type BinaryVersion = GitHubLspBinaryVersion;
190 async fn fetch_latest_server_version(
191 &self,
192 delegate: &dyn LspAdapterDelegate,
193 _: bool,
194 _: &mut AsyncApp,
195 ) -> Result<Self::BinaryVersion> {
196 let release =
197 latest_github_release("astral-sh/ty", true, true, delegate.http_client()).await?;
198 let (_, asset_name) = Self::build_asset_name()?;
199 let asset = release
200 .assets
201 .into_iter()
202 .find(|asset| asset.name == asset_name)
203 .with_context(|| format!("no asset found matching `{asset_name:?}`"))?;
204 Ok(GitHubLspBinaryVersion {
205 name: release.tag_name,
206 url: asset.browser_download_url,
207 digest: asset.digest,
208 })
209 }
210
211 async fn fetch_server_binary(
212 &self,
213 latest_version: Self::BinaryVersion,
214 container_dir: PathBuf,
215 delegate: &dyn LspAdapterDelegate,
216 ) -> Result<LanguageServerBinary> {
217 let GitHubLspBinaryVersion {
218 name,
219 url,
220 digest: expected_digest,
221 } = latest_version;
222 let destination_path = container_dir.join(format!("ty-{name}"));
223
224 async_fs::create_dir_all(&destination_path).await?;
225
226 let server_path = match Self::GITHUB_ASSET_KIND {
227 AssetKind::TarGz | AssetKind::Gz => destination_path
228 .join(Self::build_asset_name()?.0)
229 .join("ty"),
230 AssetKind::Zip => destination_path.clone().join("ty.exe"),
231 };
232
233 let binary = LanguageServerBinary {
234 path: server_path.clone(),
235 env: None,
236 arguments: vec!["server".into()],
237 };
238
239 let metadata_path = destination_path.with_extension("metadata");
240 let metadata = GithubBinaryMetadata::read_from_file(&metadata_path)
241 .await
242 .ok();
243 if let Some(metadata) = metadata {
244 let validity_check = async || {
245 delegate
246 .try_exec(LanguageServerBinary {
247 path: server_path.clone(),
248 arguments: vec!["--version".into()],
249 env: None,
250 })
251 .await
252 .inspect_err(|err| {
253 log::warn!("Unable to run {server_path:?} asset, redownloading: {err}",)
254 })
255 };
256 if let (Some(actual_digest), Some(expected_digest)) =
257 (&metadata.digest, &expected_digest)
258 {
259 if actual_digest == expected_digest {
260 if validity_check().await.is_ok() {
261 return Ok(binary);
262 }
263 } else {
264 log::info!(
265 "SHA-256 mismatch for {destination_path:?} asset, downloading new asset. Expected: {expected_digest}, Got: {actual_digest}"
266 );
267 }
268 } else if validity_check().await.is_ok() {
269 return Ok(binary);
270 }
271 }
272
273 download_server_binary(
274 &*delegate.http_client(),
275 &url,
276 expected_digest.as_deref(),
277 &destination_path,
278 Self::GITHUB_ASSET_KIND,
279 )
280 .await?;
281 make_file_executable(&server_path).await?;
282 remove_matching(&container_dir, |path| path != destination_path).await;
283 GithubBinaryMetadata::write_to_file(
284 &GithubBinaryMetadata {
285 metadata_version: 1,
286 digest: expected_digest,
287 },
288 &metadata_path,
289 )
290 .await?;
291
292 Ok(LanguageServerBinary {
293 path: server_path,
294 env: None,
295 arguments: vec!["server".into()],
296 })
297 }
298
299 async fn cached_server_binary(
300 &self,
301 container_dir: PathBuf,
302 _: &dyn LspAdapterDelegate,
303 ) -> Option<LanguageServerBinary> {
304 maybe!(async {
305 let mut last = None;
306 let mut entries = self.fs.read_dir(&container_dir).await?;
307 while let Some(entry) = entries.next().await {
308 let path = entry?;
309 if path.extension().is_some_and(|ext| ext == "metadata") {
310 continue;
311 }
312 last = Some(path);
313 }
314
315 let path = last.context("no cached binary")?;
316 let path = match TyLspAdapter::GITHUB_ASSET_KIND {
317 AssetKind::TarGz | AssetKind::Gz => {
318 path.join(Self::build_asset_name()?.0).join("ty")
319 }
320 AssetKind::Zip => path.join("ty.exe"),
321 };
322
323 anyhow::Ok(LanguageServerBinary {
324 path,
325 env: None,
326 arguments: vec!["server".into()],
327 })
328 })
329 .await
330 .log_err()
331 }
332}
333
334pub struct PyrightLspAdapter {
335 node: NodeRuntime,
336}
337
338impl PyrightLspAdapter {
339 const SERVER_NAME: LanguageServerName = LanguageServerName::new_static("pyright");
340 const SERVER_PATH: &str = "node_modules/pyright/langserver.index.js";
341 const NODE_MODULE_RELATIVE_SERVER_PATH: &str = "pyright/langserver.index.js";
342
343 pub fn new(node: NodeRuntime) -> Self {
344 PyrightLspAdapter { node }
345 }
346
347 async fn get_cached_server_binary(
348 container_dir: PathBuf,
349 node: &NodeRuntime,
350 ) -> Option<LanguageServerBinary> {
351 let server_path = container_dir.join(Self::SERVER_PATH);
352 if server_path.exists() {
353 Some(LanguageServerBinary {
354 path: node.binary_path().await.log_err()?,
355 env: None,
356 arguments: vec![server_path.into(), "--stdio".into()],
357 })
358 } else {
359 log::error!("missing executable in directory {:?}", server_path);
360 None
361 }
362 }
363}
364
365#[async_trait(?Send)]
366impl LspAdapter for PyrightLspAdapter {
367 fn name(&self) -> LanguageServerName {
368 Self::SERVER_NAME
369 }
370
371 async fn initialization_options(
372 self: Arc<Self>,
373 _: &Arc<dyn LspAdapterDelegate>,
374 ) -> Result<Option<Value>> {
375 // Provide minimal initialization options
376 // Virtual environment configuration will be handled through workspace configuration
377 Ok(Some(json!({
378 "python": {
379 "analysis": {
380 "autoSearchPaths": true,
381 "useLibraryCodeForTypes": true,
382 "autoImportCompletions": true
383 }
384 }
385 })))
386 }
387
388 async fn process_completions(&self, items: &mut [lsp::CompletionItem]) {
389 process_pyright_completions(items);
390 }
391
392 async fn label_for_completion(
393 &self,
394 item: &lsp::CompletionItem,
395 language: &Arc<language::Language>,
396 ) -> Option<language::CodeLabel> {
397 let label = &item.label;
398 let grammar = language.grammar()?;
399 let highlight_id = match item.kind? {
400 lsp::CompletionItemKind::METHOD => grammar.highlight_id_for_name("function.method"),
401 lsp::CompletionItemKind::FUNCTION => grammar.highlight_id_for_name("function"),
402 lsp::CompletionItemKind::CLASS => grammar.highlight_id_for_name("type"),
403 lsp::CompletionItemKind::CONSTANT => grammar.highlight_id_for_name("constant"),
404 lsp::CompletionItemKind::VARIABLE => grammar.highlight_id_for_name("variable"),
405 _ => {
406 return None;
407 }
408 };
409 let filter_range = item
410 .filter_text
411 .as_deref()
412 .and_then(|filter| label.find(filter).map(|ix| ix..ix + filter.len()))
413 .unwrap_or(0..label.len());
414 let mut text = label.clone();
415 if let Some(completion_details) = item
416 .label_details
417 .as_ref()
418 .and_then(|details| details.description.as_ref())
419 {
420 write!(&mut text, " {}", completion_details).ok();
421 }
422 Some(language::CodeLabel {
423 runs: highlight_id
424 .map(|id| (0..label.len(), id))
425 .into_iter()
426 .collect(),
427 text,
428 filter_range,
429 })
430 }
431
432 async fn label_for_symbol(
433 &self,
434 name: &str,
435 kind: lsp::SymbolKind,
436 language: &Arc<language::Language>,
437 ) -> Option<language::CodeLabel> {
438 let (text, filter_range, display_range) = match kind {
439 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
440 let text = format!("def {}():\n", name);
441 let filter_range = 4..4 + name.len();
442 let display_range = 0..filter_range.end;
443 (text, filter_range, display_range)
444 }
445 lsp::SymbolKind::CLASS => {
446 let text = format!("class {}:", name);
447 let filter_range = 6..6 + name.len();
448 let display_range = 0..filter_range.end;
449 (text, filter_range, display_range)
450 }
451 lsp::SymbolKind::CONSTANT => {
452 let text = format!("{} = 0", name);
453 let filter_range = 0..name.len();
454 let display_range = 0..filter_range.end;
455 (text, filter_range, display_range)
456 }
457 _ => return None,
458 };
459
460 Some(language::CodeLabel {
461 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
462 text: text[display_range].to_string(),
463 filter_range,
464 })
465 }
466
467 async fn workspace_configuration(
468 self: Arc<Self>,
469 adapter: &Arc<dyn LspAdapterDelegate>,
470 toolchain: Option<Toolchain>,
471 cx: &mut AsyncApp,
472 ) -> Result<Value> {
473 cx.update(move |cx| {
474 let mut user_settings =
475 language_server_settings(adapter.as_ref(), &Self::SERVER_NAME, cx)
476 .and_then(|s| s.settings.clone())
477 .unwrap_or_default();
478
479 // If we have a detected toolchain, configure Pyright to use it
480 if let Some(toolchain) = toolchain
481 && let Ok(env) = serde_json::from_value::<
482 pet_core::python_environment::PythonEnvironment,
483 >(toolchain.as_json.clone())
484 {
485 if !user_settings.is_object() {
486 user_settings = Value::Object(serde_json::Map::default());
487 }
488 let object = user_settings.as_object_mut().unwrap();
489
490 let interpreter_path = toolchain.path.to_string();
491 if let Some(venv_dir) = env.prefix {
492 // Set venvPath and venv at the root level
493 // This matches the format of a pyrightconfig.json file
494 if let Some(parent) = venv_dir.parent() {
495 // Use relative path if the venv is inside the workspace
496 let venv_path = if parent == adapter.worktree_root_path() {
497 ".".to_string()
498 } else {
499 parent.to_string_lossy().into_owned()
500 };
501 object.insert("venvPath".to_string(), Value::String(venv_path));
502 }
503
504 if let Some(venv_name) = venv_dir.file_name() {
505 object.insert(
506 "venv".to_owned(),
507 Value::String(venv_name.to_string_lossy().into_owned()),
508 );
509 }
510 }
511
512 // Always set the python interpreter path
513 // Get or create the python section
514 let python = object
515 .entry("python")
516 .and_modify(|v| {
517 if !v.is_object() {
518 *v = Value::Object(serde_json::Map::default());
519 }
520 })
521 .or_insert(Value::Object(serde_json::Map::default()));
522 let python = python.as_object_mut().unwrap();
523
524 // Set both pythonPath and defaultInterpreterPath for compatibility
525 python.insert(
526 "pythonPath".to_owned(),
527 Value::String(interpreter_path.clone()),
528 );
529 python.insert(
530 "defaultInterpreterPath".to_owned(),
531 Value::String(interpreter_path),
532 );
533 }
534
535 user_settings
536 })
537 }
538}
539
540impl LspInstaller for PyrightLspAdapter {
541 type BinaryVersion = String;
542
543 async fn fetch_latest_server_version(
544 &self,
545 _: &dyn LspAdapterDelegate,
546 _: bool,
547 _: &mut AsyncApp,
548 ) -> Result<String> {
549 self.node
550 .npm_package_latest_version(Self::SERVER_NAME.as_ref())
551 .await
552 }
553
554 async fn check_if_user_installed(
555 &self,
556 delegate: &dyn LspAdapterDelegate,
557 _: Option<Toolchain>,
558 _: &AsyncApp,
559 ) -> Option<LanguageServerBinary> {
560 if let Some(pyright_bin) = delegate.which("pyright-langserver".as_ref()).await {
561 let env = delegate.shell_env().await;
562 Some(LanguageServerBinary {
563 path: pyright_bin,
564 env: Some(env),
565 arguments: vec!["--stdio".into()],
566 })
567 } else {
568 let node = delegate.which("node".as_ref()).await?;
569 let (node_modules_path, _) = delegate
570 .npm_package_installed_version(Self::SERVER_NAME.as_ref())
571 .await
572 .log_err()??;
573
574 let path = node_modules_path.join(Self::NODE_MODULE_RELATIVE_SERVER_PATH);
575
576 let env = delegate.shell_env().await;
577 Some(LanguageServerBinary {
578 path: node,
579 env: Some(env),
580 arguments: vec![path.into(), "--stdio".into()],
581 })
582 }
583 }
584
585 async fn fetch_server_binary(
586 &self,
587 latest_version: Self::BinaryVersion,
588 container_dir: PathBuf,
589 delegate: &dyn LspAdapterDelegate,
590 ) -> Result<LanguageServerBinary> {
591 let server_path = container_dir.join(Self::SERVER_PATH);
592
593 self.node
594 .npm_install_packages(
595 &container_dir,
596 &[(Self::SERVER_NAME.as_ref(), latest_version.as_str())],
597 )
598 .await?;
599
600 let env = delegate.shell_env().await;
601 Ok(LanguageServerBinary {
602 path: self.node.binary_path().await?,
603 env: Some(env),
604 arguments: vec![server_path.into(), "--stdio".into()],
605 })
606 }
607
608 async fn check_if_version_installed(
609 &self,
610 version: &Self::BinaryVersion,
611 container_dir: &PathBuf,
612 delegate: &dyn LspAdapterDelegate,
613 ) -> Option<LanguageServerBinary> {
614 let server_path = container_dir.join(Self::SERVER_PATH);
615
616 let should_install_language_server = self
617 .node
618 .should_install_npm_package(
619 Self::SERVER_NAME.as_ref(),
620 &server_path,
621 container_dir,
622 VersionStrategy::Latest(version),
623 )
624 .await;
625
626 if should_install_language_server {
627 None
628 } else {
629 let env = delegate.shell_env().await;
630 Some(LanguageServerBinary {
631 path: self.node.binary_path().await.ok()?,
632 env: Some(env),
633 arguments: vec![server_path.into(), "--stdio".into()],
634 })
635 }
636 }
637
638 async fn cached_server_binary(
639 &self,
640 container_dir: PathBuf,
641 delegate: &dyn LspAdapterDelegate,
642 ) -> Option<LanguageServerBinary> {
643 let mut binary = Self::get_cached_server_binary(container_dir, &self.node).await?;
644 binary.env = Some(delegate.shell_env().await);
645 Some(binary)
646 }
647}
648
649pub(crate) struct PythonContextProvider;
650
651const PYTHON_TEST_TARGET_TASK_VARIABLE: VariableName =
652 VariableName::Custom(Cow::Borrowed("PYTHON_TEST_TARGET"));
653
654const PYTHON_ACTIVE_TOOLCHAIN_PATH: VariableName =
655 VariableName::Custom(Cow::Borrowed("PYTHON_ACTIVE_ZED_TOOLCHAIN"));
656
657const PYTHON_MODULE_NAME_TASK_VARIABLE: VariableName =
658 VariableName::Custom(Cow::Borrowed("PYTHON_MODULE_NAME"));
659
660impl ContextProvider for PythonContextProvider {
661 fn build_context(
662 &self,
663 variables: &task::TaskVariables,
664 location: ContextLocation<'_>,
665 _: Option<HashMap<String, String>>,
666 toolchains: Arc<dyn LanguageToolchainStore>,
667 cx: &mut gpui::App,
668 ) -> Task<Result<task::TaskVariables>> {
669 let test_target =
670 match selected_test_runner(location.file_location.buffer.read(cx).file(), cx) {
671 TestRunner::UNITTEST => self.build_unittest_target(variables),
672 TestRunner::PYTEST => self.build_pytest_target(variables),
673 };
674
675 let module_target = self.build_module_target(variables);
676 let location_file = location.file_location.buffer.read(cx).file().cloned();
677 let worktree_id = location_file.as_ref().map(|f| f.worktree_id(cx));
678
679 cx.spawn(async move |cx| {
680 let active_toolchain = if let Some(worktree_id) = worktree_id {
681 let file_path = location_file
682 .as_ref()
683 .and_then(|f| f.path().parent())
684 .map(Arc::from)
685 .unwrap_or_else(|| RelPath::empty().into());
686
687 toolchains
688 .active_toolchain(worktree_id, file_path, "Python".into(), cx)
689 .await
690 .map_or_else(
691 || String::from("python3"),
692 |toolchain| toolchain.path.to_string(),
693 )
694 } else {
695 String::from("python3")
696 };
697
698 let toolchain = (PYTHON_ACTIVE_TOOLCHAIN_PATH, active_toolchain);
699
700 Ok(task::TaskVariables::from_iter(
701 test_target
702 .into_iter()
703 .chain(module_target.into_iter())
704 .chain([toolchain]),
705 ))
706 })
707 }
708
709 fn associated_tasks(
710 &self,
711 file: Option<Arc<dyn language::File>>,
712 cx: &App,
713 ) -> Task<Option<TaskTemplates>> {
714 let test_runner = selected_test_runner(file.as_ref(), cx);
715
716 let mut tasks = vec![
717 // Execute a selection
718 TaskTemplate {
719 label: "execute selection".to_owned(),
720 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
721 args: vec![
722 "-c".to_owned(),
723 VariableName::SelectedText.template_value_with_whitespace(),
724 ],
725 cwd: Some(VariableName::WorktreeRoot.template_value()),
726 ..TaskTemplate::default()
727 },
728 // Execute an entire file
729 TaskTemplate {
730 label: format!("run '{}'", VariableName::File.template_value()),
731 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
732 args: vec![VariableName::File.template_value_with_whitespace()],
733 cwd: Some(VariableName::WorktreeRoot.template_value()),
734 ..TaskTemplate::default()
735 },
736 // Execute a file as module
737 TaskTemplate {
738 label: format!("run module '{}'", VariableName::File.template_value()),
739 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
740 args: vec![
741 "-m".to_owned(),
742 PYTHON_MODULE_NAME_TASK_VARIABLE.template_value(),
743 ],
744 cwd: Some(VariableName::WorktreeRoot.template_value()),
745 tags: vec!["python-module-main-method".to_owned()],
746 ..TaskTemplate::default()
747 },
748 ];
749
750 tasks.extend(match test_runner {
751 TestRunner::UNITTEST => {
752 [
753 // Run tests for an entire file
754 TaskTemplate {
755 label: format!("unittest '{}'", VariableName::File.template_value()),
756 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
757 args: vec![
758 "-m".to_owned(),
759 "unittest".to_owned(),
760 VariableName::File.template_value_with_whitespace(),
761 ],
762 cwd: Some(VariableName::WorktreeRoot.template_value()),
763 ..TaskTemplate::default()
764 },
765 // Run test(s) for a specific target within a file
766 TaskTemplate {
767 label: "unittest $ZED_CUSTOM_PYTHON_TEST_TARGET".to_owned(),
768 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
769 args: vec![
770 "-m".to_owned(),
771 "unittest".to_owned(),
772 PYTHON_TEST_TARGET_TASK_VARIABLE.template_value_with_whitespace(),
773 ],
774 tags: vec![
775 "python-unittest-class".to_owned(),
776 "python-unittest-method".to_owned(),
777 ],
778 cwd: Some(VariableName::WorktreeRoot.template_value()),
779 ..TaskTemplate::default()
780 },
781 ]
782 }
783 TestRunner::PYTEST => {
784 [
785 // Run tests for an entire file
786 TaskTemplate {
787 label: format!("pytest '{}'", VariableName::File.template_value()),
788 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
789 args: vec![
790 "-m".to_owned(),
791 "pytest".to_owned(),
792 VariableName::File.template_value_with_whitespace(),
793 ],
794 cwd: Some(VariableName::WorktreeRoot.template_value()),
795 ..TaskTemplate::default()
796 },
797 // Run test(s) for a specific target within a file
798 TaskTemplate {
799 label: "pytest $ZED_CUSTOM_PYTHON_TEST_TARGET".to_owned(),
800 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
801 args: vec![
802 "-m".to_owned(),
803 "pytest".to_owned(),
804 PYTHON_TEST_TARGET_TASK_VARIABLE.template_value_with_whitespace(),
805 ],
806 cwd: Some(VariableName::WorktreeRoot.template_value()),
807 tags: vec![
808 "python-pytest-class".to_owned(),
809 "python-pytest-method".to_owned(),
810 ],
811 ..TaskTemplate::default()
812 },
813 ]
814 }
815 });
816
817 Task::ready(Some(TaskTemplates(tasks)))
818 }
819}
820
821fn selected_test_runner(location: Option<&Arc<dyn language::File>>, cx: &App) -> TestRunner {
822 const TEST_RUNNER_VARIABLE: &str = "TEST_RUNNER";
823 language_settings(Some(LanguageName::new("Python")), location, cx)
824 .tasks
825 .variables
826 .get(TEST_RUNNER_VARIABLE)
827 .and_then(|val| TestRunner::from_str(val).ok())
828 .unwrap_or(TestRunner::PYTEST)
829}
830
831impl PythonContextProvider {
832 fn build_unittest_target(
833 &self,
834 variables: &task::TaskVariables,
835 ) -> Option<(VariableName, String)> {
836 let python_module_name =
837 python_module_name_from_relative_path(variables.get(&VariableName::RelativeFile)?);
838
839 let unittest_class_name =
840 variables.get(&VariableName::Custom(Cow::Borrowed("_unittest_class_name")));
841
842 let unittest_method_name = variables.get(&VariableName::Custom(Cow::Borrowed(
843 "_unittest_method_name",
844 )));
845
846 let unittest_target_str = match (unittest_class_name, unittest_method_name) {
847 (Some(class_name), Some(method_name)) => {
848 format!("{python_module_name}.{class_name}.{method_name}")
849 }
850 (Some(class_name), None) => format!("{python_module_name}.{class_name}"),
851 (None, None) => python_module_name,
852 // should never happen, a TestCase class is the unit of testing
853 (None, Some(_)) => return None,
854 };
855
856 Some((
857 PYTHON_TEST_TARGET_TASK_VARIABLE.clone(),
858 unittest_target_str,
859 ))
860 }
861
862 fn build_pytest_target(
863 &self,
864 variables: &task::TaskVariables,
865 ) -> Option<(VariableName, String)> {
866 let file_path = variables.get(&VariableName::RelativeFile)?;
867
868 let pytest_class_name =
869 variables.get(&VariableName::Custom(Cow::Borrowed("_pytest_class_name")));
870
871 let pytest_method_name =
872 variables.get(&VariableName::Custom(Cow::Borrowed("_pytest_method_name")));
873
874 let pytest_target_str = match (pytest_class_name, pytest_method_name) {
875 (Some(class_name), Some(method_name)) => {
876 format!("{file_path}::{class_name}::{method_name}")
877 }
878 (Some(class_name), None) => {
879 format!("{file_path}::{class_name}")
880 }
881 (None, Some(method_name)) => {
882 format!("{file_path}::{method_name}")
883 }
884 (None, None) => file_path.to_string(),
885 };
886
887 Some((PYTHON_TEST_TARGET_TASK_VARIABLE.clone(), pytest_target_str))
888 }
889
890 fn build_module_target(
891 &self,
892 variables: &task::TaskVariables,
893 ) -> Result<(VariableName, String)> {
894 let python_module_name = python_module_name_from_relative_path(
895 variables.get(&VariableName::RelativeFile).unwrap_or(""),
896 );
897
898 let module_target = (PYTHON_MODULE_NAME_TASK_VARIABLE.clone(), python_module_name);
899
900 Ok(module_target)
901 }
902}
903
904fn python_module_name_from_relative_path(relative_path: &str) -> String {
905 let path_with_dots = relative_path.replace('/', ".");
906 path_with_dots
907 .strip_suffix(".py")
908 .unwrap_or(&path_with_dots)
909 .to_string()
910}
911
912fn is_python_env_global(k: &PythonEnvironmentKind) -> bool {
913 matches!(
914 k,
915 PythonEnvironmentKind::Homebrew
916 | PythonEnvironmentKind::Pyenv
917 | PythonEnvironmentKind::GlobalPaths
918 | PythonEnvironmentKind::MacPythonOrg
919 | PythonEnvironmentKind::MacCommandLineTools
920 | PythonEnvironmentKind::LinuxGlobal
921 | PythonEnvironmentKind::MacXCode
922 | PythonEnvironmentKind::WindowsStore
923 | PythonEnvironmentKind::WindowsRegistry
924 )
925}
926
927fn python_env_kind_display(k: &PythonEnvironmentKind) -> &'static str {
928 match k {
929 PythonEnvironmentKind::Conda => "Conda",
930 PythonEnvironmentKind::Pixi => "pixi",
931 PythonEnvironmentKind::Homebrew => "Homebrew",
932 PythonEnvironmentKind::Pyenv => "global (Pyenv)",
933 PythonEnvironmentKind::GlobalPaths => "global",
934 PythonEnvironmentKind::PyenvVirtualEnv => "Pyenv",
935 PythonEnvironmentKind::Pipenv => "Pipenv",
936 PythonEnvironmentKind::Poetry => "Poetry",
937 PythonEnvironmentKind::MacPythonOrg => "global (Python.org)",
938 PythonEnvironmentKind::MacCommandLineTools => "global (Command Line Tools for Xcode)",
939 PythonEnvironmentKind::LinuxGlobal => "global",
940 PythonEnvironmentKind::MacXCode => "global (Xcode)",
941 PythonEnvironmentKind::Venv => "venv",
942 PythonEnvironmentKind::VirtualEnv => "virtualenv",
943 PythonEnvironmentKind::VirtualEnvWrapper => "virtualenvwrapper",
944 PythonEnvironmentKind::WindowsStore => "global (Windows Store)",
945 PythonEnvironmentKind::WindowsRegistry => "global (Windows Registry)",
946 }
947}
948
949pub(crate) struct PythonToolchainProvider;
950
951static ENV_PRIORITY_LIST: &[PythonEnvironmentKind] = &[
952 // Prioritize non-Conda environments.
953 PythonEnvironmentKind::Poetry,
954 PythonEnvironmentKind::Pipenv,
955 PythonEnvironmentKind::VirtualEnvWrapper,
956 PythonEnvironmentKind::Venv,
957 PythonEnvironmentKind::VirtualEnv,
958 PythonEnvironmentKind::PyenvVirtualEnv,
959 PythonEnvironmentKind::Pixi,
960 PythonEnvironmentKind::Conda,
961 PythonEnvironmentKind::Pyenv,
962 PythonEnvironmentKind::GlobalPaths,
963 PythonEnvironmentKind::Homebrew,
964];
965
966fn env_priority(kind: Option<PythonEnvironmentKind>) -> usize {
967 if let Some(kind) = kind {
968 ENV_PRIORITY_LIST
969 .iter()
970 .position(|blessed_env| blessed_env == &kind)
971 .unwrap_or(ENV_PRIORITY_LIST.len())
972 } else {
973 // Unknown toolchains are less useful than non-blessed ones.
974 ENV_PRIORITY_LIST.len() + 1
975 }
976}
977
978/// Return the name of environment declared in <worktree-root/.venv.
979///
980/// https://virtualfish.readthedocs.io/en/latest/plugins.html#auto-activation-auto-activation
981async fn get_worktree_venv_declaration(worktree_root: &Path) -> Option<String> {
982 let file = async_fs::File::open(worktree_root.join(".venv"))
983 .await
984 .ok()?;
985 let mut venv_name = String::new();
986 smol::io::BufReader::new(file)
987 .read_line(&mut venv_name)
988 .await
989 .ok()?;
990 Some(venv_name.trim().to_string())
991}
992
993fn get_venv_parent_dir(env: &PythonEnvironment) -> Option<PathBuf> {
994 // If global, we aren't a virtual environment
995 if let Some(kind) = env.kind
996 && is_python_env_global(&kind)
997 {
998 return None;
999 }
1000
1001 // Check to be sure we are a virtual environment using pet's most generic
1002 // virtual environment type, VirtualEnv
1003 let venv = env
1004 .executable
1005 .as_ref()
1006 .and_then(|p| p.parent())
1007 .and_then(|p| p.parent())
1008 .filter(|p| is_virtualenv_dir(p))?;
1009
1010 venv.parent().map(|parent| parent.to_path_buf())
1011}
1012
1013fn wr_distance(wr: &PathBuf, venv: Option<&PathBuf>) -> usize {
1014 if let Some(venv) = venv
1015 && let Ok(p) = venv.strip_prefix(wr)
1016 {
1017 p.components().count()
1018 } else {
1019 usize::MAX
1020 }
1021}
1022
1023#[async_trait]
1024impl ToolchainLister for PythonToolchainProvider {
1025 async fn list(
1026 &self,
1027 worktree_root: PathBuf,
1028 subroot_relative_path: Arc<RelPath>,
1029 project_env: Option<HashMap<String, String>>,
1030 ) -> ToolchainList {
1031 let env = project_env.unwrap_or_default();
1032 let environment = EnvironmentApi::from_env(&env);
1033 let locators = pet::locators::create_locators(
1034 Arc::new(pet_conda::Conda::from(&environment)),
1035 Arc::new(pet_poetry::Poetry::from(&environment)),
1036 &environment,
1037 );
1038 let mut config = Configuration::default();
1039
1040 // `.ancestors()` will yield at least one path, so in case of empty `subroot_relative_path`, we'll just use
1041 // worktree root as the workspace directory.
1042 config.workspace_directories = Some(
1043 subroot_relative_path
1044 .ancestors()
1045 .map(|ancestor| worktree_root.join(ancestor.as_std_path()))
1046 .collect(),
1047 );
1048 for locator in locators.iter() {
1049 locator.configure(&config);
1050 }
1051
1052 let reporter = pet_reporter::collect::create_reporter();
1053 pet::find::find_and_report_envs(&reporter, config, &locators, &environment, None);
1054
1055 let mut toolchains = reporter
1056 .environments
1057 .lock()
1058 .map_or(Vec::new(), |mut guard| std::mem::take(&mut guard));
1059
1060 let wr = worktree_root;
1061 let wr_venv = get_worktree_venv_declaration(&wr).await;
1062 // Sort detected environments by:
1063 // environment name matching activation file (<workdir>/.venv)
1064 // environment project dir matching worktree_root
1065 // general env priority
1066 // environment path matching the CONDA_PREFIX env var
1067 // executable path
1068 toolchains.sort_by(|lhs, rhs| {
1069 // Compare venv names against worktree .venv file
1070 let venv_ordering =
1071 wr_venv
1072 .as_ref()
1073 .map_or(Ordering::Equal, |venv| match (&lhs.name, &rhs.name) {
1074 (Some(l), Some(r)) => (r == venv).cmp(&(l == venv)),
1075 (Some(l), None) if l == venv => Ordering::Less,
1076 (None, Some(r)) if r == venv => Ordering::Greater,
1077 _ => Ordering::Equal,
1078 });
1079
1080 // Compare project paths against worktree root
1081 let proj_ordering = || {
1082 let lhs_project = lhs.project.clone().or_else(|| get_venv_parent_dir(lhs));
1083 let rhs_project = rhs.project.clone().or_else(|| get_venv_parent_dir(rhs));
1084 wr_distance(&wr, lhs_project.as_ref()).cmp(&wr_distance(&wr, rhs_project.as_ref()))
1085 };
1086
1087 // Compare environment priorities
1088 let priority_ordering = || env_priority(lhs.kind).cmp(&env_priority(rhs.kind));
1089
1090 // Compare conda prefixes
1091 let conda_ordering = || {
1092 if lhs.kind == Some(PythonEnvironmentKind::Conda) {
1093 environment
1094 .get_env_var("CONDA_PREFIX".to_string())
1095 .map(|conda_prefix| {
1096 let is_match = |exe: &Option<PathBuf>| {
1097 exe.as_ref().is_some_and(|e| e.starts_with(&conda_prefix))
1098 };
1099 match (is_match(&lhs.executable), is_match(&rhs.executable)) {
1100 (true, false) => Ordering::Less,
1101 (false, true) => Ordering::Greater,
1102 _ => Ordering::Equal,
1103 }
1104 })
1105 .unwrap_or(Ordering::Equal)
1106 } else {
1107 Ordering::Equal
1108 }
1109 };
1110
1111 // Compare Python executables
1112 let exe_ordering = || lhs.executable.cmp(&rhs.executable);
1113
1114 venv_ordering
1115 .then_with(proj_ordering)
1116 .then_with(priority_ordering)
1117 .then_with(conda_ordering)
1118 .then_with(exe_ordering)
1119 });
1120
1121 let mut toolchains: Vec<_> = toolchains
1122 .into_iter()
1123 .filter_map(venv_to_toolchain)
1124 .collect();
1125 toolchains.dedup();
1126 ToolchainList {
1127 toolchains,
1128 default: None,
1129 groups: Default::default(),
1130 }
1131 }
1132 fn meta(&self) -> ToolchainMetadata {
1133 ToolchainMetadata {
1134 term: SharedString::new_static("Virtual Environment"),
1135 new_toolchain_placeholder: SharedString::new_static(
1136 "A path to the python3 executable within a virtual environment, or path to virtual environment itself",
1137 ),
1138 manifest_name: ManifestName::from(SharedString::new_static("pyproject.toml")),
1139 }
1140 }
1141
1142 async fn resolve(
1143 &self,
1144 path: PathBuf,
1145 env: Option<HashMap<String, String>>,
1146 ) -> anyhow::Result<Toolchain> {
1147 let env = env.unwrap_or_default();
1148 let environment = EnvironmentApi::from_env(&env);
1149 let locators = pet::locators::create_locators(
1150 Arc::new(pet_conda::Conda::from(&environment)),
1151 Arc::new(pet_poetry::Poetry::from(&environment)),
1152 &environment,
1153 );
1154 let toolchain = pet::resolve::resolve_environment(&path, &locators, &environment)
1155 .context("Could not find a virtual environment in provided path")?;
1156 let venv = toolchain.resolved.unwrap_or(toolchain.discovered);
1157 venv_to_toolchain(venv).context("Could not convert a venv into a toolchain")
1158 }
1159
1160 async fn activation_script(
1161 &self,
1162 toolchain: &Toolchain,
1163 shell: ShellKind,
1164 fs: &dyn Fs,
1165 ) -> Vec<String> {
1166 let Ok(toolchain) = serde_json::from_value::<pet_core::python_environment::PythonEnvironment>(
1167 toolchain.as_json.clone(),
1168 ) else {
1169 return vec![];
1170 };
1171 let mut activation_script = vec![];
1172
1173 match toolchain.kind {
1174 Some(PythonEnvironmentKind::Conda) => {
1175 if let Some(name) = &toolchain.name {
1176 activation_script.push(format!("conda activate {name}"));
1177 } else {
1178 activation_script.push("conda activate".to_string());
1179 }
1180 }
1181 Some(PythonEnvironmentKind::Venv | PythonEnvironmentKind::VirtualEnv) => {
1182 if let Some(prefix) = &toolchain.prefix {
1183 let activate_keyword = match shell {
1184 ShellKind::Cmd => ".",
1185 ShellKind::Nushell => "overlay use",
1186 ShellKind::PowerShell => ".",
1187 ShellKind::Fish => "source",
1188 ShellKind::Csh => "source",
1189 ShellKind::Tcsh => "source",
1190 ShellKind::Posix | ShellKind::Rc => "source",
1191 };
1192 let activate_script_name = match shell {
1193 ShellKind::Posix | ShellKind::Rc => "activate",
1194 ShellKind::Csh => "activate.csh",
1195 ShellKind::Tcsh => "activate.csh",
1196 ShellKind::Fish => "activate.fish",
1197 ShellKind::Nushell => "activate.nu",
1198 ShellKind::PowerShell => "activate.ps1",
1199 ShellKind::Cmd => "activate.bat",
1200 };
1201 let path = prefix.join(BINARY_DIR).join(activate_script_name);
1202
1203 if let Ok(quoted) =
1204 shlex::try_quote(&path.to_string_lossy()).map(Cow::into_owned)
1205 && fs.is_file(&path).await
1206 {
1207 activation_script.push(format!("{activate_keyword} {quoted}"));
1208 }
1209 }
1210 }
1211 Some(PythonEnvironmentKind::Pyenv) => {
1212 let Some(manager) = toolchain.manager else {
1213 return vec![];
1214 };
1215 let version = toolchain.version.as_deref().unwrap_or("system");
1216 let pyenv = manager.executable;
1217 let pyenv = pyenv.display();
1218 activation_script.extend(match shell {
1219 ShellKind::Fish => Some(format!("\"{pyenv}\" shell - fish {version}")),
1220 ShellKind::Posix => Some(format!("\"{pyenv}\" shell - sh {version}")),
1221 ShellKind::Nushell => Some(format!("\"{pyenv}\" shell - nu {version}")),
1222 ShellKind::PowerShell => None,
1223 ShellKind::Csh => None,
1224 ShellKind::Tcsh => None,
1225 ShellKind::Cmd => None,
1226 ShellKind::Rc => None,
1227 })
1228 }
1229 _ => {}
1230 }
1231 activation_script
1232 }
1233}
1234
1235fn venv_to_toolchain(venv: PythonEnvironment) -> Option<Toolchain> {
1236 let mut name = String::from("Python");
1237 if let Some(ref version) = venv.version {
1238 _ = write!(name, " {version}");
1239 }
1240
1241 let name_and_kind = match (&venv.name, &venv.kind) {
1242 (Some(name), Some(kind)) => Some(format!("({name}; {})", python_env_kind_display(kind))),
1243 (Some(name), None) => Some(format!("({name})")),
1244 (None, Some(kind)) => Some(format!("({})", python_env_kind_display(kind))),
1245 (None, None) => None,
1246 };
1247
1248 if let Some(nk) = name_and_kind {
1249 _ = write!(name, " {nk}");
1250 }
1251
1252 Some(Toolchain {
1253 name: name.into(),
1254 path: venv.executable.as_ref()?.to_str()?.to_owned().into(),
1255 language_name: LanguageName::new("Python"),
1256 as_json: serde_json::to_value(venv).ok()?,
1257 })
1258}
1259
1260pub struct EnvironmentApi<'a> {
1261 global_search_locations: Arc<Mutex<Vec<PathBuf>>>,
1262 project_env: &'a HashMap<String, String>,
1263 pet_env: pet_core::os_environment::EnvironmentApi,
1264}
1265
1266impl<'a> EnvironmentApi<'a> {
1267 pub fn from_env(project_env: &'a HashMap<String, String>) -> Self {
1268 let paths = project_env
1269 .get("PATH")
1270 .map(|p| std::env::split_paths(p).collect())
1271 .unwrap_or_default();
1272
1273 EnvironmentApi {
1274 global_search_locations: Arc::new(Mutex::new(paths)),
1275 project_env,
1276 pet_env: pet_core::os_environment::EnvironmentApi::new(),
1277 }
1278 }
1279
1280 fn user_home(&self) -> Option<PathBuf> {
1281 self.project_env
1282 .get("HOME")
1283 .or_else(|| self.project_env.get("USERPROFILE"))
1284 .map(|home| pet_fs::path::norm_case(PathBuf::from(home)))
1285 .or_else(|| self.pet_env.get_user_home())
1286 }
1287}
1288
1289impl pet_core::os_environment::Environment for EnvironmentApi<'_> {
1290 fn get_user_home(&self) -> Option<PathBuf> {
1291 self.user_home()
1292 }
1293
1294 fn get_root(&self) -> Option<PathBuf> {
1295 None
1296 }
1297
1298 fn get_env_var(&self, key: String) -> Option<String> {
1299 self.project_env
1300 .get(&key)
1301 .cloned()
1302 .or_else(|| self.pet_env.get_env_var(key))
1303 }
1304
1305 fn get_know_global_search_locations(&self) -> Vec<PathBuf> {
1306 if self.global_search_locations.lock().is_empty() {
1307 let mut paths =
1308 std::env::split_paths(&self.get_env_var("PATH".to_string()).unwrap_or_default())
1309 .collect::<Vec<PathBuf>>();
1310
1311 log::trace!("Env PATH: {:?}", paths);
1312 for p in self.pet_env.get_know_global_search_locations() {
1313 if !paths.contains(&p) {
1314 paths.push(p);
1315 }
1316 }
1317
1318 let mut paths = paths
1319 .into_iter()
1320 .filter(|p| p.exists())
1321 .collect::<Vec<PathBuf>>();
1322
1323 self.global_search_locations.lock().append(&mut paths);
1324 }
1325 self.global_search_locations.lock().clone()
1326 }
1327}
1328
1329pub(crate) struct PyLspAdapter {
1330 python_venv_base: OnceCell<Result<Arc<Path>, String>>,
1331}
1332impl PyLspAdapter {
1333 const SERVER_NAME: LanguageServerName = LanguageServerName::new_static("pylsp");
1334 pub(crate) fn new() -> Self {
1335 Self {
1336 python_venv_base: OnceCell::new(),
1337 }
1338 }
1339 async fn ensure_venv(delegate: &dyn LspAdapterDelegate) -> Result<Arc<Path>> {
1340 let python_path = Self::find_base_python(delegate)
1341 .await
1342 .context("Could not find Python installation for PyLSP")?;
1343 let work_dir = delegate
1344 .language_server_download_dir(&Self::SERVER_NAME)
1345 .await
1346 .context("Could not get working directory for PyLSP")?;
1347 let mut path = PathBuf::from(work_dir.as_ref());
1348 path.push("pylsp-venv");
1349 if !path.exists() {
1350 util::command::new_smol_command(python_path)
1351 .arg("-m")
1352 .arg("venv")
1353 .arg("pylsp-venv")
1354 .current_dir(work_dir)
1355 .spawn()?
1356 .output()
1357 .await?;
1358 }
1359
1360 Ok(path.into())
1361 }
1362 // Find "baseline", user python version from which we'll create our own venv.
1363 async fn find_base_python(delegate: &dyn LspAdapterDelegate) -> Option<PathBuf> {
1364 for path in ["python3", "python"] {
1365 if let Some(path) = delegate.which(path.as_ref()).await {
1366 return Some(path);
1367 }
1368 }
1369 None
1370 }
1371
1372 async fn base_venv(&self, delegate: &dyn LspAdapterDelegate) -> Result<Arc<Path>, String> {
1373 self.python_venv_base
1374 .get_or_init(move || async move {
1375 Self::ensure_venv(delegate)
1376 .await
1377 .map_err(|e| format!("{e}"))
1378 })
1379 .await
1380 .clone()
1381 }
1382}
1383
1384const BINARY_DIR: &str = if cfg!(target_os = "windows") {
1385 "Scripts"
1386} else {
1387 "bin"
1388};
1389
1390#[async_trait(?Send)]
1391impl LspAdapter for PyLspAdapter {
1392 fn name(&self) -> LanguageServerName {
1393 Self::SERVER_NAME
1394 }
1395
1396 async fn process_completions(&self, _items: &mut [lsp::CompletionItem]) {}
1397
1398 async fn label_for_completion(
1399 &self,
1400 item: &lsp::CompletionItem,
1401 language: &Arc<language::Language>,
1402 ) -> Option<language::CodeLabel> {
1403 let label = &item.label;
1404 let grammar = language.grammar()?;
1405 let highlight_id = match item.kind? {
1406 lsp::CompletionItemKind::METHOD => grammar.highlight_id_for_name("function.method")?,
1407 lsp::CompletionItemKind::FUNCTION => grammar.highlight_id_for_name("function")?,
1408 lsp::CompletionItemKind::CLASS => grammar.highlight_id_for_name("type")?,
1409 lsp::CompletionItemKind::CONSTANT => grammar.highlight_id_for_name("constant")?,
1410 _ => return None,
1411 };
1412 let filter_range = item
1413 .filter_text
1414 .as_deref()
1415 .and_then(|filter| label.find(filter).map(|ix| ix..ix + filter.len()))
1416 .unwrap_or(0..label.len());
1417 Some(language::CodeLabel {
1418 text: label.clone(),
1419 runs: vec![(0..label.len(), highlight_id)],
1420 filter_range,
1421 })
1422 }
1423
1424 async fn label_for_symbol(
1425 &self,
1426 name: &str,
1427 kind: lsp::SymbolKind,
1428 language: &Arc<language::Language>,
1429 ) -> Option<language::CodeLabel> {
1430 let (text, filter_range, display_range) = match kind {
1431 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
1432 let text = format!("def {}():\n", name);
1433 let filter_range = 4..4 + name.len();
1434 let display_range = 0..filter_range.end;
1435 (text, filter_range, display_range)
1436 }
1437 lsp::SymbolKind::CLASS => {
1438 let text = format!("class {}:", name);
1439 let filter_range = 6..6 + name.len();
1440 let display_range = 0..filter_range.end;
1441 (text, filter_range, display_range)
1442 }
1443 lsp::SymbolKind::CONSTANT => {
1444 let text = format!("{} = 0", name);
1445 let filter_range = 0..name.len();
1446 let display_range = 0..filter_range.end;
1447 (text, filter_range, display_range)
1448 }
1449 _ => return None,
1450 };
1451
1452 Some(language::CodeLabel {
1453 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
1454 text: text[display_range].to_string(),
1455 filter_range,
1456 })
1457 }
1458
1459 async fn workspace_configuration(
1460 self: Arc<Self>,
1461 adapter: &Arc<dyn LspAdapterDelegate>,
1462 toolchain: Option<Toolchain>,
1463 cx: &mut AsyncApp,
1464 ) -> Result<Value> {
1465 cx.update(move |cx| {
1466 let mut user_settings =
1467 language_server_settings(adapter.as_ref(), &Self::SERVER_NAME, cx)
1468 .and_then(|s| s.settings.clone())
1469 .unwrap_or_else(|| {
1470 json!({
1471 "plugins": {
1472 "pycodestyle": {"enabled": false},
1473 "rope_autoimport": {"enabled": true, "memory": true},
1474 "pylsp_mypy": {"enabled": false}
1475 },
1476 "rope": {
1477 "ropeFolder": null
1478 },
1479 })
1480 });
1481
1482 // If user did not explicitly modify their python venv, use one from picker.
1483 if let Some(toolchain) = toolchain {
1484 if !user_settings.is_object() {
1485 user_settings = Value::Object(serde_json::Map::default());
1486 }
1487 let object = user_settings.as_object_mut().unwrap();
1488 if let Some(python) = object
1489 .entry("plugins")
1490 .or_insert(Value::Object(serde_json::Map::default()))
1491 .as_object_mut()
1492 {
1493 if let Some(jedi) = python
1494 .entry("jedi")
1495 .or_insert(Value::Object(serde_json::Map::default()))
1496 .as_object_mut()
1497 {
1498 jedi.entry("environment".to_string())
1499 .or_insert_with(|| Value::String(toolchain.path.clone().into()));
1500 }
1501 if let Some(pylint) = python
1502 .entry("pylsp_mypy")
1503 .or_insert(Value::Object(serde_json::Map::default()))
1504 .as_object_mut()
1505 {
1506 pylint.entry("overrides".to_string()).or_insert_with(|| {
1507 Value::Array(vec![
1508 Value::String("--python-executable".into()),
1509 Value::String(toolchain.path.into()),
1510 Value::String("--cache-dir=/dev/null".into()),
1511 Value::Bool(true),
1512 ])
1513 });
1514 }
1515 }
1516 }
1517 user_settings = Value::Object(serde_json::Map::from_iter([(
1518 "pylsp".to_string(),
1519 user_settings,
1520 )]));
1521
1522 user_settings
1523 })
1524 }
1525}
1526
1527impl LspInstaller for PyLspAdapter {
1528 type BinaryVersion = ();
1529 async fn check_if_user_installed(
1530 &self,
1531 delegate: &dyn LspAdapterDelegate,
1532 toolchain: Option<Toolchain>,
1533 _: &AsyncApp,
1534 ) -> Option<LanguageServerBinary> {
1535 if let Some(pylsp_bin) = delegate.which(Self::SERVER_NAME.as_ref()).await {
1536 let env = delegate.shell_env().await;
1537 Some(LanguageServerBinary {
1538 path: pylsp_bin,
1539 env: Some(env),
1540 arguments: vec![],
1541 })
1542 } else {
1543 let toolchain = toolchain?;
1544 let pylsp_path = Path::new(toolchain.path.as_ref()).parent()?.join("pylsp");
1545 pylsp_path.exists().then(|| LanguageServerBinary {
1546 path: toolchain.path.to_string().into(),
1547 arguments: vec![pylsp_path.into()],
1548 env: None,
1549 })
1550 }
1551 }
1552
1553 async fn fetch_latest_server_version(
1554 &self,
1555 _: &dyn LspAdapterDelegate,
1556 _: bool,
1557 _: &mut AsyncApp,
1558 ) -> Result<()> {
1559 Ok(())
1560 }
1561
1562 async fn fetch_server_binary(
1563 &self,
1564 _: (),
1565 _: PathBuf,
1566 delegate: &dyn LspAdapterDelegate,
1567 ) -> Result<LanguageServerBinary> {
1568 let venv = self.base_venv(delegate).await.map_err(|e| anyhow!(e))?;
1569 let pip_path = venv.join(BINARY_DIR).join("pip3");
1570 ensure!(
1571 util::command::new_smol_command(pip_path.as_path())
1572 .arg("install")
1573 .arg("python-lsp-server[all]")
1574 .arg("--upgrade")
1575 .output()
1576 .await?
1577 .status
1578 .success(),
1579 "python-lsp-server[all] installation failed"
1580 );
1581 ensure!(
1582 util::command::new_smol_command(pip_path)
1583 .arg("install")
1584 .arg("pylsp-mypy")
1585 .arg("--upgrade")
1586 .output()
1587 .await?
1588 .status
1589 .success(),
1590 "pylsp-mypy installation failed"
1591 );
1592 let pylsp = venv.join(BINARY_DIR).join("pylsp");
1593 ensure!(
1594 delegate.which(pylsp.as_os_str()).await.is_some(),
1595 "pylsp installation was incomplete"
1596 );
1597 Ok(LanguageServerBinary {
1598 path: pylsp,
1599 env: None,
1600 arguments: vec![],
1601 })
1602 }
1603
1604 async fn cached_server_binary(
1605 &self,
1606 _: PathBuf,
1607 delegate: &dyn LspAdapterDelegate,
1608 ) -> Option<LanguageServerBinary> {
1609 let venv = self.base_venv(delegate).await.ok()?;
1610 let pylsp = venv.join(BINARY_DIR).join("pylsp");
1611 delegate.which(pylsp.as_os_str()).await?;
1612 Some(LanguageServerBinary {
1613 path: pylsp,
1614 env: None,
1615 arguments: vec![],
1616 })
1617 }
1618}
1619
1620pub(crate) struct BasedPyrightLspAdapter {
1621 node: NodeRuntime,
1622}
1623
1624impl BasedPyrightLspAdapter {
1625 const SERVER_NAME: LanguageServerName = LanguageServerName::new_static("basedpyright");
1626 const BINARY_NAME: &'static str = "basedpyright-langserver";
1627 const SERVER_PATH: &str = "node_modules/basedpyright/langserver.index.js";
1628 const NODE_MODULE_RELATIVE_SERVER_PATH: &str = "basedpyright/langserver.index.js";
1629
1630 pub(crate) fn new(node: NodeRuntime) -> Self {
1631 BasedPyrightLspAdapter { node }
1632 }
1633
1634 async fn get_cached_server_binary(
1635 container_dir: PathBuf,
1636 node: &NodeRuntime,
1637 ) -> Option<LanguageServerBinary> {
1638 let server_path = container_dir.join(Self::SERVER_PATH);
1639 if server_path.exists() {
1640 Some(LanguageServerBinary {
1641 path: node.binary_path().await.log_err()?,
1642 env: None,
1643 arguments: vec![server_path.into(), "--stdio".into()],
1644 })
1645 } else {
1646 log::error!("missing executable in directory {:?}", server_path);
1647 None
1648 }
1649 }
1650}
1651
1652#[async_trait(?Send)]
1653impl LspAdapter for BasedPyrightLspAdapter {
1654 fn name(&self) -> LanguageServerName {
1655 Self::SERVER_NAME
1656 }
1657
1658 async fn initialization_options(
1659 self: Arc<Self>,
1660 _: &Arc<dyn LspAdapterDelegate>,
1661 ) -> Result<Option<Value>> {
1662 // Provide minimal initialization options
1663 // Virtual environment configuration will be handled through workspace configuration
1664 Ok(Some(json!({
1665 "python": {
1666 "analysis": {
1667 "autoSearchPaths": true,
1668 "useLibraryCodeForTypes": true,
1669 "autoImportCompletions": true
1670 }
1671 }
1672 })))
1673 }
1674
1675 async fn process_completions(&self, items: &mut [lsp::CompletionItem]) {
1676 process_pyright_completions(items);
1677 }
1678
1679 async fn label_for_completion(
1680 &self,
1681 item: &lsp::CompletionItem,
1682 language: &Arc<language::Language>,
1683 ) -> Option<language::CodeLabel> {
1684 let label = &item.label;
1685 let grammar = language.grammar()?;
1686 let highlight_id = match item.kind? {
1687 lsp::CompletionItemKind::METHOD => grammar.highlight_id_for_name("function.method"),
1688 lsp::CompletionItemKind::FUNCTION => grammar.highlight_id_for_name("function"),
1689 lsp::CompletionItemKind::CLASS => grammar.highlight_id_for_name("type"),
1690 lsp::CompletionItemKind::CONSTANT => grammar.highlight_id_for_name("constant"),
1691 lsp::CompletionItemKind::VARIABLE => grammar.highlight_id_for_name("variable"),
1692 _ => {
1693 return None;
1694 }
1695 };
1696 let filter_range = item
1697 .filter_text
1698 .as_deref()
1699 .and_then(|filter| label.find(filter).map(|ix| ix..ix + filter.len()))
1700 .unwrap_or(0..label.len());
1701 let mut text = label.clone();
1702 if let Some(completion_details) = item
1703 .label_details
1704 .as_ref()
1705 .and_then(|details| details.description.as_ref())
1706 {
1707 write!(&mut text, " {}", completion_details).ok();
1708 }
1709 Some(language::CodeLabel {
1710 runs: highlight_id
1711 .map(|id| (0..label.len(), id))
1712 .into_iter()
1713 .collect(),
1714 text,
1715 filter_range,
1716 })
1717 }
1718
1719 async fn label_for_symbol(
1720 &self,
1721 name: &str,
1722 kind: lsp::SymbolKind,
1723 language: &Arc<language::Language>,
1724 ) -> Option<language::CodeLabel> {
1725 let (text, filter_range, display_range) = match kind {
1726 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
1727 let text = format!("def {}():\n", name);
1728 let filter_range = 4..4 + name.len();
1729 let display_range = 0..filter_range.end;
1730 (text, filter_range, display_range)
1731 }
1732 lsp::SymbolKind::CLASS => {
1733 let text = format!("class {}:", name);
1734 let filter_range = 6..6 + name.len();
1735 let display_range = 0..filter_range.end;
1736 (text, filter_range, display_range)
1737 }
1738 lsp::SymbolKind::CONSTANT => {
1739 let text = format!("{} = 0", name);
1740 let filter_range = 0..name.len();
1741 let display_range = 0..filter_range.end;
1742 (text, filter_range, display_range)
1743 }
1744 _ => return None,
1745 };
1746
1747 Some(language::CodeLabel {
1748 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
1749 text: text[display_range].to_string(),
1750 filter_range,
1751 })
1752 }
1753
1754 async fn workspace_configuration(
1755 self: Arc<Self>,
1756 adapter: &Arc<dyn LspAdapterDelegate>,
1757 toolchain: Option<Toolchain>,
1758 cx: &mut AsyncApp,
1759 ) -> Result<Value> {
1760 cx.update(move |cx| {
1761 let mut user_settings =
1762 language_server_settings(adapter.as_ref(), &Self::SERVER_NAME, cx)
1763 .and_then(|s| s.settings.clone())
1764 .unwrap_or_default();
1765
1766 // If we have a detected toolchain, configure Pyright to use it
1767 if let Some(toolchain) = toolchain
1768 && let Ok(env) = serde_json::from_value::<
1769 pet_core::python_environment::PythonEnvironment,
1770 >(toolchain.as_json.clone())
1771 {
1772 if !user_settings.is_object() {
1773 user_settings = Value::Object(serde_json::Map::default());
1774 }
1775 let object = user_settings.as_object_mut().unwrap();
1776
1777 let interpreter_path = toolchain.path.to_string();
1778 if let Some(venv_dir) = env.prefix {
1779 // Set venvPath and venv at the root level
1780 // This matches the format of a pyrightconfig.json file
1781 if let Some(parent) = venv_dir.parent() {
1782 // Use relative path if the venv is inside the workspace
1783 let venv_path = if parent == adapter.worktree_root_path() {
1784 ".".to_string()
1785 } else {
1786 parent.to_string_lossy().into_owned()
1787 };
1788 object.insert("venvPath".to_string(), Value::String(venv_path));
1789 }
1790
1791 if let Some(venv_name) = venv_dir.file_name() {
1792 object.insert(
1793 "venv".to_owned(),
1794 Value::String(venv_name.to_string_lossy().into_owned()),
1795 );
1796 }
1797 }
1798
1799 // Set both pythonPath and defaultInterpreterPath for compatibility
1800 if let Some(python) = object
1801 .entry("python")
1802 .or_insert(Value::Object(serde_json::Map::default()))
1803 .as_object_mut()
1804 {
1805 python.insert(
1806 "pythonPath".to_owned(),
1807 Value::String(interpreter_path.clone()),
1808 );
1809 python.insert(
1810 "defaultInterpreterPath".to_owned(),
1811 Value::String(interpreter_path),
1812 );
1813 }
1814 // Basedpyright by default uses `strict` type checking, we tone it down as to not surpris users
1815 maybe!({
1816 let basedpyright = object
1817 .entry("basedpyright")
1818 .or_insert(Value::Object(serde_json::Map::default()));
1819 let analysis = basedpyright
1820 .as_object_mut()?
1821 .entry("analysis")
1822 .or_insert(Value::Object(serde_json::Map::default()));
1823 if let serde_json::map::Entry::Vacant(v) =
1824 analysis.as_object_mut()?.entry("typeCheckingMode")
1825 {
1826 v.insert(Value::String("standard".to_owned()));
1827 }
1828 Some(())
1829 });
1830 }
1831
1832 user_settings
1833 })
1834 }
1835}
1836
1837impl LspInstaller for BasedPyrightLspAdapter {
1838 type BinaryVersion = String;
1839
1840 async fn fetch_latest_server_version(
1841 &self,
1842 _: &dyn LspAdapterDelegate,
1843 _: bool,
1844 _: &mut AsyncApp,
1845 ) -> Result<String> {
1846 self.node
1847 .npm_package_latest_version(Self::SERVER_NAME.as_ref())
1848 .await
1849 }
1850
1851 async fn check_if_user_installed(
1852 &self,
1853 delegate: &dyn LspAdapterDelegate,
1854 _: Option<Toolchain>,
1855 _: &AsyncApp,
1856 ) -> Option<LanguageServerBinary> {
1857 if let Some(path) = delegate.which(Self::BINARY_NAME.as_ref()).await {
1858 let env = delegate.shell_env().await;
1859 Some(LanguageServerBinary {
1860 path,
1861 env: Some(env),
1862 arguments: vec!["--stdio".into()],
1863 })
1864 } else {
1865 // TODO shouldn't this be self.node.binary_path()?
1866 let node = delegate.which("node".as_ref()).await?;
1867 let (node_modules_path, _) = delegate
1868 .npm_package_installed_version(Self::SERVER_NAME.as_ref())
1869 .await
1870 .log_err()??;
1871
1872 let path = node_modules_path.join(Self::NODE_MODULE_RELATIVE_SERVER_PATH);
1873
1874 let env = delegate.shell_env().await;
1875 Some(LanguageServerBinary {
1876 path: node,
1877 env: Some(env),
1878 arguments: vec![path.into(), "--stdio".into()],
1879 })
1880 }
1881 }
1882
1883 async fn fetch_server_binary(
1884 &self,
1885 latest_version: Self::BinaryVersion,
1886 container_dir: PathBuf,
1887 delegate: &dyn LspAdapterDelegate,
1888 ) -> Result<LanguageServerBinary> {
1889 let server_path = container_dir.join(Self::SERVER_PATH);
1890
1891 self.node
1892 .npm_install_packages(
1893 &container_dir,
1894 &[(Self::SERVER_NAME.as_ref(), latest_version.as_str())],
1895 )
1896 .await?;
1897
1898 let env = delegate.shell_env().await;
1899 Ok(LanguageServerBinary {
1900 path: self.node.binary_path().await?,
1901 env: Some(env),
1902 arguments: vec![server_path.into(), "--stdio".into()],
1903 })
1904 }
1905
1906 async fn check_if_version_installed(
1907 &self,
1908 version: &Self::BinaryVersion,
1909 container_dir: &PathBuf,
1910 delegate: &dyn LspAdapterDelegate,
1911 ) -> Option<LanguageServerBinary> {
1912 let server_path = container_dir.join(Self::SERVER_PATH);
1913
1914 let should_install_language_server = self
1915 .node
1916 .should_install_npm_package(
1917 Self::SERVER_NAME.as_ref(),
1918 &server_path,
1919 container_dir,
1920 VersionStrategy::Latest(version),
1921 )
1922 .await;
1923
1924 if should_install_language_server {
1925 None
1926 } else {
1927 let env = delegate.shell_env().await;
1928 Some(LanguageServerBinary {
1929 path: self.node.binary_path().await.ok()?,
1930 env: Some(env),
1931 arguments: vec![server_path.into(), "--stdio".into()],
1932 })
1933 }
1934 }
1935
1936 async fn cached_server_binary(
1937 &self,
1938 container_dir: PathBuf,
1939 delegate: &dyn LspAdapterDelegate,
1940 ) -> Option<LanguageServerBinary> {
1941 let mut binary = Self::get_cached_server_binary(container_dir, &self.node).await?;
1942 binary.env = Some(delegate.shell_env().await);
1943 Some(binary)
1944 }
1945}
1946
1947pub(crate) struct RuffLspAdapter {
1948 fs: Arc<dyn Fs>,
1949}
1950
1951#[cfg(target_os = "macos")]
1952impl RuffLspAdapter {
1953 const GITHUB_ASSET_KIND: AssetKind = AssetKind::TarGz;
1954 const ARCH_SERVER_NAME: &str = "apple-darwin";
1955}
1956
1957#[cfg(target_os = "linux")]
1958impl RuffLspAdapter {
1959 const GITHUB_ASSET_KIND: AssetKind = AssetKind::TarGz;
1960 const ARCH_SERVER_NAME: &str = "unknown-linux-gnu";
1961}
1962
1963#[cfg(target_os = "freebsd")]
1964impl RuffLspAdapter {
1965 const GITHUB_ASSET_KIND: AssetKind = AssetKind::TarGz;
1966 const ARCH_SERVER_NAME: &str = "unknown-freebsd";
1967}
1968
1969#[cfg(target_os = "windows")]
1970impl RuffLspAdapter {
1971 const GITHUB_ASSET_KIND: AssetKind = AssetKind::Zip;
1972 const ARCH_SERVER_NAME: &str = "pc-windows-msvc";
1973}
1974
1975impl RuffLspAdapter {
1976 const SERVER_NAME: LanguageServerName = LanguageServerName::new_static("ruff");
1977
1978 pub fn new(fs: Arc<dyn Fs>) -> RuffLspAdapter {
1979 RuffLspAdapter { fs }
1980 }
1981
1982 fn build_asset_name() -> Result<(String, String)> {
1983 let arch = match consts::ARCH {
1984 "x86" => "i686",
1985 _ => consts::ARCH,
1986 };
1987 let os = Self::ARCH_SERVER_NAME;
1988 let suffix = match consts::OS {
1989 "windows" => "zip",
1990 _ => "tar.gz",
1991 };
1992 let asset_name = format!("ruff-{arch}-{os}.{suffix}");
1993 let asset_stem = format!("ruff-{arch}-{os}");
1994 Ok((asset_stem, asset_name))
1995 }
1996}
1997
1998#[async_trait(?Send)]
1999impl LspAdapter for RuffLspAdapter {
2000 fn name(&self) -> LanguageServerName {
2001 Self::SERVER_NAME
2002 }
2003}
2004
2005impl LspInstaller for RuffLspAdapter {
2006 type BinaryVersion = GitHubLspBinaryVersion;
2007 async fn check_if_user_installed(
2008 &self,
2009 delegate: &dyn LspAdapterDelegate,
2010 toolchain: Option<Toolchain>,
2011 _: &AsyncApp,
2012 ) -> Option<LanguageServerBinary> {
2013 let ruff_in_venv = if let Some(toolchain) = toolchain
2014 && toolchain.language_name.as_ref() == "Python"
2015 {
2016 Path::new(toolchain.path.as_str())
2017 .parent()
2018 .map(|path| path.join("ruff"))
2019 } else {
2020 None
2021 };
2022
2023 for path in ruff_in_venv.into_iter().chain(["ruff".into()]) {
2024 if let Some(ruff_bin) = delegate.which(path.as_os_str()).await {
2025 let env = delegate.shell_env().await;
2026 return Some(LanguageServerBinary {
2027 path: ruff_bin,
2028 env: Some(env),
2029 arguments: vec!["server".into()],
2030 });
2031 }
2032 }
2033
2034 None
2035 }
2036
2037 async fn fetch_latest_server_version(
2038 &self,
2039 delegate: &dyn LspAdapterDelegate,
2040 _: bool,
2041 _: &mut AsyncApp,
2042 ) -> Result<GitHubLspBinaryVersion> {
2043 let release =
2044 latest_github_release("astral-sh/ruff", true, false, delegate.http_client()).await?;
2045 let (_, asset_name) = Self::build_asset_name()?;
2046 let asset = release
2047 .assets
2048 .into_iter()
2049 .find(|asset| asset.name == asset_name)
2050 .with_context(|| format!("no asset found matching `{asset_name:?}`"))?;
2051 Ok(GitHubLspBinaryVersion {
2052 name: release.tag_name,
2053 url: asset.browser_download_url,
2054 digest: asset.digest,
2055 })
2056 }
2057
2058 async fn fetch_server_binary(
2059 &self,
2060 latest_version: GitHubLspBinaryVersion,
2061 container_dir: PathBuf,
2062 delegate: &dyn LspAdapterDelegate,
2063 ) -> Result<LanguageServerBinary> {
2064 let GitHubLspBinaryVersion {
2065 name,
2066 url,
2067 digest: expected_digest,
2068 } = latest_version;
2069 let destination_path = container_dir.join(format!("ruff-{name}"));
2070 let server_path = match Self::GITHUB_ASSET_KIND {
2071 AssetKind::TarGz | AssetKind::Gz => destination_path
2072 .join(Self::build_asset_name()?.0)
2073 .join("ruff"),
2074 AssetKind::Zip => destination_path.clone().join("ruff.exe"),
2075 };
2076
2077 let binary = LanguageServerBinary {
2078 path: server_path.clone(),
2079 env: None,
2080 arguments: vec!["server".into()],
2081 };
2082
2083 let metadata_path = destination_path.with_extension("metadata");
2084 let metadata = GithubBinaryMetadata::read_from_file(&metadata_path)
2085 .await
2086 .ok();
2087 if let Some(metadata) = metadata {
2088 let validity_check = async || {
2089 delegate
2090 .try_exec(LanguageServerBinary {
2091 path: server_path.clone(),
2092 arguments: vec!["--version".into()],
2093 env: None,
2094 })
2095 .await
2096 .inspect_err(|err| {
2097 log::warn!("Unable to run {server_path:?} asset, redownloading: {err}",)
2098 })
2099 };
2100 if let (Some(actual_digest), Some(expected_digest)) =
2101 (&metadata.digest, &expected_digest)
2102 {
2103 if actual_digest == expected_digest {
2104 if validity_check().await.is_ok() {
2105 return Ok(binary);
2106 }
2107 } else {
2108 log::info!(
2109 "SHA-256 mismatch for {destination_path:?} asset, downloading new asset. Expected: {expected_digest}, Got: {actual_digest}"
2110 );
2111 }
2112 } else if validity_check().await.is_ok() {
2113 return Ok(binary);
2114 }
2115 }
2116
2117 download_server_binary(
2118 &*delegate.http_client(),
2119 &url,
2120 expected_digest.as_deref(),
2121 &destination_path,
2122 Self::GITHUB_ASSET_KIND,
2123 )
2124 .await?;
2125 make_file_executable(&server_path).await?;
2126 remove_matching(&container_dir, |path| path != destination_path).await;
2127 GithubBinaryMetadata::write_to_file(
2128 &GithubBinaryMetadata {
2129 metadata_version: 1,
2130 digest: expected_digest,
2131 },
2132 &metadata_path,
2133 )
2134 .await?;
2135
2136 Ok(LanguageServerBinary {
2137 path: server_path,
2138 env: None,
2139 arguments: vec!["server".into()],
2140 })
2141 }
2142
2143 async fn cached_server_binary(
2144 &self,
2145 container_dir: PathBuf,
2146 _: &dyn LspAdapterDelegate,
2147 ) -> Option<LanguageServerBinary> {
2148 maybe!(async {
2149 let mut last = None;
2150 let mut entries = self.fs.read_dir(&container_dir).await?;
2151 while let Some(entry) = entries.next().await {
2152 let path = entry?;
2153 if path.extension().is_some_and(|ext| ext == "metadata") {
2154 continue;
2155 }
2156 last = Some(path);
2157 }
2158
2159 let path = last.context("no cached binary")?;
2160 let path = match Self::GITHUB_ASSET_KIND {
2161 AssetKind::TarGz | AssetKind::Gz => {
2162 path.join(Self::build_asset_name()?.0).join("ruff")
2163 }
2164 AssetKind::Zip => path.join("ruff.exe"),
2165 };
2166
2167 anyhow::Ok(LanguageServerBinary {
2168 path,
2169 env: None,
2170 arguments: vec!["server".into()],
2171 })
2172 })
2173 .await
2174 .log_err()
2175 }
2176}
2177
2178#[cfg(test)]
2179mod tests {
2180 use gpui::{AppContext as _, BorrowAppContext, Context, TestAppContext};
2181 use language::{AutoindentMode, Buffer};
2182 use settings::SettingsStore;
2183 use std::num::NonZeroU32;
2184
2185 #[gpui::test]
2186 async fn test_python_autoindent(cx: &mut TestAppContext) {
2187 cx.executor().set_block_on_ticks(usize::MAX..=usize::MAX);
2188 let language = crate::language("python", tree_sitter_python::LANGUAGE.into());
2189 cx.update(|cx| {
2190 let test_settings = SettingsStore::test(cx);
2191 cx.set_global(test_settings);
2192 language::init(cx);
2193 cx.update_global::<SettingsStore, _>(|store, cx| {
2194 store.update_user_settings(cx, |s| {
2195 s.project.all_languages.defaults.tab_size = NonZeroU32::new(2);
2196 });
2197 });
2198 });
2199
2200 cx.new(|cx| {
2201 let mut buffer = Buffer::local("", cx).with_language(language, cx);
2202 let append = |buffer: &mut Buffer, text: &str, cx: &mut Context<Buffer>| {
2203 let ix = buffer.len();
2204 buffer.edit([(ix..ix, text)], Some(AutoindentMode::EachLine), cx);
2205 };
2206
2207 // indent after "def():"
2208 append(&mut buffer, "def a():\n", cx);
2209 assert_eq!(buffer.text(), "def a():\n ");
2210
2211 // preserve indent after blank line
2212 append(&mut buffer, "\n ", cx);
2213 assert_eq!(buffer.text(), "def a():\n \n ");
2214
2215 // indent after "if"
2216 append(&mut buffer, "if a:\n ", cx);
2217 assert_eq!(buffer.text(), "def a():\n \n if a:\n ");
2218
2219 // preserve indent after statement
2220 append(&mut buffer, "b()\n", cx);
2221 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n ");
2222
2223 // preserve indent after statement
2224 append(&mut buffer, "else", cx);
2225 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else");
2226
2227 // dedent "else""
2228 append(&mut buffer, ":", cx);
2229 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else:");
2230
2231 // indent lines after else
2232 append(&mut buffer, "\n", cx);
2233 assert_eq!(
2234 buffer.text(),
2235 "def a():\n \n if a:\n b()\n else:\n "
2236 );
2237
2238 // indent after an open paren. the closing paren is not indented
2239 // because there is another token before it on the same line.
2240 append(&mut buffer, "foo(\n1)", cx);
2241 assert_eq!(
2242 buffer.text(),
2243 "def a():\n \n if a:\n b()\n else:\n foo(\n 1)"
2244 );
2245
2246 // dedent the closing paren if it is shifted to the beginning of the line
2247 let argument_ix = buffer.text().find('1').unwrap();
2248 buffer.edit(
2249 [(argument_ix..argument_ix + 1, "")],
2250 Some(AutoindentMode::EachLine),
2251 cx,
2252 );
2253 assert_eq!(
2254 buffer.text(),
2255 "def a():\n \n if a:\n b()\n else:\n foo(\n )"
2256 );
2257
2258 // preserve indent after the close paren
2259 append(&mut buffer, "\n", cx);
2260 assert_eq!(
2261 buffer.text(),
2262 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n "
2263 );
2264
2265 // manually outdent the last line
2266 let end_whitespace_ix = buffer.len() - 4;
2267 buffer.edit(
2268 [(end_whitespace_ix..buffer.len(), "")],
2269 Some(AutoindentMode::EachLine),
2270 cx,
2271 );
2272 assert_eq!(
2273 buffer.text(),
2274 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n"
2275 );
2276
2277 // preserve the newly reduced indentation on the next newline
2278 append(&mut buffer, "\n", cx);
2279 assert_eq!(
2280 buffer.text(),
2281 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n\n"
2282 );
2283
2284 // reset to a for loop statement
2285 let statement = "for i in range(10):\n print(i)\n";
2286 buffer.edit([(0..buffer.len(), statement)], None, cx);
2287
2288 // insert single line comment after each line
2289 let eol_ixs = statement
2290 .char_indices()
2291 .filter_map(|(ix, c)| if c == '\n' { Some(ix) } else { None })
2292 .collect::<Vec<usize>>();
2293 let editions = eol_ixs
2294 .iter()
2295 .enumerate()
2296 .map(|(i, &eol_ix)| (eol_ix..eol_ix, format!(" # comment {}", i + 1)))
2297 .collect::<Vec<(std::ops::Range<usize>, String)>>();
2298 buffer.edit(editions, Some(AutoindentMode::EachLine), cx);
2299 assert_eq!(
2300 buffer.text(),
2301 "for i in range(10): # comment 1\n print(i) # comment 2\n"
2302 );
2303
2304 // reset to a simple if statement
2305 buffer.edit([(0..buffer.len(), "if a:\n b(\n )")], None, cx);
2306
2307 // dedent "else" on the line after a closing paren
2308 append(&mut buffer, "\n else:\n", cx);
2309 assert_eq!(buffer.text(), "if a:\n b(\n )\nelse:\n ");
2310
2311 buffer
2312 });
2313 }
2314}