1use std::borrow::Cow;
2use std::collections::{BTreeMap, BTreeSet, VecDeque};
3use std::error::Error;
4use std::fmt::{Debug, Display, Formatter};
5use std::io;
6use std::path::{Path, PathBuf};
7use std::str::FromStr;
8use std::sync::{Arc, LazyLock};
9
10use itertools::Itertools;
11use jiff::Timestamp;
12use owo_colors::OwoColorize;
13use petgraph::graph::NodeIndex;
14use petgraph::visit::EdgeRef;
15use rustc_hash::{FxBuildHasher, FxHashMap, FxHashSet};
16use serde::Serializer;
17use toml_edit::{Array, ArrayOfTables, InlineTable, Item, Table, Value, value};
18use tracing::{debug, instrument, trace};
19use url::Url;
20
21use uv_cache_key::RepositoryUrl;
22use uv_configuration::{
23 BuildOptions, Constraints, DependencyGroupsWithDefaults, ExcludeDependency,
24 ExtrasSpecificationWithDefaults, InstallTarget, Override, PackageOverride,
25};
26use uv_distribution::{DistributionDatabase, FlatRequiresDist, RequiresDist};
27use uv_distribution_filename::{
28 BuildTag, DistExtension, ExtensionError, SourceDistExtension, WheelFilename,
29};
30use uv_distribution_types::{
31 BuiltDist, DependencyMetadata, DirectUrlBuiltDist, DirectUrlSourceDist, DirectorySourceDist,
32 Dist, FileLocation, GitDirectorySourceDist, GitPathBuiltDist, GitPathSourceDist, Identifier,
33 IndexLocations, IndexMetadata, IndexUrl, Name, PYPI_URL, PathBuiltDist, PathSourceDist,
34 RegistryBuiltDist, RegistryBuiltWheel, RegistrySourceDist, RemoteSource, Requirement,
35 RequirementSource, RequiresPython, ResolvedDist, SimplifiedMarkerTree, StaticMetadata,
36 ToUrlError, UrlString,
37};
38use uv_fs::{
39 PortablePath, PortablePathBuf, Simplified, normalize_path, relative_to, try_relative_to_if,
40};
41use uv_git::{RepositoryReference, ResolvedRepositoryReference};
42use uv_git_types::{GitLfs, GitOid, GitReference, GitUrl, GitUrlParseError};
43use uv_normalize::{ExtraName, GroupName, PackageName};
44use uv_pep440::Version;
45use uv_pep508::{
46 MarkerEnvironment, MarkerTree, Scheme, VerbatimUrl, VerbatimUrlError, split_scheme,
47};
48use uv_platform_tags::{
49 AbiTag, IncompatibleTag, LanguageTag, PlatformTag, TagCompatibility, TagPriority, Tags,
50};
51use uv_pypi_types::{
52 ConflictKind, Conflicts, HashAlgorithm, HashDigest, HashDigests, Hashes, ParsedArchiveUrl,
53 ParsedGitDirectoryUrl, ParsedGitPathUrl, PyProjectToml,
54};
55use uv_redacted::{DisplaySafeUrl, DisplaySafeUrlError};
56use uv_small_str::SmallString;
57use uv_types::{BuildContext, HashStrategy};
58use uv_workspace::{Editability, WorkspaceMember};
59
60use crate::fork_strategy::ForkStrategy;
61pub(crate) use crate::lock::export::PylockTomlPackage;
62pub use crate::lock::export::RequirementsTxtExport;
63pub use crate::lock::export::{
64 Metadata, PylockToml, PylockTomlError, PylockTomlErrorKind, cyclonedx_json,
65};
66pub use crate::lock::installable::Installable;
67pub use crate::lock::map::PackageMap;
68pub use crate::lock::tree::TreeDisplay;
69use crate::resolution::{AnnotatedDist, ResolutionGraphNode};
70use crate::universal_marker::{ConflictMarker, UniversalMarker};
71use crate::{
72 ExcludeNewer, ExcludeNewerOverride, ExcludeNewerPackage, ExcludeNewerSpan, ExcludeNewerValue,
73 InMemoryIndex, MetadataResponse, PrereleaseMode, ResolutionMode, ResolverOutput,
74};
75
76pub(crate) mod export;
77mod installable;
78mod map;
79mod tree;
80
81pub const VERSION: u32 = 1;
83
84const REVISION: u32 = 3;
86
87static LINUX_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
88 let pep508 = MarkerTree::from_str("os_name == 'posix' and sys_platform == 'linux'").unwrap();
89 UniversalMarker::new(pep508, ConflictMarker::TRUE)
90});
91static WINDOWS_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
92 let pep508 = MarkerTree::from_str("os_name == 'nt' and sys_platform == 'win32'").unwrap();
93 UniversalMarker::new(pep508, ConflictMarker::TRUE)
94});
95static MAC_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
96 let pep508 = MarkerTree::from_str("os_name == 'posix' and sys_platform == 'darwin'").unwrap();
97 UniversalMarker::new(pep508, ConflictMarker::TRUE)
98});
99static ANDROID_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
100 let pep508 = MarkerTree::from_str("sys_platform == 'android'").unwrap();
101 UniversalMarker::new(pep508, ConflictMarker::TRUE)
102});
103static ARM_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
104 let pep508 =
105 MarkerTree::from_str("platform_machine == 'aarch64' or platform_machine == 'arm64' or platform_machine == 'ARM64'")
106 .unwrap();
107 UniversalMarker::new(pep508, ConflictMarker::TRUE)
108});
109static X86_64_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
110 let pep508 =
111 MarkerTree::from_str("platform_machine == 'x86_64' or platform_machine == 'amd64' or platform_machine == 'AMD64'")
112 .unwrap();
113 UniversalMarker::new(pep508, ConflictMarker::TRUE)
114});
115static X86_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
116 let pep508 = MarkerTree::from_str(
117 "platform_machine == 'i686' or platform_machine == 'i386' or platform_machine == 'win32' or platform_machine == 'x86'",
118 )
119 .unwrap();
120 UniversalMarker::new(pep508, ConflictMarker::TRUE)
121});
122static PPC64LE_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
123 let pep508 = MarkerTree::from_str("platform_machine == 'ppc64le'").unwrap();
124 UniversalMarker::new(pep508, ConflictMarker::TRUE)
125});
126static PPC64_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
127 let pep508 = MarkerTree::from_str("platform_machine == 'ppc64'").unwrap();
128 UniversalMarker::new(pep508, ConflictMarker::TRUE)
129});
130static S390X_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
131 let pep508 = MarkerTree::from_str("platform_machine == 's390x'").unwrap();
132 UniversalMarker::new(pep508, ConflictMarker::TRUE)
133});
134static RISCV64_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
135 let pep508 = MarkerTree::from_str("platform_machine == 'riscv64'").unwrap();
136 UniversalMarker::new(pep508, ConflictMarker::TRUE)
137});
138static LOONGARCH64_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
139 let pep508 = MarkerTree::from_str("platform_machine == 'loongarch64'").unwrap();
140 UniversalMarker::new(pep508, ConflictMarker::TRUE)
141});
142static ARMV7L_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
143 let pep508 =
144 MarkerTree::from_str("platform_machine == 'armv7l' or platform_machine == 'armv8l'")
145 .unwrap();
146 UniversalMarker::new(pep508, ConflictMarker::TRUE)
147});
148static ARMV6L_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
149 let pep508 = MarkerTree::from_str("platform_machine == 'armv6l'").unwrap();
150 UniversalMarker::new(pep508, ConflictMarker::TRUE)
151});
152static LINUX_ARM_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
153 let mut marker = *LINUX_MARKERS;
154 marker.and(*ARM_MARKERS);
155 marker
156});
157static LINUX_X86_64_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
158 let mut marker = *LINUX_MARKERS;
159 marker.and(*X86_64_MARKERS);
160 marker
161});
162static LINUX_X86_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
163 let mut marker = *LINUX_MARKERS;
164 marker.and(*X86_MARKERS);
165 marker
166});
167static LINUX_PPC64LE_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
168 let mut marker = *LINUX_MARKERS;
169 marker.and(*PPC64LE_MARKERS);
170 marker
171});
172static LINUX_PPC64_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
173 let mut marker = *LINUX_MARKERS;
174 marker.and(*PPC64_MARKERS);
175 marker
176});
177static LINUX_S390X_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
178 let mut marker = *LINUX_MARKERS;
179 marker.and(*S390X_MARKERS);
180 marker
181});
182static LINUX_RISCV64_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
183 let mut marker = *LINUX_MARKERS;
184 marker.and(*RISCV64_MARKERS);
185 marker
186});
187static LINUX_LOONGARCH64_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
188 let mut marker = *LINUX_MARKERS;
189 marker.and(*LOONGARCH64_MARKERS);
190 marker
191});
192static LINUX_ARMV7L_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
193 let mut marker = *LINUX_MARKERS;
194 marker.and(*ARMV7L_MARKERS);
195 marker
196});
197static LINUX_ARMV6L_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
198 let mut marker = *LINUX_MARKERS;
199 marker.and(*ARMV6L_MARKERS);
200 marker
201});
202static WINDOWS_ARM_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
203 let mut marker = *WINDOWS_MARKERS;
204 marker.and(*ARM_MARKERS);
205 marker
206});
207static WINDOWS_X86_64_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
208 let mut marker = *WINDOWS_MARKERS;
209 marker.and(*X86_64_MARKERS);
210 marker
211});
212static WINDOWS_X86_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
213 let mut marker = *WINDOWS_MARKERS;
214 marker.and(*X86_MARKERS);
215 marker
216});
217static MAC_ARM_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
218 let mut marker = *MAC_MARKERS;
219 marker.and(*ARM_MARKERS);
220 marker
221});
222static MAC_X86_64_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
223 let mut marker = *MAC_MARKERS;
224 marker.and(*X86_64_MARKERS);
225 marker
226});
227static MAC_X86_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
228 let mut marker = *MAC_MARKERS;
229 marker.and(*X86_MARKERS);
230 marker
231});
232static ANDROID_ARM_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
233 let mut marker = *ANDROID_MARKERS;
234 marker.and(*ARM_MARKERS);
235 marker
236});
237static ANDROID_X86_64_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
238 let mut marker = *ANDROID_MARKERS;
239 marker.and(*X86_64_MARKERS);
240 marker
241});
242static ANDROID_X86_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
243 let mut marker = *ANDROID_MARKERS;
244 marker.and(*X86_MARKERS);
245 marker
246});
247
248pub(crate) struct HashedDist {
253 dist: Dist,
254 hashes: HashDigests,
255}
256
257#[derive(Clone, Debug, PartialEq, Eq, serde::Deserialize)]
258#[serde(try_from = "LockWire")]
259pub struct Lock {
260 version: u32,
269 revision: u32,
275 fork_markers: Vec<UniversalMarker>,
278 conflicts: Conflicts,
280 supported_environments: Vec<MarkerTree>,
282 required_environments: Vec<MarkerTree>,
284 requires_python: RequiresPython,
286 options: ResolverOptions,
288 packages: Vec<Package>,
290 by_id: FxHashMap<PackageId, usize>,
302 manifest: ResolverManifest,
304}
305
306#[derive(Debug)]
311pub struct DependencySelection<'lock> {
312 root: Option<&'lock Package>,
313 production: Option<&'lock Package>,
314 groups: BTreeMap<&'lock GroupName, &'lock Package>,
315}
316
317impl<'lock> DependencySelection<'lock> {
318 pub fn root(&self) -> Option<&'lock Package> {
320 self.root
321 }
322
323 pub fn production(&self) -> Option<&'lock Package> {
325 self.production
326 }
327
328 pub fn group(&self, group: &GroupName) -> Option<&'lock Package> {
330 self.groups.get(group).copied()
331 }
332}
333
334impl Lock {
335 pub fn from_resolution(
337 resolution: &ResolverOutput,
338 root: &Path,
339 supported_environments: Vec<MarkerTree>,
340 ) -> Result<Self, LockError> {
341 let mut packages = BTreeMap::new();
342 let requires_python = resolution.requires_python.clone();
343 let supported_environments = supported_environments
344 .into_iter()
345 .map(|marker| requires_python.complexify_markers(marker))
346 .collect::<Vec<_>>();
347 let supported_environments_marker = if supported_environments.is_empty() {
348 None
349 } else {
350 let mut combined = MarkerTree::FALSE;
351 for marker in &supported_environments {
352 combined.or(*marker);
353 }
354 Some(UniversalMarker::new(combined, ConflictMarker::TRUE))
355 };
356 let environment = SimplifiedMarkerTree::new(
357 &requires_python,
358 fork_markers_union(&resolution.fork_markers, &requires_python),
359 );
360
361 let mut seen = FxHashSet::default();
363 let mut duplicates = FxHashSet::default();
364 for (_, dist) in resolution.base_dists() {
365 if !seen.insert(dist.name()) {
366 duplicates.insert(dist.name());
367 }
368 }
369
370 for (node_index, dist) in resolution.base_dists() {
372 let fork_markers = if duplicates.contains(dist.name()) {
378 let fork_markers = resolution
379 .fork_markers
380 .iter()
381 .filter(|fork_markers| !fork_markers.is_disjoint(dist.marker))
382 .copied()
383 .collect::<Vec<_>>();
384 canonicalize_universal_markers(&fork_markers, &requires_python)
385 } else {
386 vec![]
387 };
388
389 let mut package = Package::from_annotated_dist(dist, fork_markers, root)?;
390 let mut wheel_marker = dist.marker;
391 if let Some(supported_environments_marker) = supported_environments_marker {
392 wheel_marker.and(supported_environments_marker);
393 }
394 let wheels = &mut package.wheels;
395 wheels.retain(|wheel| {
396 !is_wheel_unreachable_for_marker(
397 &wheel.filename,
398 &requires_python,
399 &wheel_marker,
400 None,
401 )
402 });
403
404 for edge in resolution.graph.edges(node_index) {
406 let ResolutionGraphNode::Dist(dependency_dist) = &resolution.graph[edge.target()]
407 else {
408 continue;
409 };
410 let marker = simplify_dependency_marker(
411 &requires_python,
412 environment,
413 dist.marker,
414 *edge.weight(),
415 );
416 package.add_dependency(&requires_python, dependency_dist, marker, root)?;
417 }
418
419 let id = package.id.clone();
420 if let Some(locked_dist) = packages.insert(id, package) {
421 return Err(LockErrorKind::DuplicatePackage {
422 id: locked_dist.id.clone(),
423 }
424 .into());
425 }
426 }
427
428 for node_index in resolution.graph.node_indices() {
430 let ResolutionGraphNode::Dist(dist) = &resolution.graph[node_index] else {
431 continue;
432 };
433 if let Some(extra) = dist.extra.as_ref() {
434 let id = PackageId::from_annotated_dist(dist, root)?;
435 let Some(package) = packages.get_mut(&id) else {
436 return Err(LockErrorKind::MissingExtraBase {
437 id,
438 extra: extra.clone(),
439 }
440 .into());
441 };
442 for edge in resolution.graph.edges(node_index) {
443 let ResolutionGraphNode::Dist(dependency_dist) =
444 &resolution.graph[edge.target()]
445 else {
446 continue;
447 };
448 let marker = simplify_dependency_marker(
449 &requires_python,
450 environment,
451 dist.marker,
452 *edge.weight(),
453 );
454 package.add_optional_dependency(
455 &requires_python,
456 extra.clone(),
457 dependency_dist,
458 marker,
459 root,
460 )?;
461 }
462 }
463 if let Some(group) = dist.group.as_ref() {
464 let id = PackageId::from_annotated_dist(dist, root)?;
465 let Some(package) = packages.get_mut(&id) else {
466 return Err(LockErrorKind::MissingDevBase {
467 id,
468 group: group.clone(),
469 }
470 .into());
471 };
472 for edge in resolution.graph.edges(node_index) {
473 let ResolutionGraphNode::Dist(dependency_dist) =
474 &resolution.graph[edge.target()]
475 else {
476 continue;
477 };
478 let marker = simplify_dependency_marker(
479 &requires_python,
480 environment,
481 dist.marker,
482 *edge.weight(),
483 );
484 package.add_group_dependency(
485 &requires_python,
486 group.clone(),
487 dependency_dist,
488 marker,
489 root,
490 )?;
491 }
492 }
493 }
494
495 let packages = packages.into_values().collect();
496
497 let options = ResolverOptions {
498 resolution_mode: resolution.options.resolution_mode,
499 prerelease_mode: resolution.options.prerelease_mode,
500 fork_strategy: resolution.options.fork_strategy,
501 exclude_newer: resolution.options.exclude_newer.clone().into(),
502 };
503 let fork_markers =
508 canonicalize_universal_markers(&resolution.fork_markers, &requires_python);
509 let lock = Self::new(
510 VERSION,
511 REVISION,
512 packages,
513 requires_python,
514 options,
515 ResolverManifest::default(),
516 Conflicts::empty(),
517 supported_environments,
518 vec![],
519 fork_markers,
520 )?;
521 Ok(lock)
522 }
523
524 fn new(
526 version: u32,
527 revision: u32,
528 mut packages: Vec<Package>,
529 requires_python: RequiresPython,
530 options: ResolverOptions,
531 manifest: ResolverManifest,
532 conflicts: Conflicts,
533 supported_environments: Vec<MarkerTree>,
534 required_environments: Vec<MarkerTree>,
535 fork_markers: Vec<UniversalMarker>,
536 ) -> Result<Self, LockError> {
537 for package in &mut packages {
540 package.dependencies.sort();
541 for [dep1, dep2] in package.dependencies.array_windows() {
542 if dep1 == dep2 {
543 return Err(LockErrorKind::DuplicateDependency {
544 id: package.id.clone(),
545 dependency: dep1.clone(),
546 }
547 .into());
548 }
549 }
550
551 for (extra, dependencies) in &mut package.optional_dependencies {
553 dependencies.sort();
554 for [dep1, dep2] in dependencies.array_windows() {
555 if dep1 == dep2 {
556 return Err(LockErrorKind::DuplicateOptionalDependency {
557 id: package.id.clone(),
558 extra: extra.clone(),
559 dependency: dep1.clone(),
560 }
561 .into());
562 }
563 }
564 }
565
566 for (group, dependencies) in &mut package.dependency_groups {
568 dependencies.sort();
569 for [dep1, dep2] in dependencies.array_windows() {
570 if dep1 == dep2 {
571 return Err(LockErrorKind::DuplicateDevDependency {
572 id: package.id.clone(),
573 group: group.clone(),
574 dependency: dep1.clone(),
575 }
576 .into());
577 }
578 }
579 }
580 }
581 packages.sort_by(|dist1, dist2| dist1.id.cmp(&dist2.id));
582
583 let mut by_id = FxHashMap::default();
586 for (i, dist) in packages.iter().enumerate() {
587 if by_id.insert(dist.id.clone(), i).is_some() {
588 return Err(LockErrorKind::DuplicatePackage {
589 id: dist.id.clone(),
590 }
591 .into());
592 }
593 }
594
595 let mut extras_by_id = FxHashMap::default();
597 for dist in &packages {
598 for extra in dist.optional_dependencies.keys() {
599 extras_by_id
600 .entry(dist.id.clone())
601 .or_insert_with(FxHashSet::default)
602 .insert(extra.clone());
603 }
604 }
605
606 for dist in &mut packages {
608 for dep in dist
609 .dependencies
610 .iter_mut()
611 .chain(dist.optional_dependencies.values_mut().flatten())
612 .chain(dist.dependency_groups.values_mut().flatten())
613 {
614 dep.extra.retain(|extra| {
615 extras_by_id
616 .get(&dep.package_id)
617 .is_some_and(|extras| extras.contains(extra))
618 });
619 }
620 }
621
622 for dist in &packages {
626 for dep in &dist.dependencies {
627 if !by_id.contains_key(&dep.package_id) {
628 return Err(LockErrorKind::UnrecognizedDependency {
629 id: dist.id.clone(),
630 dependency: dep.clone(),
631 }
632 .into());
633 }
634 }
635
636 for dependencies in dist.optional_dependencies.values() {
638 for dep in dependencies {
639 if !by_id.contains_key(&dep.package_id) {
640 return Err(LockErrorKind::UnrecognizedDependency {
641 id: dist.id.clone(),
642 dependency: dep.clone(),
643 }
644 .into());
645 }
646 }
647 }
648
649 for dependencies in dist.dependency_groups.values() {
651 for dep in dependencies {
652 if !by_id.contains_key(&dep.package_id) {
653 return Err(LockErrorKind::UnrecognizedDependency {
654 id: dist.id.clone(),
655 dependency: dep.clone(),
656 }
657 .into());
658 }
659 }
660 }
661
662 if let Some(requires_hash) = dist.id.source.requires_hash() {
665 for wheel in &dist.wheels {
666 if requires_hash != wheel.hash.is_some() {
667 return Err(LockErrorKind::Hash {
668 id: dist.id.clone(),
669 artifact_type: "wheel",
670 expected: requires_hash,
671 }
672 .into());
673 }
674 }
675 }
676 }
677 let lock = Self {
678 version,
679 revision,
680 fork_markers,
681 conflicts,
682 supported_environments,
683 required_environments,
684 requires_python,
685 options,
686 packages,
687 by_id,
688 manifest,
689 };
690 Ok(lock)
691 }
692
693 #[must_use]
695 pub fn with_manifest(mut self, manifest: ResolverManifest) -> Self {
696 self.manifest = manifest;
697 self
698 }
699
700 #[must_use]
702 pub fn with_conflicts(mut self, conflicts: Conflicts) -> Self {
703 self.conflicts = conflicts;
704 self
705 }
706
707 #[must_use]
709 pub fn with_required_environments(mut self, required_environments: Vec<MarkerTree>) -> Self {
710 self.required_environments = required_environments
711 .into_iter()
712 .map(|marker| self.requires_python.complexify_markers(marker))
713 .collect();
714 self
715 }
716
717 pub fn supports_provides_extra(&self) -> bool {
719 (self.version(), self.revision()) >= (1, 1)
721 }
722
723 fn includes_empty_groups(&self) -> bool {
725 (self.version(), self.revision()) >= (1, 1)
728 }
729
730 pub fn version(&self) -> u32 {
732 self.version
733 }
734
735 fn revision(&self) -> u32 {
737 self.revision
738 }
739
740 pub fn len(&self) -> usize {
742 self.packages.len()
743 }
744
745 pub fn is_empty(&self) -> bool {
747 self.packages.is_empty()
748 }
749
750 pub fn packages(&self) -> &[Package] {
752 &self.packages
753 }
754
755 pub fn requires_python(&self) -> &RequiresPython {
757 &self.requires_python
758 }
759
760 pub fn resolution_mode(&self) -> ResolutionMode {
762 self.options.resolution_mode
763 }
764
765 pub fn prerelease_mode(&self) -> PrereleaseMode {
767 self.options.prerelease_mode
768 }
769
770 pub fn fork_strategy(&self) -> ForkStrategy {
772 self.options.fork_strategy
773 }
774
775 pub fn exclude_newer(&self) -> ExcludeNewer {
777 self.options.exclude_newer.clone().into()
780 }
781
782 pub fn conflicts(&self) -> &Conflicts {
784 &self.conflicts
785 }
786
787 pub fn supported_environments(&self) -> &[MarkerTree] {
789 &self.supported_environments
790 }
791
792 fn required_environments(&self) -> &[MarkerTree] {
794 &self.required_environments
795 }
796
797 pub fn members(&self) -> &BTreeSet<PackageName> {
799 &self.manifest.members
800 }
801
802 fn requirements(&self) -> &BTreeSet<Requirement> {
804 &self.manifest.requirements
805 }
806
807 fn root_requirement_marker(
810 &self,
811 requirement: &Requirement,
812 package: &Package,
813 ) -> Option<MarkerTree> {
814 let marker = if package.fork_markers.is_empty() {
815 requirement.marker
816 } else {
817 let mut combined = MarkerTree::FALSE;
818 for fork_marker in &package.fork_markers {
819 combined.or(fork_marker.pep508());
820 }
821 combined.and(requirement.marker);
822 combined
823 };
824
825 (!marker.is_false()).then(|| self.simplify_environment(marker))
826 }
827
828 pub(crate) fn dependency_groups(&self) -> &BTreeMap<GroupName, BTreeSet<Requirement>> {
830 &self.manifest.dependency_groups
831 }
832
833 pub fn dependency_selection<'lock>(
838 &'lock self,
839 project_name: Option<&PackageName>,
840 dependency_name: &PackageName,
841 marker_environment: &MarkerEnvironment,
842 ) -> Result<DependencySelection<'lock>, String> {
843 let (root, production, groups) = if let Some(project_name) = project_name {
844 let Some(project) = self.find_by_name(project_name)? else {
845 return Ok(DependencySelection {
846 root: None,
847 production: None,
848 groups: BTreeMap::new(),
849 });
850 };
851 let production =
852 self.find_project_dependency_package(project, dependency_name, marker_environment)?;
853 let mut groups = BTreeMap::new();
854 for group in project.resolved_dependency_groups().keys() {
855 if let Some(package) = self.find_project_dependency_group_package(
856 project,
857 group,
858 dependency_name,
859 marker_environment,
860 )? {
861 groups.insert(group, package);
862 }
863 }
864 (None, production, groups)
865 } else {
866 let root_applies = self.manifest.requirements.iter().any(|requirement| {
867 &requirement.name == dependency_name
868 && requirement.marker.evaluate(marker_environment, &[])
869 });
870
871 let mut applicable_groups = self
875 .manifest
876 .dependency_groups
877 .iter()
878 .filter_map(|(group, requirements)| {
879 requirements
880 .iter()
881 .any(|requirement| {
882 &requirement.name == dependency_name
883 && requirement.marker.evaluate(marker_environment, &[])
884 })
885 .then_some(group)
886 })
887 .peekable();
888 let package = if root_applies || applicable_groups.peek().is_some() {
889 self.find_by_markers(dependency_name, marker_environment)?
890 } else {
891 None
892 };
893 let root = root_applies.then_some(package).flatten();
894 let groups = package.map_or_else(BTreeMap::new, |package| {
895 applicable_groups.map(|group| (group, package)).collect()
896 });
897 (root, None, groups)
898 };
899 Ok(DependencySelection {
900 root,
901 production,
902 groups,
903 })
904 }
905
906 fn find_project_dependency_group_package(
908 &self,
909 project: &Package,
910 group: &GroupName,
911 dependency_name: &PackageName,
912 marker_environment: &MarkerEnvironment,
913 ) -> Result<Option<&Package>, String> {
914 let Some(dependencies) = project.resolved_dependency_groups().get(group) else {
915 return Ok(None);
916 };
917 let project_name = project.name();
918
919 let mut selected = None;
920 for dependency in dependencies
921 .iter()
922 .filter(|dependency| &dependency.package_id.name == dependency_name)
923 {
924 if !dependency.complexified_marker.evaluate(
930 marker_environment,
931 std::iter::empty::<&PackageName>(),
932 dependency
933 .extra
934 .iter()
935 .map(|extra| (&dependency.package_id.name, extra)),
936 std::iter::once((project_name, group)),
937 ) {
938 continue;
939 }
940
941 let package = self.find_by_id(&dependency.package_id);
942 if selected.is_some_and(|selected: &Package| selected.id != package.id) {
943 return Err(format!(
944 "found multiple packages matching `{dependency_name}` in dependency group `{group}` for `{project_name}`"
945 ));
946 }
947 selected = Some(package);
948 }
949 Ok(selected)
950 }
951
952 fn find_project_dependency_package(
954 &self,
955 project: &Package,
956 dependency_name: &PackageName,
957 marker_environment: &MarkerEnvironment,
958 ) -> Result<Option<&Package>, String> {
959 let project_name = project.name();
960
961 let mut selected = None;
962 for dependency in project
963 .dependencies()
964 .iter()
965 .filter(|dependency| &dependency.package_id.name == dependency_name)
966 {
967 if !dependency.complexified_marker.evaluate(
968 marker_environment,
969 std::iter::once(project_name),
970 dependency
971 .extra
972 .iter()
973 .map(|extra| (&dependency.package_id.name, extra)),
974 std::iter::empty::<(&PackageName, &GroupName)>(),
975 ) {
976 continue;
977 }
978
979 let package = self.find_by_id(&dependency.package_id);
980 if selected.is_some_and(|selected: &Package| selected.id != package.id) {
981 return Err(format!(
982 "found multiple packages matching production dependency `{dependency_name}` for `{project_name}`"
983 ));
984 }
985 selected = Some(package);
986 }
987 Ok(selected)
988 }
989
990 pub fn build_constraints(&self, root: &Path) -> Constraints {
992 Constraints::from_requirements(
993 self.manifest
994 .build_constraints
995 .iter()
996 .cloned()
997 .map(|requirement| requirement.to_absolute(root)),
998 )
999 }
1000
1001 pub fn auditable<'lock>(
1008 &'lock self,
1009 extras: &'lock ExtrasSpecificationWithDefaults,
1010 groups: &'lock DependencyGroupsWithDefaults,
1011 collect_filter: impl Fn(&Package) -> bool,
1012 ) -> Auditable<'lock> {
1013 let mut by_name_version: BTreeMap<(&PackageName, &Version), &Package> = BTreeMap::default();
1018 self.walk_auditable(extras, groups, collect_filter, |package, version| {
1019 by_name_version
1020 .entry((package.name(), version))
1021 .or_insert(package);
1022 });
1023 let packages = by_name_version
1024 .into_iter()
1025 .map(|((_, version), package)| (package, version))
1026 .collect();
1027 Auditable { packages }
1028 }
1029
1030 fn walk_auditable<'lock, F>(
1040 &'lock self,
1041 extras: &'lock ExtrasSpecificationWithDefaults,
1042 groups: &'lock DependencyGroupsWithDefaults,
1043 collect_filter: impl Fn(&Package) -> bool,
1044 mut visit: F,
1045 ) where
1046 F: FnMut(&'lock Package, &'lock Version),
1047 {
1048 fn enqueue_dep<'lock>(
1050 lock: &'lock Lock,
1051 seen: &mut FxHashSet<(&'lock PackageId, Option<&'lock ExtraName>)>,
1052 queue: &mut VecDeque<(&'lock Package, Option<&'lock ExtraName>)>,
1053 dep: &'lock Dependency,
1054 ) {
1055 let dep_pkg = lock.find_by_id(&dep.package_id);
1056 for maybe_extra in std::iter::once(None).chain(dep.extra.iter().map(Some)) {
1057 if seen.insert((&dep.package_id, maybe_extra)) {
1058 queue.push_back((dep_pkg, maybe_extra));
1059 }
1060 }
1061 }
1062
1063 let workspace_member_ids: FxHashSet<&PackageId> = if self.members().is_empty() {
1065 self.root().into_iter().map(|package| &package.id).collect()
1066 } else {
1067 self.packages
1068 .iter()
1069 .filter(|package| self.members().contains(&package.id.name))
1070 .map(|package| &package.id)
1071 .collect()
1072 };
1073
1074 let mut queue: VecDeque<(&Package, Option<&ExtraName>)> = VecDeque::new();
1076 let mut seen: FxHashSet<(&PackageId, Option<&ExtraName>)> = FxHashSet::default();
1077
1078 for package in self
1081 .packages
1082 .iter()
1083 .filter(|p| workspace_member_ids.contains(&p.id))
1084 {
1085 if seen.insert((&package.id, None)) {
1086 queue.push_back((package, None));
1087 }
1088 if groups.prod() {
1089 for extra in extras.extra_names(package.optional_dependencies.keys()) {
1090 if seen.insert((&package.id, Some(extra))) {
1091 queue.push_back((package, Some(extra)));
1092 }
1093 }
1094 }
1095 }
1096
1097 for requirement in self.requirements() {
1099 for package in self
1100 .packages
1101 .iter()
1102 .filter(|p| p.id.name == requirement.name)
1103 {
1104 if seen.insert((&package.id, None)) {
1105 queue.push_back((package, None));
1106 }
1107 for extra in &*requirement.extras {
1108 if seen.insert((&package.id, Some(extra))) {
1109 queue.push_back((package, Some(extra)));
1110 }
1111 }
1112 }
1113 }
1114
1115 for (group, requirements) in self.dependency_groups() {
1118 if !groups.contains(group) {
1119 continue;
1120 }
1121 for requirement in requirements {
1122 for package in self
1123 .packages
1124 .iter()
1125 .filter(|p| p.id.name == requirement.name)
1126 {
1127 if seen.insert((&package.id, None)) {
1128 queue.push_back((package, None));
1129 }
1130 for extra in &*requirement.extras {
1131 if seen.insert((&package.id, Some(extra))) {
1132 queue.push_back((package, Some(extra)));
1133 }
1134 }
1135 }
1136 }
1137 }
1138
1139 while let Some((package, extra)) = queue.pop_front() {
1140 let is_member = workspace_member_ids.contains(&package.id);
1141
1142 if !is_member && collect_filter(package) {
1145 if let Some(version) = package.version() {
1146 visit(package, version);
1147 } else {
1148 trace!(
1149 "Skipping audit for `{}` because it has no version information",
1150 package.name()
1151 );
1152 }
1153 }
1154
1155 if is_member && extra.is_none() {
1157 for dep in package
1158 .dependency_groups
1159 .iter()
1160 .filter(|(group, _)| groups.contains(group))
1161 .flat_map(|(_, deps)| deps)
1162 {
1163 enqueue_dep(self, &mut seen, &mut queue, dep);
1164 }
1165 }
1166
1167 let dependencies: &[Dependency] = match extra {
1170 Some(extra) => package
1171 .optional_dependencies
1172 .get(extra)
1173 .map(Vec::as_slice)
1174 .unwrap_or_default(),
1175 None if is_member && !groups.prod() => &[],
1176 None => &package.dependencies,
1177 };
1178
1179 for dep in dependencies {
1180 enqueue_dep(self, &mut seen, &mut queue, dep);
1181 }
1182 }
1183 }
1184
1185 pub fn root(&self) -> Option<&Package> {
1187 self.packages.iter().find(|package| {
1188 let (Source::Editable(path) | Source::Virtual(path)) = &package.id.source else {
1189 return false;
1190 };
1191 path.as_ref() == Path::new("")
1192 })
1193 }
1194
1195 pub fn simplified_supported_environments(&self) -> Vec<MarkerTree> {
1205 self.supported_environments()
1206 .iter()
1207 .copied()
1208 .map(|marker| self.simplify_environment(marker))
1209 .collect()
1210 }
1211
1212 pub fn simplified_required_environments(&self) -> Vec<MarkerTree> {
1215 self.required_environments()
1216 .iter()
1217 .copied()
1218 .map(|marker| self.simplify_environment(marker))
1219 .collect()
1220 }
1221
1222 pub fn simplify_environment(&self, marker: MarkerTree) -> MarkerTree {
1225 self.requires_python.simplify_markers(marker)
1226 }
1227
1228 pub fn fork_markers(&self) -> &[UniversalMarker] {
1231 self.fork_markers.as_slice()
1232 }
1233
1234 fn fork_markers_union(&self) -> MarkerTree {
1236 fork_markers_union(&self.fork_markers, &self.requires_python)
1237 }
1238
1239 pub fn check_marker_coverage(&self) -> Result<(), (MarkerTree, MarkerTree)> {
1243 let fork_markers_union = self.fork_markers_union();
1244 let mut environments_union = if !self.supported_environments.is_empty() {
1245 let mut environments_union = MarkerTree::FALSE;
1246 for fork_marker in &self.supported_environments {
1247 environments_union.or(*fork_marker);
1248 }
1249 environments_union
1250 } else {
1251 MarkerTree::TRUE
1252 };
1253 environments_union.and(self.requires_python.to_marker_tree());
1255 if fork_markers_union.negate().is_disjoint(environments_union) {
1256 Ok(())
1257 } else {
1258 Err((fork_markers_union, environments_union))
1259 }
1260 }
1261
1262 pub fn requires_python_coverage(
1272 &self,
1273 new_requires_python: &RequiresPython,
1274 ) -> Result<(), (MarkerTree, MarkerTree)> {
1275 let fork_markers_union = self.fork_markers_union();
1276 let new_requires_python = new_requires_python.to_marker_tree();
1277 if fork_markers_union.is_disjoint(new_requires_python) {
1278 Err((fork_markers_union, new_requires_python))
1279 } else {
1280 Ok(())
1281 }
1282 }
1283
1284 pub fn to_toml(&self) -> Result<String, toml_edit::ser::Error> {
1286 debug_assert!(self.check_marker_coverage().is_ok());
1289
1290 let mut doc = toml_edit::DocumentMut::new();
1293 doc.insert("version", value(i64::from(self.version)));
1294
1295 if self.revision > 0 {
1296 doc.insert("revision", value(i64::from(self.revision)));
1297 }
1298
1299 doc.insert("requires-python", value(self.requires_python.to_string()));
1300
1301 if !self.fork_markers.is_empty() {
1302 let fork_markers = each_element_on_its_line_array(
1303 simplified_universal_markers(&self.fork_markers, &self.requires_python).into_iter(),
1304 );
1305 if !fork_markers.is_empty() {
1306 doc.insert("resolution-markers", value(fork_markers));
1307 }
1308 }
1309
1310 let simplified_environment =
1312 SimplifiedMarkerTree::new(&self.requires_python, self.fork_markers_union())
1313 .as_simplified_marker_tree();
1314
1315 if !self.supported_environments.is_empty() {
1316 let supported_environments = each_element_on_its_line_array(
1317 self.supported_environments
1318 .iter()
1319 .copied()
1320 .map(|marker| SimplifiedMarkerTree::new(&self.requires_python, marker))
1321 .filter_map(SimplifiedMarkerTree::try_to_string),
1322 );
1323 doc.insert("supported-markers", value(supported_environments));
1324 }
1325
1326 if !self.required_environments.is_empty() {
1327 let required_environments = each_element_on_its_line_array(
1328 self.required_environments
1329 .iter()
1330 .copied()
1331 .map(|marker| SimplifiedMarkerTree::new(&self.requires_python, marker))
1332 .filter_map(SimplifiedMarkerTree::try_to_string),
1333 );
1334 doc.insert("required-markers", value(required_environments));
1335 }
1336
1337 if !self.conflicts.is_empty() {
1338 let mut list = Array::new();
1339 for set in self.conflicts.iter() {
1340 list.push(each_element_on_its_line_array(set.iter().map(|item| {
1341 let mut table = InlineTable::new();
1342 table.insert("package", Value::from(item.package().to_string()));
1343 match item.kind() {
1344 ConflictKind::Project => {}
1345 ConflictKind::Extra(extra) => {
1346 table.insert("extra", Value::from(extra.to_string()));
1347 }
1348 ConflictKind::Group(group) => {
1349 table.insert("group", Value::from(group.to_string()));
1350 }
1351 }
1352 table
1353 })));
1354 }
1355 doc.insert("conflicts", value(list));
1356 }
1357
1358 {
1362 let mut options_table = Table::new();
1363
1364 if self.options.resolution_mode != ResolutionMode::default() {
1365 options_table.insert(
1366 "resolution-mode",
1367 value(self.options.resolution_mode.to_string()),
1368 );
1369 }
1370 if self.options.prerelease_mode != PrereleaseMode::default() {
1371 options_table.insert(
1372 "prerelease-mode",
1373 value(self.options.prerelease_mode.to_string()),
1374 );
1375 }
1376 if self.options.fork_strategy != ForkStrategy::default() {
1377 options_table.insert(
1378 "fork-strategy",
1379 value(self.options.fork_strategy.to_string()),
1380 );
1381 }
1382 let exclude_newer = ExcludeNewer::from(self.options.exclude_newer.clone());
1383 if !exclude_newer.is_empty() {
1384 if let Some(global) = &exclude_newer.global {
1386 if let Some(span) = global.span() {
1387 let mut noop = value(ExcludeNewerValue::PLACEHOLDER);
1391 if let Item::Value(ref mut v) = noop {
1392 v.decor_mut().set_suffix(" # This has no effect and is included for backwards compatibility when using relative exclude-newer values.");
1393 }
1394 options_table.insert("exclude-newer", noop);
1395 options_table.insert("exclude-newer-span", value(span.to_string()));
1396 } else {
1397 options_table.insert("exclude-newer", value(global.to_string()));
1398 }
1399 }
1400
1401 if !exclude_newer.package.is_empty() {
1403 let mut package_table = toml_edit::Table::new();
1404 for (name, setting) in &exclude_newer.package {
1405 match setting {
1406 ExcludeNewerOverride::Enabled(exclude_newer_value) => {
1407 if let Some(span) = exclude_newer_value.span() {
1408 let mut inline = toml_edit::InlineTable::new();
1412 inline
1413 .insert("timestamp", ExcludeNewerValue::PLACEHOLDER.into());
1414 inline.insert("span", span.to_string().into());
1415 package_table.insert(name.as_ref(), Item::Value(inline.into()));
1416 } else {
1417 package_table.insert(
1419 name.as_ref(),
1420 value(exclude_newer_value.to_string()),
1421 );
1422 }
1423 }
1424 ExcludeNewerOverride::Disabled => {
1425 package_table.insert(name.as_ref(), value(false));
1426 }
1427 }
1428 }
1429 options_table.insert("exclude-newer-package", Item::Table(package_table));
1430 }
1431 }
1432
1433 if !options_table.is_empty() {
1434 doc.insert("options", Item::Table(options_table));
1435 }
1436 }
1437
1438 {
1440 let mut manifest_table = Table::new();
1441
1442 if !self.manifest.members.is_empty() {
1443 manifest_table.insert(
1444 "members",
1445 value(each_element_on_its_line_array(
1446 self.manifest
1447 .members
1448 .iter()
1449 .map(std::string::ToString::to_string),
1450 )),
1451 );
1452 }
1453
1454 if !self.manifest.requirements.is_empty() {
1455 let requirements = self
1456 .manifest
1457 .requirements
1458 .iter()
1459 .map(|requirement| {
1460 serde::Serialize::serialize(
1461 &requirement,
1462 toml_edit::ser::ValueSerializer::new(),
1463 )
1464 })
1465 .collect::<Result<Vec<_>, _>>()?;
1466 let requirements = match requirements.as_slice() {
1467 [] => Array::new(),
1468 [requirement] => Array::from_iter([requirement]),
1469 requirements => each_element_on_its_line_array(requirements.iter()),
1470 };
1471 manifest_table.insert("requirements", value(requirements));
1472 }
1473
1474 if !self.manifest.constraints.is_empty() {
1475 let constraints = self
1476 .manifest
1477 .constraints
1478 .iter()
1479 .map(|requirement| {
1480 serde::Serialize::serialize(
1481 &requirement,
1482 toml_edit::ser::ValueSerializer::new(),
1483 )
1484 })
1485 .collect::<Result<Vec<_>, _>>()?;
1486 let constraints = match constraints.as_slice() {
1487 [] => Array::new(),
1488 [requirement] => Array::from_iter([requirement]),
1489 constraints => each_element_on_its_line_array(constraints.iter()),
1490 };
1491 manifest_table.insert("constraints", value(constraints));
1492 }
1493
1494 if !self.manifest.overrides.is_empty() {
1495 let overrides = self
1496 .manifest
1497 .overrides
1498 .iter()
1499 .map(|requirement| {
1500 serde::Serialize::serialize(
1501 &requirement,
1502 toml_edit::ser::ValueSerializer::new(),
1503 )
1504 })
1505 .collect::<Result<Vec<_>, _>>()?;
1506 let overrides = match overrides.as_slice() {
1507 [] => Array::new(),
1508 [requirement] => Array::from_iter([requirement]),
1509 overrides => each_element_on_its_line_array(overrides.iter()),
1510 };
1511 manifest_table.insert("overrides", value(overrides));
1512 }
1513
1514 if !self.manifest.excludes.is_empty() {
1515 let excludes = self
1516 .manifest
1517 .excludes
1518 .iter()
1519 .map(|name| {
1520 serde::Serialize::serialize(&name, toml_edit::ser::ValueSerializer::new())
1521 })
1522 .collect::<Result<Vec<_>, _>>()?;
1523 let excludes = match excludes.as_slice() {
1524 [] => Array::new(),
1525 [name] => Array::from_iter([name]),
1526 excludes => each_element_on_its_line_array(excludes.iter()),
1527 };
1528 manifest_table.insert("excludes", value(excludes));
1529 }
1530
1531 if !self.manifest.build_constraints.is_empty() {
1532 let build_constraints = self
1533 .manifest
1534 .build_constraints
1535 .iter()
1536 .map(|requirement| {
1537 serde::Serialize::serialize(
1538 &requirement,
1539 toml_edit::ser::ValueSerializer::new(),
1540 )
1541 })
1542 .collect::<Result<Vec<_>, _>>()?;
1543 let build_constraints = match build_constraints.as_slice() {
1544 [] => Array::new(),
1545 [requirement] => Array::from_iter([requirement]),
1546 build_constraints => each_element_on_its_line_array(build_constraints.iter()),
1547 };
1548 manifest_table.insert("build-constraints", value(build_constraints));
1549 }
1550
1551 if !self.manifest.dependency_groups.is_empty() {
1552 let mut dependency_groups = Table::new();
1553 for (extra, requirements) in &self.manifest.dependency_groups {
1554 let requirements = requirements
1555 .iter()
1556 .map(|requirement| {
1557 serde::Serialize::serialize(
1558 &requirement,
1559 toml_edit::ser::ValueSerializer::new(),
1560 )
1561 })
1562 .collect::<Result<Vec<_>, _>>()?;
1563 let requirements = match requirements.as_slice() {
1564 [] => Array::new(),
1565 [requirement] => Array::from_iter([requirement]),
1566 requirements => each_element_on_its_line_array(requirements.iter()),
1567 };
1568 if !requirements.is_empty() {
1569 dependency_groups.insert(extra.as_ref(), value(requirements));
1570 }
1571 }
1572 if !dependency_groups.is_empty() {
1573 manifest_table.insert("dependency-groups", Item::Table(dependency_groups));
1574 }
1575 }
1576
1577 if !self.manifest.dependency_metadata.is_empty() {
1578 let mut tables = ArrayOfTables::new();
1579 for metadata in &self.manifest.dependency_metadata {
1580 let mut table = Table::new();
1581 table.insert("name", value(metadata.name.to_string()));
1582 if let Some(version) = metadata.version.as_ref() {
1583 table.insert("version", value(version.to_string()));
1584 }
1585 if !metadata.requires_dist.is_empty() {
1586 table.insert(
1587 "requires-dist",
1588 value(serde::Serialize::serialize(
1589 &metadata.requires_dist,
1590 toml_edit::ser::ValueSerializer::new(),
1591 )?),
1592 );
1593 }
1594 if let Some(requires_python) = metadata.requires_python.as_ref() {
1595 table.insert("requires-python", value(requires_python.to_string()));
1596 }
1597 if !metadata.provides_extra.is_empty() {
1598 table.insert(
1599 "provides-extras",
1600 value(serde::Serialize::serialize(
1601 &metadata.provides_extra,
1602 toml_edit::ser::ValueSerializer::new(),
1603 )?),
1604 );
1605 }
1606 tables.push(table);
1607 }
1608 manifest_table.insert("dependency-metadata", Item::ArrayOfTables(tables));
1609 }
1610
1611 if !manifest_table.is_empty() {
1612 doc.insert("manifest", Item::Table(manifest_table));
1613 }
1614 }
1615
1616 let mut dist_count_by_name: FxHashMap<PackageName, u64> = FxHashMap::default();
1621 for dist in &self.packages {
1622 *dist_count_by_name.entry(dist.id.name.clone()).or_default() += 1;
1623 }
1624
1625 let mut packages = ArrayOfTables::new();
1626 for dist in &self.packages {
1627 packages.push(dist.to_toml(
1628 &self.requires_python,
1629 simplified_environment,
1630 &dist_count_by_name,
1631 )?);
1632 }
1633
1634 doc.insert("package", Item::ArrayOfTables(packages));
1635 Ok(doc.to_string())
1636 }
1637
1638 pub fn find_by_name(&self, name: &PackageName) -> Result<Option<&Package>, String> {
1642 let mut found_dist = None;
1643 for dist in &self.packages {
1644 if &dist.id.name == name {
1645 if found_dist.is_some() {
1646 return Err(format!("found multiple packages matching `{name}`"));
1647 }
1648 found_dist = Some(dist);
1649 }
1650 }
1651 Ok(found_dist)
1652 }
1653
1654 fn find_by_markers(
1664 &self,
1665 name: &PackageName,
1666 marker_env: &MarkerEnvironment,
1667 ) -> Result<Option<&Package>, String> {
1668 let mut found_dist = None;
1669 for dist in &self.packages {
1670 if &dist.id.name == name {
1671 if dist.fork_markers.is_empty()
1672 || dist
1673 .fork_markers
1674 .iter()
1675 .any(|marker| marker.evaluate_no_extras(marker_env))
1676 {
1677 if found_dist.is_some() {
1678 return Err(format!("found multiple packages matching `{name}`"));
1679 }
1680 found_dist = Some(dist);
1681 }
1682 }
1683 }
1684 Ok(found_dist)
1685 }
1686
1687 fn find_by_id(&self, id: &PackageId) -> &Package {
1688 let index = *self.by_id.get(id).expect("locked package for ID");
1689
1690 (self.packages.get(index).expect("valid index for package")) as _
1691 }
1692
1693 fn satisfies_provides_extra<'lock>(
1695 &self,
1696 provides_extra: Box<[ExtraName]>,
1697 package: &'lock Package,
1698 ) -> SatisfiesResult<'lock> {
1699 if !self.supports_provides_extra() {
1700 return SatisfiesResult::Satisfied;
1701 }
1702
1703 let expected: BTreeSet<_> = provides_extra.iter().collect();
1704 let actual: BTreeSet<_> = package.metadata.provides_extra.iter().collect();
1705
1706 if expected != actual {
1707 let expected = Box::into_iter(provides_extra).collect();
1708 return SatisfiesResult::MismatchedPackageProvidesExtra(
1709 &package.id.name,
1710 package.id.version.as_ref(),
1711 expected,
1712 actual,
1713 );
1714 }
1715
1716 SatisfiesResult::Satisfied
1717 }
1718
1719 fn satisfies_requires_dist<'lock>(
1721 &self,
1722 requires_dist: Box<[Requirement]>,
1723 dependency_groups: BTreeMap<GroupName, Box<[Requirement]>>,
1724 package: &'lock Package,
1725 root: &Path,
1726 ) -> Result<SatisfiesResult<'lock>, LockError> {
1727 let flattened = if package.is_dynamic() {
1729 Some(
1730 FlatRequiresDist::from_requirements(requires_dist.clone(), &package.id.name)
1731 .into_iter()
1732 .map(|requirement| {
1733 normalize_requirement(requirement, root, &self.requires_python)
1734 })
1735 .collect::<Result<BTreeSet<_>, _>>()?,
1736 )
1737 } else {
1738 None
1739 };
1740
1741 let expected: BTreeSet<_> = Box::into_iter(requires_dist)
1743 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1744 .collect::<Result<_, _>>()?;
1745 let actual: BTreeSet<_> = package
1746 .metadata
1747 .requires_dist
1748 .iter()
1749 .cloned()
1750 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1751 .collect::<Result<_, _>>()?;
1752
1753 if expected != actual && flattened.is_none_or(|expected| expected != actual) {
1754 return Ok(SatisfiesResult::MismatchedPackageRequirements(
1755 &package.id.name,
1756 package.id.version.as_ref(),
1757 expected,
1758 actual,
1759 ));
1760 }
1761
1762 let expected: BTreeMap<GroupName, BTreeSet<Requirement>> = dependency_groups
1764 .into_iter()
1765 .filter(|(_, requirements)| self.includes_empty_groups() || !requirements.is_empty())
1766 .map(|(group, requirements)| {
1767 Ok::<_, LockError>((
1768 group,
1769 Box::into_iter(requirements)
1770 .map(|requirement| {
1771 normalize_requirement(requirement, root, &self.requires_python)
1772 })
1773 .collect::<Result<_, _>>()?,
1774 ))
1775 })
1776 .collect::<Result<_, _>>()?;
1777 let actual: BTreeMap<GroupName, BTreeSet<Requirement>> = package
1778 .metadata
1779 .dependency_groups
1780 .iter()
1781 .filter(|(_, requirements)| self.includes_empty_groups() || !requirements.is_empty())
1782 .map(|(group, requirements)| {
1783 Ok::<_, LockError>((
1784 group.clone(),
1785 requirements
1786 .iter()
1787 .cloned()
1788 .map(|requirement| {
1789 normalize_requirement(requirement, root, &self.requires_python)
1790 })
1791 .collect::<Result<_, _>>()?,
1792 ))
1793 })
1794 .collect::<Result<_, _>>()?;
1795
1796 if expected != actual {
1797 return Ok(SatisfiesResult::MismatchedPackageDependencyGroups(
1798 &package.id.name,
1799 package.id.version.as_ref(),
1800 expected,
1801 actual,
1802 ));
1803 }
1804
1805 Ok(SatisfiesResult::Satisfied)
1806 }
1807
1808 #[instrument(skip_all)]
1810 pub async fn satisfies<Context: BuildContext>(
1811 &self,
1812 root: &Path,
1813 packages: &BTreeMap<PackageName, WorkspaceMember>,
1814 members: &[PackageName],
1815 required_members: &BTreeMap<PackageName, Editability>,
1816 requirements: &[Requirement],
1817 constraints: &[Requirement],
1818 overrides: &[Override<Requirement>],
1819 excludes: &[ExcludeDependency],
1820 build_constraints: &[Requirement],
1821 dependency_groups: &BTreeMap<GroupName, Vec<Requirement>>,
1822 dependency_metadata: &DependencyMetadata,
1823 indexes: Option<&IndexLocations>,
1824 tags: &Tags,
1825 markers: &MarkerEnvironment,
1826 build_options: &BuildOptions,
1827 hasher: &HashStrategy,
1828 index: &InMemoryIndex,
1829 database: &DistributionDatabase<'_, Context>,
1830 ) -> Result<SatisfiesResult<'_>, LockError> {
1831 let mut queue: VecDeque<&Package> = VecDeque::new();
1832 let mut seen = FxHashSet::default();
1833
1834 {
1836 let expected = members.iter().cloned().collect::<BTreeSet<_>>();
1837 let actual = &self.manifest.members;
1838 if expected != *actual {
1839 return Ok(SatisfiesResult::MismatchedMembers(expected, actual));
1840 }
1841 }
1842
1843 for (name, member) in packages {
1846 let source = self.find_by_name(name).ok().flatten();
1847
1848 let value = required_members.get(name);
1850 let is_required_member = value.is_some();
1851 let editability = value.copied().flatten();
1852
1853 let expected_virtual = !member.pyproject_toml().is_package(!is_required_member);
1855 let actual_virtual =
1856 source.map(|package| matches!(package.id.source, Source::Virtual(..)));
1857 if actual_virtual != Some(expected_virtual) {
1858 return Ok(SatisfiesResult::MismatchedVirtual(
1859 name.clone(),
1860 expected_virtual,
1861 ));
1862 }
1863
1864 let expected_editable = if expected_virtual {
1866 false
1867 } else {
1868 editability.unwrap_or(true)
1869 };
1870 let actual_editable =
1871 source.map(|package| matches!(package.id.source, Source::Editable(..)));
1872 if actual_editable != Some(expected_editable) {
1873 return Ok(SatisfiesResult::MismatchedEditable(
1874 name.clone(),
1875 expected_editable,
1876 ));
1877 }
1878 }
1879
1880 {
1882 let expected: BTreeSet<_> = requirements
1883 .iter()
1884 .cloned()
1885 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1886 .collect::<Result<_, _>>()?;
1887 let actual: BTreeSet<_> = self
1888 .manifest
1889 .requirements
1890 .iter()
1891 .cloned()
1892 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1893 .collect::<Result<_, _>>()?;
1894 if expected != actual {
1895 return Ok(SatisfiesResult::MismatchedRequirements(expected, actual));
1896 }
1897 }
1898
1899 {
1901 let expected: BTreeSet<_> = constraints
1902 .iter()
1903 .cloned()
1904 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1905 .collect::<Result<_, _>>()?;
1906 let actual: BTreeSet<_> = self
1907 .manifest
1908 .constraints
1909 .iter()
1910 .cloned()
1911 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1912 .collect::<Result<_, _>>()?;
1913 if expected != actual {
1914 return Ok(SatisfiesResult::MismatchedConstraints(expected, actual));
1915 }
1916 }
1917
1918 {
1920 let normalize = |entry: Override<Requirement>| -> Result<_, LockError> {
1921 match entry {
1922 Override::Requirement(requirement) => Ok(Override::Requirement(
1923 normalize_requirement(requirement, root, &self.requires_python)?,
1924 )),
1925 Override::Package(package) => Ok(Override::Package(PackageOverride {
1926 package: package.package,
1927 dependencies: package
1928 .dependencies
1929 .into_vec()
1930 .into_iter()
1931 .map(|requirement| {
1932 normalize_requirement(requirement, root, &self.requires_python)
1933 })
1934 .collect::<Result<Vec<_>, _>>()?
1935 .into_boxed_slice(),
1936 })),
1937 }
1938 };
1939 let expected: BTreeSet<_> = overrides
1940 .iter()
1941 .cloned()
1942 .map(normalize)
1943 .collect::<Result<_, _>>()?;
1944 let actual: BTreeSet<_> = self
1945 .manifest
1946 .overrides
1947 .iter()
1948 .cloned()
1949 .map(normalize)
1950 .collect::<Result<_, _>>()?;
1951 if expected != actual {
1952 return Ok(SatisfiesResult::MismatchedOverrides(expected, actual));
1953 }
1954 }
1955
1956 {
1958 let expected: BTreeSet<_> = excludes.iter().cloned().collect();
1959 let actual: BTreeSet<_> = self.manifest.excludes.iter().cloned().collect();
1960 if expected != actual {
1961 return Ok(SatisfiesResult::MismatchedExcludes(expected, actual));
1962 }
1963 }
1964
1965 {
1967 let expected: BTreeSet<_> = build_constraints
1968 .iter()
1969 .cloned()
1970 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1971 .collect::<Result<_, _>>()?;
1972 let actual: BTreeSet<_> = self
1973 .manifest
1974 .build_constraints
1975 .iter()
1976 .cloned()
1977 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1978 .collect::<Result<_, _>>()?;
1979 if expected != actual {
1980 return Ok(SatisfiesResult::MismatchedBuildConstraints(
1981 expected, actual,
1982 ));
1983 }
1984 }
1985
1986 {
1988 let expected: BTreeMap<GroupName, BTreeSet<Requirement>> = dependency_groups
1989 .iter()
1990 .filter(|(_, requirements)| !requirements.is_empty())
1991 .map(|(group, requirements)| {
1992 Ok::<_, LockError>((
1993 group.clone(),
1994 requirements
1995 .iter()
1996 .cloned()
1997 .map(|requirement| {
1998 normalize_requirement(requirement, root, &self.requires_python)
1999 })
2000 .collect::<Result<_, _>>()?,
2001 ))
2002 })
2003 .collect::<Result<_, _>>()?;
2004 let actual: BTreeMap<GroupName, BTreeSet<Requirement>> = self
2005 .manifest
2006 .dependency_groups
2007 .iter()
2008 .filter(|(_, requirements)| !requirements.is_empty())
2009 .map(|(group, requirements)| {
2010 Ok::<_, LockError>((
2011 group.clone(),
2012 requirements
2013 .iter()
2014 .cloned()
2015 .map(|requirement| {
2016 normalize_requirement(requirement, root, &self.requires_python)
2017 })
2018 .collect::<Result<_, _>>()?,
2019 ))
2020 })
2021 .collect::<Result<_, _>>()?;
2022 if expected != actual {
2023 return Ok(SatisfiesResult::MismatchedDependencyGroups(
2024 expected, actual,
2025 ));
2026 }
2027 }
2028
2029 {
2031 let expected = dependency_metadata
2032 .values()
2033 .cloned()
2034 .collect::<BTreeSet<_>>();
2035 let actual = &self.manifest.dependency_metadata;
2036 if expected != *actual {
2037 return Ok(SatisfiesResult::MismatchedStaticMetadata(expected, actual));
2038 }
2039 }
2040
2041 let mut remotes = indexes.map(|locations| {
2043 locations
2044 .allowed_indexes()
2045 .into_iter()
2046 .filter_map(|index| match index.url() {
2047 IndexUrl::Pypi(_) | IndexUrl::Url(_) => {
2048 Some(UrlString::from(index.url().without_credentials().as_ref()))
2049 }
2050 IndexUrl::Path(_) => None,
2051 })
2052 .collect::<BTreeSet<_>>()
2053 });
2054
2055 let mut locals = indexes.map(|locations| {
2056 locations
2057 .allowed_indexes()
2058 .into_iter()
2059 .filter_map(|index| match index.url() {
2060 IndexUrl::Pypi(_) | IndexUrl::Url(_) => None,
2061 IndexUrl::Path(url) => {
2062 let path = url.to_file_path().ok()?;
2063 let path = try_relative_to_if(&path, root, !url.was_given_absolute())
2064 .ok()?
2065 .into_boxed_path();
2066 Some(path)
2067 }
2068 })
2069 .collect::<BTreeSet<_>>()
2070 });
2071
2072 for root_name in packages.keys() {
2074 let root = self
2075 .find_by_name(root_name)
2076 .expect("found too many packages matching root");
2077
2078 let Some(root) = root else {
2079 return Ok(SatisfiesResult::MissingRoot(root_name.clone()));
2081 };
2082
2083 if seen.insert(&root.id) {
2084 queue.push_back(root);
2085 }
2086 }
2087
2088 let root_requirements = requirements
2091 .iter()
2092 .chain(dependency_groups.values().flatten())
2093 .collect::<Vec<_>>();
2094
2095 for requirement in &root_requirements {
2096 if let RequirementSource::Registry {
2097 index: Some(index), ..
2098 } = &requirement.source
2099 {
2100 match &index.url {
2101 IndexUrl::Pypi(_) | IndexUrl::Url(_) => {
2102 if let Some(remotes) = remotes.as_mut() {
2103 remotes.insert(UrlString::from(
2104 index.url().without_credentials().as_ref(),
2105 ));
2106 }
2107 }
2108 IndexUrl::Path(url) => {
2109 if let Some(locals) = locals.as_mut() {
2110 if let Some(path) = url.to_file_path().ok().and_then(|path| {
2111 try_relative_to_if(&path, root, !url.was_given_absolute()).ok()
2112 }) {
2113 locals.insert(path.into_boxed_path());
2114 }
2115 }
2116 }
2117 }
2118 }
2119 }
2120
2121 if !root_requirements.is_empty() {
2122 let names = root_requirements
2123 .iter()
2124 .map(|requirement| &requirement.name)
2125 .collect::<FxHashSet<_>>();
2126
2127 let by_name: FxHashMap<_, Vec<_>> = self.packages.iter().fold(
2128 FxHashMap::with_capacity_and_hasher(self.packages.len(), FxBuildHasher),
2129 |mut by_name, package| {
2130 if names.contains(&package.id.name) {
2131 by_name.entry(&package.id.name).or_default().push(package);
2132 }
2133 by_name
2134 },
2135 );
2136
2137 for requirement in root_requirements {
2138 for package in by_name.get(&requirement.name).into_iter().flatten() {
2139 if !package.id.source.is_source_tree() {
2140 continue;
2141 }
2142
2143 let marker = if package.fork_markers.is_empty() {
2144 requirement.marker
2145 } else {
2146 let mut combined = MarkerTree::FALSE;
2147 for fork_marker in &package.fork_markers {
2148 combined.or(fork_marker.pep508());
2149 }
2150 combined.and(requirement.marker);
2151 combined
2152 };
2153 if marker.is_false() {
2154 continue;
2155 }
2156 if !marker.evaluate(markers, &[]) {
2157 continue;
2158 }
2159
2160 if seen.insert(&package.id) {
2161 queue.push_back(package);
2162 }
2163 }
2164 }
2165 }
2166
2167 while let Some(package) = queue.pop_front() {
2168 if let Source::Registry(index) = &package.id.source {
2170 match index {
2171 RegistrySource::Url(url) => {
2172 if remotes
2173 .as_ref()
2174 .is_some_and(|remotes| !remotes.contains(url))
2175 {
2176 let name = &package.id.name;
2177 let version = &package
2178 .id
2179 .version
2180 .as_ref()
2181 .expect("version for registry source");
2182 return Ok(SatisfiesResult::MissingRemoteIndex(name, version, url));
2183 }
2184 }
2185 RegistrySource::Path(path) => {
2186 if locals.as_ref().is_some_and(|locals| !locals.contains(path)) {
2187 let name = &package.id.name;
2188 let version = &package
2189 .id
2190 .version
2191 .as_ref()
2192 .expect("version for registry source");
2193 return Ok(SatisfiesResult::MissingLocalIndex(name, version, path));
2194 }
2195 }
2196 }
2197 }
2198
2199 if package.id.source.is_immutable() {
2201 continue;
2202 }
2203
2204 if matches!(&package.id.source, Source::Direct(..))
2208 && database.client().unmanaged.connectivity().is_offline()
2209 {
2210 trace!(
2211 "Skipping metadata validation for `{}` because its direct URL cannot be refreshed while offline",
2212 package.id
2213 );
2214 } else if let Some(version) = package.id.version.as_ref() {
2215 let statically_satisfied = if let Some(source_tree) =
2219 package.id.source.as_source_tree()
2220 && let Some(SourceTreeRequiresDist {
2221 version: static_version,
2222 metadata,
2223 }) = Self::source_tree_requires_dist(source_tree, root, package, database)
2224 .await?
2225 {
2226 if metadata.dynamic {
2229 return Ok(SatisfiesResult::MismatchedDynamic(&package.id.name, false));
2230 }
2231
2232 if let Some(static_version) = static_version {
2233 if static_version != *version {
2235 return Ok(SatisfiesResult::MismatchedVersion(
2236 &package.id.name,
2237 version.clone(),
2238 Some(static_version),
2239 ));
2240 }
2241
2242 match self.satisfies_provides_extra(metadata.provides_extra, package) {
2244 SatisfiesResult::Satisfied => {}
2245 result => return Ok(result),
2246 }
2247
2248 match self.satisfies_requires_dist(
2250 metadata.requires_dist,
2251 metadata.dependency_groups,
2252 package,
2253 root,
2254 )? {
2255 SatisfiesResult::Satisfied => true,
2256 result => return Ok(result),
2257 }
2258 } else {
2259 false
2260 }
2261 } else {
2262 false
2263 };
2264
2265 if !statically_satisfied {
2266 let HashedDist { dist, .. } = package.to_dist(
2269 root,
2270 TagPolicy::Preferred(tags),
2271 build_options,
2272 markers,
2273 )?;
2274
2275 let metadata = {
2276 let id = dist.distribution_id();
2277 if let Some(archive) =
2278 index
2279 .distributions()
2280 .get(&id)
2281 .as_deref()
2282 .and_then(|response| {
2283 if let MetadataResponse::Found(archive, ..) = response {
2284 Some(archive)
2285 } else {
2286 None
2287 }
2288 })
2289 {
2290 archive.metadata.clone()
2292 } else {
2293 let archive = database
2295 .get_or_build_wheel_metadata(&dist, hasher.get(&dist))
2296 .await
2297 .map_err(|err| LockErrorKind::Resolution {
2298 id: package.id.clone(),
2299 err,
2300 })?;
2301
2302 let metadata = archive.metadata.clone();
2303
2304 index
2306 .distributions()
2307 .done(id, Arc::new(MetadataResponse::Found(archive)));
2308
2309 metadata
2310 }
2311 };
2312
2313 if package.id.source.is_source_tree() && metadata.dynamic {
2316 return Ok(SatisfiesResult::MismatchedDynamic(&package.id.name, false));
2317 }
2318
2319 if metadata.version != *version {
2321 return Ok(SatisfiesResult::MismatchedVersion(
2322 &package.id.name,
2323 version.clone(),
2324 Some(metadata.version.clone()),
2325 ));
2326 }
2327
2328 match self.satisfies_provides_extra(metadata.provides_extra, package) {
2330 SatisfiesResult::Satisfied => {}
2331 result => return Ok(result),
2332 }
2333
2334 match self.satisfies_requires_dist(
2336 metadata.requires_dist,
2337 metadata.dependency_groups,
2338 package,
2339 root,
2340 )? {
2341 SatisfiesResult::Satisfied => {}
2342 result => return Ok(result),
2343 }
2344 }
2345 } else if let Some(source_tree) = package.id.source.as_source_tree() {
2346 let metadata =
2356 Self::source_tree_requires_dist(source_tree, root, package, database)
2357 .await?
2358 .map(|metadata| metadata.metadata);
2359
2360 let satisfied = metadata.is_some_and(|metadata| {
2361 if !metadata.dynamic {
2363 debug!("Static `requires-dist` for `{}` is out-of-date; falling back to distribution database", package.id);
2364 return false;
2365 }
2366
2367 if let SatisfiesResult::Satisfied = self.satisfies_provides_extra(metadata.provides_extra, package, ) {
2369 debug!("Static `provides-extra` for `{}` is up-to-date", package.id);
2370 } else {
2371 debug!("Static `provides-extra` for `{}` is out-of-date; falling back to distribution database", package.id);
2372 return false;
2373 }
2374
2375 match self.satisfies_requires_dist(metadata.requires_dist, metadata.dependency_groups, package, root) {
2377 Ok(SatisfiesResult::Satisfied) => {
2378 debug!("Static `requires-dist` for `{}` is up-to-date", package.id);
2379 },
2380 Ok(..) => {
2381 debug!("Static `requires-dist` for `{}` is out-of-date; falling back to distribution database", package.id);
2382 return false;
2383 },
2384 Err(..) => {
2385 debug!("Static `requires-dist` for `{}` is invalid; falling back to distribution database", package.id);
2386 return false;
2387 },
2388 }
2389
2390 true
2391 });
2392
2393 if !satisfied {
2399 let HashedDist { dist, .. } = package.to_dist(
2400 root,
2401 TagPolicy::Preferred(tags),
2402 build_options,
2403 markers,
2404 )?;
2405
2406 let metadata = {
2407 let id = dist.distribution_id();
2408 if let Some(archive) =
2409 index
2410 .distributions()
2411 .get(&id)
2412 .as_deref()
2413 .and_then(|response| {
2414 if let MetadataResponse::Found(archive, ..) = response {
2415 Some(archive)
2416 } else {
2417 None
2418 }
2419 })
2420 {
2421 archive.metadata.clone()
2423 } else {
2424 let archive = database
2426 .get_or_build_wheel_metadata(&dist, hasher.get(&dist))
2427 .await
2428 .map_err(|err| LockErrorKind::Resolution {
2429 id: package.id.clone(),
2430 err,
2431 })?;
2432
2433 let metadata = archive.metadata.clone();
2434
2435 index
2437 .distributions()
2438 .done(id, Arc::new(MetadataResponse::Found(archive)));
2439
2440 metadata
2441 }
2442 };
2443
2444 if !metadata.dynamic {
2446 return Ok(SatisfiesResult::MismatchedDynamic(&package.id.name, true));
2447 }
2448
2449 match self.satisfies_provides_extra(metadata.provides_extra, package) {
2451 SatisfiesResult::Satisfied => {}
2452 result => return Ok(result),
2453 }
2454
2455 match self.satisfies_requires_dist(
2457 metadata.requires_dist,
2458 metadata.dependency_groups,
2459 package,
2460 root,
2461 )? {
2462 SatisfiesResult::Satisfied => {}
2463 result => return Ok(result),
2464 }
2465 }
2466 } else {
2467 return Ok(SatisfiesResult::MissingVersion(&package.id.name));
2468 }
2469
2470 for requirement in package
2475 .metadata
2476 .requires_dist
2477 .iter()
2478 .chain(package.metadata.dependency_groups.values().flatten())
2479 {
2480 if let RequirementSource::Registry {
2481 index: Some(index), ..
2482 } = &requirement.source
2483 {
2484 match &index.url {
2485 IndexUrl::Pypi(_) | IndexUrl::Url(_) => {
2486 if let Some(remotes) = remotes.as_mut() {
2487 remotes.insert(UrlString::from(
2488 index.url().without_credentials().as_ref(),
2489 ));
2490 }
2491 }
2492 IndexUrl::Path(url) => {
2493 if let Some(locals) = locals.as_mut() {
2494 if let Some(path) = url.to_file_path().ok().and_then(|path| {
2495 try_relative_to_if(&path, root, !url.was_given_absolute()).ok()
2496 }) {
2497 locals.insert(path.into_boxed_path());
2498 }
2499 }
2500 }
2501 }
2502 }
2503 }
2504
2505 for dep in &package.dependencies {
2507 if seen.insert(&dep.package_id) {
2508 let dep_dist = self.find_by_id(&dep.package_id);
2509 queue.push_back(dep_dist);
2510 }
2511 }
2512
2513 for dependencies in package.optional_dependencies.values() {
2514 for dep in dependencies {
2515 if seen.insert(&dep.package_id) {
2516 let dep_dist = self.find_by_id(&dep.package_id);
2517 queue.push_back(dep_dist);
2518 }
2519 }
2520 }
2521
2522 for dependencies in package.dependency_groups.values() {
2523 for dep in dependencies {
2524 if seen.insert(&dep.package_id) {
2525 let dep_dist = self.find_by_id(&dep.package_id);
2526 queue.push_back(dep_dist);
2527 }
2528 }
2529 }
2530 }
2531
2532 Ok(SatisfiesResult::Satisfied)
2533 }
2534
2535 async fn source_tree_requires_dist<Context: BuildContext>(
2536 source_tree: &Path,
2537 root: &Path,
2538 package: &Package,
2539 database: &DistributionDatabase<'_, Context>,
2540 ) -> Result<Option<SourceTreeRequiresDist>, LockError> {
2541 let parent = root.join(source_tree);
2542 let path = parent.join("pyproject.toml");
2543 match fs_err::tokio::read_to_string(&path).await {
2544 Ok(contents) => {
2545 let pyproject_toml = PyProjectToml::from_toml(&contents, path.user_display())
2546 .map_err(|err| LockErrorKind::InvalidPyprojectToml {
2547 path: path.clone(),
2548 err,
2549 })?;
2550 let version = pyproject_toml
2551 .project
2552 .as_ref()
2553 .and_then(|project| project.version.clone());
2554 let metadata = database
2555 .requires_dist(&parent, &pyproject_toml)
2556 .await
2557 .map_err(|err| LockErrorKind::Resolution {
2558 id: package.id.clone(),
2559 err,
2560 })?;
2561 Ok(metadata.map(|metadata| SourceTreeRequiresDist { version, metadata }))
2562 }
2563 Err(err) if err.kind() == io::ErrorKind::NotFound => Ok(None),
2564 Err(err) => Err(LockErrorKind::UnreadablePyprojectToml { path, err }.into()),
2565 }
2566 }
2567}
2568
2569#[derive(Debug)]
2577pub struct Auditable<'lock> {
2578 packages: Vec<(&'lock Package, &'lock Version)>,
2580}
2581
2582struct SourceTreeRequiresDist {
2583 version: Option<Version>,
2584 metadata: RequiresDist,
2585}
2586
2587impl<'lock> Auditable<'lock> {
2588 pub fn len(&self) -> usize {
2590 self.packages.len()
2591 }
2592
2593 pub fn is_empty(&self) -> bool {
2595 self.packages.is_empty()
2596 }
2597
2598 pub fn packages(&self) -> impl Iterator<Item = (&'lock PackageName, &'lock Version)> + '_ {
2600 self.packages
2601 .iter()
2602 .map(|(package, version)| (package.name(), *version))
2603 }
2604
2605 pub fn projects(&self, root: &Path) -> Result<Vec<(&'lock PackageName, IndexUrl)>, LockError> {
2609 let mut seen: FxHashSet<(&PackageName, String)> = FxHashSet::default();
2610 let mut projects: Vec<(&PackageName, IndexUrl)> = Vec::with_capacity(self.packages.len());
2611 for (package, _version) in &self.packages {
2612 if let Some(index) = package.index(root)?
2613 && seen.insert((package.name(), index.url().to_string()))
2614 {
2615 projects.push((package.name(), index));
2616 }
2617 }
2618 Ok(projects)
2619 }
2620}
2621
2622#[derive(Debug, Copy, Clone)]
2623enum TagPolicy<'tags> {
2624 Required(&'tags Tags),
2626 Preferred(&'tags Tags),
2629}
2630
2631impl<'tags> TagPolicy<'tags> {
2632 fn tags(&self) -> &'tags Tags {
2634 match self {
2635 Self::Required(tags) | Self::Preferred(tags) => tags,
2636 }
2637 }
2638}
2639
2640#[derive(Debug)]
2642pub enum SatisfiesResult<'lock> {
2643 Satisfied,
2645 MismatchedMembers(BTreeSet<PackageName>, &'lock BTreeSet<PackageName>),
2647 MismatchedVirtual(PackageName, bool),
2649 MismatchedEditable(PackageName, bool),
2651 MismatchedDynamic(&'lock PackageName, bool),
2653 MismatchedVersion(&'lock PackageName, Version, Option<Version>),
2655 MismatchedRequirements(BTreeSet<Requirement>, BTreeSet<Requirement>),
2657 MismatchedConstraints(BTreeSet<Requirement>, BTreeSet<Requirement>),
2659 MismatchedOverrides(
2661 BTreeSet<Override<Requirement>>,
2662 BTreeSet<Override<Requirement>>,
2663 ),
2664 MismatchedExcludes(BTreeSet<ExcludeDependency>, BTreeSet<ExcludeDependency>),
2666 MismatchedBuildConstraints(BTreeSet<Requirement>, BTreeSet<Requirement>),
2668 MismatchedDependencyGroups(
2670 BTreeMap<GroupName, BTreeSet<Requirement>>,
2671 BTreeMap<GroupName, BTreeSet<Requirement>>,
2672 ),
2673 MismatchedStaticMetadata(BTreeSet<StaticMetadata>, &'lock BTreeSet<StaticMetadata>),
2675 MissingRoot(PackageName),
2677 MissingRemoteIndex(&'lock PackageName, &'lock Version, &'lock UrlString),
2679 MissingLocalIndex(&'lock PackageName, &'lock Version, &'lock Path),
2681 MismatchedPackageRequirements(
2683 &'lock PackageName,
2684 Option<&'lock Version>,
2685 BTreeSet<Requirement>,
2686 BTreeSet<Requirement>,
2687 ),
2688 MismatchedPackageProvidesExtra(
2690 &'lock PackageName,
2691 Option<&'lock Version>,
2692 BTreeSet<ExtraName>,
2693 BTreeSet<&'lock ExtraName>,
2694 ),
2695 MismatchedPackageDependencyGroups(
2697 &'lock PackageName,
2698 Option<&'lock Version>,
2699 BTreeMap<GroupName, BTreeSet<Requirement>>,
2700 BTreeMap<GroupName, BTreeSet<Requirement>>,
2701 ),
2702 MissingVersion(&'lock PackageName),
2704}
2705
2706#[derive(Clone, Debug, Default, serde::Deserialize, PartialEq, Eq)]
2708#[serde(rename_all = "kebab-case")]
2709struct ResolverOptions {
2710 #[serde(default)]
2712 resolution_mode: ResolutionMode,
2713 #[serde(default)]
2715 prerelease_mode: PrereleaseMode,
2716 #[serde(default)]
2718 fork_strategy: ForkStrategy,
2719 #[serde(flatten)]
2721 exclude_newer: ExcludeNewerWire,
2722}
2723
2724#[expect(clippy::struct_field_names)]
2725#[derive(Clone, Debug, Default, serde::Deserialize, PartialEq, Eq)]
2726#[serde(rename_all = "kebab-case")]
2727struct ExcludeNewerWire {
2728 exclude_newer: Option<Timestamp>,
2729 exclude_newer_span: Option<ExcludeNewerSpan>,
2730 #[serde(default, skip_serializing_if = "ExcludeNewerPackage::is_empty")]
2731 exclude_newer_package: ExcludeNewerPackage,
2732}
2733
2734impl From<ExcludeNewerWire> for ExcludeNewer {
2735 fn from(wire: ExcludeNewerWire) -> Self {
2736 let global = match (wire.exclude_newer, wire.exclude_newer_span) {
2737 (Some(timestamp), None) => Some(ExcludeNewerValue::absolute(timestamp)),
2738 (Some(_), Some(span)) => Some(ExcludeNewerValue::relative(span)),
2741 (None, Some(span)) => Some(ExcludeNewerValue::relative(span)),
2744 (None, None) => None,
2745 };
2746 Self {
2747 global,
2748 package: wire.exclude_newer_package,
2749 }
2750 }
2751}
2752
2753impl From<ExcludeNewer> for ExcludeNewerWire {
2754 fn from(exclude_newer: ExcludeNewer) -> Self {
2755 let (timestamp, span) = match exclude_newer.global {
2756 Some(ExcludeNewerValue::Absolute(timestamp)) => (Some(timestamp), None),
2757 Some(ExcludeNewerValue::Relative(span)) => (None, Some(span)),
2758 None => (None, None),
2759 };
2760 Self {
2761 exclude_newer: timestamp,
2762 exclude_newer_span: span,
2763 exclude_newer_package: exclude_newer.package,
2764 }
2765 }
2766}
2767
2768#[derive(Clone, Debug, Default, serde::Deserialize, PartialEq, Eq)]
2769#[serde(rename_all = "kebab-case")]
2770pub struct ResolverManifest {
2771 #[serde(default)]
2773 members: BTreeSet<PackageName>,
2774 #[serde(default)]
2779 requirements: BTreeSet<Requirement>,
2780 #[serde(default)]
2786 dependency_groups: BTreeMap<GroupName, BTreeSet<Requirement>>,
2787 #[serde(default)]
2789 constraints: BTreeSet<Requirement>,
2790 #[serde(default)]
2792 overrides: BTreeSet<Override<Requirement>>,
2793 #[serde(default)]
2795 excludes: BTreeSet<ExcludeDependency>,
2796 #[serde(default)]
2798 build_constraints: BTreeSet<Requirement>,
2799 #[serde(default)]
2801 dependency_metadata: BTreeSet<StaticMetadata>,
2802}
2803
2804impl ResolverManifest {
2805 pub fn new(
2808 members: impl IntoIterator<Item = PackageName>,
2809 requirements: impl IntoIterator<Item = Requirement>,
2810 constraints: impl IntoIterator<Item = Requirement>,
2811 overrides: impl IntoIterator<Item = Override<Requirement>>,
2812 excludes: impl IntoIterator<Item = ExcludeDependency>,
2813 build_constraints: impl IntoIterator<Item = Requirement>,
2814 dependency_groups: impl IntoIterator<Item = (GroupName, Vec<Requirement>)>,
2815 dependency_metadata: impl IntoIterator<Item = StaticMetadata>,
2816 ) -> Self {
2817 Self {
2818 members: members.into_iter().collect(),
2819 requirements: requirements.into_iter().collect(),
2820 constraints: constraints.into_iter().collect(),
2821 overrides: overrides.into_iter().collect(),
2822 excludes: excludes.into_iter().collect(),
2823 build_constraints: build_constraints.into_iter().collect(),
2824 dependency_groups: dependency_groups
2825 .into_iter()
2826 .map(|(group, requirements)| (group, requirements.into_iter().collect()))
2827 .collect(),
2828 dependency_metadata: dependency_metadata.into_iter().collect(),
2829 }
2830 }
2831
2832 pub fn relative_to(self, root: &Path) -> Result<Self, io::Error> {
2834 Ok(Self {
2835 members: self.members,
2836 requirements: self
2837 .requirements
2838 .into_iter()
2839 .map(|requirement| requirement.relative_to(root))
2840 .collect::<Result<BTreeSet<_>, _>>()?,
2841 constraints: self
2842 .constraints
2843 .into_iter()
2844 .map(|requirement| requirement.relative_to(root))
2845 .collect::<Result<BTreeSet<_>, _>>()?,
2846 overrides: self
2847 .overrides
2848 .into_iter()
2849 .map(|entry| match entry {
2850 Override::Requirement(requirement) => {
2851 Ok(Override::Requirement(requirement.relative_to(root)?))
2852 }
2853 Override::Package(package) => Ok(Override::Package(PackageOverride {
2854 package: package.package,
2855 dependencies: package
2856 .dependencies
2857 .into_vec()
2858 .into_iter()
2859 .map(|requirement| requirement.relative_to(root))
2860 .collect::<Result<Vec<_>, _>>()?
2861 .into_boxed_slice(),
2862 })),
2863 })
2864 .collect::<Result<BTreeSet<_>, io::Error>>()?,
2865 excludes: self.excludes,
2866 build_constraints: self
2867 .build_constraints
2868 .into_iter()
2869 .map(|requirement| requirement.relative_to(root))
2870 .collect::<Result<BTreeSet<_>, _>>()?,
2871 dependency_groups: self
2872 .dependency_groups
2873 .into_iter()
2874 .map(|(group, requirements)| {
2875 Ok::<_, io::Error>((
2876 group,
2877 requirements
2878 .into_iter()
2879 .map(|requirement| requirement.relative_to(root))
2880 .collect::<Result<BTreeSet<_>, _>>()?,
2881 ))
2882 })
2883 .collect::<Result<BTreeMap<_, _>, _>>()?,
2884 dependency_metadata: self.dependency_metadata,
2885 })
2886 }
2887}
2888
2889#[derive(Clone, Debug, serde::Deserialize)]
2890#[serde(rename_all = "kebab-case")]
2891struct LockWire {
2892 version: u32,
2893 revision: Option<u32>,
2894 requires_python: RequiresPython,
2895 #[serde(rename = "resolution-markers", default)]
2898 fork_markers: Vec<SimplifiedMarkerTree>,
2899 #[serde(rename = "supported-markers", default)]
2900 supported_environments: Vec<SimplifiedMarkerTree>,
2901 #[serde(rename = "required-markers", default)]
2902 required_environments: Vec<SimplifiedMarkerTree>,
2903 #[serde(rename = "conflicts", default)]
2904 conflicts: Option<Conflicts>,
2905 #[serde(default)]
2907 options: ResolverOptions,
2908 #[serde(default)]
2909 manifest: ResolverManifest,
2910 #[serde(rename = "package", alias = "distribution", default)]
2911 packages: Vec<PackageWire>,
2912}
2913
2914impl TryFrom<LockWire> for Lock {
2915 type Error = LockError;
2916
2917 fn try_from(wire: LockWire) -> Result<Self, LockError> {
2918 let mut unambiguous_package_ids: FxHashMap<PackageName, PackageId> = FxHashMap::default();
2923 let mut ambiguous = FxHashSet::default();
2924 for dist in &wire.packages {
2925 if ambiguous.contains(&dist.id.name) {
2926 continue;
2927 }
2928 if let Some(id) = unambiguous_package_ids.remove(&dist.id.name) {
2929 ambiguous.insert(id.name);
2930 continue;
2931 }
2932 unambiguous_package_ids.insert(dist.id.name.clone(), dist.id.clone());
2933 }
2934
2935 let fork_markers = wire
2936 .fork_markers
2937 .into_iter()
2938 .map(|simplified_marker| simplified_marker.into_marker(&wire.requires_python))
2939 .map(UniversalMarker::from_combined)
2940 .collect::<Vec<_>>();
2941 let environment = SimplifiedMarkerTree::new(
2942 &wire.requires_python,
2943 fork_markers_union(&fork_markers, &wire.requires_python),
2944 );
2945 let default =
2948 UniversalMarker::from_combined(environment.into_marker(&wire.requires_python));
2949 let packages = wire
2950 .packages
2951 .into_iter()
2952 .map(|dist| {
2953 dist.unwire(
2954 &wire.requires_python,
2955 environment,
2956 default,
2957 &unambiguous_package_ids,
2958 )
2959 })
2960 .collect::<Result<Vec<_>, _>>()?;
2961 let supported_environments = wire
2962 .supported_environments
2963 .into_iter()
2964 .map(|simplified_marker| simplified_marker.into_marker(&wire.requires_python))
2965 .collect();
2966 let required_environments = wire
2967 .required_environments
2968 .into_iter()
2969 .map(|simplified_marker| simplified_marker.into_marker(&wire.requires_python))
2970 .collect();
2971 let mut options = wire.options;
2972 if options.exclude_newer.exclude_newer_span.is_some() {
2973 options.exclude_newer.exclude_newer = None;
2974 }
2975 let lock = Self::new(
2976 wire.version,
2977 wire.revision.unwrap_or(0),
2978 packages,
2979 wire.requires_python,
2980 options,
2981 wire.manifest,
2982 wire.conflicts.unwrap_or_else(Conflicts::empty),
2983 supported_environments,
2984 required_environments,
2985 fork_markers,
2986 )?;
2987
2988 Ok(lock)
2989 }
2990}
2991
2992#[derive(Clone, Debug, serde::Deserialize)]
2996#[serde(rename_all = "kebab-case")]
2997pub struct LockVersion {
2998 version: u32,
2999}
3000
3001impl LockVersion {
3002 pub fn version(&self) -> u32 {
3004 self.version
3005 }
3006}
3007
3008#[derive(Clone, Debug, PartialEq, Eq)]
3009pub struct Package {
3010 pub(crate) id: PackageId,
3011 sdist: Option<SourceDist>,
3012 wheels: Vec<Wheel>,
3013 fork_markers: Vec<UniversalMarker>,
3019 dependencies: Vec<Dependency>,
3021 optional_dependencies: BTreeMap<ExtraName, Vec<Dependency>>,
3023 dependency_groups: BTreeMap<GroupName, Vec<Dependency>>,
3025 metadata: PackageMetadata,
3027}
3028
3029impl Package {
3030 pub fn is_from_pypi_registry(&self) -> bool {
3031 self.id.source.is_pypi_registry()
3032 }
3033
3034 fn from_annotated_dist(
3035 annotated_dist: &AnnotatedDist,
3036 fork_markers: Vec<UniversalMarker>,
3037 root: &Path,
3038 ) -> Result<Self, LockError> {
3039 let id = PackageId::from_annotated_dist(annotated_dist, root)?;
3040 let sdist = SourceDist::from_annotated_dist(&id, annotated_dist)?;
3041 let wheels = Wheel::from_annotated_dist(annotated_dist)?;
3042 let requires_dist = if id.source.is_immutable() {
3043 BTreeSet::default()
3044 } else {
3045 annotated_dist
3046 .metadata
3047 .as_ref()
3048 .expect("metadata is present")
3049 .requires_dist
3050 .iter()
3051 .cloned()
3052 .map(|requirement| requirement.relative_to(root))
3053 .collect::<Result<_, _>>()
3054 .map_err(LockErrorKind::RequirementRelativePath)?
3055 };
3056 let provides_extra = if id.source.is_immutable() {
3057 Box::default()
3058 } else {
3059 annotated_dist
3060 .metadata
3061 .as_ref()
3062 .expect("metadata is present")
3063 .provides_extra
3064 .clone()
3065 };
3066 let dependency_groups = if id.source.is_immutable() {
3067 BTreeMap::default()
3068 } else {
3069 annotated_dist
3070 .metadata
3071 .as_ref()
3072 .expect("metadata is present")
3073 .dependency_groups
3074 .iter()
3075 .map(|(group, requirements)| {
3076 let requirements = requirements
3077 .iter()
3078 .cloned()
3079 .map(|requirement| requirement.relative_to(root))
3080 .collect::<Result<_, _>>()
3081 .map_err(LockErrorKind::RequirementRelativePath)?;
3082 Ok::<_, LockError>((group.clone(), requirements))
3083 })
3084 .collect::<Result<_, _>>()?
3085 };
3086 Ok(Self {
3087 id,
3088 sdist,
3089 wheels,
3090 fork_markers,
3091 dependencies: vec![],
3092 optional_dependencies: BTreeMap::default(),
3093 dependency_groups: BTreeMap::default(),
3094 metadata: PackageMetadata {
3095 requires_dist,
3096 provides_extra,
3097 dependency_groups,
3098 },
3099 })
3100 }
3101
3102 fn add_dependency(
3104 &mut self,
3105 requires_python: &RequiresPython,
3106 annotated_dist: &AnnotatedDist,
3107 marker: UniversalMarker,
3108 root: &Path,
3109 ) -> Result<(), LockError> {
3110 let new_dep =
3111 Dependency::from_annotated_dist(requires_python, annotated_dist, marker, root)?;
3112 for existing_dep in &mut self.dependencies {
3113 if existing_dep.package_id == new_dep.package_id
3114 && existing_dep.simplified_marker == new_dep.simplified_marker
3137 {
3138 existing_dep.extra.extend(new_dep.extra);
3139 return Ok(());
3140 }
3141 }
3142
3143 self.dependencies.push(new_dep);
3144 Ok(())
3145 }
3146
3147 fn add_optional_dependency(
3149 &mut self,
3150 requires_python: &RequiresPython,
3151 extra: ExtraName,
3152 annotated_dist: &AnnotatedDist,
3153 marker: UniversalMarker,
3154 root: &Path,
3155 ) -> Result<(), LockError> {
3156 let dep = Dependency::from_annotated_dist(requires_python, annotated_dist, marker, root)?;
3157 let optional_deps = self.optional_dependencies.entry(extra).or_default();
3158 for existing_dep in &mut *optional_deps {
3159 if existing_dep.package_id == dep.package_id
3160 && existing_dep.simplified_marker == dep.simplified_marker
3163 {
3164 existing_dep.extra.extend(dep.extra);
3165 return Ok(());
3166 }
3167 }
3168
3169 optional_deps.push(dep);
3170 Ok(())
3171 }
3172
3173 fn add_group_dependency(
3175 &mut self,
3176 requires_python: &RequiresPython,
3177 group: GroupName,
3178 annotated_dist: &AnnotatedDist,
3179 marker: UniversalMarker,
3180 root: &Path,
3181 ) -> Result<(), LockError> {
3182 let dep = Dependency::from_annotated_dist(requires_python, annotated_dist, marker, root)?;
3183 let deps = self.dependency_groups.entry(group).or_default();
3184 for existing_dep in &mut *deps {
3185 if existing_dep.package_id == dep.package_id
3186 && existing_dep.simplified_marker == dep.simplified_marker
3189 {
3190 existing_dep.extra.extend(dep.extra);
3191 return Ok(());
3192 }
3193 }
3194
3195 deps.push(dep);
3196 Ok(())
3197 }
3198
3199 fn to_dist(
3201 &self,
3202 workspace_root: &Path,
3203 tag_policy: TagPolicy<'_>,
3204 build_options: &BuildOptions,
3205 markers: &MarkerEnvironment,
3206 ) -> Result<HashedDist, LockError> {
3207 let no_binary = build_options.no_binary_package(&self.id.name);
3208 let no_build = build_options.no_build_package(&self.id.name);
3209
3210 if !no_binary {
3211 if let Some(best_wheel_index) = self.find_best_wheel(tag_policy) {
3212 let hashes = {
3213 let wheel = &self.wheels[best_wheel_index];
3214 HashDigests::from(
3215 wheel
3216 .hash
3217 .iter()
3218 .chain(wheel.zstd.iter().flat_map(|z| z.hash.iter()))
3219 .map(|h| h.0.clone())
3220 .collect::<Vec<_>>(),
3221 )
3222 };
3223
3224 let dist = match &self.id.source {
3225 Source::Registry(source) => {
3226 let wheels = self
3227 .wheels
3228 .iter()
3229 .map(|wheel| wheel.to_registry_wheel(source, workspace_root))
3230 .collect::<Result<_, LockError>>()?;
3231 let reg_built_dist = RegistryBuiltDist {
3232 wheels,
3233 best_wheel_index,
3234 sdist: None,
3235 };
3236 Dist::Built(BuiltDist::Registry(reg_built_dist))
3237 }
3238 Source::Path(path) => {
3239 let filename: WheelFilename =
3240 self.wheels[best_wheel_index].filename.clone();
3241 let install_path = absolute_path(workspace_root, path)?;
3242 let path_dist = PathBuiltDist {
3243 filename,
3244 url: verbatim_url(&install_path, &self.id)?,
3245 install_path: absolute_path(workspace_root, path)?.into_boxed_path(),
3246 };
3247 let built_dist = BuiltDist::Path(path_dist);
3248 Dist::Built(built_dist)
3249 }
3250 Source::Direct(url, direct) => {
3251 let filename: WheelFilename =
3252 self.wheels[best_wheel_index].filename.clone();
3253 let url = DisplaySafeUrl::from(ParsedArchiveUrl {
3254 url: url.to_url().map_err(LockErrorKind::InvalidUrl)?,
3255 subdirectory: direct.subdirectory.clone(),
3256 ext: DistExtension::Wheel,
3257 });
3258 let direct_dist = DirectUrlBuiltDist {
3259 filename,
3260 location: Box::new(url.clone()),
3261 url: VerbatimUrl::from_url(url),
3262 };
3263 let built_dist = BuiltDist::DirectUrl(direct_dist);
3264 Dist::Built(built_dist)
3265 }
3266 Source::Git(url, git) => {
3267 let Some(install_path) = git.path.as_ref() else {
3268 return Err(LockErrorKind::InvalidWheelSource {
3269 id: self.id.clone(),
3270 source_type: "Git",
3271 }
3272 .into());
3273 };
3274
3275 let mut url = url.to_url().map_err(LockErrorKind::InvalidUrl)?;
3278 url.set_fragment(None);
3279 url.set_query(None);
3280
3281 let git_url = GitUrl::from_commit(
3283 url,
3284 GitReference::from(git.kind.clone()),
3285 git.precise,
3286 git.lfs,
3287 )?;
3288
3289 let url = DisplaySafeUrl::from(ParsedGitPathUrl {
3291 url: git_url.clone(),
3292 install_path: install_path.clone(),
3293 ext: DistExtension::Wheel,
3294 });
3295
3296 let filename: WheelFilename =
3297 self.wheels[best_wheel_index].filename.clone();
3298
3299 let git_dist = GitPathBuiltDist {
3300 filename,
3301 git: Box::new(git_url),
3302 install_path: install_path.clone(),
3303 url: VerbatimUrl::from_url(url),
3304 };
3305 let built_dist = BuiltDist::GitPath(git_dist);
3306 Dist::Built(built_dist)
3307 }
3308 Source::Directory(_) => {
3309 return Err(LockErrorKind::InvalidWheelSource {
3310 id: self.id.clone(),
3311 source_type: "directory",
3312 }
3313 .into());
3314 }
3315 Source::Editable(_) => {
3316 return Err(LockErrorKind::InvalidWheelSource {
3317 id: self.id.clone(),
3318 source_type: "editable",
3319 }
3320 .into());
3321 }
3322 Source::Virtual(_) => {
3323 return Err(LockErrorKind::InvalidWheelSource {
3324 id: self.id.clone(),
3325 source_type: "virtual",
3326 }
3327 .into());
3328 }
3329 };
3330
3331 return Ok(HashedDist { dist, hashes });
3332 }
3333 }
3334
3335 if let Some(sdist) = self.to_source_dist(workspace_root)? {
3336 if !no_build || sdist.is_virtual() {
3340 let hashes = self
3341 .sdist
3342 .as_ref()
3343 .and_then(|s| s.hash())
3344 .map(|hash| HashDigests::from(vec![hash.0.clone()]))
3345 .unwrap_or_else(|| HashDigests::from(vec![]));
3346 return Ok(HashedDist {
3347 dist: Dist::Source(sdist),
3348 hashes,
3349 });
3350 }
3351 }
3352
3353 match (no_binary, no_build) {
3354 (true, true) => Err(LockErrorKind::NoBinaryNoBuild {
3355 id: self.id.clone(),
3356 }
3357 .into()),
3358 (true, false) if self.id.source.is_wheel() => Err(LockErrorKind::NoBinaryWheelOnly {
3359 id: self.id.clone(),
3360 }
3361 .into()),
3362 (true, false) => Err(LockErrorKind::NoBinary {
3363 id: self.id.clone(),
3364 }
3365 .into()),
3366 (false, true) => Err(LockErrorKind::NoBuild {
3367 id: self.id.clone(),
3368 }
3369 .into()),
3370 (false, false) if self.id.source.is_wheel() => Err(LockError {
3371 kind: Box::new(LockErrorKind::IncompatibleWheelOnly {
3372 id: self.id.clone(),
3373 }),
3374 hint: self.tag_hint(tag_policy, markers),
3375 }),
3376 (false, false) => Err(LockError {
3377 kind: Box::new(LockErrorKind::NeitherSourceDistNorWheel {
3378 id: self.id.clone(),
3379 }),
3380 hint: self.tag_hint(tag_policy, markers),
3381 }),
3382 }
3383 }
3384
3385 fn tag_hint(
3387 &self,
3388 tag_policy: TagPolicy<'_>,
3389 markers: &MarkerEnvironment,
3390 ) -> Option<WheelTagHint> {
3391 let filenames = self
3392 .wheels
3393 .iter()
3394 .map(|wheel| &wheel.filename)
3395 .collect::<Vec<_>>();
3396 WheelTagHint::from_wheels(
3397 &self.id.name,
3398 self.id.version.as_ref(),
3399 &filenames,
3400 tag_policy.tags(),
3401 markers,
3402 )
3403 }
3404
3405 fn to_source_dist(
3410 &self,
3411 workspace_root: &Path,
3412 ) -> Result<Option<uv_distribution_types::SourceDist>, LockError> {
3413 let sdist = match &self.id.source {
3414 Source::Path(path) => {
3415 let DistExtension::Source(ext) = DistExtension::from_path(path).map_err(|err| {
3417 LockErrorKind::MissingExtension {
3418 id: self.id.clone(),
3419 err,
3420 }
3421 })?
3422 else {
3423 return Ok(None);
3424 };
3425 let install_path = absolute_path(workspace_root, path)?;
3426 let given = path.to_str().expect("lock file paths must be UTF-8");
3427 let path_dist = PathSourceDist {
3428 name: self.id.name.clone(),
3429 version: self.id.version.clone(),
3430 url: verbatim_url(&install_path, &self.id)?.with_given(given),
3431 install_path: install_path.into_boxed_path(),
3432 ext,
3433 };
3434 uv_distribution_types::SourceDist::Path(path_dist)
3435 }
3436 Source::Directory(path) => {
3437 let install_path = absolute_path(workspace_root, path)?;
3438 let given = path.to_str().expect("lock file paths must be UTF-8");
3439 let dir_dist = DirectorySourceDist {
3440 name: self.id.name.clone(),
3441 url: verbatim_url(&install_path, &self.id)?.with_given(given),
3442 install_path: install_path.into_boxed_path(),
3443 editable: Some(false),
3444 r#virtual: Some(false),
3445 };
3446 uv_distribution_types::SourceDist::Directory(dir_dist)
3447 }
3448 Source::Editable(path) => {
3449 let install_path = absolute_path(workspace_root, path)?;
3450 let given = path.to_str().expect("lock file paths must be UTF-8");
3451 let dir_dist = DirectorySourceDist {
3452 name: self.id.name.clone(),
3453 url: verbatim_url(&install_path, &self.id)?.with_given(given),
3454 install_path: install_path.into_boxed_path(),
3455 editable: Some(true),
3456 r#virtual: Some(false),
3457 };
3458 uv_distribution_types::SourceDist::Directory(dir_dist)
3459 }
3460 Source::Virtual(path) => {
3461 let install_path = absolute_path(workspace_root, path)?;
3462 let given = path.to_str().expect("lock file paths must be UTF-8");
3463 let dir_dist = DirectorySourceDist {
3464 name: self.id.name.clone(),
3465 url: verbatim_url(&install_path, &self.id)?.with_given(given),
3466 install_path: install_path.into_boxed_path(),
3467 editable: Some(false),
3468 r#virtual: Some(true),
3469 };
3470 uv_distribution_types::SourceDist::Directory(dir_dist)
3471 }
3472 Source::Git(url, git) => {
3473 let mut url = url.to_url().map_err(LockErrorKind::InvalidUrl)?;
3476 url.set_fragment(None);
3477 url.set_query(None);
3478
3479 let git_url = GitUrl::from_commit(
3480 url,
3481 GitReference::from(git.kind.clone()),
3482 git.precise,
3483 git.lfs,
3484 )?;
3485
3486 if let Some(install_path) = git.path.as_ref() {
3487 let DistExtension::Source(ext) = DistExtension::from_path(install_path)
3489 .map_err(|err| LockErrorKind::MissingExtension {
3490 id: self.id.clone(),
3491 err,
3492 })?
3493 else {
3494 return Ok(None);
3495 };
3496
3497 let url = DisplaySafeUrl::from(ParsedGitPathUrl {
3499 url: git_url.clone(),
3500 install_path: install_path.clone(),
3501 ext: DistExtension::Source(ext),
3502 });
3503
3504 let git_dist = GitPathSourceDist {
3505 name: self.id.name.clone(),
3506 url: VerbatimUrl::from_url(url),
3507 git: Box::new(git_url),
3508 install_path: install_path.clone(),
3509 ext,
3510 };
3511 uv_distribution_types::SourceDist::GitPath(git_dist)
3512 } else {
3513 let url = DisplaySafeUrl::from(ParsedGitDirectoryUrl {
3515 url: git_url.clone(),
3516 subdirectory: git.subdirectory.clone(),
3517 });
3518
3519 let git_dist = GitDirectorySourceDist {
3520 name: self.id.name.clone(),
3521 url: VerbatimUrl::from_url(url),
3522 git: Box::new(git_url),
3523 subdirectory: git.subdirectory.clone(),
3524 };
3525 uv_distribution_types::SourceDist::GitDirectory(git_dist)
3526 }
3527 }
3528 Source::Direct(url, direct) => {
3529 let DistExtension::Source(ext) =
3531 DistExtension::from_path(url.base_str()).map_err(|err| {
3532 LockErrorKind::MissingExtension {
3533 id: self.id.clone(),
3534 err,
3535 }
3536 })?
3537 else {
3538 return Ok(None);
3539 };
3540 let location = url.to_url().map_err(LockErrorKind::InvalidUrl)?;
3541 let url = DisplaySafeUrl::from(ParsedArchiveUrl {
3542 url: location.clone(),
3543 subdirectory: direct.subdirectory.clone(),
3544 ext: DistExtension::Source(ext),
3545 });
3546 let direct_dist = DirectUrlSourceDist {
3547 name: self.id.name.clone(),
3548 location: Box::new(location),
3549 subdirectory: direct.subdirectory.clone(),
3550 ext,
3551 url: VerbatimUrl::from_url(url),
3552 };
3553 uv_distribution_types::SourceDist::DirectUrl(direct_dist)
3554 }
3555 Source::Registry(RegistrySource::Url(url)) => {
3556 let Some(ref sdist) = self.sdist else {
3557 return Ok(None);
3558 };
3559
3560 let name = &self.id.name;
3561 let version = self
3562 .id
3563 .version
3564 .as_ref()
3565 .expect("version for registry source");
3566
3567 let file_url = sdist.url().ok_or_else(|| LockErrorKind::MissingUrl {
3568 name: name.clone(),
3569 version: version.clone(),
3570 })?;
3571 let filename = sdist
3572 .filename()
3573 .ok_or_else(|| LockErrorKind::MissingFilename {
3574 id: self.id.clone(),
3575 })?;
3576 let ext = SourceDistExtension::from_path(filename.as_ref()).map_err(|err| {
3577 LockErrorKind::MissingExtension {
3578 id: self.id.clone(),
3579 err,
3580 }
3581 })?;
3582 let file = Box::new(uv_distribution_types::File {
3583 dist_info_metadata: false,
3584 filename: SmallString::from(filename),
3585 hashes: sdist.hash().map_or(HashDigests::empty(), |hash| {
3586 HashDigests::from(hash.0.clone())
3587 }),
3588 requires_python: None,
3589 size: sdist.size(),
3590 upload_time_utc_ms: sdist.upload_time().map(Timestamp::as_millisecond),
3591 url: FileLocation::AbsoluteUrl(file_url.clone()),
3592 yanked: None,
3593 zstd: None,
3594 });
3595
3596 let index = IndexUrl::from(VerbatimUrl::from_url(
3597 url.to_url().map_err(LockErrorKind::InvalidUrl)?,
3598 ));
3599
3600 let reg_dist = RegistrySourceDist {
3601 name: name.clone(),
3602 version: version.clone(),
3603 file,
3604 ext,
3605 index,
3606 wheels: vec![],
3607 };
3608 uv_distribution_types::SourceDist::Registry(reg_dist)
3609 }
3610 Source::Registry(RegistrySource::Path(path)) => {
3611 let Some(ref sdist) = self.sdist else {
3612 return Ok(None);
3613 };
3614
3615 let name = &self.id.name;
3616 let version = self
3617 .id
3618 .version
3619 .as_ref()
3620 .expect("version for registry source");
3621
3622 let file_url = match sdist {
3623 SourceDist::Url { url: file_url, .. } => {
3624 FileLocation::AbsoluteUrl(file_url.clone())
3625 }
3626 SourceDist::Path {
3627 path: file_path, ..
3628 } => {
3629 let file_path = workspace_root.join(path).join(file_path);
3630 let file_url =
3631 DisplaySafeUrl::from_file_path(&file_path).map_err(|()| {
3632 LockErrorKind::PathToUrl {
3633 path: file_path.into_boxed_path(),
3634 }
3635 })?;
3636 FileLocation::AbsoluteUrl(UrlString::from(file_url))
3637 }
3638 SourceDist::Metadata { .. } => {
3639 return Err(LockErrorKind::MissingPath {
3640 name: name.clone(),
3641 version: version.clone(),
3642 }
3643 .into());
3644 }
3645 };
3646 let filename = sdist
3647 .filename()
3648 .ok_or_else(|| LockErrorKind::MissingFilename {
3649 id: self.id.clone(),
3650 })?;
3651 let ext = SourceDistExtension::from_path(filename.as_ref()).map_err(|err| {
3652 LockErrorKind::MissingExtension {
3653 id: self.id.clone(),
3654 err,
3655 }
3656 })?;
3657 let file = Box::new(uv_distribution_types::File {
3658 dist_info_metadata: false,
3659 filename: SmallString::from(filename),
3660 hashes: sdist.hash().map_or(HashDigests::empty(), |hash| {
3661 HashDigests::from(hash.0.clone())
3662 }),
3663 requires_python: None,
3664 size: sdist.size(),
3665 upload_time_utc_ms: sdist.upload_time().map(Timestamp::as_millisecond),
3666 url: file_url,
3667 yanked: None,
3668 zstd: None,
3669 });
3670
3671 let index = IndexUrl::from(
3672 VerbatimUrl::from_absolute_path(workspace_root.join(path))
3673 .map_err(LockErrorKind::RegistryVerbatimUrl)?,
3674 );
3675
3676 let reg_dist = RegistrySourceDist {
3677 name: name.clone(),
3678 version: version.clone(),
3679 file,
3680 ext,
3681 index,
3682 wheels: vec![],
3683 };
3684 uv_distribution_types::SourceDist::Registry(reg_dist)
3685 }
3686 };
3687
3688 Ok(Some(sdist))
3689 }
3690
3691 fn to_toml(
3692 &self,
3693 requires_python: &RequiresPython,
3694 simplified_environment: MarkerTree,
3695 dist_count_by_name: &FxHashMap<PackageName, u64>,
3696 ) -> Result<Table, toml_edit::ser::Error> {
3697 let mut table = Table::new();
3698
3699 self.id.to_toml(None, &mut table);
3700
3701 if !self.fork_markers.is_empty() {
3702 let fork_markers = each_element_on_its_line_array(
3703 simplified_universal_markers(&self.fork_markers, requires_python).into_iter(),
3704 );
3705 if !fork_markers.is_empty() {
3706 table.insert("resolution-markers", value(fork_markers));
3707 }
3708 }
3709
3710 if !self.dependencies.is_empty() {
3711 let deps = each_element_on_its_line_array(self.dependencies.iter().map(|dep| {
3712 dep.to_toml(simplified_environment, dist_count_by_name)
3713 .into_inline_table()
3714 }));
3715 table.insert("dependencies", value(deps));
3716 }
3717
3718 if !self.optional_dependencies.is_empty() {
3719 let mut optional_deps = Table::new();
3720 for (extra, deps) in &self.optional_dependencies {
3721 let deps = each_element_on_its_line_array(deps.iter().map(|dep| {
3722 dep.to_toml(simplified_environment, dist_count_by_name)
3723 .into_inline_table()
3724 }));
3725 if !deps.is_empty() {
3726 optional_deps.insert(extra.as_ref(), value(deps));
3727 }
3728 }
3729 if !optional_deps.is_empty() {
3730 table.insert("optional-dependencies", Item::Table(optional_deps));
3731 }
3732 }
3733
3734 if !self.dependency_groups.is_empty() {
3735 let mut dependency_groups = Table::new();
3736 for (extra, deps) in &self.dependency_groups {
3737 let deps = each_element_on_its_line_array(deps.iter().map(|dep| {
3738 dep.to_toml(simplified_environment, dist_count_by_name)
3739 .into_inline_table()
3740 }));
3741 if !deps.is_empty() {
3742 dependency_groups.insert(extra.as_ref(), value(deps));
3743 }
3744 }
3745 if !dependency_groups.is_empty() {
3746 table.insert("dev-dependencies", Item::Table(dependency_groups));
3747 }
3748 }
3749
3750 if let Some(ref sdist) = self.sdist {
3751 table.insert("sdist", value(sdist.to_toml()?));
3752 }
3753
3754 if !self.wheels.is_empty() {
3755 let wheels = each_element_on_its_line_array(
3756 self.wheels
3757 .iter()
3758 .map(Wheel::to_toml)
3759 .collect::<Result<Vec<_>, _>>()?
3760 .into_iter(),
3761 );
3762 table.insert("wheels", value(wheels));
3763 }
3764
3765 {
3767 let mut metadata_table = Table::new();
3768
3769 if !self.metadata.requires_dist.is_empty() {
3770 let requires_dist = self
3771 .metadata
3772 .requires_dist
3773 .iter()
3774 .map(|requirement| {
3775 serde::Serialize::serialize(
3776 &requirement,
3777 toml_edit::ser::ValueSerializer::new(),
3778 )
3779 })
3780 .collect::<Result<Vec<_>, _>>()?;
3781 let requires_dist = match requires_dist.as_slice() {
3782 [] => Array::new(),
3783 [requirement] => Array::from_iter([requirement]),
3784 requires_dist => each_element_on_its_line_array(requires_dist.iter()),
3785 };
3786 metadata_table.insert("requires-dist", value(requires_dist));
3787 }
3788
3789 if !self.metadata.dependency_groups.is_empty() {
3790 let mut dependency_groups = Table::new();
3791 for (extra, deps) in &self.metadata.dependency_groups {
3792 let deps = deps
3793 .iter()
3794 .map(|requirement| {
3795 serde::Serialize::serialize(
3796 &requirement,
3797 toml_edit::ser::ValueSerializer::new(),
3798 )
3799 })
3800 .collect::<Result<Vec<_>, _>>()?;
3801 let deps = match deps.as_slice() {
3802 [] => Array::new(),
3803 [requirement] => Array::from_iter([requirement]),
3804 deps => each_element_on_its_line_array(deps.iter()),
3805 };
3806 dependency_groups.insert(extra.as_ref(), value(deps));
3807 }
3808 if !dependency_groups.is_empty() {
3809 metadata_table.insert("requires-dev", Item::Table(dependency_groups));
3810 }
3811 }
3812
3813 if !self.metadata.provides_extra.is_empty() {
3814 let provides_extras = self
3815 .metadata
3816 .provides_extra
3817 .iter()
3818 .map(|extra| {
3819 serde::Serialize::serialize(&extra, toml_edit::ser::ValueSerializer::new())
3820 })
3821 .collect::<Result<Vec<_>, _>>()?;
3822 let provides_extras = Array::from_iter(provides_extras);
3824 metadata_table.insert("provides-extras", value(provides_extras));
3825 }
3826
3827 if !metadata_table.is_empty() {
3828 table.insert("metadata", Item::Table(metadata_table));
3829 }
3830 }
3831
3832 Ok(table)
3833 }
3834
3835 fn find_best_wheel(&self, tag_policy: TagPolicy<'_>) -> Option<usize> {
3836 type WheelPriority<'lock> = (TagPriority, Option<&'lock BuildTag>);
3837
3838 let mut best: Option<(WheelPriority, usize)> = None;
3839 for (i, wheel) in self.wheels.iter().enumerate() {
3840 let TagCompatibility::Compatible(tag_priority) =
3841 wheel.filename.compatibility(tag_policy.tags())
3842 else {
3843 continue;
3844 };
3845 let build_tag = wheel.filename.build_tag();
3846 let wheel_priority = (tag_priority, build_tag);
3847 match best {
3848 None => {
3849 best = Some((wheel_priority, i));
3850 }
3851 Some((best_priority, _)) => {
3852 if wheel_priority > best_priority {
3853 best = Some((wheel_priority, i));
3854 }
3855 }
3856 }
3857 }
3858
3859 let best = best.map(|(_, i)| i);
3860 match tag_policy {
3861 TagPolicy::Required(_) => best,
3862 TagPolicy::Preferred(_) => best.or_else(|| self.wheels.first().map(|_| 0)),
3863 }
3864 }
3865
3866 pub fn name(&self) -> &PackageName {
3868 &self.id.name
3869 }
3870
3871 pub fn version(&self) -> Option<&Version> {
3873 self.id.version.as_ref()
3874 }
3875
3876 pub fn git_sha(&self) -> Option<&GitOid> {
3878 match &self.id.source {
3879 Source::Git(_, git) => Some(&git.precise),
3880 _ => None,
3881 }
3882 }
3883
3884 pub(crate) fn fork_markers(&self) -> &[UniversalMarker] {
3886 self.fork_markers.as_slice()
3887 }
3888
3889 pub fn is_included_by_marker(&self, marker: MarkerTree) -> bool {
3891 self.fork_markers.is_empty()
3892 || self
3893 .fork_markers
3894 .iter()
3895 .any(|fork_marker| !fork_marker.pep508().is_disjoint(marker))
3896 }
3897
3898 pub fn index(&self, root: &Path) -> Result<Option<IndexUrl>, LockError> {
3900 match &self.id.source {
3901 Source::Registry(RegistrySource::Url(url)) => {
3902 let index = IndexUrl::from(VerbatimUrl::from_url(
3903 url.to_url().map_err(LockErrorKind::InvalidUrl)?,
3904 ));
3905 Ok(Some(index))
3906 }
3907 Source::Registry(RegistrySource::Path(path)) => {
3908 let index = IndexUrl::from(
3909 VerbatimUrl::from_absolute_path(root.join(path))
3910 .map_err(LockErrorKind::RegistryVerbatimUrl)?,
3911 );
3912 Ok(Some(index))
3913 }
3914 _ => Ok(None),
3915 }
3916 }
3917
3918 fn hashes(&self) -> HashDigests {
3920 let mut hashes = Vec::with_capacity(
3921 usize::from(self.sdist.as_ref().and_then(|sdist| sdist.hash()).is_some())
3922 + self
3923 .wheels
3924 .iter()
3925 .map(|wheel| usize::from(wheel.hash.is_some()))
3926 .sum::<usize>(),
3927 );
3928 if let Some(ref sdist) = self.sdist {
3929 if let Some(hash) = sdist.hash() {
3930 hashes.push(hash.0.clone());
3931 }
3932 }
3933 for wheel in &self.wheels {
3934 hashes.extend(wheel.hash.as_ref().map(|h| h.0.clone()));
3935 if let Some(zstd) = wheel.zstd.as_ref() {
3936 hashes.extend(zstd.hash.as_ref().map(|h| h.0.clone()));
3937 }
3938 }
3939 HashDigests::from(hashes)
3940 }
3941
3942 pub fn as_git_ref(&self) -> Result<Option<ResolvedRepositoryReference>, LockError> {
3944 match &self.id.source {
3945 Source::Git(url, git) => Ok(Some(ResolvedRepositoryReference {
3946 reference: RepositoryReference {
3947 url: RepositoryUrl::new(url.to_url().map_err(LockErrorKind::InvalidUrl)?),
3948 reference: GitReference::from(git.kind.clone()),
3949 },
3950 sha: git.precise,
3951 })),
3952 _ => Ok(None),
3953 }
3954 }
3955
3956 fn is_dynamic(&self) -> bool {
3958 self.id.version.is_none()
3959 }
3960
3961 pub fn provides_extras(&self) -> &[ExtraName] {
3963 &self.metadata.provides_extra
3964 }
3965
3966 pub fn dependency_groups(&self) -> &BTreeMap<GroupName, BTreeSet<Requirement>> {
3968 &self.metadata.dependency_groups
3969 }
3970
3971 pub fn dependencies(&self) -> &[Dependency] {
3973 &self.dependencies
3974 }
3975
3976 pub fn optional_dependencies(&self) -> &BTreeMap<ExtraName, Vec<Dependency>> {
3978 &self.optional_dependencies
3979 }
3980
3981 pub fn resolved_dependency_groups(&self) -> &BTreeMap<GroupName, Vec<Dependency>> {
3983 &self.dependency_groups
3984 }
3985
3986 fn as_install_target(&self) -> InstallTarget<'_> {
3988 InstallTarget {
3989 name: self.name(),
3990 is_local: self.id.source.is_local(),
3991 }
3992 }
3993}
3994
3995fn verbatim_url(path: &Path, id: &PackageId) -> Result<VerbatimUrl, LockError> {
3997 let url =
3998 VerbatimUrl::from_normalized_path(path).map_err(|err| LockErrorKind::VerbatimUrl {
3999 id: id.clone(),
4000 err,
4001 })?;
4002 Ok(url)
4003}
4004
4005fn absolute_path(workspace_root: &Path, path: &Path) -> Result<PathBuf, LockError> {
4007 let path = uv_fs::normalize_absolute_path(&workspace_root.join(path))
4008 .map_err(LockErrorKind::AbsolutePath)?;
4009 Ok(path)
4010}
4011
4012#[derive(Clone, Debug, serde::Deserialize)]
4013#[serde(rename_all = "kebab-case")]
4014struct PackageWire {
4015 #[serde(flatten)]
4016 id: PackageId,
4017 #[serde(default)]
4018 metadata: PackageMetadata,
4019 #[serde(default)]
4020 sdist: Option<SourceDist>,
4021 #[serde(default)]
4022 wheels: Vec<Wheel>,
4023 #[serde(default, rename = "resolution-markers")]
4024 fork_markers: Vec<SimplifiedMarkerTree>,
4025 #[serde(default)]
4026 dependencies: Vec<DependencyWire>,
4027 #[serde(default)]
4028 optional_dependencies: BTreeMap<ExtraName, Vec<DependencyWire>>,
4029 #[serde(default, rename = "dev-dependencies", alias = "dependency-groups")]
4030 dependency_groups: BTreeMap<GroupName, Vec<DependencyWire>>,
4031}
4032
4033#[derive(Clone, Default, Debug, Eq, PartialEq, serde::Deserialize)]
4034#[serde(rename_all = "kebab-case")]
4035struct PackageMetadata {
4036 #[serde(default)]
4037 requires_dist: BTreeSet<Requirement>,
4038 #[serde(default, rename = "provides-extras")]
4039 provides_extra: Box<[ExtraName]>,
4040 #[serde(default, rename = "requires-dev", alias = "dependency-groups")]
4041 dependency_groups: BTreeMap<GroupName, BTreeSet<Requirement>>,
4042}
4043
4044impl PackageWire {
4045 fn unwire(
4046 self,
4047 requires_python: &RequiresPython,
4048 environment: SimplifiedMarkerTree,
4049 default: UniversalMarker,
4050 unambiguous_package_ids: &FxHashMap<PackageName, PackageId>,
4051 ) -> Result<Package, LockError> {
4052 if !uv_flags::contains(uv_flags::EnvironmentFlags::SKIP_WHEEL_FILENAME_CHECK) {
4054 if let Some(version) = &self.id.version {
4055 for wheel in &self.wheels {
4056 if *version != wheel.filename.version
4057 && *version != wheel.filename.version.clone().without_local()
4058 {
4059 return Err(LockError::from(LockErrorKind::InconsistentVersions {
4060 name: self.id.name,
4061 version: version.clone(),
4062 wheel: wheel.clone(),
4063 }));
4064 }
4065 }
4066 }
4069 }
4070
4071 if matches!(self.id.source, Source::Registry(_)) && self.id.version.is_none() {
4074 return Err(LockErrorKind::MissingPackageVersion {
4075 name: self.id.name.clone(),
4076 }
4077 .into());
4078 }
4079
4080 let unwire_deps = |deps: Vec<DependencyWire>| -> Result<Vec<Dependency>, LockError> {
4081 deps.into_iter()
4082 .map(|dep| {
4083 dep.unwire(
4084 requires_python,
4085 environment,
4086 default,
4087 unambiguous_package_ids,
4088 )
4089 })
4090 .collect()
4091 };
4092
4093 Ok(Package {
4094 id: self.id,
4095 metadata: self.metadata,
4096 sdist: self.sdist,
4097 wheels: self.wheels,
4098 fork_markers: self
4099 .fork_markers
4100 .into_iter()
4101 .map(|simplified_marker| simplified_marker.into_marker(requires_python))
4102 .map(UniversalMarker::from_combined)
4103 .collect(),
4104 dependencies: unwire_deps(self.dependencies)?,
4105 optional_dependencies: self
4106 .optional_dependencies
4107 .into_iter()
4108 .map(|(extra, deps)| Ok((extra, unwire_deps(deps)?)))
4109 .collect::<Result<_, LockError>>()?,
4110 dependency_groups: self
4111 .dependency_groups
4112 .into_iter()
4113 .map(|(group, deps)| Ok((group, unwire_deps(deps)?)))
4114 .collect::<Result<_, LockError>>()?,
4115 })
4116 }
4117}
4118
4119#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord, serde::Deserialize)]
4122#[serde(rename_all = "kebab-case")]
4123pub(crate) struct PackageId {
4124 pub(crate) name: PackageName,
4125 version: Option<Version>,
4126 source: Source,
4127}
4128
4129impl PackageId {
4130 fn from_annotated_dist(annotated_dist: &AnnotatedDist, root: &Path) -> Result<Self, LockError> {
4131 let source = Source::from_resolved_dist(&annotated_dist.dist, root)?;
4133 let version = if source.is_source_tree()
4135 && annotated_dist
4136 .metadata
4137 .as_ref()
4138 .is_some_and(|metadata| metadata.dynamic)
4139 {
4140 None
4141 } else {
4142 Some(annotated_dist.version.clone())
4143 };
4144 let name = annotated_dist.name.clone();
4145 Ok(Self {
4146 name,
4147 version,
4148 source,
4149 })
4150 }
4151
4152 fn to_toml(&self, dist_count_by_name: Option<&FxHashMap<PackageName, u64>>, table: &mut Table) {
4159 let count = dist_count_by_name.and_then(|map| map.get(&self.name).copied());
4160 table.insert("name", value(self.name.to_string()));
4161 if count.is_none_or(|count| count > 1) {
4162 if let Some(version) = &self.version {
4163 table.insert("version", value(version.to_string()));
4164 }
4165 self.source.to_toml(table);
4166 }
4167 }
4168}
4169
4170impl Display for PackageId {
4171 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
4172 if let Some(version) = &self.version {
4173 write!(f, "{}=={} @ {}", self.name, version, self.source)
4174 } else {
4175 write!(f, "{} @ {}", self.name, self.source)
4176 }
4177 }
4178}
4179
4180#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord, serde::Deserialize)]
4181#[serde(rename_all = "kebab-case")]
4182struct PackageIdForDependency {
4183 name: PackageName,
4184 version: Option<Version>,
4185 source: Option<Source>,
4186}
4187
4188impl PackageIdForDependency {
4189 fn unwire(
4190 self,
4191 unambiguous_package_ids: &FxHashMap<PackageName, PackageId>,
4192 ) -> Result<PackageId, LockError> {
4193 let unambiguous_package_id = unambiguous_package_ids.get(&self.name);
4194 let source = self.source.map(Ok::<_, LockError>).unwrap_or_else(|| {
4195 let Some(package_id) = unambiguous_package_id else {
4196 return Err(LockErrorKind::MissingDependencySource {
4197 name: self.name.clone(),
4198 }
4199 .into());
4200 };
4201 Ok(package_id.source.clone())
4202 })?;
4203 let version = if let Some(version) = self.version {
4204 Some(version)
4205 } else {
4206 if let Some(package_id) = unambiguous_package_id {
4207 package_id.version.clone()
4208 } else {
4209 if source.is_source_tree() {
4212 None
4213 } else {
4214 return Err(LockErrorKind::MissingDependencyVersion {
4215 name: self.name.clone(),
4216 }
4217 .into());
4218 }
4219 }
4220 };
4221 Ok(PackageId {
4222 name: self.name,
4223 version,
4224 source,
4225 })
4226 }
4227}
4228
4229impl From<PackageId> for PackageIdForDependency {
4230 fn from(id: PackageId) -> Self {
4231 Self {
4232 name: id.name,
4233 version: id.version,
4234 source: Some(id.source),
4235 }
4236 }
4237}
4238
4239#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord, serde::Deserialize)]
4247#[serde(try_from = "SourceWire")]
4248enum Source {
4249 Registry(RegistrySource),
4251 Git(UrlString, GitSource),
4253 Direct(UrlString, DirectSource),
4255 Path(Box<Path>),
4257 Directory(Box<Path>),
4259 Editable(Box<Path>),
4261 Virtual(Box<Path>),
4263}
4264
4265impl Source {
4266 fn from_resolved_dist(resolved_dist: &ResolvedDist, root: &Path) -> Result<Self, LockError> {
4267 match *resolved_dist {
4268 ResolvedDist::Installed { .. } => unreachable!(),
4270 ResolvedDist::Installable { ref dist, .. } => Self::from_dist(dist, root),
4271 }
4272 }
4273
4274 fn from_dist(dist: &Dist, root: &Path) -> Result<Self, LockError> {
4275 match *dist {
4276 Dist::Built(ref built_dist) => Self::from_built_dist(built_dist, root),
4277 Dist::Source(ref source_dist) => Self::from_source_dist(source_dist, root),
4278 }
4279 }
4280
4281 fn from_built_dist(built_dist: &BuiltDist, root: &Path) -> Result<Self, LockError> {
4282 match *built_dist {
4283 BuiltDist::Registry(ref reg_dist) => Self::from_registry_built_dist(reg_dist, root),
4284 BuiltDist::DirectUrl(ref direct_dist) => Ok(Self::from_direct_built_dist(direct_dist)),
4285 BuiltDist::Path(ref path_dist) => Self::from_path_built_dist(path_dist, root),
4286 BuiltDist::GitPath(ref git_dist) => Self::from_git_path_built_dist(git_dist, root),
4287 }
4288 }
4289
4290 fn from_source_dist(
4291 source_dist: &uv_distribution_types::SourceDist,
4292 root: &Path,
4293 ) -> Result<Self, LockError> {
4294 match *source_dist {
4295 uv_distribution_types::SourceDist::Registry(ref reg_dist) => {
4296 Self::from_registry_source_dist(reg_dist, root)
4297 }
4298 uv_distribution_types::SourceDist::DirectUrl(ref direct_dist) => {
4299 Ok(Self::from_direct_source_dist(direct_dist))
4300 }
4301 uv_distribution_types::SourceDist::GitDirectory(ref git_dist) => {
4302 Ok(Self::from_git_directory_source_dist(git_dist))
4303 }
4304 uv_distribution_types::SourceDist::GitPath(ref git_dist) => {
4305 Self::from_git_path_source_dist(git_dist, root)
4306 }
4307 uv_distribution_types::SourceDist::Path(ref path_dist) => {
4308 Self::from_path_source_dist(path_dist, root)
4309 }
4310 uv_distribution_types::SourceDist::Directory(ref directory) => {
4311 Self::from_directory_source_dist(directory, root)
4312 }
4313 }
4314 }
4315
4316 fn from_registry_built_dist(
4317 reg_dist: &RegistryBuiltDist,
4318 root: &Path,
4319 ) -> Result<Self, LockError> {
4320 Self::from_index_url(®_dist.best_wheel().index, root)
4321 }
4322
4323 fn from_registry_source_dist(
4324 reg_dist: &RegistrySourceDist,
4325 root: &Path,
4326 ) -> Result<Self, LockError> {
4327 Self::from_index_url(®_dist.index, root)
4328 }
4329
4330 fn from_direct_built_dist(direct_dist: &DirectUrlBuiltDist) -> Self {
4331 Self::Direct(
4332 normalize_url(direct_dist.url.to_url()),
4333 DirectSource { subdirectory: None },
4334 )
4335 }
4336
4337 fn from_direct_source_dist(direct_dist: &DirectUrlSourceDist) -> Self {
4338 Self::Direct(
4339 normalize_url(direct_dist.url.to_url()),
4340 DirectSource {
4341 subdirectory: direct_dist.subdirectory.clone(),
4342 },
4343 )
4344 }
4345
4346 fn from_path_built_dist(path_dist: &PathBuiltDist, root: &Path) -> Result<Self, LockError> {
4347 let path = try_relative_to_if(
4348 &path_dist.install_path,
4349 root,
4350 !path_dist.url.was_given_absolute(),
4351 )
4352 .map_err(LockErrorKind::DistributionRelativePath)?;
4353 Ok(Self::Path(path.into_boxed_path()))
4354 }
4355
4356 fn from_path_source_dist(path_dist: &PathSourceDist, root: &Path) -> Result<Self, LockError> {
4357 let path = try_relative_to_if(
4358 &path_dist.install_path,
4359 root,
4360 !path_dist.url.was_given_absolute(),
4361 )
4362 .map_err(LockErrorKind::DistributionRelativePath)?;
4363 Ok(Self::Path(path.into_boxed_path()))
4364 }
4365
4366 fn from_directory_source_dist(
4367 directory_dist: &DirectorySourceDist,
4368 root: &Path,
4369 ) -> Result<Self, LockError> {
4370 let path = try_relative_to_if(
4371 &directory_dist.install_path,
4372 root,
4373 !directory_dist.url.was_given_absolute(),
4374 )
4375 .map_err(LockErrorKind::DistributionRelativePath)?;
4376 if directory_dist.editable.unwrap_or(false) {
4377 Ok(Self::Editable(path.into_boxed_path()))
4378 } else if directory_dist.r#virtual.unwrap_or(false) {
4379 Ok(Self::Virtual(path.into_boxed_path()))
4380 } else {
4381 Ok(Self::Directory(path.into_boxed_path()))
4382 }
4383 }
4384
4385 fn from_index_url(index_url: &IndexUrl, root: &Path) -> Result<Self, LockError> {
4386 match index_url {
4387 IndexUrl::Pypi(_) | IndexUrl::Url(_) => {
4388 let redacted = index_url.without_credentials();
4390 let source = RegistrySource::Url(UrlString::from(redacted.as_ref()));
4391 Ok(Self::Registry(source))
4392 }
4393 IndexUrl::Path(url) => {
4394 let path = url
4395 .to_file_path()
4396 .map_err(|()| LockErrorKind::UrlToPath { url: url.to_url() })?;
4397 let path = try_relative_to_if(&path, root, !url.was_given_absolute())
4398 .map_err(LockErrorKind::IndexRelativePath)?;
4399 let source = RegistrySource::Path(path.into_boxed_path());
4400 Ok(Self::Registry(source))
4401 }
4402 }
4403 }
4404
4405 fn from_git_path_built_dist(
4406 git_dist: &GitPathBuiltDist,
4407 root: &Path,
4408 ) -> Result<Self, LockError> {
4409 let path = relative_to(&git_dist.install_path, root)
4410 .or_else(|_| std::path::absolute(&git_dist.install_path))
4411 .map_err(LockErrorKind::DistributionRelativePath)?;
4412 Ok(Self::Git(
4413 UrlString::from(locked_git_url(
4414 &git_dist.git,
4415 None,
4416 Some(git_dist.install_path.as_path()),
4417 )),
4418 GitSource {
4419 kind: GitSourceKind::from(git_dist.git.reference().clone()),
4420 precise: git_dist.git.precise().unwrap_or_else(|| {
4421 panic!("Git distribution is missing a precise hash: {git_dist}")
4422 }),
4423 subdirectory: None,
4424 path: Some(path),
4425 lfs: git_dist.git.lfs(),
4426 },
4427 ))
4428 }
4429
4430 fn from_git_path_source_dist(
4431 git_dist: &GitPathSourceDist,
4432 root: &Path,
4433 ) -> Result<Self, LockError> {
4434 let path = relative_to(&git_dist.install_path, root)
4435 .or_else(|_| std::path::absolute(&git_dist.install_path))
4436 .map_err(LockErrorKind::DistributionRelativePath)?;
4437 Ok(Self::Git(
4438 UrlString::from(locked_git_url(
4439 &git_dist.git,
4440 None,
4441 Some(git_dist.install_path.as_path()),
4442 )),
4443 GitSource {
4444 kind: GitSourceKind::from(git_dist.git.reference().clone()),
4445 precise: git_dist.git.precise().unwrap_or_else(|| {
4446 panic!("Git distribution is missing a precise hash: {git_dist}")
4447 }),
4448 subdirectory: None,
4449 path: Some(path),
4450 lfs: git_dist.git.lfs(),
4451 },
4452 ))
4453 }
4454
4455 fn from_git_directory_source_dist(git_dist: &GitDirectorySourceDist) -> Self {
4456 Self::Git(
4457 UrlString::from(locked_git_url(
4458 &git_dist.git,
4459 git_dist.subdirectory.as_deref(),
4460 None,
4461 )),
4462 GitSource {
4463 kind: GitSourceKind::from(git_dist.git.reference().clone()),
4464 precise: git_dist.git.precise().unwrap_or_else(|| {
4465 panic!("Git distribution is missing a precise hash: {git_dist}")
4466 }),
4467 subdirectory: git_dist.subdirectory.clone(),
4468 path: None,
4469 lfs: git_dist.git.lfs(),
4470 },
4471 )
4472 }
4473
4474 fn is_pypi_registry(&self) -> bool {
4476 matches!(
4477 self,
4478 Self::Registry(RegistrySource::Url(url)) if url.as_ref() == PYPI_URL.as_str()
4479 )
4480 }
4481
4482 fn is_immutable(&self) -> bool {
4489 matches!(self, Self::Registry(..) | Self::Git(_, _))
4490 }
4491
4492 fn is_wheel(&self) -> bool {
4494 match self {
4495 Self::Path(path) => {
4496 matches!(
4497 DistExtension::from_path(path).ok(),
4498 Some(DistExtension::Wheel)
4499 )
4500 }
4501 Self::Direct(url, _) => {
4502 matches!(
4503 DistExtension::from_path(url.as_ref()).ok(),
4504 Some(DistExtension::Wheel)
4505 )
4506 }
4507 Self::Directory(..) => false,
4508 Self::Editable(..) => false,
4509 Self::Virtual(..) => false,
4510 Self::Git(..) => false,
4511 Self::Registry(..) => false,
4512 }
4513 }
4514
4515 fn is_source_tree(&self) -> bool {
4517 match self {
4518 Self::Directory(..) | Self::Editable(..) | Self::Virtual(..) => true,
4519 Self::Path(..) | Self::Git(..) | Self::Registry(..) | Self::Direct(..) => false,
4520 }
4521 }
4522
4523 fn as_source_tree(&self) -> Option<&Path> {
4525 match self {
4526 Self::Directory(path) | Self::Editable(path) | Self::Virtual(path) => Some(path),
4527 Self::Path(..) | Self::Git(..) | Self::Registry(..) | Self::Direct(..) => None,
4528 }
4529 }
4530
4531 fn to_toml(&self, table: &mut Table) {
4532 let mut source_table = InlineTable::new();
4533 match self {
4534 Self::Registry(source) => match source {
4535 RegistrySource::Url(url) => {
4536 source_table.insert("registry", Value::from(url.as_ref()));
4537 }
4538 RegistrySource::Path(path) => {
4539 source_table.insert(
4540 "registry",
4541 Value::from(PortablePath::from(path).to_string()),
4542 );
4543 }
4544 },
4545 Self::Git(url, _) => {
4546 source_table.insert("git", Value::from(url.as_ref()));
4547 }
4548 Self::Direct(url, DirectSource { subdirectory }) => {
4549 source_table.insert("url", Value::from(url.as_ref()));
4550 if let Some(ref subdirectory) = *subdirectory {
4551 source_table.insert(
4552 "subdirectory",
4553 Value::from(PortablePath::from(subdirectory).to_string()),
4554 );
4555 }
4556 }
4557 Self::Path(path) => {
4558 source_table.insert("path", Value::from(PortablePath::from(path).to_string()));
4559 }
4560 Self::Directory(path) => {
4561 source_table.insert(
4562 "directory",
4563 Value::from(PortablePath::from(path).to_string()),
4564 );
4565 }
4566 Self::Editable(path) => {
4567 source_table.insert(
4568 "editable",
4569 Value::from(PortablePath::from(path).to_string()),
4570 );
4571 }
4572 Self::Virtual(path) => {
4573 source_table.insert("virtual", Value::from(PortablePath::from(path).to_string()));
4574 }
4575 }
4576 table.insert("source", value(source_table));
4577 }
4578
4579 fn is_local(&self) -> bool {
4581 matches!(
4582 self,
4583 Self::Path(_) | Self::Directory(_) | Self::Editable(_) | Self::Virtual(_)
4584 )
4585 }
4586}
4587
4588impl Display for Source {
4589 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
4590 match self {
4591 Self::Registry(RegistrySource::Url(url)) | Self::Git(url, _) | Self::Direct(url, _) => {
4592 write!(f, "{}+{}", self.name(), url)
4593 }
4594 Self::Registry(RegistrySource::Path(path))
4595 | Self::Path(path)
4596 | Self::Directory(path)
4597 | Self::Editable(path)
4598 | Self::Virtual(path) => {
4599 write!(f, "{}+{}", self.name(), PortablePath::from(path))
4600 }
4601 }
4602 }
4603}
4604
4605impl Source {
4606 fn name(&self) -> &str {
4607 match self {
4608 Self::Registry(..) => "registry",
4609 Self::Git(..) => "git",
4610 Self::Direct(..) => "direct",
4611 Self::Path(..) => "path",
4612 Self::Directory(..) => "directory",
4613 Self::Editable(..) => "editable",
4614 Self::Virtual(..) => "virtual",
4615 }
4616 }
4617
4618 fn requires_hash(&self) -> Option<bool> {
4626 match self {
4627 Self::Registry(..) => None,
4628 Self::Direct(..) | Self::Path(..) => Some(true),
4629 Self::Git(.., GitSource { path, .. }) => Some(path.is_some()),
4630 Self::Directory(..) | Self::Editable(..) | Self::Virtual(..) => Some(false),
4631 }
4632 }
4633}
4634
4635#[derive(Clone, Debug, serde::Deserialize)]
4636#[serde(untagged, rename_all = "kebab-case")]
4637enum SourceWire {
4638 Registry {
4639 registry: RegistrySourceWire,
4640 },
4641 Git {
4642 git: String,
4643 },
4644 Direct {
4645 url: UrlString,
4646 subdirectory: Option<PortablePathBuf>,
4647 },
4648 Path {
4649 path: PortablePathBuf,
4650 },
4651 Directory {
4652 directory: PortablePathBuf,
4653 },
4654 Editable {
4655 editable: PortablePathBuf,
4656 },
4657 Virtual {
4658 r#virtual: PortablePathBuf,
4659 },
4660}
4661
4662impl TryFrom<SourceWire> for Source {
4663 type Error = LockError;
4664
4665 fn try_from(wire: SourceWire) -> Result<Self, LockError> {
4666 use self::SourceWire::{Direct, Directory, Editable, Git, Path, Registry, Virtual};
4667
4668 match wire {
4669 Registry { registry } => Ok(Self::Registry(registry.into())),
4670 Git { git } => {
4671 let url = DisplaySafeUrl::parse(&git)
4672 .map_err(|err| SourceParseError::InvalidUrl {
4673 given: git.clone(),
4674 err,
4675 })
4676 .map_err(LockErrorKind::InvalidGitSourceUrl)?;
4677
4678 let git_source = GitSource::from_url(&url)
4679 .map_err(|err| match err {
4680 GitSourceError::InvalidSha => SourceParseError::InvalidSha { given: git },
4681 GitSourceError::MissingSha => SourceParseError::MissingSha { given: git },
4682 })
4683 .map_err(LockErrorKind::InvalidGitSourceUrl)?;
4684
4685 Ok(Self::Git(UrlString::from(url), git_source))
4686 }
4687 Direct { url, subdirectory } => Ok(Self::Direct(
4688 url,
4689 DirectSource {
4690 subdirectory: subdirectory.map(Box::<std::path::Path>::from),
4691 },
4692 )),
4693 Path { path } => Ok(Self::Path(path.into())),
4694 Directory { directory } => Ok(Self::Directory(directory.into())),
4695 Editable { editable } => Ok(Self::Editable(editable.into())),
4696 Virtual { r#virtual } => Ok(Self::Virtual(r#virtual.into())),
4697 }
4698 }
4699}
4700
4701#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
4703enum RegistrySource {
4704 Url(UrlString),
4706 Path(Box<Path>),
4708}
4709
4710impl Display for RegistrySource {
4711 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
4712 match self {
4713 Self::Url(url) => write!(f, "{url}"),
4714 Self::Path(path) => write!(f, "{}", path.display()),
4715 }
4716 }
4717}
4718
4719#[derive(Clone, Debug)]
4720enum RegistrySourceWire {
4721 Url(UrlString),
4723 Path(PortablePathBuf),
4725}
4726
4727impl<'de> serde::de::Deserialize<'de> for RegistrySourceWire {
4728 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
4729 where
4730 D: serde::de::Deserializer<'de>,
4731 {
4732 struct Visitor;
4733
4734 impl serde::de::Visitor<'_> for Visitor {
4735 type Value = RegistrySourceWire;
4736
4737 fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
4738 formatter.write_str("a valid URL or a file path")
4739 }
4740
4741 fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
4742 where
4743 E: serde::de::Error,
4744 {
4745 if split_scheme(value).is_some_and(|(scheme, _)| Scheme::parse(scheme).is_some()) {
4746 Ok(
4747 serde::Deserialize::deserialize(serde::de::value::StrDeserializer::new(
4748 value,
4749 ))
4750 .map(RegistrySourceWire::Url)?,
4751 )
4752 } else {
4753 Ok(
4754 serde::Deserialize::deserialize(serde::de::value::StrDeserializer::new(
4755 value,
4756 ))
4757 .map(RegistrySourceWire::Path)?,
4758 )
4759 }
4760 }
4761 }
4762
4763 deserializer.deserialize_str(Visitor)
4764 }
4765}
4766
4767impl From<RegistrySourceWire> for RegistrySource {
4768 fn from(wire: RegistrySourceWire) -> Self {
4769 match wire {
4770 RegistrySourceWire::Url(url) => Self::Url(url),
4771 RegistrySourceWire::Path(path) => Self::Path(path.into()),
4772 }
4773 }
4774}
4775
4776#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord, serde::Deserialize)]
4777#[serde(rename_all = "kebab-case")]
4778struct DirectSource {
4779 subdirectory: Option<Box<Path>>,
4780}
4781
4782#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
4787struct GitSource {
4788 precise: GitOid,
4789 subdirectory: Option<Box<Path>>,
4790 path: Option<PathBuf>,
4791 kind: GitSourceKind,
4792 lfs: GitLfs,
4793}
4794
4795#[derive(Clone, Debug, Eq, PartialEq)]
4797enum GitSourceError {
4798 InvalidSha,
4799 MissingSha,
4800}
4801
4802impl GitSource {
4803 fn from_url(url: &Url) -> Result<Self, GitSourceError> {
4806 let mut kind = GitSourceKind::DefaultBranch;
4807 let mut subdirectory = None;
4808 let mut lfs = GitLfs::Disabled;
4809 let mut path = None;
4810 for (key, val) in url.query_pairs() {
4811 match &*key {
4812 "tag" => kind = GitSourceKind::Tag(val.into_owned()),
4813 "branch" => kind = GitSourceKind::Branch(val.into_owned()),
4814 "rev" => kind = GitSourceKind::Rev(val.into_owned()),
4815 "subdirectory" => subdirectory = Some(PortablePathBuf::from(val.as_ref()).into()),
4816 "lfs" => lfs = GitLfs::from(val.eq_ignore_ascii_case("true")),
4817 "path" => {
4818 path = Some(PathBuf::from(Box::<Path>::from(PortablePathBuf::from(
4819 val.as_ref(),
4820 ))));
4821 }
4822 _ => {}
4823 }
4824 }
4825
4826 let precise = GitOid::from_str(url.fragment().ok_or(GitSourceError::MissingSha)?)
4827 .map_err(|_| GitSourceError::InvalidSha)?;
4828
4829 Ok(Self {
4830 precise,
4831 subdirectory,
4832 path,
4833 kind,
4834 lfs,
4835 })
4836 }
4837}
4838
4839#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord, serde::Deserialize)]
4840#[serde(rename_all = "kebab-case")]
4841enum GitSourceKind {
4842 Tag(String),
4843 Branch(String),
4844 Rev(String),
4845 DefaultBranch,
4846}
4847
4848#[derive(Clone, Debug, serde::Deserialize, PartialEq, Eq)]
4850#[serde(rename_all = "kebab-case")]
4851struct SourceDistMetadata {
4852 hash: Option<Hash>,
4854 size: Option<u64>,
4858 #[serde(alias = "upload_time")]
4860 upload_time: Option<Timestamp>,
4861}
4862
4863#[derive(Clone, Debug, serde::Deserialize, PartialEq, Eq)]
4868#[serde(from = "SourceDistWire")]
4869enum SourceDist {
4870 Url {
4871 url: UrlString,
4872 #[serde(flatten)]
4873 metadata: SourceDistMetadata,
4874 },
4875 Path {
4876 path: Box<Path>,
4877 #[serde(flatten)]
4878 metadata: SourceDistMetadata,
4879 },
4880 Metadata {
4881 #[serde(flatten)]
4882 metadata: SourceDistMetadata,
4883 },
4884}
4885
4886impl SourceDist {
4887 fn filename(&self) -> Option<Cow<'_, str>> {
4888 match self {
4889 Self::Metadata { .. } => None,
4890 Self::Url { url, .. } => url.filename().ok(),
4891 Self::Path { path, .. } => path.file_name().map(|filename| filename.to_string_lossy()),
4892 }
4893 }
4894
4895 fn url(&self) -> Option<&UrlString> {
4896 match self {
4897 Self::Metadata { .. } => None,
4898 Self::Url { url, .. } => Some(url),
4899 Self::Path { .. } => None,
4900 }
4901 }
4902
4903 fn hash(&self) -> Option<&Hash> {
4904 match self {
4905 Self::Metadata { metadata } => metadata.hash.as_ref(),
4906 Self::Url { metadata, .. } => metadata.hash.as_ref(),
4907 Self::Path { metadata, .. } => metadata.hash.as_ref(),
4908 }
4909 }
4910
4911 fn size(&self) -> Option<u64> {
4912 match self {
4913 Self::Metadata { metadata } => metadata.size,
4914 Self::Url { metadata, .. } => metadata.size,
4915 Self::Path { metadata, .. } => metadata.size,
4916 }
4917 }
4918
4919 fn upload_time(&self) -> Option<Timestamp> {
4920 match self {
4921 Self::Metadata { metadata } => metadata.upload_time,
4922 Self::Url { metadata, .. } => metadata.upload_time,
4923 Self::Path { metadata, .. } => metadata.upload_time,
4924 }
4925 }
4926}
4927
4928impl SourceDist {
4929 fn from_annotated_dist(
4930 id: &PackageId,
4931 annotated_dist: &AnnotatedDist,
4932 ) -> Result<Option<Self>, LockError> {
4933 match annotated_dist.dist {
4934 ResolvedDist::Installed { .. } => unreachable!(),
4936 ResolvedDist::Installable { ref dist, .. } => Self::from_dist(
4937 id,
4938 dist,
4939 annotated_dist.hashes.as_slice(),
4940 annotated_dist.index(),
4941 ),
4942 }
4943 }
4944
4945 fn from_dist(
4946 id: &PackageId,
4947 dist: &Dist,
4948 hashes: &[HashDigest],
4949 index: Option<&IndexUrl>,
4950 ) -> Result<Option<Self>, LockError> {
4951 match *dist {
4952 Dist::Built(BuiltDist::Registry(ref built_dist)) => {
4953 let Some(sdist) = built_dist.sdist.as_ref() else {
4954 return Ok(None);
4955 };
4956 Self::from_registry_dist(sdist, index)
4957 }
4958 Dist::Built(_) => Ok(None),
4959 Dist::Source(ref source_dist) => Self::from_source_dist(id, source_dist, hashes, index),
4960 }
4961 }
4962
4963 fn from_source_dist(
4964 id: &PackageId,
4965 source_dist: &uv_distribution_types::SourceDist,
4966 hashes: &[HashDigest],
4967 index: Option<&IndexUrl>,
4968 ) -> Result<Option<Self>, LockError> {
4969 match *source_dist {
4970 uv_distribution_types::SourceDist::Registry(ref reg_dist) => {
4971 Self::from_registry_dist(reg_dist, index)
4972 }
4973 uv_distribution_types::SourceDist::DirectUrl(_) => {
4974 Self::from_direct_dist(id, hashes).map(Some)
4975 }
4976 uv_distribution_types::SourceDist::Path(_) => {
4977 Self::from_path_dist(id, hashes).map(Some)
4978 }
4979 uv_distribution_types::SourceDist::GitPath(_) => {
4980 Self::from_git_path_dist(id, hashes).map(Some)
4981 }
4982 uv_distribution_types::SourceDist::GitDirectory(_)
4983 | uv_distribution_types::SourceDist::Directory(_) => Ok(None),
4984 }
4985 }
4986
4987 fn from_registry_dist(
4988 reg_dist: &RegistrySourceDist,
4989 index: Option<&IndexUrl>,
4990 ) -> Result<Option<Self>, LockError> {
4991 if index.is_none_or(|index| *index != reg_dist.index) {
4994 return Ok(None);
4995 }
4996
4997 match ®_dist.index {
4998 IndexUrl::Pypi(_) | IndexUrl::Url(_) => {
4999 let url = normalize_file_location(®_dist.file.url)
5000 .map_err(LockErrorKind::InvalidUrl)
5001 .map_err(LockError::from)?;
5002 let hash = reg_dist.file.hashes.iter().max().cloned().map(Hash::from);
5003 let size = reg_dist.file.size;
5004 let upload_time = reg_dist
5005 .file
5006 .upload_time_utc_ms
5007 .map(Timestamp::from_millisecond)
5008 .transpose()
5009 .map_err(LockErrorKind::InvalidTimestamp)?;
5010 Ok(Some(Self::Url {
5011 url,
5012 metadata: SourceDistMetadata {
5013 hash,
5014 size,
5015 upload_time,
5016 },
5017 }))
5018 }
5019 IndexUrl::Path(path) => {
5020 let index_path = path
5021 .to_file_path()
5022 .map_err(|()| LockErrorKind::UrlToPath { url: path.to_url() })?;
5023 let url = reg_dist
5024 .file
5025 .url
5026 .to_url()
5027 .map_err(LockErrorKind::InvalidUrl)?;
5028
5029 if url.scheme() == "file" {
5030 let reg_dist_path = url
5031 .to_file_path()
5032 .map_err(|()| LockErrorKind::UrlToPath { url })?;
5033 let path =
5034 try_relative_to_if(®_dist_path, index_path, !path.was_given_absolute())
5035 .map_err(LockErrorKind::DistributionRelativePath)?
5036 .into_boxed_path();
5037 let hash = reg_dist.file.hashes.iter().max().cloned().map(Hash::from);
5038 let size = reg_dist.file.size;
5039 let upload_time = reg_dist
5040 .file
5041 .upload_time_utc_ms
5042 .map(Timestamp::from_millisecond)
5043 .transpose()
5044 .map_err(LockErrorKind::InvalidTimestamp)?;
5045 Ok(Some(Self::Path {
5046 path,
5047 metadata: SourceDistMetadata {
5048 hash,
5049 size,
5050 upload_time,
5051 },
5052 }))
5053 } else {
5054 let url = normalize_file_location(®_dist.file.url)
5055 .map_err(LockErrorKind::InvalidUrl)
5056 .map_err(LockError::from)?;
5057 let hash = reg_dist.file.hashes.iter().max().cloned().map(Hash::from);
5058 let size = reg_dist.file.size;
5059 let upload_time = reg_dist
5060 .file
5061 .upload_time_utc_ms
5062 .map(Timestamp::from_millisecond)
5063 .transpose()
5064 .map_err(LockErrorKind::InvalidTimestamp)?;
5065 Ok(Some(Self::Url {
5066 url,
5067 metadata: SourceDistMetadata {
5068 hash,
5069 size,
5070 upload_time,
5071 },
5072 }))
5073 }
5074 }
5075 }
5076 }
5077
5078 fn from_direct_dist(id: &PackageId, hashes: &[HashDigest]) -> Result<Self, LockError> {
5079 let Some(hash) = hashes.iter().max().cloned().map(Hash::from) else {
5080 let kind = LockErrorKind::Hash {
5081 id: id.clone(),
5082 artifact_type: "direct URL source distribution",
5083 expected: true,
5084 };
5085 return Err(kind.into());
5086 };
5087 Ok(Self::Metadata {
5088 metadata: SourceDistMetadata {
5089 hash: Some(hash),
5090 size: None,
5091 upload_time: None,
5092 },
5093 })
5094 }
5095
5096 fn from_path_dist(id: &PackageId, hashes: &[HashDigest]) -> Result<Self, LockError> {
5097 let Some(hash) = hashes.iter().max().cloned().map(Hash::from) else {
5098 let kind = LockErrorKind::Hash {
5099 id: id.clone(),
5100 artifact_type: "path source distribution",
5101 expected: true,
5102 };
5103 return Err(kind.into());
5104 };
5105 Ok(Self::Metadata {
5106 metadata: SourceDistMetadata {
5107 hash: Some(hash),
5108 size: None,
5109 upload_time: None,
5110 },
5111 })
5112 }
5113
5114 fn from_git_path_dist(id: &PackageId, hashes: &[HashDigest]) -> Result<Self, LockError> {
5115 let Some(hash) = hashes.iter().max().cloned().map(Hash::from) else {
5116 let kind = LockErrorKind::Hash {
5117 id: id.clone(),
5118 artifact_type: "Git archive source distribution",
5119 expected: true,
5120 };
5121 return Err(kind.into());
5122 };
5123 Ok(Self::Metadata {
5124 metadata: SourceDistMetadata {
5125 hash: Some(hash),
5126 size: None,
5127 upload_time: None,
5128 },
5129 })
5130 }
5131}
5132
5133#[derive(Clone, Debug, serde::Deserialize)]
5134#[serde(untagged, rename_all = "kebab-case")]
5135enum SourceDistWire {
5136 Url {
5137 url: UrlString,
5138 #[serde(flatten)]
5139 metadata: SourceDistMetadata,
5140 },
5141 Path {
5142 path: PortablePathBuf,
5143 #[serde(flatten)]
5144 metadata: SourceDistMetadata,
5145 },
5146 Metadata {
5147 #[serde(flatten)]
5148 metadata: SourceDistMetadata,
5149 },
5150}
5151
5152impl SourceDist {
5153 fn to_toml(&self) -> Result<InlineTable, toml_edit::ser::Error> {
5155 let mut table = InlineTable::new();
5156 match self {
5157 Self::Metadata { .. } => {}
5158 Self::Url { url, .. } => {
5159 table.insert("url", Value::from(url.as_ref()));
5160 }
5161 Self::Path { path, .. } => {
5162 table.insert("path", Value::from(PortablePath::from(path).to_string()));
5163 }
5164 }
5165 if let Some(hash) = self.hash() {
5166 table.insert("hash", Value::from(hash.to_string()));
5167 }
5168 if let Some(size) = self.size() {
5169 table.insert(
5170 "size",
5171 toml_edit::ser::ValueSerializer::new().serialize_u64(size)?,
5172 );
5173 }
5174 if let Some(upload_time) = self.upload_time() {
5175 table.insert("upload-time", Value::from(upload_time.to_string()));
5176 }
5177 Ok(table)
5178 }
5179}
5180
5181impl From<SourceDistWire> for SourceDist {
5182 fn from(wire: SourceDistWire) -> Self {
5183 match wire {
5184 SourceDistWire::Url { url, metadata } => Self::Url { url, metadata },
5185 SourceDistWire::Path { path, metadata } => Self::Path {
5186 path: path.into(),
5187 metadata,
5188 },
5189 SourceDistWire::Metadata { metadata } => Self::Metadata { metadata },
5190 }
5191 }
5192}
5193
5194impl From<GitReference> for GitSourceKind {
5195 fn from(value: GitReference) -> Self {
5196 match value {
5197 GitReference::Branch(branch) => Self::Branch(branch),
5198 GitReference::Tag(tag) => Self::Tag(tag),
5199 GitReference::BranchOrTag(rev) => Self::Rev(rev),
5200 GitReference::BranchOrTagOrCommit(rev) => Self::Rev(rev),
5201 GitReference::NamedRef(rev) => Self::Rev(rev),
5202 GitReference::DefaultBranch => Self::DefaultBranch,
5203 }
5204 }
5205}
5206
5207impl From<GitSourceKind> for GitReference {
5208 fn from(value: GitSourceKind) -> Self {
5209 match value {
5210 GitSourceKind::Branch(branch) => Self::Branch(branch),
5211 GitSourceKind::Tag(tag) => Self::Tag(tag),
5212 GitSourceKind::Rev(rev) => Self::from_rev(rev),
5213 GitSourceKind::DefaultBranch => Self::DefaultBranch,
5214 }
5215 }
5216}
5217
5218fn locked_git_url(
5220 git: &GitUrl,
5221 subdirectory: Option<&Path>,
5222 path: Option<&Path>,
5223) -> DisplaySafeUrl {
5224 let mut url = git.url().clone();
5225
5226 url.remove_credentials();
5228
5229 url.set_fragment(None);
5231 url.set_query(None);
5232
5233 if let Some(subdirectory) = subdirectory
5235 .map(PortablePath::from)
5236 .as_ref()
5237 .map(PortablePath::to_string)
5238 {
5239 url.query_pairs_mut()
5240 .append_pair("subdirectory", &subdirectory);
5241 }
5242
5243 if let Some(path) = path
5245 .map(PortablePath::from)
5246 .as_ref()
5247 .map(PortablePath::to_string)
5248 {
5249 url.query_pairs_mut().append_pair("path", &path);
5250 }
5251
5252 if git.lfs().enabled() {
5254 url.query_pairs_mut().append_pair("lfs", "true");
5255 }
5256
5257 match git.reference() {
5259 GitReference::Branch(branch) => {
5260 url.query_pairs_mut().append_pair("branch", branch.as_str());
5261 }
5262 GitReference::Tag(tag) => {
5263 url.query_pairs_mut().append_pair("tag", tag.as_str());
5264 }
5265 GitReference::BranchOrTag(rev)
5266 | GitReference::BranchOrTagOrCommit(rev)
5267 | GitReference::NamedRef(rev) => {
5268 url.query_pairs_mut().append_pair("rev", rev.as_str());
5269 }
5270 GitReference::DefaultBranch => {}
5271 }
5272
5273 url.set_fragment(git.precise().as_ref().map(GitOid::to_string).as_deref());
5275
5276 url
5277}
5278
5279#[derive(Clone, Debug, serde::Deserialize, PartialEq, Eq)]
5280struct ZstdWheel {
5281 hash: Option<Hash>,
5282 size: Option<u64>,
5283}
5284
5285#[derive(Clone, Debug, serde::Deserialize, PartialEq, Eq)]
5287#[serde(try_from = "WheelWire")]
5288struct Wheel {
5289 url: WheelWireSource,
5294 hash: Option<Hash>,
5300 size: Option<u64>,
5304 upload_time: Option<Timestamp>,
5308 filename: WheelFilename,
5315 zstd: Option<ZstdWheel>,
5317}
5318
5319impl Wheel {
5320 fn from_annotated_dist(annotated_dist: &AnnotatedDist) -> Result<Vec<Self>, LockError> {
5321 match annotated_dist.dist {
5322 ResolvedDist::Installed { .. } => unreachable!(),
5324 ResolvedDist::Installable { ref dist, .. } => Self::from_dist(
5325 dist,
5326 annotated_dist.hashes.as_slice(),
5327 annotated_dist.index(),
5328 ),
5329 }
5330 }
5331
5332 fn from_dist(
5333 dist: &Dist,
5334 hashes: &[HashDigest],
5335 index: Option<&IndexUrl>,
5336 ) -> Result<Vec<Self>, LockError> {
5337 match *dist {
5338 Dist::Built(ref built_dist) => Self::from_built_dist(built_dist, hashes, index),
5339 Dist::Source(uv_distribution_types::SourceDist::Registry(ref source_dist)) => {
5340 source_dist
5341 .wheels
5342 .iter()
5343 .filter(|wheel| {
5344 index.is_some_and(|index| *index == wheel.index)
5347 })
5348 .map(Self::from_registry_wheel)
5349 .collect()
5350 }
5351 Dist::Source(_) => Ok(vec![]),
5352 }
5353 }
5354
5355 fn from_built_dist(
5356 built_dist: &BuiltDist,
5357 hashes: &[HashDigest],
5358 index: Option<&IndexUrl>,
5359 ) -> Result<Vec<Self>, LockError> {
5360 match *built_dist {
5361 BuiltDist::Registry(ref reg_dist) => Self::from_registry_dist(reg_dist, index),
5362 BuiltDist::DirectUrl(ref direct_dist) => {
5363 Ok(vec![Self::from_direct_dist(direct_dist, hashes)])
5364 }
5365 BuiltDist::Path(ref path_dist) => Ok(vec![Self::from_path_dist(path_dist, hashes)]),
5366 BuiltDist::GitPath(ref git_dist) => {
5367 Ok(vec![Self::from_git_path_dist(git_dist, hashes)])
5368 }
5369 }
5370 }
5371
5372 fn from_registry_dist(
5373 reg_dist: &RegistryBuiltDist,
5374 index: Option<&IndexUrl>,
5375 ) -> Result<Vec<Self>, LockError> {
5376 reg_dist
5377 .wheels
5378 .iter()
5379 .filter(|wheel| {
5380 index.is_some_and(|index| *index == wheel.index)
5383 })
5384 .map(Self::from_registry_wheel)
5385 .collect()
5386 }
5387
5388 fn from_registry_wheel(wheel: &RegistryBuiltWheel) -> Result<Self, LockError> {
5389 let url = match &wheel.index {
5390 IndexUrl::Pypi(_) | IndexUrl::Url(_) => {
5391 let url = normalize_file_location(&wheel.file.url)
5392 .map_err(LockErrorKind::InvalidUrl)
5393 .map_err(LockError::from)?;
5394 WheelWireSource::Url { url }
5395 }
5396 IndexUrl::Path(path) => {
5397 let index_path = path
5398 .to_file_path()
5399 .map_err(|()| LockErrorKind::UrlToPath { url: path.to_url() })?;
5400 let wheel_url = wheel.file.url.to_url().map_err(LockErrorKind::InvalidUrl)?;
5401
5402 if wheel_url.scheme() == "file" {
5403 let wheel_path = wheel_url
5404 .to_file_path()
5405 .map_err(|()| LockErrorKind::UrlToPath { url: wheel_url })?;
5406 let path =
5407 try_relative_to_if(&wheel_path, index_path, !path.was_given_absolute())
5408 .map_err(LockErrorKind::DistributionRelativePath)?
5409 .into_boxed_path();
5410 WheelWireSource::Path { path }
5411 } else {
5412 let url = normalize_file_location(&wheel.file.url)
5413 .map_err(LockErrorKind::InvalidUrl)
5414 .map_err(LockError::from)?;
5415 WheelWireSource::Url { url }
5416 }
5417 }
5418 };
5419 let filename = wheel.filename.clone();
5420 let hash = wheel.file.hashes.iter().max().cloned().map(Hash::from);
5421 let size = wheel.file.size;
5422 let upload_time = wheel
5423 .file
5424 .upload_time_utc_ms
5425 .map(Timestamp::from_millisecond)
5426 .transpose()
5427 .map_err(LockErrorKind::InvalidTimestamp)?;
5428 let zstd = wheel.file.zstd.as_ref().map(|zstd| ZstdWheel {
5429 hash: zstd.hashes.iter().max().cloned().map(Hash::from),
5430 size: zstd.size,
5431 });
5432 Ok(Self {
5433 url,
5434 hash,
5435 size,
5436 upload_time,
5437 filename,
5438 zstd,
5439 })
5440 }
5441
5442 fn from_direct_dist(direct_dist: &DirectUrlBuiltDist, hashes: &[HashDigest]) -> Self {
5443 Self {
5444 url: WheelWireSource::Url {
5445 url: normalize_url(direct_dist.url.to_url()),
5446 },
5447 hash: hashes.iter().max().cloned().map(Hash::from),
5448 size: None,
5449 upload_time: None,
5450 filename: direct_dist.filename.clone(),
5451 zstd: None,
5452 }
5453 }
5454
5455 fn from_path_dist(path_dist: &PathBuiltDist, hashes: &[HashDigest]) -> Self {
5456 Self {
5457 url: WheelWireSource::Filename {
5458 filename: path_dist.filename.clone(),
5459 },
5460 hash: hashes.iter().max().cloned().map(Hash::from),
5461 size: None,
5462 upload_time: None,
5463 filename: path_dist.filename.clone(),
5464 zstd: None,
5465 }
5466 }
5467
5468 fn from_git_path_dist(path_dist: &GitPathBuiltDist, hashes: &[HashDigest]) -> Self {
5469 Self {
5470 url: WheelWireSource::Filename {
5471 filename: path_dist.filename.clone(),
5472 },
5473 hash: hashes.iter().max().cloned().map(Hash::from),
5474 size: None,
5475 upload_time: None,
5476 filename: path_dist.filename.clone(),
5477 zstd: None,
5478 }
5479 }
5480
5481 fn to_registry_wheel(
5482 &self,
5483 source: &RegistrySource,
5484 root: &Path,
5485 ) -> Result<RegistryBuiltWheel, LockError> {
5486 let filename: WheelFilename = self.filename.clone();
5487
5488 match source {
5489 RegistrySource::Url(url) => {
5490 let file_location = match &self.url {
5491 WheelWireSource::Url { url: file_url } => {
5492 FileLocation::AbsoluteUrl(file_url.clone())
5493 }
5494 WheelWireSource::Path { .. } | WheelWireSource::Filename { .. } => {
5495 return Err(LockErrorKind::MissingUrl {
5496 name: filename.name,
5497 version: filename.version,
5498 }
5499 .into());
5500 }
5501 };
5502 let file = Box::new(uv_distribution_types::File {
5503 dist_info_metadata: false,
5504 filename: SmallString::from(filename.to_string()),
5505 hashes: self.hash.iter().map(|h| h.0.clone()).collect(),
5506 requires_python: None,
5507 size: self.size,
5508 upload_time_utc_ms: self.upload_time.map(Timestamp::as_millisecond),
5509 url: file_location,
5510 yanked: None,
5511 zstd: self
5512 .zstd
5513 .as_ref()
5514 .map(|zstd| uv_distribution_types::Zstd {
5515 hashes: zstd.hash.iter().map(|h| h.0.clone()).collect(),
5516 size: zstd.size,
5517 })
5518 .map(Box::new),
5519 });
5520 let index = IndexUrl::from(VerbatimUrl::from_url(
5521 url.to_url().map_err(LockErrorKind::InvalidUrl)?,
5522 ));
5523 Ok(RegistryBuiltWheel {
5524 filename,
5525 file,
5526 index,
5527 })
5528 }
5529 RegistrySource::Path(index_path) => {
5530 let file_location = match &self.url {
5531 WheelWireSource::Url { url: file_url } => {
5532 FileLocation::AbsoluteUrl(file_url.clone())
5533 }
5534 WheelWireSource::Path { path: file_path } => {
5535 let file_path = root.join(index_path).join(file_path);
5536 let file_url =
5537 DisplaySafeUrl::from_file_path(&file_path).map_err(|()| {
5538 LockErrorKind::PathToUrl {
5539 path: file_path.into_boxed_path(),
5540 }
5541 })?;
5542 FileLocation::AbsoluteUrl(UrlString::from(file_url))
5543 }
5544 WheelWireSource::Filename { .. } => {
5545 return Err(LockErrorKind::MissingPath {
5546 name: filename.name,
5547 version: filename.version,
5548 }
5549 .into());
5550 }
5551 };
5552 let file = Box::new(uv_distribution_types::File {
5553 dist_info_metadata: false,
5554 filename: SmallString::from(filename.to_string()),
5555 hashes: self.hash.iter().map(|h| h.0.clone()).collect(),
5556 requires_python: None,
5557 size: self.size,
5558 upload_time_utc_ms: self.upload_time.map(Timestamp::as_millisecond),
5559 url: file_location,
5560 yanked: None,
5561 zstd: self
5562 .zstd
5563 .as_ref()
5564 .map(|zstd| uv_distribution_types::Zstd {
5565 hashes: zstd.hash.iter().map(|h| h.0.clone()).collect(),
5566 size: zstd.size,
5567 })
5568 .map(Box::new),
5569 });
5570 let index = IndexUrl::from(
5571 VerbatimUrl::from_absolute_path(root.join(index_path))
5572 .map_err(LockErrorKind::RegistryVerbatimUrl)?,
5573 );
5574 Ok(RegistryBuiltWheel {
5575 filename,
5576 file,
5577 index,
5578 })
5579 }
5580 }
5581 }
5582}
5583
5584#[derive(Clone, Debug, serde::Deserialize)]
5585#[serde(rename_all = "kebab-case")]
5586struct WheelWire {
5587 #[serde(flatten)]
5588 url: WheelWireSource,
5589 hash: Option<Hash>,
5595 size: Option<u64>,
5599 #[serde(alias = "upload_time")]
5603 upload_time: Option<Timestamp>,
5604 #[serde(alias = "zstd")]
5606 zstd: Option<ZstdWheel>,
5607}
5608
5609#[derive(Clone, Debug, serde::Deserialize, PartialEq, Eq)]
5610#[serde(untagged, rename_all = "kebab-case")]
5611enum WheelWireSource {
5612 Url {
5614 url: UrlString,
5619 },
5620 Path {
5622 path: Box<Path>,
5624 },
5625 Filename {
5629 filename: WheelFilename,
5632 },
5633}
5634
5635impl Wheel {
5636 fn to_toml(&self) -> Result<InlineTable, toml_edit::ser::Error> {
5638 let mut table = InlineTable::new();
5639 match &self.url {
5640 WheelWireSource::Url { url } => {
5641 table.insert("url", Value::from(url.as_ref()));
5642 }
5643 WheelWireSource::Path { path } => {
5644 table.insert("path", Value::from(PortablePath::from(path).to_string()));
5645 }
5646 WheelWireSource::Filename { filename } => {
5647 table.insert("filename", Value::from(filename.to_string()));
5648 }
5649 }
5650 if let Some(ref hash) = self.hash {
5651 table.insert("hash", Value::from(hash.to_string()));
5652 }
5653 if let Some(size) = self.size {
5654 table.insert(
5655 "size",
5656 toml_edit::ser::ValueSerializer::new().serialize_u64(size)?,
5657 );
5658 }
5659 if let Some(upload_time) = self.upload_time {
5660 table.insert("upload-time", Value::from(upload_time.to_string()));
5661 }
5662 if let Some(zstd) = &self.zstd {
5663 let mut inner = InlineTable::new();
5664 if let Some(ref hash) = zstd.hash {
5665 inner.insert("hash", Value::from(hash.to_string()));
5666 }
5667 if let Some(size) = zstd.size {
5668 inner.insert(
5669 "size",
5670 toml_edit::ser::ValueSerializer::new().serialize_u64(size)?,
5671 );
5672 }
5673 table.insert("zstd", Value::from(inner));
5674 }
5675 Ok(table)
5676 }
5677}
5678
5679impl TryFrom<WheelWire> for Wheel {
5680 type Error = String;
5681
5682 fn try_from(wire: WheelWire) -> Result<Self, String> {
5683 let filename = match &wire.url {
5684 WheelWireSource::Url { url } => {
5685 let filename = url.filename().map_err(|err| err.to_string())?;
5686 filename.parse::<WheelFilename>().map_err(|err| {
5687 format!("failed to parse `{filename}` as wheel filename: {err}")
5688 })?
5689 }
5690 WheelWireSource::Path { path } => {
5691 let filename = path
5692 .file_name()
5693 .and_then(|file_name| file_name.to_str())
5694 .ok_or_else(|| {
5695 format!("path `{}` has no filename component", path.display())
5696 })?;
5697 filename.parse::<WheelFilename>().map_err(|err| {
5698 format!("failed to parse `{filename}` as wheel filename: {err}")
5699 })?
5700 }
5701 WheelWireSource::Filename { filename } => filename.clone(),
5702 };
5703
5704 Ok(Self {
5705 url: wire.url,
5706 hash: wire.hash,
5707 size: wire.size,
5708 upload_time: wire.upload_time,
5709 zstd: wire.zstd,
5710 filename,
5711 })
5712 }
5713}
5714
5715#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
5717pub struct Dependency {
5718 package_id: PackageId,
5719 extra: BTreeSet<ExtraName>,
5720 simplified_marker: SimplifiedMarkerTree,
5741 complexified_marker: UniversalMarker,
5745}
5746
5747impl Dependency {
5748 fn new(
5749 requires_python: &RequiresPython,
5750 package_id: PackageId,
5751 extra: BTreeSet<ExtraName>,
5752 complexified_marker: UniversalMarker,
5753 ) -> Self {
5754 let simplified_marker =
5755 SimplifiedMarkerTree::new(requires_python, complexified_marker.combined());
5756 let complexified_marker = simplified_marker.into_marker(requires_python);
5757 Self {
5758 package_id,
5759 extra,
5760 simplified_marker,
5761 complexified_marker: UniversalMarker::from_combined(complexified_marker),
5762 }
5763 }
5764
5765 fn from_annotated_dist(
5766 requires_python: &RequiresPython,
5767 annotated_dist: &AnnotatedDist,
5768 complexified_marker: UniversalMarker,
5769 root: &Path,
5770 ) -> Result<Self, LockError> {
5771 let package_id = PackageId::from_annotated_dist(annotated_dist, root)?;
5772 let extra = annotated_dist.extra.iter().cloned().collect();
5773 Ok(Self::new(
5774 requires_python,
5775 package_id,
5776 extra,
5777 complexified_marker,
5778 ))
5779 }
5780
5781 fn to_toml(
5783 &self,
5784 simplified_environment: MarkerTree,
5785 dist_count_by_name: &FxHashMap<PackageName, u64>,
5786 ) -> Table {
5787 let mut table = Table::new();
5788 self.package_id
5789 .to_toml(Some(dist_count_by_name), &mut table);
5790 if !self.extra.is_empty() {
5791 let extra_array = self
5792 .extra
5793 .iter()
5794 .map(ToString::to_string)
5795 .collect::<Array>();
5796 table.insert("extra", value(extra_array));
5797 }
5798 if let Some(marker) = self
5800 .simplified_marker
5801 .as_simplified_marker_tree()
5802 .restrict(simplified_environment)
5803 .try_to_string()
5804 {
5805 table.insert("marker", value(marker));
5806 }
5807
5808 table
5809 }
5810
5811 pub fn package_name(&self) -> &PackageName {
5813 &self.package_id.name
5814 }
5815
5816 pub fn extra(&self) -> &BTreeSet<ExtraName> {
5818 &self.extra
5819 }
5820}
5821
5822impl Display for Dependency {
5823 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
5824 match (self.extra.is_empty(), self.package_id.version.as_ref()) {
5825 (true, Some(version)) => write!(f, "{}=={}", self.package_id.name, version),
5826 (true, None) => write!(f, "{}", self.package_id.name),
5827 (false, Some(version)) => write!(
5828 f,
5829 "{}[{}]=={}",
5830 self.package_id.name,
5831 self.extra.iter().join(","),
5832 version
5833 ),
5834 (false, None) => write!(
5835 f,
5836 "{}[{}]",
5837 self.package_id.name,
5838 self.extra.iter().join(",")
5839 ),
5840 }
5841 }
5842}
5843
5844#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord, serde::Deserialize)]
5846#[serde(rename_all = "kebab-case")]
5847struct DependencyWire {
5848 #[serde(flatten)]
5849 package_id: PackageIdForDependency,
5850 #[serde(default)]
5851 extra: BTreeSet<ExtraName>,
5852 #[serde(default)]
5853 marker: SimplifiedMarkerTree,
5854}
5855
5856impl DependencyWire {
5857 fn unwire(
5858 self,
5859 requires_python: &RequiresPython,
5860 environment: SimplifiedMarkerTree,
5861 default: UniversalMarker,
5862 unambiguous_package_ids: &FxHashMap<PackageName, PackageId>,
5863 ) -> Result<Dependency, LockError> {
5864 let (simplified_marker, complexified_marker) =
5865 if self.marker.as_simplified_marker_tree().is_true() {
5866 (environment, default)
5867 } else {
5868 let mut simplified_marker = self.marker;
5869 simplified_marker.and(environment);
5870 let complexified_marker =
5871 UniversalMarker::from_combined(simplified_marker.into_marker(requires_python));
5872 (simplified_marker, complexified_marker)
5873 };
5874 Ok(Dependency {
5875 package_id: self.package_id.unwire(unambiguous_package_ids)?,
5876 extra: self.extra,
5877 simplified_marker,
5878 complexified_marker,
5879 })
5880 }
5881}
5882
5883#[derive(Clone, Debug, PartialEq, Eq)]
5888struct Hash(HashDigest);
5889
5890impl From<HashDigest> for Hash {
5891 fn from(hd: HashDigest) -> Self {
5892 Self(hd)
5893 }
5894}
5895
5896impl FromStr for Hash {
5897 type Err = HashParseError;
5898
5899 fn from_str(s: &str) -> Result<Self, HashParseError> {
5900 let (algorithm, digest) = s.split_once(':').ok_or(HashParseError(
5901 "expected '{algorithm}:{digest}', but found no ':' in hash digest",
5902 ))?;
5903 let algorithm = algorithm
5904 .parse()
5905 .map_err(|_| HashParseError("unrecognized hash algorithm"))?;
5906 Ok(Self(HashDigest {
5907 algorithm,
5908 digest: digest.into(),
5909 }))
5910 }
5911}
5912
5913impl Display for Hash {
5914 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
5915 write!(f, "{}:{}", self.0.algorithm, self.0.digest)
5916 }
5917}
5918
5919impl<'de> serde::Deserialize<'de> for Hash {
5920 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
5921 where
5922 D: serde::de::Deserializer<'de>,
5923 {
5924 struct Visitor;
5925
5926 impl serde::de::Visitor<'_> for Visitor {
5927 type Value = Hash;
5928
5929 fn expecting(&self, f: &mut Formatter) -> std::fmt::Result {
5930 f.write_str("a string")
5931 }
5932
5933 fn visit_str<E: serde::de::Error>(self, v: &str) -> Result<Self::Value, E> {
5934 Hash::from_str(v).map_err(serde::de::Error::custom)
5935 }
5936 }
5937
5938 deserializer.deserialize_str(Visitor)
5939 }
5940}
5941
5942impl From<Hash> for Hashes {
5943 fn from(value: Hash) -> Self {
5944 match value.0.algorithm {
5945 HashAlgorithm::Md5 => Self {
5946 md5: Some(value.0.digest),
5947 sha256: None,
5948 sha384: None,
5949 sha512: None,
5950 blake2b: None,
5951 },
5952 HashAlgorithm::Sha256 => Self {
5953 md5: None,
5954 sha256: Some(value.0.digest),
5955 sha384: None,
5956 sha512: None,
5957 blake2b: None,
5958 },
5959 HashAlgorithm::Sha384 => Self {
5960 md5: None,
5961 sha256: None,
5962 sha384: Some(value.0.digest),
5963 sha512: None,
5964 blake2b: None,
5965 },
5966 HashAlgorithm::Sha512 => Self {
5967 md5: None,
5968 sha256: None,
5969 sha384: None,
5970 sha512: Some(value.0.digest),
5971 blake2b: None,
5972 },
5973 HashAlgorithm::Blake2b => Self {
5974 md5: None,
5975 sha256: None,
5976 sha384: None,
5977 sha512: None,
5978 blake2b: Some(value.0.digest),
5979 },
5980 }
5981 }
5982}
5983
5984fn normalize_file_location(location: &FileLocation) -> Result<UrlString, ToUrlError> {
5986 match location {
5987 FileLocation::AbsoluteUrl(absolute) => Ok(absolute.without_fragment().into_owned()),
5988 FileLocation::RelativeUrl(_, _) => Ok(normalize_url(location.to_url()?)),
5989 }
5990}
5991
5992fn normalize_url(mut url: DisplaySafeUrl) -> UrlString {
5994 url.set_fragment(None);
5995 UrlString::from(url)
5996}
5997
5998fn normalize_requirement(
6008 mut requirement: Requirement,
6009 root: &Path,
6010 requires_python: &RequiresPython,
6011) -> Result<Requirement, LockError> {
6012 requirement.extras.sort();
6014 requirement.groups.sort();
6015
6016 match requirement.source {
6018 RequirementSource::GitDirectory {
6019 git,
6020 subdirectory,
6021 url: _,
6022 } => {
6023 let git = {
6025 let mut repository = git.url().clone();
6026
6027 repository.remove_credentials();
6029
6030 repository.set_fragment(None);
6032 repository.set_query(None);
6033
6034 GitUrl::from_fields(
6035 repository,
6036 git.reference().clone(),
6037 git.precise(),
6038 git.lfs(),
6039 )?
6040 };
6041
6042 let url = DisplaySafeUrl::from(ParsedGitDirectoryUrl {
6044 url: git.clone(),
6045 subdirectory: subdirectory.clone(),
6046 });
6047
6048 Ok(Requirement {
6049 name: requirement.name,
6050 extras: requirement.extras,
6051 groups: requirement.groups,
6052 marker: requires_python.simplify_markers(requirement.marker),
6053 source: RequirementSource::GitDirectory {
6054 git,
6055 subdirectory,
6056 url: VerbatimUrl::from_url(url),
6057 },
6058 origin: None,
6059 })
6060 }
6061 RequirementSource::GitPath {
6062 git,
6063 install_path,
6064 ext,
6065 url: _,
6066 } => {
6067 let git = {
6069 let mut repository = git.url().clone();
6070
6071 repository.remove_credentials();
6073
6074 repository.set_fragment(None);
6076 repository.set_query(None);
6077
6078 GitUrl::from_fields(
6079 repository,
6080 git.reference().clone(),
6081 git.precise(),
6082 git.lfs(),
6083 )?
6084 };
6085
6086 let url = DisplaySafeUrl::from(ParsedGitPathUrl {
6088 url: git.clone(),
6089 install_path: install_path.clone(),
6090 ext,
6091 });
6092
6093 Ok(Requirement {
6094 name: requirement.name,
6095 extras: requirement.extras,
6096 groups: requirement.groups,
6097 marker: requires_python.simplify_markers(requirement.marker),
6098 source: RequirementSource::GitPath {
6099 git,
6100 install_path,
6101 ext,
6102 url: VerbatimUrl::from_url(url),
6103 },
6104 origin: None,
6105 })
6106 }
6107 RequirementSource::Path {
6108 install_path,
6109 ext,
6110 url: _,
6111 } => {
6112 let path = root.join(&install_path);
6113 let install_path = normalize_path(path).into_owned().into_boxed_path();
6114 let url = VerbatimUrl::from_normalized_path(&install_path)
6115 .map_err(LockErrorKind::RequirementVerbatimUrl)?;
6116
6117 Ok(Requirement {
6118 name: requirement.name,
6119 extras: requirement.extras,
6120 groups: requirement.groups,
6121 marker: requires_python.simplify_markers(requirement.marker),
6122 source: RequirementSource::Path {
6123 install_path,
6124 ext,
6125 url,
6126 },
6127 origin: None,
6128 })
6129 }
6130 RequirementSource::Directory {
6131 install_path,
6132 editable,
6133 r#virtual,
6134 url: _,
6135 } => {
6136 let path = root.join(&install_path);
6137 let install_path = normalize_path(path).into_owned().into_boxed_path();
6138 let url = VerbatimUrl::from_normalized_path(&install_path)
6139 .map_err(LockErrorKind::RequirementVerbatimUrl)?;
6140
6141 Ok(Requirement {
6142 name: requirement.name,
6143 extras: requirement.extras,
6144 groups: requirement.groups,
6145 marker: requires_python.simplify_markers(requirement.marker),
6146 source: RequirementSource::Directory {
6147 install_path,
6148 editable: Some(editable.unwrap_or(false)),
6149 r#virtual: Some(r#virtual.unwrap_or(false)),
6150 url,
6151 },
6152 origin: None,
6153 })
6154 }
6155 RequirementSource::Registry {
6156 specifier,
6157 index,
6158 conflict,
6159 } => {
6160 let index = index
6162 .map(|index| index.url.into_url())
6163 .map(|mut index| {
6164 index.remove_credentials();
6165 index
6166 })
6167 .map(|index| IndexMetadata::from(IndexUrl::from(VerbatimUrl::from_url(index))));
6168 Ok(Requirement {
6169 name: requirement.name,
6170 extras: requirement.extras,
6171 groups: requirement.groups,
6172 marker: requires_python.simplify_markers(requirement.marker),
6173 source: RequirementSource::Registry {
6174 specifier,
6175 index,
6176 conflict,
6177 },
6178 origin: None,
6179 })
6180 }
6181 RequirementSource::Url {
6182 mut location,
6183 subdirectory,
6184 ext,
6185 url: _,
6186 } => {
6187 location.remove_credentials();
6189
6190 location.set_fragment(None);
6192
6193 let url = DisplaySafeUrl::from(ParsedArchiveUrl {
6195 url: location.clone(),
6196 subdirectory: subdirectory.clone(),
6197 ext,
6198 });
6199
6200 Ok(Requirement {
6201 name: requirement.name,
6202 extras: requirement.extras,
6203 groups: requirement.groups,
6204 marker: requires_python.simplify_markers(requirement.marker),
6205 source: RequirementSource::Url {
6206 location,
6207 subdirectory,
6208 ext,
6209 url: VerbatimUrl::from_url(url),
6210 },
6211 origin: None,
6212 })
6213 }
6214 }
6215}
6216
6217#[derive(Debug)]
6218pub struct LockError {
6219 kind: Box<LockErrorKind>,
6220 hint: Option<WheelTagHint>,
6221}
6222
6223impl std::error::Error for LockError {
6224 fn source(&self) -> Option<&(dyn Error + 'static)> {
6225 self.kind.source()
6226 }
6227}
6228
6229impl uv_errors::Hint for LockError {
6230 fn hints(&self) -> uv_errors::Hints<'_> {
6231 if let Some(hint) = &self.hint {
6232 uv_errors::Hints::from(hint.to_string())
6233 } else {
6234 uv_errors::Hints::none()
6235 }
6236 }
6237}
6238
6239impl std::fmt::Display for LockError {
6240 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
6241 write!(f, "{}", self.kind)
6242 }
6243}
6244
6245impl LockError {
6246 pub fn is_resolution(&self) -> bool {
6248 matches!(&*self.kind, LockErrorKind::Resolution { .. })
6249 }
6250
6251 pub fn is_no_build(&self) -> bool {
6253 matches!(
6254 &*self.kind,
6255 LockErrorKind::NoBuild { .. } | LockErrorKind::NoBinaryNoBuild { .. }
6256 )
6257 }
6258}
6259
6260impl<E> From<E> for LockError
6261where
6262 LockErrorKind: From<E>,
6263{
6264 fn from(err: E) -> Self {
6265 Self {
6266 kind: Box::new(LockErrorKind::from(err)),
6267 hint: None,
6268 }
6269 }
6270}
6271
6272#[derive(Debug, Clone, PartialEq, Eq)]
6273#[expect(clippy::enum_variant_names)]
6274enum WheelTagHint {
6275 LanguageTags {
6278 package: PackageName,
6279 version: Option<Version>,
6280 tags: BTreeSet<LanguageTag>,
6281 best: Option<LanguageTag>,
6282 },
6283 AbiTags {
6286 package: PackageName,
6287 version: Option<Version>,
6288 tags: BTreeSet<AbiTag>,
6289 best: Option<AbiTag>,
6290 },
6291 PlatformTags {
6294 package: PackageName,
6295 version: Option<Version>,
6296 tags: BTreeSet<PlatformTag>,
6297 best: Option<PlatformTag>,
6298 markers: MarkerEnvironment,
6299 },
6300}
6301
6302impl WheelTagHint {
6303 fn from_wheels(
6305 name: &PackageName,
6306 version: Option<&Version>,
6307 filenames: &[&WheelFilename],
6308 tags: &Tags,
6309 markers: &MarkerEnvironment,
6310 ) -> Option<Self> {
6311 let incompatibility = filenames
6312 .iter()
6313 .map(|filename| {
6314 tags.compatibility(
6315 filename.python_tags().iter(),
6316 filename.abi_tags().iter(),
6317 filename.platform_tags().iter(),
6318 )
6319 })
6320 .max()?;
6321 match incompatibility {
6322 TagCompatibility::Incompatible(IncompatibleTag::Python) => {
6323 let best = tags.python_tag();
6324 let tags = Self::python_tags(filenames.iter().copied()).collect::<BTreeSet<_>>();
6325 if tags.is_empty() {
6326 None
6327 } else {
6328 Some(Self::LanguageTags {
6329 package: name.clone(),
6330 version: version.cloned(),
6331 tags,
6332 best,
6333 })
6334 }
6335 }
6336 TagCompatibility::Incompatible(IncompatibleTag::Abi) => {
6337 let best = tags.abi_tag();
6338 let tags = Self::abi_tags(filenames.iter().copied())
6339 .filter(|tag| *tag != AbiTag::None)
6348 .collect::<BTreeSet<_>>();
6349 if tags.is_empty() {
6350 None
6351 } else {
6352 Some(Self::AbiTags {
6353 package: name.clone(),
6354 version: version.cloned(),
6355 tags,
6356 best,
6357 })
6358 }
6359 }
6360 TagCompatibility::Incompatible(IncompatibleTag::Platform) => {
6361 let best = tags.platform_tag().cloned();
6362 let incompatible_tags = Self::platform_tags(filenames.iter().copied(), tags)
6363 .cloned()
6364 .collect::<BTreeSet<_>>();
6365 if incompatible_tags.is_empty() {
6366 None
6367 } else {
6368 Some(Self::PlatformTags {
6369 package: name.clone(),
6370 version: version.cloned(),
6371 tags: incompatible_tags,
6372 best,
6373 markers: markers.clone(),
6374 })
6375 }
6376 }
6377 _ => None,
6378 }
6379 }
6380
6381 fn python_tags<'a>(
6383 filenames: impl Iterator<Item = &'a WheelFilename> + 'a,
6384 ) -> impl Iterator<Item = LanguageTag> + 'a {
6385 filenames.flat_map(WheelFilename::python_tags).copied()
6386 }
6387
6388 fn abi_tags<'a>(
6390 filenames: impl Iterator<Item = &'a WheelFilename> + 'a,
6391 ) -> impl Iterator<Item = AbiTag> + 'a {
6392 filenames.flat_map(WheelFilename::abi_tags).copied()
6393 }
6394
6395 fn platform_tags<'a>(
6398 filenames: impl Iterator<Item = &'a WheelFilename> + 'a,
6399 tags: &'a Tags,
6400 ) -> impl Iterator<Item = &'a PlatformTag> + 'a {
6401 filenames.flat_map(move |filename| {
6402 if filename.python_tags().iter().any(|wheel_py| {
6403 filename
6404 .abi_tags()
6405 .iter()
6406 .any(|wheel_abi| tags.is_compatible_abi(*wheel_py, *wheel_abi))
6407 }) {
6408 filename.platform_tags().iter()
6409 } else {
6410 [].iter()
6411 }
6412 })
6413 }
6414
6415 fn suggest_environment_marker(markers: &MarkerEnvironment) -> String {
6416 let sys_platform = markers.sys_platform();
6417 let platform_machine = markers.platform_machine();
6418
6419 if platform_machine.is_empty() {
6421 format!("sys_platform == '{sys_platform}'")
6422 } else {
6423 format!("sys_platform == '{sys_platform}' and platform_machine == '{platform_machine}'")
6424 }
6425 }
6426}
6427
6428impl std::fmt::Display for WheelTagHint {
6429 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
6430 match self {
6431 Self::LanguageTags {
6432 package,
6433 version,
6434 tags,
6435 best,
6436 } => {
6437 if let Some(best) = best {
6438 let s = if tags.len() == 1 { "" } else { "s" };
6439 let best = if let Some(pretty) = best.pretty() {
6440 format!("{} (`{}`)", pretty.cyan(), best.cyan())
6441 } else {
6442 format!("{}", best.cyan())
6443 };
6444 if let Some(version) = version {
6445 write!(
6446 f,
6447 "You're using {}, but `{}` ({}) only has wheels with the following Python implementation tag{s}: {}",
6448 best,
6449 package.cyan(),
6450 format!("v{version}").cyan(),
6451 tags.iter()
6452 .map(|tag| format!("`{}`", tag.cyan()))
6453 .join(", "),
6454 )
6455 } else {
6456 write!(
6457 f,
6458 "You're using {}, but `{}` only has wheels with the following Python implementation tag{s}: {}",
6459 best,
6460 package.cyan(),
6461 tags.iter()
6462 .map(|tag| format!("`{}`", tag.cyan()))
6463 .join(", "),
6464 )
6465 }
6466 } else {
6467 let s = if tags.len() == 1 { "" } else { "s" };
6468 if let Some(version) = version {
6469 write!(
6470 f,
6471 "Wheels are available for `{}` ({}) with the following Python implementation tag{s}: {}",
6472 package.cyan(),
6473 format!("v{version}").cyan(),
6474 tags.iter()
6475 .map(|tag| format!("`{}`", tag.cyan()))
6476 .join(", "),
6477 )
6478 } else {
6479 write!(
6480 f,
6481 "Wheels are available for `{}` with the following Python implementation tag{s}: {}",
6482 package.cyan(),
6483 tags.iter()
6484 .map(|tag| format!("`{}`", tag.cyan()))
6485 .join(", "),
6486 )
6487 }
6488 }
6489 }
6490 Self::AbiTags {
6491 package,
6492 version,
6493 tags,
6494 best,
6495 } => {
6496 if let Some(best) = best {
6497 let s = if tags.len() == 1 { "" } else { "s" };
6498 let best = if let Some(pretty) = best.pretty() {
6499 format!("{} (`{}`)", pretty.cyan(), best.cyan())
6500 } else {
6501 format!("{}", best.cyan())
6502 };
6503 if let Some(version) = version {
6504 write!(
6505 f,
6506 "You're using {}, but `{}` ({}) only has wheels with the following Python ABI tag{s}: {}",
6507 best,
6508 package.cyan(),
6509 format!("v{version}").cyan(),
6510 tags.iter()
6511 .map(|tag| format!("`{}`", tag.cyan()))
6512 .join(", "),
6513 )
6514 } else {
6515 write!(
6516 f,
6517 "You're using {}, but `{}` only has wheels with the following Python ABI tag{s}: {}",
6518 best,
6519 package.cyan(),
6520 tags.iter()
6521 .map(|tag| format!("`{}`", tag.cyan()))
6522 .join(", "),
6523 )
6524 }
6525 } else {
6526 let s = if tags.len() == 1 { "" } else { "s" };
6527 if let Some(version) = version {
6528 write!(
6529 f,
6530 "Wheels are available for `{}` ({}) with the following Python ABI tag{s}: {}",
6531 package.cyan(),
6532 format!("v{version}").cyan(),
6533 tags.iter()
6534 .map(|tag| format!("`{}`", tag.cyan()))
6535 .join(", "),
6536 )
6537 } else {
6538 write!(
6539 f,
6540 "Wheels are available for `{}` with the following Python ABI tag{s}: {}",
6541 package.cyan(),
6542 tags.iter()
6543 .map(|tag| format!("`{}`", tag.cyan()))
6544 .join(", "),
6545 )
6546 }
6547 }
6548 }
6549 Self::PlatformTags {
6550 package,
6551 version,
6552 tags,
6553 best,
6554 markers,
6555 } => {
6556 let s = if tags.len() == 1 { "" } else { "s" };
6557 if let Some(best) = best {
6558 let example_marker = Self::suggest_environment_marker(markers);
6559 let best = if let Some(pretty) = best.pretty() {
6560 format!("{} (`{}`)", pretty.cyan(), best.cyan())
6561 } else {
6562 format!("`{}`", best.cyan())
6563 };
6564 let package_ref = if let Some(version) = version {
6565 format!("`{}` ({})", package.cyan(), format!("v{version}").cyan())
6566 } else {
6567 format!("`{}`", package.cyan())
6568 };
6569 write!(
6570 f,
6571 "You're on {}, but {} only has wheels for the following platform{s}: {}; consider adding {} to `{}` to ensure uv resolves to a version with compatible wheels",
6572 best,
6573 package_ref,
6574 tags.iter()
6575 .map(|tag| format!("`{}`", tag.cyan()))
6576 .join(", "),
6577 format!("\"{example_marker}\"").cyan(),
6578 "tool.uv.required-environments".green()
6579 )
6580 } else {
6581 if let Some(version) = version {
6582 write!(
6583 f,
6584 "Wheels are available for `{}` ({}) on the following platform{s}: {}",
6585 package.cyan(),
6586 format!("v{version}").cyan(),
6587 tags.iter()
6588 .map(|tag| format!("`{}`", tag.cyan()))
6589 .join(", "),
6590 )
6591 } else {
6592 write!(
6593 f,
6594 "Wheels are available for `{}` on the following platform{s}: {}",
6595 package.cyan(),
6596 tags.iter()
6597 .map(|tag| format!("`{}`", tag.cyan()))
6598 .join(", "),
6599 )
6600 }
6601 }
6602 }
6603 }
6604 }
6605}
6606
6607#[derive(Debug, thiserror::Error)]
6614enum LockErrorKind {
6615 #[error("Found duplicate package `{id}`", id = id.cyan())]
6618 DuplicatePackage {
6619 id: PackageId,
6621 },
6622 #[error("For package `{id}`, found duplicate dependency `{dependency}`", id = id.cyan(), dependency = dependency.cyan())]
6625 DuplicateDependency {
6626 id: PackageId,
6629 dependency: Dependency,
6631 },
6632 #[error("For package `{id}`, found duplicate dependency `{dependency}`", id = format!("{id}[{extra}]").cyan(), dependency = dependency.cyan())]
6636 DuplicateOptionalDependency {
6637 id: PackageId,
6640 extra: ExtraName,
6642 dependency: Dependency,
6644 },
6645 #[error("For package `{id}`, found duplicate dependency `{dependency}`", id = format!("{id}:{group}").cyan(), dependency = dependency.cyan())]
6649 DuplicateDevDependency {
6650 id: PackageId,
6653 group: GroupName,
6655 dependency: Dependency,
6657 },
6658 #[error(transparent)]
6661 InvalidUrl(
6662 #[from]
6665 ToUrlError,
6666 ),
6667 #[error("Failed to parse file extension for `{id}`; expected one of: {err}", id = id.cyan())]
6670 MissingExtension {
6671 id: PackageId,
6673 err: ExtensionError,
6675 },
6676 #[error("Failed to parse Git URL")]
6678 InvalidGitSourceUrl(
6679 #[source]
6682 SourceParseError,
6683 ),
6684 #[error("Failed to parse timestamp")]
6685 InvalidTimestamp(
6686 #[source]
6689 jiff::Error,
6690 ),
6691 #[error("For package `{id}`, found dependency `{dependency}` with no locked package", id = id.cyan(), dependency = dependency.cyan())]
6695 UnrecognizedDependency {
6696 id: PackageId,
6698 dependency: Dependency,
6701 },
6702 #[error("Since the package `{id}` comes from a {source} dependency, a hash was {expected} but one was not found for {artifact_type}", id = id.cyan(), source = id.source.name(), expected = if *expected { "expected" } else { "not expected" })]
6705 Hash {
6706 id: PackageId,
6708 artifact_type: &'static str,
6711 expected: bool,
6713 },
6714 #[error("Found package `{id}` with extra `{extra}` but no base package", id = id.cyan(), extra = extra.cyan())]
6717 MissingExtraBase {
6718 id: PackageId,
6720 extra: ExtraName,
6722 },
6723 #[error("Found package `{id}` with development dependency group `{group}` but no base package", id = id.cyan())]
6727 MissingDevBase {
6728 id: PackageId,
6730 group: GroupName,
6732 },
6733 #[error("Wheels cannot come from {source_type} sources")]
6736 InvalidWheelSource {
6737 id: PackageId,
6739 source_type: &'static str,
6741 },
6742 #[error("Found registry distribution `{name}` ({version}) without a valid URL", name = name.cyan(), version = format!("v{version}").cyan())]
6745 MissingUrl {
6746 name: PackageName,
6748 version: Version,
6750 },
6751 #[error("Found registry distribution `{name}` ({version}) without a valid path", name = name.cyan(), version = format!("v{version}").cyan())]
6754 MissingPath {
6755 name: PackageName,
6757 version: Version,
6759 },
6760 #[error("Found registry distribution `{id}` without a valid filename", id = id.cyan())]
6763 MissingFilename {
6764 id: PackageId,
6766 },
6767 #[error("Distribution `{id}` can't be installed because it doesn't have a source distribution or wheel for the current platform", id = id.cyan())]
6770 NeitherSourceDistNorWheel {
6771 id: PackageId,
6773 },
6774 #[error("Distribution `{id}` can't be installed because it is marked as both `--no-binary` and `--no-build`", id = id.cyan())]
6776 NoBinaryNoBuild {
6777 id: PackageId,
6779 },
6780 #[error("Distribution `{id}` can't be installed because it is marked as `--no-binary` but has no source distribution", id = id.cyan())]
6783 NoBinary {
6784 id: PackageId,
6786 },
6787 #[error("Distribution `{id}` can't be installed because it is marked as `--no-build` but has no binary distribution", id = id.cyan())]
6790 NoBuild {
6791 id: PackageId,
6793 },
6794 #[error("Distribution `{id}` can't be installed because the binary distribution is incompatible with the current platform", id = id.cyan())]
6797 IncompatibleWheelOnly {
6798 id: PackageId,
6800 },
6801 #[error("Distribution `{id}` can't be installed because it is marked as `--no-binary` but is itself a binary distribution", id = id.cyan())]
6803 NoBinaryWheelOnly {
6804 id: PackageId,
6806 },
6807 #[error("Found dependency `{id}` with no locked distribution", id = id.cyan())]
6809 VerbatimUrl {
6810 id: PackageId,
6812 #[source]
6814 err: VerbatimUrlError,
6815 },
6816 #[error("Could not compute relative path between workspace and distribution")]
6818 DistributionRelativePath(
6819 #[source]
6821 io::Error,
6822 ),
6823 #[error("Could not compute relative path between workspace and index")]
6825 IndexRelativePath(
6826 #[source]
6828 io::Error,
6829 ),
6830 #[error("Could not compute absolute path from workspace root and lockfile path")]
6832 AbsolutePath(
6833 #[source]
6835 io::Error,
6836 ),
6837 #[error("Dependency `{name}` has missing `version` field but has more than one matching package", name = name.cyan())]
6840 MissingDependencyVersion {
6841 name: PackageName,
6843 },
6844 #[error("Package `{name}` from a registry source has a missing `version` field", name = name.cyan())]
6847 MissingPackageVersion {
6848 name: PackageName,
6850 },
6851 #[error("Dependency `{name}` has missing `source` field but has more than one matching package", name = name.cyan())]
6854 MissingDependencySource {
6855 name: PackageName,
6857 },
6858 #[error("Could not compute relative path between workspace and requirement")]
6860 RequirementRelativePath(
6861 #[source]
6863 io::Error,
6864 ),
6865 #[error("Could not convert between URL and path")]
6867 RequirementVerbatimUrl(
6868 #[source]
6870 VerbatimUrlError,
6871 ),
6872 #[error("Could not convert between URL and path")]
6874 RegistryVerbatimUrl(
6875 #[source]
6877 VerbatimUrlError,
6878 ),
6879 #[error("Failed to convert path to URL: {path}", path = path.display().cyan())]
6881 PathToUrl { path: Box<Path> },
6882 #[error("Failed to convert URL to path: {url}", url = url.cyan())]
6884 UrlToPath { url: DisplaySafeUrl },
6885 #[error("Found multiple packages matching `{name}`", name = name.cyan())]
6888 MultipleRootPackages {
6889 name: PackageName,
6891 },
6892 #[error("Could not find root package `{name}`", name = name.cyan())]
6894 MissingRootPackage {
6895 name: PackageName,
6897 },
6898 #[error("Could not find root package `{id}` in lock", id = id.cyan())]
6900 RootPackageMissingFromLock {
6901 id: PackageId,
6903 },
6904 #[error(
6906 "Cannot materialize dependency `{dependency}` of `{package}` because its conflict marker depends on a package outside the selected subgraph",
6907 package = package.cyan(),
6908 dependency = dependency.cyan()
6909 )]
6910 DependencyConflictOutsideSubgraph {
6911 package: PackageId,
6913 dependency: PackageId,
6915 },
6916 #[error("Failed to generate package metadata for `{id}`", id = id.cyan())]
6918 Resolution {
6919 id: PackageId,
6921 #[source]
6923 err: uv_distribution::Error,
6924 },
6925 #[error("The entry for package `{name}` ({version}) has wheel `{wheel_filename}` with inconsistent version ({wheel_version}), which indicates a malformed wheel. If this is intentional, set `{env_var}`.", name = name.cyan(), wheel_filename = wheel.filename, wheel_version = wheel.filename.version, env_var = "UV_SKIP_WHEEL_FILENAME_CHECK=1".green())]
6928 InconsistentVersions {
6929 name: PackageName,
6931 version: Version,
6933 wheel: Wheel,
6935 },
6936 #[error(
6937 "Found conflicting extras `{package1}[{extra1}]` \
6938 and `{package2}[{extra2}]` enabled simultaneously"
6939 )]
6940 ConflictingExtra {
6941 package1: PackageName,
6942 extra1: ExtraName,
6943 package2: PackageName,
6944 extra2: ExtraName,
6945 },
6946 #[error(transparent)]
6947 GitUrlParse(#[from] GitUrlParseError),
6948 #[error("Failed to read `{path}`")]
6949 UnreadablePyprojectToml {
6950 path: PathBuf,
6951 #[source]
6952 err: std::io::Error,
6953 },
6954 #[error("Failed to parse `{path}`")]
6955 InvalidPyprojectToml {
6956 path: PathBuf,
6957 #[source]
6958 err: uv_pypi_types::MetadataError,
6959 },
6960 #[error("Workspace member `{id}` has non-local source", id = id.cyan())]
6962 NonLocalWorkspaceMember {
6963 id: PackageId,
6965 },
6966}
6967
6968#[derive(Debug, thiserror::Error)]
6970enum SourceParseError {
6971 #[error("Invalid URL in source `{given}`")]
6973 InvalidUrl {
6974 given: String,
6976 #[source]
6978 err: DisplaySafeUrlError,
6979 },
6980 #[error("Missing SHA in source `{given}`")]
6982 MissingSha {
6983 given: String,
6985 },
6986 #[error("Invalid SHA in source `{given}`")]
6988 InvalidSha {
6989 given: String,
6991 },
6992}
6993
6994#[derive(Clone, Debug, Eq, PartialEq)]
6996struct HashParseError(&'static str);
6997
6998impl std::error::Error for HashParseError {}
6999
7000impl Display for HashParseError {
7001 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
7002 Display::fmt(self.0, f)
7003 }
7004}
7005
7006fn each_element_on_its_line_array(elements: impl Iterator<Item = impl Into<Value>>) -> Array {
7017 let mut array = elements
7018 .map(|item| {
7019 let mut value = item.into();
7020 value.decor_mut().set_prefix("\n ");
7022 value
7023 })
7024 .collect::<Array>();
7025 array.set_trailing_comma(true);
7028 array.set_trailing("\n");
7030 array
7031}
7032
7033fn fork_markers_union(
7035 fork_markers: &[UniversalMarker],
7036 requires_python: &RequiresPython,
7037) -> MarkerTree {
7038 if fork_markers.is_empty() {
7039 return requires_python.to_marker_tree();
7040 }
7041 let mut environment = MarkerTree::FALSE;
7042 for fork_marker in fork_markers {
7043 environment.or(fork_marker.pep508());
7044 }
7045 environment
7046}
7047
7048fn simplify_dependency_marker(
7052 requires_python: &RequiresPython,
7053 environment: SimplifiedMarkerTree,
7054 parent: UniversalMarker,
7055 marker: UniversalMarker,
7056) -> UniversalMarker {
7057 let parent =
7058 SimplifiedMarkerTree::new(requires_python, parent.pep508()).as_simplified_marker_tree();
7059 let marker =
7060 SimplifiedMarkerTree::new(requires_python, marker.combined()).as_simplified_marker_tree();
7061 let marker = marker.restrict(parent);
7062
7063 let mut marker = SimplifiedMarkerTree::new(requires_python, marker);
7066 marker.and(environment);
7067 UniversalMarker::from_combined(marker.into_marker(requires_python))
7068}
7069
7070fn simplified_universal_markers(
7075 markers: &[UniversalMarker],
7076 requires_python: &RequiresPython,
7077) -> Vec<String> {
7078 canonical_marker_trees(markers, requires_python)
7079 .into_iter()
7080 .filter_map(MarkerTree::try_to_string)
7081 .collect()
7082}
7083
7084fn canonicalize_universal_markers(
7091 markers: &[UniversalMarker],
7092 requires_python: &RequiresPython,
7093) -> Vec<UniversalMarker> {
7094 canonical_marker_trees(markers, requires_python)
7095 .into_iter()
7096 .map(|marker| {
7097 let simplified = SimplifiedMarkerTree::new(requires_python, marker);
7098 UniversalMarker::from_combined(simplified.into_marker(requires_python))
7099 })
7100 .collect()
7101}
7102
7103fn canonical_marker_trees(
7105 markers: &[UniversalMarker],
7106 requires_python: &RequiresPython,
7107) -> Vec<MarkerTree> {
7108 let mut pep508_only = vec![];
7109 let mut seen = FxHashSet::default();
7110 for marker in markers {
7111 let simplified =
7112 SimplifiedMarkerTree::new(requires_python, marker.pep508()).as_simplified_marker_tree();
7113 if seen.insert(simplified) {
7114 pep508_only.push(simplified);
7115 }
7116 }
7117 let any_overlap = pep508_only
7118 .iter()
7119 .tuple_combinations()
7120 .any(|(&marker1, &marker2)| !marker1.is_disjoint(marker2));
7121 let markers = if !any_overlap {
7122 pep508_only
7123 } else {
7124 markers
7125 .iter()
7126 .map(|marker| {
7127 SimplifiedMarkerTree::new(requires_python, marker.combined())
7128 .as_simplified_marker_tree()
7129 })
7130 .collect()
7131 };
7132 markers
7133 .into_iter()
7134 .filter(|marker| !marker.is_true())
7135 .collect()
7136}
7137
7138fn is_wheel_unreachable_for_marker(
7146 filename: &WheelFilename,
7147 requires_python: &RequiresPython,
7148 marker: &UniversalMarker,
7149 tags: Option<&Tags>,
7150) -> bool {
7151 if let Some(tags) = tags
7152 && !filename.compatibility(tags).is_compatible()
7153 {
7154 return true;
7155 }
7156 if !requires_python.matches_wheel_tag(filename) {
7158 return true;
7159 }
7160
7161 let platform_tags = filename.platform_tags();
7170
7171 if platform_tags.iter().all(PlatformTag::is_any) {
7172 return false;
7173 }
7174
7175 if platform_tags.iter().all(PlatformTag::is_linux) {
7176 if platform_tags.iter().all(PlatformTag::is_arm) {
7177 if marker.is_disjoint(*LINUX_ARM_MARKERS) {
7178 return true;
7179 }
7180 } else if platform_tags.iter().all(PlatformTag::is_x86_64) {
7181 if marker.is_disjoint(*LINUX_X86_64_MARKERS) {
7182 return true;
7183 }
7184 } else if platform_tags.iter().all(PlatformTag::is_x86) {
7185 if marker.is_disjoint(*LINUX_X86_MARKERS) {
7186 return true;
7187 }
7188 } else if platform_tags.iter().all(PlatformTag::is_ppc64le) {
7189 if marker.is_disjoint(*LINUX_PPC64LE_MARKERS) {
7190 return true;
7191 }
7192 } else if platform_tags.iter().all(PlatformTag::is_ppc64) {
7193 if marker.is_disjoint(*LINUX_PPC64_MARKERS) {
7194 return true;
7195 }
7196 } else if platform_tags.iter().all(PlatformTag::is_s390x) {
7197 if marker.is_disjoint(*LINUX_S390X_MARKERS) {
7198 return true;
7199 }
7200 } else if platform_tags.iter().all(PlatformTag::is_riscv64) {
7201 if marker.is_disjoint(*LINUX_RISCV64_MARKERS) {
7202 return true;
7203 }
7204 } else if platform_tags.iter().all(PlatformTag::is_loongarch64) {
7205 if marker.is_disjoint(*LINUX_LOONGARCH64_MARKERS) {
7206 return true;
7207 }
7208 } else if platform_tags.iter().all(PlatformTag::is_armv7l) {
7209 if marker.is_disjoint(*LINUX_ARMV7L_MARKERS) {
7210 return true;
7211 }
7212 } else if platform_tags.iter().all(PlatformTag::is_armv6l) {
7213 if marker.is_disjoint(*LINUX_ARMV6L_MARKERS) {
7214 return true;
7215 }
7216 } else if marker.is_disjoint(*LINUX_MARKERS) {
7217 return true;
7218 }
7219 }
7220
7221 if platform_tags.iter().all(PlatformTag::is_windows) {
7222 if platform_tags.iter().all(PlatformTag::is_arm) {
7223 if marker.is_disjoint(*WINDOWS_ARM_MARKERS) {
7224 return true;
7225 }
7226 } else if platform_tags.iter().all(PlatformTag::is_x86_64) {
7227 if marker.is_disjoint(*WINDOWS_X86_64_MARKERS) {
7228 return true;
7229 }
7230 } else if platform_tags.iter().all(PlatformTag::is_x86) {
7231 if marker.is_disjoint(*WINDOWS_X86_MARKERS) {
7232 return true;
7233 }
7234 } else if marker.is_disjoint(*WINDOWS_MARKERS) {
7235 return true;
7236 }
7237 }
7238
7239 if platform_tags.iter().all(PlatformTag::is_macos) {
7240 if platform_tags.iter().all(PlatformTag::is_arm) {
7241 if marker.is_disjoint(*MAC_ARM_MARKERS) {
7242 return true;
7243 }
7244 } else if platform_tags.iter().all(PlatformTag::is_x86_64) {
7245 if marker.is_disjoint(*MAC_X86_64_MARKERS) {
7246 return true;
7247 }
7248 } else if platform_tags.iter().all(PlatformTag::is_x86) {
7249 if marker.is_disjoint(*MAC_X86_MARKERS) {
7250 return true;
7251 }
7252 } else if marker.is_disjoint(*MAC_MARKERS) {
7253 return true;
7254 }
7255 }
7256
7257 if platform_tags.iter().all(PlatformTag::is_android) {
7258 if platform_tags.iter().all(PlatformTag::is_arm) {
7259 if marker.is_disjoint(*ANDROID_ARM_MARKERS) {
7260 return true;
7261 }
7262 } else if platform_tags.iter().all(PlatformTag::is_x86_64) {
7263 if marker.is_disjoint(*ANDROID_X86_64_MARKERS) {
7264 return true;
7265 }
7266 } else if platform_tags.iter().all(PlatformTag::is_x86) {
7267 if marker.is_disjoint(*ANDROID_X86_MARKERS) {
7268 return true;
7269 }
7270 } else if marker.is_disjoint(*ANDROID_MARKERS) {
7271 return true;
7272 }
7273 }
7274
7275 if platform_tags.iter().all(PlatformTag::is_arm) {
7276 if marker.is_disjoint(*ARM_MARKERS) {
7277 return true;
7278 }
7279 }
7280
7281 if platform_tags.iter().all(PlatformTag::is_x86_64) {
7282 if marker.is_disjoint(*X86_64_MARKERS) {
7283 return true;
7284 }
7285 }
7286
7287 if platform_tags.iter().all(PlatformTag::is_x86) {
7288 if marker.is_disjoint(*X86_MARKERS) {
7289 return true;
7290 }
7291 }
7292
7293 if platform_tags.iter().all(PlatformTag::is_ppc64le) {
7294 if marker.is_disjoint(*PPC64LE_MARKERS) {
7295 return true;
7296 }
7297 }
7298
7299 if platform_tags.iter().all(PlatformTag::is_ppc64) {
7300 if marker.is_disjoint(*PPC64_MARKERS) {
7301 return true;
7302 }
7303 }
7304
7305 if platform_tags.iter().all(PlatformTag::is_s390x) {
7306 if marker.is_disjoint(*S390X_MARKERS) {
7307 return true;
7308 }
7309 }
7310
7311 if platform_tags.iter().all(PlatformTag::is_riscv64) {
7312 if marker.is_disjoint(*RISCV64_MARKERS) {
7313 return true;
7314 }
7315 }
7316
7317 if platform_tags.iter().all(PlatformTag::is_loongarch64) {
7318 if marker.is_disjoint(*LOONGARCH64_MARKERS) {
7319 return true;
7320 }
7321 }
7322
7323 if platform_tags.iter().all(PlatformTag::is_armv7l) {
7324 if marker.is_disjoint(*ARMV7L_MARKERS) {
7325 return true;
7326 }
7327 }
7328
7329 if platform_tags.iter().all(PlatformTag::is_armv6l) {
7330 if marker.is_disjoint(*ARMV6L_MARKERS) {
7331 return true;
7332 }
7333 }
7334
7335 false
7336}
7337
7338pub(crate) fn is_wheel_unreachable(
7339 filename: &WheelFilename,
7340 graph: &ResolverOutput,
7341 requires_python: &RequiresPython,
7342 node_index: NodeIndex,
7343 tags: Option<&Tags>,
7344) -> bool {
7345 is_wheel_unreachable_for_marker(
7346 filename,
7347 requires_python,
7348 graph.graph[node_index].marker(),
7349 tags,
7350 )
7351}
7352
7353#[cfg(test)]
7354mod tests {
7355 use uv_pep440::VersionSpecifiers;
7356 use uv_pep508::MarkerEnvironmentBuilder;
7357 use uv_warnings::anstream;
7358
7359 use super::*;
7360
7361 macro_rules! assert_stripped_snapshot {
7363 ($expr:expr, @$snapshot:literal) => {{
7364 let expr = format!("{}", $expr);
7365 let expr = format!("{}", anstream::adapter::strip_str(&expr));
7366 insta::assert_snapshot!(expr, @$snapshot);
7367 }};
7368 }
7369
7370 fn marker_environment() -> MarkerEnvironment {
7371 MarkerEnvironment::try_from(MarkerEnvironmentBuilder {
7372 implementation_name: "cpython",
7373 implementation_version: "3.12.0",
7374 os_name: "posix",
7375 platform_machine: "arm64",
7376 platform_python_implementation: "CPython",
7377 platform_release: "23.0.0",
7378 platform_system: "Darwin",
7379 platform_version: "test",
7380 python_full_version: "3.12.0",
7381 python_version: "3.12",
7382 sys_platform: "darwin",
7383 })
7384 .expect("valid marker environment")
7385 }
7386
7387 #[test]
7388 fn dependency_marker_preserves_parent_conflicts() {
7389 let requires_python = RequiresPython::from_specifiers(
7390 &VersionSpecifiers::from_str(">=3.12").expect("valid version specifier"),
7391 );
7392 let parent = UniversalMarker::from_combined(
7393 MarkerTree::from_str(
7394 "python_full_version >= '3.12' and sys_platform == 'darwin' and extra != 'extra-1-x-foo'",
7395 )
7396 .expect("valid parent marker"),
7397 );
7398 let environment = SimplifiedMarkerTree::new(&requires_python, MarkerTree::TRUE);
7399
7400 let marker = simplify_dependency_marker(&requires_python, environment, parent, parent);
7401
7402 assert_eq!(
7403 marker.combined().try_to_string().as_deref(),
7404 Some("python_full_version >= '3.12' and extra != 'extra-1-x-foo'")
7405 );
7406 }
7407
7408 #[test]
7409 fn dependency_selection_resolves_included_groups_to_same_package() {
7410 let lock: Lock = toml::from_str(
7411 r#"
7412version = 1
7413revision = 3
7414requires-python = ">=3.12"
7415
7416[[package]]
7417name = "project"
7418version = "0.1.0"
7419source = { virtual = "." }
7420dependencies = [{ name = "ty" }]
7421
7422[package.dependency-groups]
7423dev = [{ name = "ty" }]
7424typing = [{ name = "ty" }]
7425
7426[[package]]
7427name = "ty"
7428version = "1.0.0"
7429source = { registry = "https://example.com/simple" }
7430"#,
7431 )
7432 .expect("valid lock");
7433 let project_name = PackageName::from_str("project").expect("valid package name");
7434 let dependency_name = PackageName::from_str("ty").expect("valid package name");
7435 let dev = GroupName::from_str("dev").expect("valid group name");
7436 let typing = GroupName::from_str("typing").expect("valid group name");
7437 let marker_environment = marker_environment();
7438
7439 let selection = lock
7440 .dependency_selection(Some(&project_name), &dependency_name, &marker_environment)
7441 .expect("unique project package");
7442 let preferred = selection.group(&dev).expect("dev dependency");
7443 let included = selection.group(&typing).expect("typing dependency");
7444 let production = selection.production().expect("production dependency");
7445
7446 assert!(std::ptr::eq(preferred, included));
7447 assert!(std::ptr::eq(preferred, production));
7448 }
7449
7450 #[test]
7451 fn dependency_selection_resolves_lock_manifest_requirement() {
7452 let lock: Lock = toml::from_str(
7453 r#"
7454version = 1
7455revision = 3
7456requires-python = ">=3.12"
7457
7458[manifest]
7459requirements = [{ name = "ty" }]
7460
7461[[package]]
7462name = "ty"
7463version = "1.0.0"
7464source = { registry = "https://example.com/simple" }
7465"#,
7466 )
7467 .expect("valid lock");
7468 let dependency_name = PackageName::from_str("ty").expect("valid package name");
7469 let marker_environment = marker_environment();
7470
7471 let selection = lock
7472 .dependency_selection(None, &dependency_name, &marker_environment)
7473 .expect("unique root package");
7474 let root = selection.root().expect("root dependency");
7475
7476 assert_eq!(root.name(), &dependency_name);
7477 assert!(selection.production().is_none());
7478 }
7479
7480 #[test]
7481 fn dependency_selection_returns_any_selection_error() {
7482 let lock: Lock = toml::from_str(
7483 r#"
7484version = 1
7485revision = 3
7486requires-python = ">=3.12"
7487
7488[[package]]
7489name = "project"
7490version = "0.1.0"
7491source = { virtual = "." }
7492dependencies = [
7493 { name = "ty", version = "1.0.0", source = { registry = "https://example.com/simple" } },
7494 { name = "ty", version = "2.0.0", source = { registry = "https://example.com/simple" } },
7495]
7496
7497[package.dependency-groups]
7498dev = [
7499 { name = "ty", version = "1.0.0", source = { registry = "https://example.com/simple" } },
7500]
7501
7502[[package]]
7503name = "ty"
7504version = "1.0.0"
7505source = { registry = "https://example.com/simple" }
7506
7507[[package]]
7508name = "ty"
7509version = "2.0.0"
7510source = { registry = "https://example.com/simple" }
7511"#,
7512 )
7513 .expect("valid lock");
7514 let project_name = PackageName::from_str("project").expect("valid package name");
7515 let dependency_name = PackageName::from_str("ty").expect("valid package name");
7516 let marker_environment = marker_environment();
7517
7518 let error = lock
7519 .dependency_selection(Some(&project_name), &dependency_name, &marker_environment)
7520 .expect_err("ambiguous production selection");
7521 insta::assert_snapshot!(error, @"found multiple packages matching production dependency `ty` for `project`");
7522 }
7523
7524 #[test]
7525 fn missing_dependency_source_unambiguous() {
7526 let data = r#"
7527version = 1
7528requires-python = ">=3.12"
7529
7530[[package]]
7531name = "a"
7532version = "0.1.0"
7533source = { registry = "https://pypi.org/simple" }
7534sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7535
7536[[package]]
7537name = "b"
7538version = "0.1.0"
7539source = { registry = "https://pypi.org/simple" }
7540sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7541
7542[[package.dependencies]]
7543name = "a"
7544version = "0.1.0"
7545"#;
7546 let result: Result<Lock, _> = toml::from_str(data);
7547 insta::assert_debug_snapshot!(result);
7548 }
7549
7550 #[test]
7551 fn missing_dependency_version_unambiguous() {
7552 let data = r#"
7553version = 1
7554requires-python = ">=3.12"
7555
7556[[package]]
7557name = "a"
7558version = "0.1.0"
7559source = { registry = "https://pypi.org/simple" }
7560sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7561
7562[[package]]
7563name = "b"
7564version = "0.1.0"
7565source = { registry = "https://pypi.org/simple" }
7566sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7567
7568[[package.dependencies]]
7569name = "a"
7570source = { registry = "https://pypi.org/simple" }
7571"#;
7572 let result: Result<Lock, _> = toml::from_str(data);
7573 insta::assert_debug_snapshot!(result);
7574 }
7575
7576 #[test]
7577 fn missing_dependency_source_version_unambiguous() {
7578 let data = r#"
7579version = 1
7580requires-python = ">=3.12"
7581
7582[[package]]
7583name = "a"
7584version = "0.1.0"
7585source = { registry = "https://pypi.org/simple" }
7586sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7587
7588[[package]]
7589name = "b"
7590version = "0.1.0"
7591source = { registry = "https://pypi.org/simple" }
7592sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7593
7594[[package.dependencies]]
7595name = "a"
7596"#;
7597 let result: Result<Lock, _> = toml::from_str(data);
7598 insta::assert_debug_snapshot!(result);
7599 }
7600
7601 #[test]
7602 fn missing_dependency_source_ambiguous() {
7603 let data = r#"
7604version = 1
7605requires-python = ">=3.12"
7606
7607[[package]]
7608name = "a"
7609version = "0.1.0"
7610source = { registry = "https://pypi.org/simple" }
7611sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7612
7613[[package]]
7614name = "a"
7615version = "0.1.1"
7616source = { registry = "https://pypi.org/simple" }
7617sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7618
7619[[package]]
7620name = "b"
7621version = "0.1.0"
7622source = { registry = "https://pypi.org/simple" }
7623sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7624
7625[[package.dependencies]]
7626name = "a"
7627version = "0.1.0"
7628"#;
7629 let result = toml::from_str::<Lock>(data).unwrap_err();
7630 assert_stripped_snapshot!(result, @"Dependency `a` has missing `source` field but has more than one matching package");
7631 }
7632
7633 #[test]
7634 fn missing_dependency_version_ambiguous() {
7635 let data = r#"
7636version = 1
7637requires-python = ">=3.12"
7638
7639[[package]]
7640name = "a"
7641version = "0.1.0"
7642source = { registry = "https://pypi.org/simple" }
7643sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7644
7645[[package]]
7646name = "a"
7647version = "0.1.1"
7648source = { registry = "https://pypi.org/simple" }
7649sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7650
7651[[package]]
7652name = "b"
7653version = "0.1.0"
7654source = { registry = "https://pypi.org/simple" }
7655sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7656
7657[[package.dependencies]]
7658name = "a"
7659source = { registry = "https://pypi.org/simple" }
7660"#;
7661 let result = toml::from_str::<Lock>(data).unwrap_err();
7662 assert_stripped_snapshot!(result, @"Dependency `a` has missing `version` field but has more than one matching package");
7663 }
7664
7665 #[test]
7666 fn missing_package_version_registry() {
7667 let data = r#"
7668version = 1
7669requires-python = ">=3.12"
7670
7671[[package]]
7672name = "a"
7673source = { registry = "https://pypi.org/simple" }
7674sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7675"#;
7676 let result = toml::from_str::<Lock>(data).unwrap_err();
7677 assert_stripped_snapshot!(result, @"Package `a` from a registry source has a missing `version` field");
7678 }
7679
7680 #[test]
7681 fn missing_dependency_source_version_ambiguous() {
7682 let data = r#"
7683version = 1
7684requires-python = ">=3.12"
7685
7686[[package]]
7687name = "a"
7688version = "0.1.0"
7689source = { registry = "https://pypi.org/simple" }
7690sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7691
7692[[package]]
7693name = "a"
7694version = "0.1.1"
7695source = { registry = "https://pypi.org/simple" }
7696sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7697
7698[[package]]
7699name = "b"
7700version = "0.1.0"
7701source = { registry = "https://pypi.org/simple" }
7702sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7703
7704[[package.dependencies]]
7705name = "a"
7706"#;
7707 let result = toml::from_str::<Lock>(data).unwrap_err();
7708 assert_stripped_snapshot!(result, @"Dependency `a` has missing `source` field but has more than one matching package");
7709 }
7710
7711 #[test]
7712 fn missing_dependency_version_dynamic() {
7713 let data = r#"
7714version = 1
7715requires-python = ">=3.12"
7716
7717[[package]]
7718name = "a"
7719source = { editable = "path/to/a" }
7720
7721[[package]]
7722name = "a"
7723version = "0.1.1"
7724source = { registry = "https://pypi.org/simple" }
7725sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7726
7727[[package]]
7728name = "b"
7729version = "0.1.0"
7730source = { registry = "https://pypi.org/simple" }
7731sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7732
7733[[package.dependencies]]
7734name = "a"
7735source = { editable = "path/to/a" }
7736"#;
7737 let result = toml::from_str::<Lock>(data);
7738 insta::assert_debug_snapshot!(result);
7739 }
7740
7741 #[test]
7742 fn hash_optional_missing() {
7743 let data = r#"
7744version = 1
7745requires-python = ">=3.12"
7746
7747[[package]]
7748name = "anyio"
7749version = "4.3.0"
7750source = { registry = "https://pypi.org/simple" }
7751wheels = [{ url = "https://files.pythonhosted.org/packages/14/fd/2f20c40b45e4fb4324834aea24bd4afdf1143390242c0b33774da0e2e34f/anyio-4.3.0-py3-none-any.whl" }]
7752"#;
7753 let result: Result<Lock, _> = toml::from_str(data);
7754 insta::assert_debug_snapshot!(result);
7755 }
7756
7757 #[test]
7758 fn hash_optional_present() {
7759 let data = r#"
7760version = 1
7761requires-python = ">=3.12"
7762
7763[[package]]
7764name = "anyio"
7765version = "4.3.0"
7766source = { registry = "https://pypi.org/simple" }
7767wheels = [{ url = "https://files.pythonhosted.org/packages/14/fd/2f20c40b45e4fb4324834aea24bd4afdf1143390242c0b33774da0e2e34f/anyio-4.3.0-py3-none-any.whl", hash = "sha256:048e05d0f6caeed70d731f3db756d35dcc1f35747c8c403364a8332c630441b8" }]
7768"#;
7769 let result: Result<Lock, _> = toml::from_str(data);
7770 insta::assert_debug_snapshot!(result);
7771 }
7772
7773 #[test]
7774 fn hash_required_present() {
7775 let data = r#"
7776version = 1
7777requires-python = ">=3.12"
7778
7779[[package]]
7780name = "anyio"
7781version = "4.3.0"
7782source = { path = "file:///foo/bar" }
7783wheels = [{ url = "file:///foo/bar/anyio-4.3.0-py3-none-any.whl", hash = "sha256:048e05d0f6caeed70d731f3db756d35dcc1f35747c8c403364a8332c630441b8" }]
7784"#;
7785 let result: Result<Lock, _> = toml::from_str(data);
7786 insta::assert_debug_snapshot!(result);
7787 }
7788
7789 #[test]
7790 fn source_direct_no_subdir() {
7791 let data = r#"
7792version = 1
7793requires-python = ">=3.12"
7794
7795[[package]]
7796name = "anyio"
7797version = "4.3.0"
7798source = { url = "https://burntsushi.net" }
7799"#;
7800 let result: Result<Lock, _> = toml::from_str(data);
7801 insta::assert_debug_snapshot!(result);
7802 }
7803
7804 #[test]
7805 fn source_direct_has_subdir() {
7806 let data = r#"
7807version = 1
7808requires-python = ">=3.12"
7809
7810[[package]]
7811name = "anyio"
7812version = "4.3.0"
7813source = { url = "https://burntsushi.net", subdirectory = "wat/foo/bar" }
7814"#;
7815 let result: Result<Lock, _> = toml::from_str(data);
7816 insta::assert_debug_snapshot!(result);
7817 }
7818
7819 #[test]
7820 fn source_directory() {
7821 let data = r#"
7822version = 1
7823requires-python = ">=3.12"
7824
7825[[package]]
7826name = "anyio"
7827version = "4.3.0"
7828source = { directory = "path/to/dir" }
7829"#;
7830 let result: Result<Lock, _> = toml::from_str(data);
7831 insta::assert_debug_snapshot!(result);
7832 }
7833
7834 #[test]
7835 fn source_editable() {
7836 let data = r#"
7837version = 1
7838requires-python = ">=3.12"
7839
7840[[package]]
7841name = "anyio"
7842version = "4.3.0"
7843source = { editable = "path/to/dir" }
7844"#;
7845 let result: Result<Lock, _> = toml::from_str(data);
7846 insta::assert_debug_snapshot!(result);
7847 }
7848
7849 #[test]
7852 fn registry_source_windows_drive_letter() {
7853 let data = r#"
7854version = 1
7855requires-python = ">=3.12"
7856
7857[[package]]
7858name = "tqdm"
7859version = "1000.0.0"
7860source = { registry = "C:/Users/user/links" }
7861wheels = [
7862 { path = "C:/Users/user/links/tqdm-1000.0.0-py3-none-any.whl" },
7863]
7864"#;
7865 let lock: Lock = toml::from_str(data).unwrap();
7866 assert_eq!(
7867 lock.packages[0].id.source,
7868 Source::Registry(RegistrySource::Path(
7869 Path::new("C:/Users/user/links").into()
7870 ))
7871 );
7872 }
7873}