|
| 1 | +use std::collections::BTreeMap; |
| 2 | +use std::path::Path; |
| 3 | + |
| 4 | +use uv_configuration::SourceStrategy; |
| 5 | +use uv_distribution_types::{IndexLocations, Requirement}; |
| 6 | +use uv_normalize::{DEV_DEPENDENCIES, GroupName, PackageName}; |
| 7 | +use uv_workspace::dependency_groups::FlatDependencyGroups; |
| 8 | +use uv_workspace::pyproject::{Sources, ToolUvSources}; |
| 9 | +use uv_workspace::{DiscoveryOptions, MemberDiscovery, VirtualProject, WorkspaceCache}; |
| 10 | + |
| 11 | +use crate::metadata::{GitWorkspaceMember, LoweredRequirement, MetadataError}; |
| 12 | + |
| 13 | +#[derive(Debug, Clone)] |
| 14 | +pub struct SourcedDependencyGroups { |
| 15 | + pub name: Option<PackageName>, |
| 16 | + pub dependency_groups: BTreeMap<GroupName, Box<[Requirement]>>, |
| 17 | +} |
| 18 | + |
| 19 | +impl SourcedDependencyGroups { |
| 20 | + /// Lower by considering `tool.uv` in `pyproject.toml` if present, used for Git and directory |
| 21 | + /// dependencies. |
| 22 | + pub async fn from_virtual_project( |
| 23 | + pyproject_path: &Path, |
| 24 | + git_member: Option<&GitWorkspaceMember<'_>>, |
| 25 | + locations: &IndexLocations, |
| 26 | + source_strategy: SourceStrategy, |
| 27 | + cache: &WorkspaceCache, |
| 28 | + ) -> Result<Self, MetadataError> { |
| 29 | + let discovery = DiscoveryOptions { |
| 30 | + stop_discovery_at: git_member.map(|git_member| { |
| 31 | + git_member |
| 32 | + .fetch_root |
| 33 | + .parent() |
| 34 | + .expect("git checkout has a parent") |
| 35 | + .to_path_buf() |
| 36 | + }), |
| 37 | + members: match source_strategy { |
| 38 | + SourceStrategy::Enabled => MemberDiscovery::default(), |
| 39 | + SourceStrategy::Disabled => MemberDiscovery::None, |
| 40 | + }, |
| 41 | + }; |
| 42 | + let project = VirtualProject::discover_defaulted(pyproject_path, &discovery, cache).await?; |
| 43 | + |
| 44 | + // Collect any `tool.uv.index` entries. |
| 45 | + let empty = vec![]; |
| 46 | + let project_indexes = match source_strategy { |
| 47 | + SourceStrategy::Enabled => project |
| 48 | + .pyproject_toml() |
| 49 | + .tool |
| 50 | + .as_ref() |
| 51 | + .and_then(|tool| tool.uv.as_ref()) |
| 52 | + .and_then(|uv| uv.index.as_deref()) |
| 53 | + .unwrap_or(&empty), |
| 54 | + SourceStrategy::Disabled => &empty, |
| 55 | + }; |
| 56 | + |
| 57 | + // Collect any `tool.uv.sources` and `tool.uv.dev_dependencies` from `pyproject.toml`. |
| 58 | + let empty = BTreeMap::default(); |
| 59 | + let project_sources = match source_strategy { |
| 60 | + SourceStrategy::Enabled => project |
| 61 | + .pyproject_toml() |
| 62 | + .tool |
| 63 | + .as_ref() |
| 64 | + .and_then(|tool| tool.uv.as_ref()) |
| 65 | + .and_then(|uv| uv.sources.as_ref()) |
| 66 | + .map(ToolUvSources::inner) |
| 67 | + .unwrap_or(&empty), |
| 68 | + SourceStrategy::Disabled => &empty, |
| 69 | + }; |
| 70 | + |
| 71 | + // Collect the dependency groups. |
| 72 | + let dependency_groups = { |
| 73 | + // First, collect `tool.uv.dev_dependencies` |
| 74 | + let dev_dependencies = project |
| 75 | + .pyproject_toml() |
| 76 | + .tool |
| 77 | + .as_ref() |
| 78 | + .and_then(|tool| tool.uv.as_ref()) |
| 79 | + .and_then(|uv| uv.dev_dependencies.as_ref()); |
| 80 | + |
| 81 | + // Then, collect `dependency-groups` |
| 82 | + let dependency_groups = project |
| 83 | + .pyproject_toml() |
| 84 | + .dependency_groups |
| 85 | + .iter() |
| 86 | + .flatten() |
| 87 | + .collect::<BTreeMap<_, _>>(); |
| 88 | + |
| 89 | + // Flatten the dependency groups. |
| 90 | + let mut dependency_groups = |
| 91 | + FlatDependencyGroups::from_dependency_groups(&dependency_groups) |
| 92 | + .map_err(|err| err.with_dev_dependencies(dev_dependencies))?; |
| 93 | + |
| 94 | + // Add the `dev` group, if `dev-dependencies` is defined. |
| 95 | + if let Some(dev_dependencies) = dev_dependencies { |
| 96 | + dependency_groups |
| 97 | + .entry(DEV_DEPENDENCIES.clone()) |
| 98 | + .or_insert_with(Vec::new) |
| 99 | + .extend(dev_dependencies.clone()); |
| 100 | + } |
| 101 | + |
| 102 | + dependency_groups |
| 103 | + }; |
| 104 | + |
| 105 | + // Now that we've resolved the dependency groups, we can validate that each source references |
| 106 | + // a valid extra or group, if present. |
| 107 | + Self::validate_sources(project_sources, &dependency_groups)?; |
| 108 | + |
| 109 | + // Lower the dependency groups. |
| 110 | + let dependency_groups = dependency_groups |
| 111 | + .into_iter() |
| 112 | + .map(|(name, requirements)| { |
| 113 | + let requirements = match source_strategy { |
| 114 | + SourceStrategy::Enabled => requirements |
| 115 | + .into_iter() |
| 116 | + .flat_map(|requirement| { |
| 117 | + let requirement_name = requirement.name.clone(); |
| 118 | + let group = name.clone(); |
| 119 | + let extra = None; |
| 120 | + LoweredRequirement::from_requirement( |
| 121 | + requirement, |
| 122 | + project.project_name(), |
| 123 | + project.root(), |
| 124 | + project_sources, |
| 125 | + project_indexes, |
| 126 | + extra, |
| 127 | + Some(&group), |
| 128 | + locations, |
| 129 | + project.workspace(), |
| 130 | + git_member, |
| 131 | + ) |
| 132 | + .map( |
| 133 | + move |requirement| match requirement { |
| 134 | + Ok(requirement) => Ok(requirement.into_inner()), |
| 135 | + Err(err) => Err(MetadataError::GroupLoweringError( |
| 136 | + group.clone(), |
| 137 | + requirement_name.clone(), |
| 138 | + Box::new(err), |
| 139 | + )), |
| 140 | + }, |
| 141 | + ) |
| 142 | + }) |
| 143 | + .collect::<Result<Box<_>, _>>(), |
| 144 | + SourceStrategy::Disabled => { |
| 145 | + Ok(requirements.into_iter().map(Requirement::from).collect()) |
| 146 | + } |
| 147 | + }?; |
| 148 | + Ok::<(GroupName, Box<_>), MetadataError>((name, requirements)) |
| 149 | + }) |
| 150 | + .collect::<Result<BTreeMap<_, _>, _>>()?; |
| 151 | + |
| 152 | + Ok(Self { |
| 153 | + name: project.project_name().cloned(), |
| 154 | + dependency_groups, |
| 155 | + }) |
| 156 | + } |
| 157 | + |
| 158 | + /// Validate the sources. |
| 159 | + /// |
| 160 | + /// If a source is requested with `group`, ensure that the relevant dependency is |
| 161 | + /// present in the relevant `dependency-groups` section. |
| 162 | + fn validate_sources( |
| 163 | + sources: &BTreeMap<PackageName, Sources>, |
| 164 | + dependency_groups: &FlatDependencyGroups, |
| 165 | + ) -> Result<(), MetadataError> { |
| 166 | + for (name, sources) in sources { |
| 167 | + for source in sources.iter() { |
| 168 | + if let Some(group) = source.group() { |
| 169 | + // If the group doesn't exist at all, error. |
| 170 | + let Some(dependencies) = dependency_groups.get(group) else { |
| 171 | + return Err(MetadataError::MissingSourceGroup( |
| 172 | + name.clone(), |
| 173 | + group.clone(), |
| 174 | + )); |
| 175 | + }; |
| 176 | + |
| 177 | + // If there is no such requirement with the group, error. |
| 178 | + if !dependencies |
| 179 | + .iter() |
| 180 | + .any(|requirement| requirement.name == *name) |
| 181 | + { |
| 182 | + return Err(MetadataError::IncompleteSourceGroup( |
| 183 | + name.clone(), |
| 184 | + group.clone(), |
| 185 | + )); |
| 186 | + } |
| 187 | + } |
| 188 | + } |
| 189 | + } |
| 190 | + |
| 191 | + Ok(()) |
| 192 | + } |
| 193 | +} |
0 commit comments