-
Notifications
You must be signed in to change notification settings - Fork 790
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Summary resolves #3272 added it as a new subcommand rather than a flag on an existing command since that seems more consistent with `cargo tree` + cleaner code organization, but can make changes if it's preferred the other way.
- Loading branch information
1 parent
7e574f5
commit dd45fce
Showing
7 changed files
with
942 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,235 @@ | ||
| use std::fmt::Write; | ||
|
|
||
| use distribution_types::{Diagnostic, InstalledDist, Name}; | ||
| use owo_colors::OwoColorize; | ||
| use tracing::debug; | ||
| use uv_cache::Cache; | ||
| use uv_configuration::PreviewMode; | ||
| use uv_fs::Simplified; | ||
| use uv_installer::SitePackages; | ||
| use uv_normalize::PackageName; | ||
| use uv_toolchain::EnvironmentPreference; | ||
| use uv_toolchain::PythonEnvironment; | ||
| use uv_toolchain::ToolchainRequest; | ||
|
|
||
| use crate::commands::ExitStatus; | ||
| use crate::printer::Printer; | ||
| use std::collections::{HashMap, HashSet}; | ||
|
|
||
| use pypi_types::VerbatimParsedUrl; | ||
|
|
||
| /// Display the installed packages in the current environment as a dependency tree. | ||
| pub(crate) fn pip_tree( | ||
| strict: bool, | ||
| python: Option<&str>, | ||
| system: bool, | ||
| _preview: PreviewMode, | ||
| cache: &Cache, | ||
| printer: Printer, | ||
| ) -> anyhow::Result<ExitStatus> { | ||
| // Detect the current Python interpreter. | ||
| let environment = PythonEnvironment::find( | ||
| &python.map(ToolchainRequest::parse).unwrap_or_default(), | ||
| EnvironmentPreference::from_system_flag(system, false), | ||
| cache, | ||
| )?; | ||
|
|
||
| debug!( | ||
| "Using Python {} environment at {}", | ||
| environment.interpreter().python_version(), | ||
| environment.python_executable().user_display().cyan() | ||
| ); | ||
|
|
||
| // Build the installed index. | ||
| let site_packages = SitePackages::from_executable(&environment)?; | ||
|
|
||
| let rendered_tree = DisplayDependencyGraph::new(&site_packages) | ||
| .render() | ||
| .join("\n"); | ||
| writeln!(printer.stdout(), "{rendered_tree}").unwrap(); | ||
| if rendered_tree.contains('*') { | ||
| writeln!( | ||
| printer.stdout(), | ||
| r#"{}: (*) indicates the package has been `de-duplicated`. | ||
| The dependencies for the package have already been shown elsewhere in the graph, and so are not repeated."#, | ||
| "Note".yellow().bold() | ||
| )?; | ||
| } | ||
|
|
||
| // Validate that the environment is consistent. | ||
| if strict { | ||
| for diagnostic in site_packages.diagnostics()? { | ||
| writeln!( | ||
| printer.stderr(), | ||
| "{}{} {}", | ||
| "warning".yellow().bold(), | ||
| ":".bold(), | ||
| diagnostic.message().bold() | ||
| )?; | ||
| } | ||
| } | ||
| Ok(ExitStatus::Success) | ||
| } | ||
|
|
||
| // Filter out all required packages of the given distribution if they | ||
| // are required by an extra. | ||
| // For example, `requests==2.32.3` requires `charset-normalizer`, `idna`, `urllib`, and `certifi` at | ||
| // all times, `PySocks` on `socks` extra and `chardet` on `use_chardet_on_py3` extra. | ||
| // This function will return `["charset-normalizer", "idna", "urllib", "certifi"]` for `requests`. | ||
| fn required_with_no_extra(dist: &InstalledDist) -> Vec<pep508_rs::Requirement<VerbatimParsedUrl>> { | ||
| let metadata = dist.metadata().unwrap(); | ||
| return metadata | ||
| .requires_dist | ||
| .into_iter() | ||
| .filter(|r| { | ||
| r.marker.is_none() | ||
| || !r | ||
| .marker | ||
| .as_ref() | ||
| .unwrap() | ||
| .evaluate_optional_environment(None, &metadata.provides_extras[..]) | ||
| }) | ||
| .collect::<Vec<_>>(); | ||
| } | ||
|
|
||
| // Render the line for the given installed distribution in the dependency tree. | ||
| fn render_line(installed_dist: &InstalledDist, is_visited: bool) -> String { | ||
| let mut line = String::new(); | ||
| write!( | ||
| &mut line, | ||
| "{} v{}", | ||
| installed_dist.name(), | ||
| installed_dist.version() | ||
| ) | ||
| .unwrap(); | ||
|
|
||
| if is_visited { | ||
| line.push_str(" (*)"); | ||
| } | ||
| line | ||
| } | ||
| #[derive(Debug)] | ||
| struct DisplayDependencyGraph<'a> { | ||
| site_packages: &'a SitePackages, | ||
| // Map from package name to the installed distribution. | ||
| dist_by_package_name: HashMap<&'a PackageName, &'a InstalledDist>, | ||
| // Set of package names that are required by at least one installed distribution. | ||
| // It is used to determine the starting nodes when recursing the | ||
| // dependency graph. | ||
| required_packages: HashSet<PackageName>, | ||
| } | ||
|
|
||
| impl<'a> DisplayDependencyGraph<'a> { | ||
| /// Create a new [`DisplayDependencyGraph`] for the set of installed distributions. | ||
| fn new(site_packages: &'a SitePackages) -> DisplayDependencyGraph<'a> { | ||
| let mut dist_by_package_name = HashMap::new(); | ||
| let mut required_packages = HashSet::new(); | ||
| for site_package in site_packages.iter() { | ||
| dist_by_package_name.insert(site_package.name(), site_package); | ||
| } | ||
| for site_package in site_packages.iter() { | ||
| for required in required_with_no_extra(site_package) { | ||
| required_packages.insert(required.name.clone()); | ||
| } | ||
| } | ||
|
|
||
| Self { | ||
| site_packages, | ||
| dist_by_package_name, | ||
| required_packages, | ||
| } | ||
| } | ||
|
|
||
| // Depth-first traversal of the given distribution and its dependencies. | ||
| fn visit( | ||
| &self, | ||
| installed_dist: &InstalledDist, | ||
| visited: &mut HashSet<String>, | ||
| path: &mut Vec<String>, | ||
| ) -> Vec<String> { | ||
| let mut lines = Vec::new(); | ||
| let package_name = installed_dist.name().to_string(); | ||
| let is_visited = visited.contains(&package_name); | ||
| lines.push(render_line(installed_dist, is_visited)); | ||
| if is_visited { | ||
| return lines; | ||
| } | ||
|
|
||
| path.push(package_name.clone()); | ||
| visited.insert(package_name.clone()); | ||
| let required_packages = required_with_no_extra(installed_dist); | ||
| for (index, required_package) in required_packages.iter().enumerate() { | ||
| // Skip if the current package is not one of the installed distributions. | ||
| if !self | ||
| .dist_by_package_name | ||
| .contains_key(&required_package.name) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| // For sub-visited packages, add the prefix to make the tree display user-friendly. | ||
| // The key observation here is you can group the tree as follows when you're at the | ||
| // root of the tree: | ||
| // root_package | ||
| // ├── level_1_0 // Group 1 | ||
| // │ ├── level_2_0 ... | ||
| // │ │ ├── level_3_0 ... | ||
| // │ │ └── level_3_1 ... | ||
| // │ └── level_2_1 ... | ||
| // ├── level_1_1 // Group 2 | ||
| // │ ├── level_2_2 ... | ||
| // │ └── level_2_3 ... | ||
| // └── level_1_2 // Group 3 | ||
| // └── level_2_4 ... | ||
| // | ||
| // The lines in Group 1 and 2 have `├── ` at the top and `| ` at the rest while | ||
| // those in Group 3 have `└── ` at the top and ` ` at the rest. | ||
| // This observation is true recursively even when looking at the subtree rooted | ||
| // at `level_1_0`. | ||
| let (prefix_top, prefix_rest) = if required_packages.len() - 1 == index { | ||
| ("└── ", " ") | ||
| } else { | ||
| ("├── ", "│ ") | ||
| }; | ||
|
|
||
| let mut prefixed_lines = Vec::new(); | ||
| for (visited_index, visited_line) in self | ||
| .visit( | ||
| self.dist_by_package_name[&required_package.name], | ||
| visited, | ||
| path, | ||
| ) | ||
| .iter() | ||
| .enumerate() | ||
| { | ||
| prefixed_lines.push(format!( | ||
| "{}{}", | ||
| if visited_index == 0 { | ||
| prefix_top | ||
| } else { | ||
| prefix_rest | ||
| }, | ||
| visited_line | ||
| )); | ||
| } | ||
| lines.extend(prefixed_lines); | ||
| } | ||
| path.pop(); | ||
| lines | ||
| } | ||
|
|
||
| // Depth-first traverse the nodes to render the tree. | ||
| // The starting nodes are the ones without incoming edges. | ||
| fn render(&self) -> Vec<String> { | ||
| let mut visited: HashSet<String> = HashSet::new(); | ||
| let mut lines: Vec<String> = Vec::new(); | ||
| for site_package in self.site_packages.iter() { | ||
| // If the current package is not required by any other package, start the traversal | ||
| // with the current package as the root. | ||
| if !self.required_packages.contains(site_package.name()) { | ||
| lines.extend(self.visit(site_package, &mut visited, &mut Vec::new())); | ||
| } | ||
| } | ||
| lines | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.