1use anyhow::ensure;
2use anyhow::{Result, anyhow};
3use async_trait::async_trait;
4use collections::HashMap;
5use gpui::{App, Task};
6use gpui::{AsyncApp, SharedString};
7use language::LanguageToolchainStore;
8use language::Toolchain;
9use language::ToolchainList;
10use language::ToolchainLister;
11use language::language_settings::language_settings;
12use language::{ContextProvider, LspAdapter, LspAdapterDelegate};
13use language::{LanguageName, ManifestName, ManifestProvider, ManifestQuery};
14use lsp::LanguageServerBinary;
15use lsp::LanguageServerName;
16use node_runtime::NodeRuntime;
17use pet_core::Configuration;
18use pet_core::os_environment::Environment;
19use pet_core::python_environment::PythonEnvironmentKind;
20use project::Fs;
21use project::lsp_store::language_server_settings;
22use serde_json::{Value, json};
23use smol::lock::OnceCell;
24use std::cmp::Ordering;
25
26use std::str::FromStr;
27use std::sync::Mutex;
28use std::{
29 any::Any,
30 borrow::Cow,
31 ffi::OsString,
32 fmt::Write,
33 fs,
34 io::{self, BufRead},
35 path::{Path, PathBuf},
36 sync::Arc,
37};
38use task::{TaskTemplate, TaskTemplates, VariableName};
39use util::ResultExt;
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<Path>> {
56 for path in path.ancestors().take(depth) {
57 let p = path.join("pyproject.toml");
58 if delegate.exists(&p, Some(false)) {
59 return Some(path.into());
60 }
61 }
62
63 None
64 }
65}
66
67const SERVER_PATH: &str = "node_modules/pyright/langserver.index.js";
68const NODE_MODULE_RELATIVE_SERVER_PATH: &str = "pyright/langserver.index.js";
69
70enum TestRunner {
71 UNITTEST,
72 PYTEST,
73}
74
75impl FromStr for TestRunner {
76 type Err = ();
77
78 fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
79 match s {
80 "unittest" => Ok(Self::UNITTEST),
81 "pytest" => Ok(Self::PYTEST),
82 _ => Err(()),
83 }
84 }
85}
86
87fn server_binary_arguments(server_path: &Path) -> Vec<OsString> {
88 vec![server_path.into(), "--stdio".into()]
89}
90
91pub struct PythonLspAdapter {
92 node: NodeRuntime,
93}
94
95impl PythonLspAdapter {
96 const SERVER_NAME: LanguageServerName = LanguageServerName::new_static("pyright");
97
98 pub fn new(node: NodeRuntime) -> Self {
99 PythonLspAdapter { node }
100 }
101}
102
103#[async_trait(?Send)]
104impl LspAdapter for PythonLspAdapter {
105 fn name(&self) -> LanguageServerName {
106 Self::SERVER_NAME.clone()
107 }
108
109 async fn check_if_user_installed(
110 &self,
111 delegate: &dyn LspAdapterDelegate,
112 _: Arc<dyn LanguageToolchainStore>,
113 _: &AsyncApp,
114 ) -> Option<LanguageServerBinary> {
115 if let Some(pyright_bin) = delegate.which("pyright-langserver".as_ref()).await {
116 let env = delegate.shell_env().await;
117 Some(LanguageServerBinary {
118 path: pyright_bin,
119 env: Some(env),
120 arguments: vec!["--stdio".into()],
121 })
122 } else {
123 let node = delegate.which("node".as_ref()).await?;
124 let (node_modules_path, _) = delegate
125 .npm_package_installed_version(Self::SERVER_NAME.as_ref())
126 .await
127 .log_err()??;
128
129 let path = node_modules_path.join(NODE_MODULE_RELATIVE_SERVER_PATH);
130
131 Some(LanguageServerBinary {
132 path: node,
133 env: None,
134 arguments: server_binary_arguments(&path),
135 })
136 }
137 }
138
139 async fn fetch_latest_server_version(
140 &self,
141 _: &dyn LspAdapterDelegate,
142 ) -> Result<Box<dyn 'static + Any + Send>> {
143 Ok(Box::new(
144 self.node
145 .npm_package_latest_version(Self::SERVER_NAME.as_ref())
146 .await?,
147 ) as Box<_>)
148 }
149
150 async fn fetch_server_binary(
151 &self,
152 latest_version: Box<dyn 'static + Send + Any>,
153 container_dir: PathBuf,
154 _: &dyn LspAdapterDelegate,
155 ) -> Result<LanguageServerBinary> {
156 let latest_version = latest_version.downcast::<String>().unwrap();
157 let server_path = container_dir.join(SERVER_PATH);
158
159 self.node
160 .npm_install_packages(
161 &container_dir,
162 &[(Self::SERVER_NAME.as_ref(), latest_version.as_str())],
163 )
164 .await?;
165
166 Ok(LanguageServerBinary {
167 path: self.node.binary_path().await?,
168 env: None,
169 arguments: server_binary_arguments(&server_path),
170 })
171 }
172
173 async fn check_if_version_installed(
174 &self,
175 version: &(dyn 'static + Send + Any),
176 container_dir: &PathBuf,
177 _: &dyn LspAdapterDelegate,
178 ) -> Option<LanguageServerBinary> {
179 let version = version.downcast_ref::<String>().unwrap();
180 let server_path = container_dir.join(SERVER_PATH);
181
182 let should_install_language_server = self
183 .node
184 .should_install_npm_package(
185 Self::SERVER_NAME.as_ref(),
186 &server_path,
187 &container_dir,
188 &version,
189 )
190 .await;
191
192 if should_install_language_server {
193 None
194 } else {
195 Some(LanguageServerBinary {
196 path: self.node.binary_path().await.ok()?,
197 env: None,
198 arguments: server_binary_arguments(&server_path),
199 })
200 }
201 }
202
203 async fn cached_server_binary(
204 &self,
205 container_dir: PathBuf,
206 _: &dyn LspAdapterDelegate,
207 ) -> Option<LanguageServerBinary> {
208 get_cached_server_binary(container_dir, &self.node).await
209 }
210
211 async fn process_completions(&self, items: &mut [lsp::CompletionItem]) {
212 // Pyright assigns each completion item a `sortText` of the form `XX.YYYY.name`.
213 // Where `XX` is the sorting category, `YYYY` is based on most recent usage,
214 // and `name` is the symbol name itself.
215 //
216 // Because the symbol name is included, there generally are not ties when
217 // sorting by the `sortText`, so the symbol's fuzzy match score is not taken
218 // into account. Here, we remove the symbol name from the sortText in order
219 // to allow our own fuzzy score to be used to break ties.
220 //
221 // see https://github.com/microsoft/pyright/blob/95ef4e103b9b2f129c9320427e51b73ea7cf78bd/packages/pyright-internal/src/languageService/completionProvider.ts#LL2873
222 for item in items {
223 let Some(sort_text) = &mut item.sort_text else {
224 continue;
225 };
226 let mut parts = sort_text.split('.');
227 let Some(first) = parts.next() else { continue };
228 let Some(second) = parts.next() else { continue };
229 let Some(_) = parts.next() else { continue };
230 sort_text.replace_range(first.len() + second.len() + 1.., "");
231 }
232 }
233
234 async fn label_for_completion(
235 &self,
236 item: &lsp::CompletionItem,
237 language: &Arc<language::Language>,
238 ) -> Option<language::CodeLabel> {
239 let label = &item.label;
240 let grammar = language.grammar()?;
241 let highlight_id = match item.kind? {
242 lsp::CompletionItemKind::METHOD => grammar.highlight_id_for_name("function.method")?,
243 lsp::CompletionItemKind::FUNCTION => grammar.highlight_id_for_name("function")?,
244 lsp::CompletionItemKind::CLASS => grammar.highlight_id_for_name("type")?,
245 lsp::CompletionItemKind::CONSTANT => grammar.highlight_id_for_name("constant")?,
246 _ => return None,
247 };
248 Some(language::CodeLabel {
249 text: label.clone(),
250 runs: vec![(0..label.len(), highlight_id)],
251 filter_range: 0..label.len(),
252 })
253 }
254
255 async fn label_for_symbol(
256 &self,
257 name: &str,
258 kind: lsp::SymbolKind,
259 language: &Arc<language::Language>,
260 ) -> Option<language::CodeLabel> {
261 let (text, filter_range, display_range) = match kind {
262 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
263 let text = format!("def {}():\n", name);
264 let filter_range = 4..4 + name.len();
265 let display_range = 0..filter_range.end;
266 (text, filter_range, display_range)
267 }
268 lsp::SymbolKind::CLASS => {
269 let text = format!("class {}:", name);
270 let filter_range = 6..6 + name.len();
271 let display_range = 0..filter_range.end;
272 (text, filter_range, display_range)
273 }
274 lsp::SymbolKind::CONSTANT => {
275 let text = format!("{} = 0", name);
276 let filter_range = 0..name.len();
277 let display_range = 0..filter_range.end;
278 (text, filter_range, display_range)
279 }
280 _ => return None,
281 };
282
283 Some(language::CodeLabel {
284 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
285 text: text[display_range].to_string(),
286 filter_range,
287 })
288 }
289
290 async fn workspace_configuration(
291 self: Arc<Self>,
292 _: &dyn Fs,
293 adapter: &Arc<dyn LspAdapterDelegate>,
294 toolchains: Arc<dyn LanguageToolchainStore>,
295 cx: &mut AsyncApp,
296 ) -> Result<Value> {
297 let toolchain = toolchains
298 .active_toolchain(
299 adapter.worktree_id(),
300 Arc::from("".as_ref()),
301 LanguageName::new("Python"),
302 cx,
303 )
304 .await;
305 cx.update(move |cx| {
306 let mut user_settings =
307 language_server_settings(adapter.as_ref(), &Self::SERVER_NAME, cx)
308 .and_then(|s| s.settings.clone())
309 .unwrap_or_default();
310
311 // If python.pythonPath is not set in user config, do so using our toolchain picker.
312 if let Some(toolchain) = toolchain {
313 if user_settings.is_null() {
314 user_settings = Value::Object(serde_json::Map::default());
315 }
316 let object = user_settings.as_object_mut().unwrap();
317 if let Some(python) = object
318 .entry("python")
319 .or_insert(Value::Object(serde_json::Map::default()))
320 .as_object_mut()
321 {
322 python
323 .entry("pythonPath")
324 .or_insert(Value::String(toolchain.path.into()));
325 }
326 }
327 user_settings
328 })
329 }
330 fn manifest_name(&self) -> Option<ManifestName> {
331 Some(SharedString::new_static("pyproject.toml").into())
332 }
333}
334
335async fn get_cached_server_binary(
336 container_dir: PathBuf,
337 node: &NodeRuntime,
338) -> Option<LanguageServerBinary> {
339 let server_path = container_dir.join(SERVER_PATH);
340 if server_path.exists() {
341 Some(LanguageServerBinary {
342 path: node.binary_path().await.log_err()?,
343 env: None,
344 arguments: server_binary_arguments(&server_path),
345 })
346 } else {
347 log::error!("missing executable in directory {:?}", server_path);
348 None
349 }
350}
351
352pub(crate) struct PythonContextProvider;
353
354const PYTHON_TEST_TARGET_TASK_VARIABLE: VariableName =
355 VariableName::Custom(Cow::Borrowed("PYTHON_TEST_TARGET"));
356
357const PYTHON_ACTIVE_TOOLCHAIN_PATH: VariableName =
358 VariableName::Custom(Cow::Borrowed("PYTHON_ACTIVE_ZED_TOOLCHAIN"));
359
360const PYTHON_MODULE_NAME_TASK_VARIABLE: VariableName =
361 VariableName::Custom(Cow::Borrowed("PYTHON_MODULE_NAME"));
362
363impl ContextProvider for PythonContextProvider {
364 fn build_context(
365 &self,
366 variables: &task::TaskVariables,
367 location: &project::Location,
368 _: Option<HashMap<String, String>>,
369 toolchains: Arc<dyn LanguageToolchainStore>,
370 cx: &mut gpui::App,
371 ) -> Task<Result<task::TaskVariables>> {
372 let test_target = match selected_test_runner(location.buffer.read(cx).file(), cx) {
373 TestRunner::UNITTEST => self.build_unittest_target(variables),
374 TestRunner::PYTEST => self.build_pytest_target(variables),
375 };
376
377 let module_target = self.build_module_target(variables);
378 let worktree_id = location.buffer.read(cx).file().map(|f| f.worktree_id(cx));
379
380 cx.spawn(async move |cx| {
381 let active_toolchain = if let Some(worktree_id) = worktree_id {
382 toolchains
383 .active_toolchain(worktree_id, Arc::from("".as_ref()), "Python".into(), cx)
384 .await
385 .map_or_else(
386 || "python3".to_owned(),
387 |toolchain| format!("\"{}\"", toolchain.path),
388 )
389 } else {
390 String::from("python3")
391 };
392 let toolchain = (PYTHON_ACTIVE_TOOLCHAIN_PATH, active_toolchain);
393
394 Ok(task::TaskVariables::from_iter(
395 test_target
396 .into_iter()
397 .chain(module_target.into_iter())
398 .chain([toolchain]),
399 ))
400 })
401 }
402
403 fn associated_tasks(
404 &self,
405 file: Option<Arc<dyn language::File>>,
406 cx: &App,
407 ) -> Option<TaskTemplates> {
408 let test_runner = selected_test_runner(file.as_ref(), cx);
409
410 let mut tasks = vec![
411 // Execute a selection
412 TaskTemplate {
413 label: "execute selection".to_owned(),
414 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
415 args: vec![
416 "-c".to_owned(),
417 VariableName::SelectedText.template_value_with_whitespace(),
418 ],
419 ..TaskTemplate::default()
420 },
421 // Execute an entire file
422 TaskTemplate {
423 label: format!("run '{}'", VariableName::File.template_value()),
424 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
425 args: vec![VariableName::File.template_value_with_whitespace()],
426 ..TaskTemplate::default()
427 },
428 // Execute a file as module
429 TaskTemplate {
430 label: format!("run module '{}'", VariableName::File.template_value()),
431 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
432 args: vec![
433 "-m".to_owned(),
434 PYTHON_MODULE_NAME_TASK_VARIABLE.template_value(),
435 ],
436 tags: vec!["python-module-main-method".to_owned()],
437 ..TaskTemplate::default()
438 },
439 ];
440
441 tasks.extend(match test_runner {
442 TestRunner::UNITTEST => {
443 [
444 // Run tests for an entire file
445 TaskTemplate {
446 label: format!("unittest '{}'", VariableName::File.template_value()),
447 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
448 args: vec![
449 "-m".to_owned(),
450 "unittest".to_owned(),
451 VariableName::File.template_value_with_whitespace(),
452 ],
453 ..TaskTemplate::default()
454 },
455 // Run test(s) for a specific target within a file
456 TaskTemplate {
457 label: "unittest $ZED_CUSTOM_PYTHON_TEST_TARGET".to_owned(),
458 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
459 args: vec![
460 "-m".to_owned(),
461 "unittest".to_owned(),
462 PYTHON_TEST_TARGET_TASK_VARIABLE.template_value_with_whitespace(),
463 ],
464 tags: vec![
465 "python-unittest-class".to_owned(),
466 "python-unittest-method".to_owned(),
467 ],
468 ..TaskTemplate::default()
469 },
470 ]
471 }
472 TestRunner::PYTEST => {
473 [
474 // Run tests for an entire file
475 TaskTemplate {
476 label: format!("pytest '{}'", VariableName::File.template_value()),
477 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
478 args: vec![
479 "-m".to_owned(),
480 "pytest".to_owned(),
481 VariableName::File.template_value_with_whitespace(),
482 ],
483 ..TaskTemplate::default()
484 },
485 // Run test(s) for a specific target within a file
486 TaskTemplate {
487 label: "pytest $ZED_CUSTOM_PYTHON_TEST_TARGET".to_owned(),
488 command: PYTHON_ACTIVE_TOOLCHAIN_PATH.template_value(),
489 args: vec![
490 "-m".to_owned(),
491 "pytest".to_owned(),
492 PYTHON_TEST_TARGET_TASK_VARIABLE.template_value_with_whitespace(),
493 ],
494 tags: vec![
495 "python-pytest-class".to_owned(),
496 "python-pytest-method".to_owned(),
497 ],
498 ..TaskTemplate::default()
499 },
500 ]
501 }
502 });
503
504 Some(TaskTemplates(tasks))
505 }
506}
507
508fn selected_test_runner(location: Option<&Arc<dyn language::File>>, cx: &App) -> TestRunner {
509 const TEST_RUNNER_VARIABLE: &str = "TEST_RUNNER";
510 language_settings(Some(LanguageName::new("Python")), location, cx)
511 .tasks
512 .variables
513 .get(TEST_RUNNER_VARIABLE)
514 .and_then(|val| TestRunner::from_str(val).ok())
515 .unwrap_or(TestRunner::PYTEST)
516}
517
518impl PythonContextProvider {
519 fn build_unittest_target(
520 &self,
521 variables: &task::TaskVariables,
522 ) -> Option<(VariableName, String)> {
523 let python_module_name =
524 python_module_name_from_relative_path(variables.get(&VariableName::RelativeFile)?);
525
526 let unittest_class_name =
527 variables.get(&VariableName::Custom(Cow::Borrowed("_unittest_class_name")));
528
529 let unittest_method_name = variables.get(&VariableName::Custom(Cow::Borrowed(
530 "_unittest_method_name",
531 )));
532
533 let unittest_target_str = match (unittest_class_name, unittest_method_name) {
534 (Some(class_name), Some(method_name)) => {
535 format!("{python_module_name}.{class_name}.{method_name}")
536 }
537 (Some(class_name), None) => format!("{python_module_name}.{class_name}"),
538 (None, None) => python_module_name,
539 // should never happen, a TestCase class is the unit of testing
540 (None, Some(_)) => return None,
541 };
542
543 Some((
544 PYTHON_TEST_TARGET_TASK_VARIABLE.clone(),
545 unittest_target_str,
546 ))
547 }
548
549 fn build_pytest_target(
550 &self,
551 variables: &task::TaskVariables,
552 ) -> Option<(VariableName, String)> {
553 let file_path = variables.get(&VariableName::RelativeFile)?;
554
555 let pytest_class_name =
556 variables.get(&VariableName::Custom(Cow::Borrowed("_pytest_class_name")));
557
558 let pytest_method_name =
559 variables.get(&VariableName::Custom(Cow::Borrowed("_pytest_method_name")));
560
561 let pytest_target_str = match (pytest_class_name, pytest_method_name) {
562 (Some(class_name), Some(method_name)) => {
563 format!("{file_path}::{class_name}::{method_name}")
564 }
565 (Some(class_name), None) => {
566 format!("{file_path}::{class_name}")
567 }
568 (None, Some(method_name)) => {
569 format!("{file_path}::{method_name}")
570 }
571 (None, None) => file_path.to_string(),
572 };
573
574 Some((PYTHON_TEST_TARGET_TASK_VARIABLE.clone(), pytest_target_str))
575 }
576
577 fn build_module_target(
578 &self,
579 variables: &task::TaskVariables,
580 ) -> Result<(VariableName, String)> {
581 let python_module_name = python_module_name_from_relative_path(
582 variables.get(&VariableName::RelativeFile).unwrap_or(""),
583 );
584
585 let module_target = (PYTHON_MODULE_NAME_TASK_VARIABLE.clone(), python_module_name);
586
587 Ok(module_target)
588 }
589}
590
591fn python_module_name_from_relative_path(relative_path: &str) -> String {
592 let path_with_dots = relative_path.replace('/', ".");
593 path_with_dots
594 .strip_suffix(".py")
595 .unwrap_or(&path_with_dots)
596 .to_string()
597}
598
599fn python_env_kind_display(k: &PythonEnvironmentKind) -> &'static str {
600 match k {
601 PythonEnvironmentKind::Conda => "Conda",
602 PythonEnvironmentKind::Pixi => "pixi",
603 PythonEnvironmentKind::Homebrew => "Homebrew",
604 PythonEnvironmentKind::Pyenv => "global (Pyenv)",
605 PythonEnvironmentKind::GlobalPaths => "global",
606 PythonEnvironmentKind::PyenvVirtualEnv => "Pyenv",
607 PythonEnvironmentKind::Pipenv => "Pipenv",
608 PythonEnvironmentKind::Poetry => "Poetry",
609 PythonEnvironmentKind::MacPythonOrg => "global (Python.org)",
610 PythonEnvironmentKind::MacCommandLineTools => "global (Command Line Tools for Xcode)",
611 PythonEnvironmentKind::LinuxGlobal => "global",
612 PythonEnvironmentKind::MacXCode => "global (Xcode)",
613 PythonEnvironmentKind::Venv => "venv",
614 PythonEnvironmentKind::VirtualEnv => "virtualenv",
615 PythonEnvironmentKind::VirtualEnvWrapper => "virtualenvwrapper",
616 PythonEnvironmentKind::WindowsStore => "global (Windows Store)",
617 PythonEnvironmentKind::WindowsRegistry => "global (Windows Registry)",
618 }
619}
620
621pub(crate) struct PythonToolchainProvider {
622 term: SharedString,
623}
624
625impl Default for PythonToolchainProvider {
626 fn default() -> Self {
627 Self {
628 term: SharedString::new_static("Virtual Environment"),
629 }
630 }
631}
632
633static ENV_PRIORITY_LIST: &'static [PythonEnvironmentKind] = &[
634 // Prioritize non-Conda environments.
635 PythonEnvironmentKind::Poetry,
636 PythonEnvironmentKind::Pipenv,
637 PythonEnvironmentKind::VirtualEnvWrapper,
638 PythonEnvironmentKind::Venv,
639 PythonEnvironmentKind::VirtualEnv,
640 PythonEnvironmentKind::PyenvVirtualEnv,
641 PythonEnvironmentKind::Pixi,
642 PythonEnvironmentKind::Conda,
643 PythonEnvironmentKind::Pyenv,
644 PythonEnvironmentKind::GlobalPaths,
645 PythonEnvironmentKind::Homebrew,
646];
647
648fn env_priority(kind: Option<PythonEnvironmentKind>) -> usize {
649 if let Some(kind) = kind {
650 ENV_PRIORITY_LIST
651 .iter()
652 .position(|blessed_env| blessed_env == &kind)
653 .unwrap_or(ENV_PRIORITY_LIST.len())
654 } else {
655 // Unknown toolchains are less useful than non-blessed ones.
656 ENV_PRIORITY_LIST.len() + 1
657 }
658}
659
660/// Return the name of environment declared in <worktree-root/.venv.
661///
662/// https://virtualfish.readthedocs.io/en/latest/plugins.html#auto-activation-auto-activation
663fn get_worktree_venv_declaration(worktree_root: &Path) -> Option<String> {
664 fs::File::open(worktree_root.join(".venv"))
665 .and_then(|file| {
666 let mut venv_name = String::new();
667 io::BufReader::new(file).read_line(&mut venv_name)?;
668 Ok(venv_name.trim().to_string())
669 })
670 .ok()
671}
672
673#[async_trait]
674impl ToolchainLister for PythonToolchainProvider {
675 async fn list(
676 &self,
677 worktree_root: PathBuf,
678 project_env: Option<HashMap<String, String>>,
679 ) -> ToolchainList {
680 let env = project_env.unwrap_or_default();
681 let environment = EnvironmentApi::from_env(&env);
682 let locators = pet::locators::create_locators(
683 Arc::new(pet_conda::Conda::from(&environment)),
684 Arc::new(pet_poetry::Poetry::from(&environment)),
685 &environment,
686 );
687 let mut config = Configuration::default();
688 config.workspace_directories = Some(vec![worktree_root.clone()]);
689 for locator in locators.iter() {
690 locator.configure(&config);
691 }
692
693 let reporter = pet_reporter::collect::create_reporter();
694 pet::find::find_and_report_envs(&reporter, config, &locators, &environment, None);
695
696 let mut toolchains = reporter
697 .environments
698 .lock()
699 .ok()
700 .map_or(Vec::new(), |mut guard| std::mem::take(&mut guard));
701
702 let wr = worktree_root;
703 let wr_venv = get_worktree_venv_declaration(&wr);
704 // Sort detected environments by:
705 // environment name matching activation file (<workdir>/.venv)
706 // environment project dir matching worktree_root
707 // general env priority
708 // environment path matching the CONDA_PREFIX env var
709 // executable path
710 toolchains.sort_by(|lhs, rhs| {
711 // Compare venv names against worktree .venv file
712 let venv_ordering =
713 wr_venv
714 .as_ref()
715 .map_or(Ordering::Equal, |venv| match (&lhs.name, &rhs.name) {
716 (Some(l), Some(r)) => (r == venv).cmp(&(l == venv)),
717 (Some(l), None) if l == venv => Ordering::Less,
718 (None, Some(r)) if r == venv => Ordering::Greater,
719 _ => Ordering::Equal,
720 });
721
722 // Compare project paths against worktree root
723 let proj_ordering = || match (&lhs.project, &rhs.project) {
724 (Some(l), Some(r)) => (r == &wr).cmp(&(l == &wr)),
725 (Some(l), None) if l == &wr => Ordering::Less,
726 (None, Some(r)) if r == &wr => Ordering::Greater,
727 _ => Ordering::Equal,
728 };
729
730 // Compare environment priorities
731 let priority_ordering = || env_priority(lhs.kind).cmp(&env_priority(rhs.kind));
732
733 // Compare conda prefixes
734 let conda_ordering = || {
735 if lhs.kind == Some(PythonEnvironmentKind::Conda) {
736 environment
737 .get_env_var("CONDA_PREFIX".to_string())
738 .map(|conda_prefix| {
739 let is_match = |exe: &Option<PathBuf>| {
740 exe.as_ref().map_or(false, |e| e.starts_with(&conda_prefix))
741 };
742 match (is_match(&lhs.executable), is_match(&rhs.executable)) {
743 (true, false) => Ordering::Less,
744 (false, true) => Ordering::Greater,
745 _ => Ordering::Equal,
746 }
747 })
748 .unwrap_or(Ordering::Equal)
749 } else {
750 Ordering::Equal
751 }
752 };
753
754 // Compare Python executables
755 let exe_ordering = || lhs.executable.cmp(&rhs.executable);
756
757 venv_ordering
758 .then_with(proj_ordering)
759 .then_with(priority_ordering)
760 .then_with(conda_ordering)
761 .then_with(exe_ordering)
762 });
763
764 let mut toolchains: Vec<_> = toolchains
765 .into_iter()
766 .filter_map(|toolchain| {
767 let mut name = String::from("Python");
768 if let Some(ref version) = toolchain.version {
769 _ = write!(name, " {version}");
770 }
771
772 let name_and_kind = match (&toolchain.name, &toolchain.kind) {
773 (Some(name), Some(kind)) => {
774 Some(format!("({name}; {})", python_env_kind_display(kind)))
775 }
776 (Some(name), None) => Some(format!("({name})")),
777 (None, Some(kind)) => Some(format!("({})", python_env_kind_display(kind))),
778 (None, None) => None,
779 };
780
781 if let Some(nk) = name_and_kind {
782 _ = write!(name, " {nk}");
783 }
784
785 Some(Toolchain {
786 name: name.into(),
787 path: toolchain.executable.as_ref()?.to_str()?.to_owned().into(),
788 language_name: LanguageName::new("Python"),
789 as_json: serde_json::to_value(toolchain).ok()?,
790 })
791 })
792 .collect();
793 toolchains.dedup();
794 ToolchainList {
795 toolchains,
796 default: None,
797 groups: Default::default(),
798 }
799 }
800 fn term(&self) -> SharedString {
801 self.term.clone()
802 }
803}
804
805pub struct EnvironmentApi<'a> {
806 global_search_locations: Arc<Mutex<Vec<PathBuf>>>,
807 project_env: &'a HashMap<String, String>,
808 pet_env: pet_core::os_environment::EnvironmentApi,
809}
810
811impl<'a> EnvironmentApi<'a> {
812 pub fn from_env(project_env: &'a HashMap<String, String>) -> Self {
813 let paths = project_env
814 .get("PATH")
815 .map(|p| std::env::split_paths(p).collect())
816 .unwrap_or_default();
817
818 EnvironmentApi {
819 global_search_locations: Arc::new(Mutex::new(paths)),
820 project_env,
821 pet_env: pet_core::os_environment::EnvironmentApi::new(),
822 }
823 }
824
825 fn user_home(&self) -> Option<PathBuf> {
826 self.project_env
827 .get("HOME")
828 .or_else(|| self.project_env.get("USERPROFILE"))
829 .map(|home| pet_fs::path::norm_case(PathBuf::from(home)))
830 .or_else(|| self.pet_env.get_user_home())
831 }
832}
833
834impl pet_core::os_environment::Environment for EnvironmentApi<'_> {
835 fn get_user_home(&self) -> Option<PathBuf> {
836 self.user_home()
837 }
838
839 fn get_root(&self) -> Option<PathBuf> {
840 None
841 }
842
843 fn get_env_var(&self, key: String) -> Option<String> {
844 self.project_env
845 .get(&key)
846 .cloned()
847 .or_else(|| self.pet_env.get_env_var(key))
848 }
849
850 fn get_know_global_search_locations(&self) -> Vec<PathBuf> {
851 if self.global_search_locations.lock().unwrap().is_empty() {
852 let mut paths =
853 std::env::split_paths(&self.get_env_var("PATH".to_string()).unwrap_or_default())
854 .collect::<Vec<PathBuf>>();
855
856 log::trace!("Env PATH: {:?}", paths);
857 for p in self.pet_env.get_know_global_search_locations() {
858 if !paths.contains(&p) {
859 paths.push(p);
860 }
861 }
862
863 let mut paths = paths
864 .into_iter()
865 .filter(|p| p.exists())
866 .collect::<Vec<PathBuf>>();
867
868 self.global_search_locations
869 .lock()
870 .unwrap()
871 .append(&mut paths);
872 }
873 self.global_search_locations.lock().unwrap().clone()
874 }
875}
876
877pub(crate) struct PyLspAdapter {
878 python_venv_base: OnceCell<Result<Arc<Path>, String>>,
879}
880impl PyLspAdapter {
881 const SERVER_NAME: LanguageServerName = LanguageServerName::new_static("pylsp");
882 pub(crate) fn new() -> Self {
883 Self {
884 python_venv_base: OnceCell::new(),
885 }
886 }
887 async fn ensure_venv(delegate: &dyn LspAdapterDelegate) -> Result<Arc<Path>> {
888 let python_path = Self::find_base_python(delegate)
889 .await
890 .ok_or_else(|| anyhow!("Could not find Python installation for PyLSP"))?;
891 let work_dir = delegate
892 .language_server_download_dir(&Self::SERVER_NAME)
893 .await
894 .ok_or_else(|| anyhow!("Could not get working directory for PyLSP"))?;
895 let mut path = PathBuf::from(work_dir.as_ref());
896 path.push("pylsp-venv");
897 if !path.exists() {
898 util::command::new_smol_command(python_path)
899 .arg("-m")
900 .arg("venv")
901 .arg("pylsp-venv")
902 .current_dir(work_dir)
903 .spawn()?
904 .output()
905 .await?;
906 }
907
908 Ok(path.into())
909 }
910 // Find "baseline", user python version from which we'll create our own venv.
911 async fn find_base_python(delegate: &dyn LspAdapterDelegate) -> Option<PathBuf> {
912 for path in ["python3", "python"] {
913 if let Some(path) = delegate.which(path.as_ref()).await {
914 return Some(path);
915 }
916 }
917 None
918 }
919
920 async fn base_venv(&self, delegate: &dyn LspAdapterDelegate) -> Result<Arc<Path>, String> {
921 self.python_venv_base
922 .get_or_init(move || async move {
923 Self::ensure_venv(delegate)
924 .await
925 .map_err(|e| format!("{e}"))
926 })
927 .await
928 .clone()
929 }
930}
931
932const BINARY_DIR: &str = if cfg!(target_os = "windows") {
933 "Scripts"
934} else {
935 "bin"
936};
937
938#[async_trait(?Send)]
939impl LspAdapter for PyLspAdapter {
940 fn name(&self) -> LanguageServerName {
941 Self::SERVER_NAME.clone()
942 }
943
944 async fn check_if_user_installed(
945 &self,
946 delegate: &dyn LspAdapterDelegate,
947 toolchains: Arc<dyn LanguageToolchainStore>,
948 cx: &AsyncApp,
949 ) -> Option<LanguageServerBinary> {
950 if let Some(pylsp_bin) = delegate.which(Self::SERVER_NAME.as_ref()).await {
951 let env = delegate.shell_env().await;
952 Some(LanguageServerBinary {
953 path: pylsp_bin,
954 env: Some(env),
955 arguments: vec![],
956 })
957 } else {
958 let venv = toolchains
959 .active_toolchain(
960 delegate.worktree_id(),
961 Arc::from("".as_ref()),
962 LanguageName::new("Python"),
963 &mut cx.clone(),
964 )
965 .await?;
966 let pylsp_path = Path::new(venv.path.as_ref()).parent()?.join("pylsp");
967 pylsp_path.exists().then(|| LanguageServerBinary {
968 path: venv.path.to_string().into(),
969 arguments: vec![pylsp_path.into()],
970 env: None,
971 })
972 }
973 }
974
975 async fn fetch_latest_server_version(
976 &self,
977 _: &dyn LspAdapterDelegate,
978 ) -> Result<Box<dyn 'static + Any + Send>> {
979 Ok(Box::new(()) as Box<_>)
980 }
981
982 async fn fetch_server_binary(
983 &self,
984 _: Box<dyn 'static + Send + Any>,
985 _: PathBuf,
986 delegate: &dyn LspAdapterDelegate,
987 ) -> Result<LanguageServerBinary> {
988 let venv = self.base_venv(delegate).await.map_err(|e| anyhow!(e))?;
989 let pip_path = venv.join(BINARY_DIR).join("pip3");
990 ensure!(
991 util::command::new_smol_command(pip_path.as_path())
992 .arg("install")
993 .arg("python-lsp-server")
994 .arg("-U")
995 .output()
996 .await?
997 .status
998 .success(),
999 "python-lsp-server installation failed"
1000 );
1001 ensure!(
1002 util::command::new_smol_command(pip_path.as_path())
1003 .arg("install")
1004 .arg("python-lsp-server[all]")
1005 .arg("-U")
1006 .output()
1007 .await?
1008 .status
1009 .success(),
1010 "python-lsp-server[all] installation failed"
1011 );
1012 ensure!(
1013 util::command::new_smol_command(pip_path)
1014 .arg("install")
1015 .arg("pylsp-mypy")
1016 .arg("-U")
1017 .output()
1018 .await?
1019 .status
1020 .success(),
1021 "pylsp-mypy installation failed"
1022 );
1023 let pylsp = venv.join(BINARY_DIR).join("pylsp");
1024 Ok(LanguageServerBinary {
1025 path: pylsp,
1026 env: None,
1027 arguments: vec![],
1028 })
1029 }
1030
1031 async fn cached_server_binary(
1032 &self,
1033 _: PathBuf,
1034 delegate: &dyn LspAdapterDelegate,
1035 ) -> Option<LanguageServerBinary> {
1036 let venv = self.base_venv(delegate).await.ok()?;
1037 let pylsp = venv.join(BINARY_DIR).join("pylsp");
1038 Some(LanguageServerBinary {
1039 path: pylsp,
1040 env: None,
1041 arguments: vec![],
1042 })
1043 }
1044
1045 async fn process_completions(&self, _items: &mut [lsp::CompletionItem]) {}
1046
1047 async fn label_for_completion(
1048 &self,
1049 item: &lsp::CompletionItem,
1050 language: &Arc<language::Language>,
1051 ) -> Option<language::CodeLabel> {
1052 let label = &item.label;
1053 let grammar = language.grammar()?;
1054 let highlight_id = match item.kind? {
1055 lsp::CompletionItemKind::METHOD => grammar.highlight_id_for_name("function.method")?,
1056 lsp::CompletionItemKind::FUNCTION => grammar.highlight_id_for_name("function")?,
1057 lsp::CompletionItemKind::CLASS => grammar.highlight_id_for_name("type")?,
1058 lsp::CompletionItemKind::CONSTANT => grammar.highlight_id_for_name("constant")?,
1059 _ => return None,
1060 };
1061 Some(language::CodeLabel {
1062 text: label.clone(),
1063 runs: vec![(0..label.len(), highlight_id)],
1064 filter_range: 0..label.len(),
1065 })
1066 }
1067
1068 async fn label_for_symbol(
1069 &self,
1070 name: &str,
1071 kind: lsp::SymbolKind,
1072 language: &Arc<language::Language>,
1073 ) -> Option<language::CodeLabel> {
1074 let (text, filter_range, display_range) = match kind {
1075 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
1076 let text = format!("def {}():\n", name);
1077 let filter_range = 4..4 + name.len();
1078 let display_range = 0..filter_range.end;
1079 (text, filter_range, display_range)
1080 }
1081 lsp::SymbolKind::CLASS => {
1082 let text = format!("class {}:", name);
1083 let filter_range = 6..6 + name.len();
1084 let display_range = 0..filter_range.end;
1085 (text, filter_range, display_range)
1086 }
1087 lsp::SymbolKind::CONSTANT => {
1088 let text = format!("{} = 0", name);
1089 let filter_range = 0..name.len();
1090 let display_range = 0..filter_range.end;
1091 (text, filter_range, display_range)
1092 }
1093 _ => return None,
1094 };
1095
1096 Some(language::CodeLabel {
1097 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
1098 text: text[display_range].to_string(),
1099 filter_range,
1100 })
1101 }
1102
1103 async fn workspace_configuration(
1104 self: Arc<Self>,
1105 _: &dyn Fs,
1106 adapter: &Arc<dyn LspAdapterDelegate>,
1107 toolchains: Arc<dyn LanguageToolchainStore>,
1108 cx: &mut AsyncApp,
1109 ) -> Result<Value> {
1110 let toolchain = toolchains
1111 .active_toolchain(
1112 adapter.worktree_id(),
1113 Arc::from("".as_ref()),
1114 LanguageName::new("Python"),
1115 cx,
1116 )
1117 .await;
1118 cx.update(move |cx| {
1119 let mut user_settings =
1120 language_server_settings(adapter.as_ref(), &Self::SERVER_NAME, cx)
1121 .and_then(|s| s.settings.clone())
1122 .unwrap_or_else(|| {
1123 json!({
1124 "plugins": {
1125 "pycodestyle": {"enabled": false},
1126 "rope_autoimport": {"enabled": true, "memory": true},
1127 "pylsp_mypy": {"enabled": false}
1128 },
1129 "rope": {
1130 "ropeFolder": null
1131 },
1132 })
1133 });
1134
1135 // If user did not explicitly modify their python venv, use one from picker.
1136 if let Some(toolchain) = toolchain {
1137 if user_settings.is_null() {
1138 user_settings = Value::Object(serde_json::Map::default());
1139 }
1140 let object = user_settings.as_object_mut().unwrap();
1141 if let Some(python) = object
1142 .entry("plugins")
1143 .or_insert(Value::Object(serde_json::Map::default()))
1144 .as_object_mut()
1145 {
1146 if let Some(jedi) = python
1147 .entry("jedi")
1148 .or_insert(Value::Object(serde_json::Map::default()))
1149 .as_object_mut()
1150 {
1151 jedi.entry("environment".to_string())
1152 .or_insert_with(|| Value::String(toolchain.path.clone().into()));
1153 }
1154 if let Some(pylint) = python
1155 .entry("pylsp_mypy")
1156 .or_insert(Value::Object(serde_json::Map::default()))
1157 .as_object_mut()
1158 {
1159 pylint.entry("overrides".to_string()).or_insert_with(|| {
1160 Value::Array(vec![
1161 Value::String("--python-executable".into()),
1162 Value::String(toolchain.path.into()),
1163 Value::String("--cache-dir=/dev/null".into()),
1164 Value::Bool(true),
1165 ])
1166 });
1167 }
1168 }
1169 }
1170 user_settings = Value::Object(serde_json::Map::from_iter([(
1171 "pylsp".to_string(),
1172 user_settings,
1173 )]));
1174
1175 user_settings
1176 })
1177 }
1178 fn manifest_name(&self) -> Option<ManifestName> {
1179 Some(SharedString::new_static("pyproject.toml").into())
1180 }
1181}
1182
1183#[cfg(test)]
1184mod tests {
1185 use gpui::{AppContext as _, BorrowAppContext, Context, TestAppContext};
1186 use language::{AutoindentMode, Buffer, language_settings::AllLanguageSettings};
1187 use settings::SettingsStore;
1188 use std::num::NonZeroU32;
1189
1190 #[gpui::test]
1191 async fn test_python_autoindent(cx: &mut TestAppContext) {
1192 cx.executor().set_block_on_ticks(usize::MAX..=usize::MAX);
1193 let language = crate::language("python", tree_sitter_python::LANGUAGE.into());
1194 cx.update(|cx| {
1195 let test_settings = SettingsStore::test(cx);
1196 cx.set_global(test_settings);
1197 language::init(cx);
1198 cx.update_global::<SettingsStore, _>(|store, cx| {
1199 store.update_user_settings::<AllLanguageSettings>(cx, |s| {
1200 s.defaults.tab_size = NonZeroU32::new(2);
1201 });
1202 });
1203 });
1204
1205 cx.new(|cx| {
1206 let mut buffer = Buffer::local("", cx).with_language(language, cx);
1207 let append = |buffer: &mut Buffer, text: &str, cx: &mut Context<Buffer>| {
1208 let ix = buffer.len();
1209 buffer.edit([(ix..ix, text)], Some(AutoindentMode::EachLine), cx);
1210 };
1211
1212 // indent after "def():"
1213 append(&mut buffer, "def a():\n", cx);
1214 assert_eq!(buffer.text(), "def a():\n ");
1215
1216 // preserve indent after blank line
1217 append(&mut buffer, "\n ", cx);
1218 assert_eq!(buffer.text(), "def a():\n \n ");
1219
1220 // indent after "if"
1221 append(&mut buffer, "if a:\n ", cx);
1222 assert_eq!(buffer.text(), "def a():\n \n if a:\n ");
1223
1224 // preserve indent after statement
1225 append(&mut buffer, "b()\n", cx);
1226 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n ");
1227
1228 // preserve indent after statement
1229 append(&mut buffer, "else", cx);
1230 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else");
1231
1232 // dedent "else""
1233 append(&mut buffer, ":", cx);
1234 assert_eq!(buffer.text(), "def a():\n \n if a:\n b()\n else:");
1235
1236 // indent lines after else
1237 append(&mut buffer, "\n", cx);
1238 assert_eq!(
1239 buffer.text(),
1240 "def a():\n \n if a:\n b()\n else:\n "
1241 );
1242
1243 // indent after an open paren. the closing paren is not indented
1244 // because there is another token before it on the same line.
1245 append(&mut buffer, "foo(\n1)", cx);
1246 assert_eq!(
1247 buffer.text(),
1248 "def a():\n \n if a:\n b()\n else:\n foo(\n 1)"
1249 );
1250
1251 // dedent the closing paren if it is shifted to the beginning of the line
1252 let argument_ix = buffer.text().find('1').unwrap();
1253 buffer.edit(
1254 [(argument_ix..argument_ix + 1, "")],
1255 Some(AutoindentMode::EachLine),
1256 cx,
1257 );
1258 assert_eq!(
1259 buffer.text(),
1260 "def a():\n \n if a:\n b()\n else:\n foo(\n )"
1261 );
1262
1263 // preserve indent after the close paren
1264 append(&mut buffer, "\n", cx);
1265 assert_eq!(
1266 buffer.text(),
1267 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n "
1268 );
1269
1270 // manually outdent the last line
1271 let end_whitespace_ix = buffer.len() - 4;
1272 buffer.edit(
1273 [(end_whitespace_ix..buffer.len(), "")],
1274 Some(AutoindentMode::EachLine),
1275 cx,
1276 );
1277 assert_eq!(
1278 buffer.text(),
1279 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n"
1280 );
1281
1282 // preserve the newly reduced indentation on the next newline
1283 append(&mut buffer, "\n", cx);
1284 assert_eq!(
1285 buffer.text(),
1286 "def a():\n \n if a:\n b()\n else:\n foo(\n )\n\n"
1287 );
1288
1289 // reset to a simple if statement
1290 buffer.edit([(0..buffer.len(), "if a:\n b(\n )")], None, cx);
1291
1292 // dedent "else" on the line after a closing paren
1293 append(&mut buffer, "\n else:\n", cx);
1294 assert_eq!(buffer.text(), "if a:\n b(\n )\nelse:\n ");
1295
1296 buffer
1297 });
1298 }
1299}