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, ExtrasSpecificationWithDefaults,
24 InstallTarget,
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
306impl Lock {
307 pub fn from_resolution(
309 resolution: &ResolverOutput,
310 root: &Path,
311 supported_environments: Vec<MarkerTree>,
312 ) -> Result<Self, LockError> {
313 let mut packages = BTreeMap::new();
314 let requires_python = resolution.requires_python.clone();
315 let supported_environments = supported_environments
316 .into_iter()
317 .map(|marker| requires_python.complexify_markers(marker))
318 .collect::<Vec<_>>();
319 let supported_environments_marker = if supported_environments.is_empty() {
320 None
321 } else {
322 let mut combined = MarkerTree::FALSE;
323 for marker in &supported_environments {
324 combined.or(*marker);
325 }
326 Some(UniversalMarker::new(combined, ConflictMarker::TRUE))
327 };
328
329 let mut seen = FxHashSet::default();
331 let mut duplicates = FxHashSet::default();
332 for node_index in resolution.graph.node_indices() {
333 let ResolutionGraphNode::Dist(dist) = &resolution.graph[node_index] else {
334 continue;
335 };
336 if !dist.is_base() {
337 continue;
338 }
339 if !seen.insert(dist.name()) {
340 duplicates.insert(dist.name());
341 }
342 }
343
344 for node_index in resolution.graph.node_indices() {
346 let ResolutionGraphNode::Dist(dist) = &resolution.graph[node_index] else {
347 continue;
348 };
349 if !dist.is_base() {
350 continue;
351 }
352
353 let fork_markers = if duplicates.contains(dist.name()) {
359 let fork_markers = resolution
360 .fork_markers
361 .iter()
362 .filter(|fork_markers| !fork_markers.is_disjoint(dist.marker))
363 .copied()
364 .collect::<Vec<_>>();
365 canonicalize_universal_markers(&fork_markers, &requires_python)
366 } else {
367 vec![]
368 };
369
370 let mut package = Package::from_annotated_dist(dist, fork_markers, root)?;
371 let mut wheel_marker = dist.marker;
372 if let Some(supported_environments_marker) = supported_environments_marker {
373 wheel_marker.and(supported_environments_marker);
374 }
375 let wheels = &mut package.wheels;
376 wheels.retain(|wheel| {
377 !is_wheel_unreachable_for_marker(
378 &wheel.filename,
379 &requires_python,
380 &wheel_marker,
381 None,
382 )
383 });
384
385 for edge in resolution.graph.edges(node_index) {
387 let ResolutionGraphNode::Dist(dependency_dist) = &resolution.graph[edge.target()]
388 else {
389 continue;
390 };
391 let marker = *edge.weight();
392 package.add_dependency(&requires_python, dependency_dist, marker, root)?;
393 }
394
395 let id = package.id.clone();
396 if let Some(locked_dist) = packages.insert(id, package) {
397 return Err(LockErrorKind::DuplicatePackage {
398 id: locked_dist.id.clone(),
399 }
400 .into());
401 }
402 }
403
404 for node_index in resolution.graph.node_indices() {
406 let ResolutionGraphNode::Dist(dist) = &resolution.graph[node_index] else {
407 continue;
408 };
409 if let Some(extra) = dist.extra.as_ref() {
410 let id = PackageId::from_annotated_dist(dist, root)?;
411 let Some(package) = packages.get_mut(&id) else {
412 return Err(LockErrorKind::MissingExtraBase {
413 id,
414 extra: extra.clone(),
415 }
416 .into());
417 };
418 for edge in resolution.graph.edges(node_index) {
419 let ResolutionGraphNode::Dist(dependency_dist) =
420 &resolution.graph[edge.target()]
421 else {
422 continue;
423 };
424 let marker = *edge.weight();
425 package.add_optional_dependency(
426 &requires_python,
427 extra.clone(),
428 dependency_dist,
429 marker,
430 root,
431 )?;
432 }
433 }
434 if let Some(group) = dist.group.as_ref() {
435 let id = PackageId::from_annotated_dist(dist, root)?;
436 let Some(package) = packages.get_mut(&id) else {
437 return Err(LockErrorKind::MissingDevBase {
438 id,
439 group: group.clone(),
440 }
441 .into());
442 };
443 for edge in resolution.graph.edges(node_index) {
444 let ResolutionGraphNode::Dist(dependency_dist) =
445 &resolution.graph[edge.target()]
446 else {
447 continue;
448 };
449 let marker = *edge.weight();
450 package.add_group_dependency(
451 &requires_python,
452 group.clone(),
453 dependency_dist,
454 marker,
455 root,
456 )?;
457 }
458 }
459 }
460
461 let packages = packages.into_values().collect();
462
463 let options = ResolverOptions {
464 resolution_mode: resolution.options.resolution_mode,
465 prerelease_mode: resolution.options.prerelease_mode,
466 fork_strategy: resolution.options.fork_strategy,
467 exclude_newer: resolution.options.exclude_newer.clone().into(),
468 };
469 let fork_markers =
474 canonicalize_universal_markers(&resolution.fork_markers, &requires_python);
475 let lock = Self::new(
476 VERSION,
477 REVISION,
478 packages,
479 requires_python,
480 options,
481 ResolverManifest::default(),
482 Conflicts::empty(),
483 supported_environments,
484 vec![],
485 fork_markers,
486 )?;
487 Ok(lock)
488 }
489
490 fn new(
492 version: u32,
493 revision: u32,
494 mut packages: Vec<Package>,
495 requires_python: RequiresPython,
496 options: ResolverOptions,
497 manifest: ResolverManifest,
498 conflicts: Conflicts,
499 supported_environments: Vec<MarkerTree>,
500 required_environments: Vec<MarkerTree>,
501 fork_markers: Vec<UniversalMarker>,
502 ) -> Result<Self, LockError> {
503 for package in &mut packages {
506 package.dependencies.sort();
507 for [dep1, dep2] in package.dependencies.array_windows() {
508 if dep1 == dep2 {
509 return Err(LockErrorKind::DuplicateDependency {
510 id: package.id.clone(),
511 dependency: dep1.clone(),
512 }
513 .into());
514 }
515 }
516
517 for (extra, dependencies) in &mut package.optional_dependencies {
519 dependencies.sort();
520 for [dep1, dep2] in dependencies.array_windows() {
521 if dep1 == dep2 {
522 return Err(LockErrorKind::DuplicateOptionalDependency {
523 id: package.id.clone(),
524 extra: extra.clone(),
525 dependency: dep1.clone(),
526 }
527 .into());
528 }
529 }
530 }
531
532 for (group, dependencies) in &mut package.dependency_groups {
534 dependencies.sort();
535 for [dep1, dep2] in dependencies.array_windows() {
536 if dep1 == dep2 {
537 return Err(LockErrorKind::DuplicateDevDependency {
538 id: package.id.clone(),
539 group: group.clone(),
540 dependency: dep1.clone(),
541 }
542 .into());
543 }
544 }
545 }
546 }
547 packages.sort_by(|dist1, dist2| dist1.id.cmp(&dist2.id));
548
549 let mut by_id = FxHashMap::default();
552 for (i, dist) in packages.iter().enumerate() {
553 if by_id.insert(dist.id.clone(), i).is_some() {
554 return Err(LockErrorKind::DuplicatePackage {
555 id: dist.id.clone(),
556 }
557 .into());
558 }
559 }
560
561 let mut extras_by_id = FxHashMap::default();
563 for dist in &packages {
564 for extra in dist.optional_dependencies.keys() {
565 extras_by_id
566 .entry(dist.id.clone())
567 .or_insert_with(FxHashSet::default)
568 .insert(extra.clone());
569 }
570 }
571
572 for dist in &mut packages {
574 for dep in dist
575 .dependencies
576 .iter_mut()
577 .chain(dist.optional_dependencies.values_mut().flatten())
578 .chain(dist.dependency_groups.values_mut().flatten())
579 {
580 dep.extra.retain(|extra| {
581 extras_by_id
582 .get(&dep.package_id)
583 .is_some_and(|extras| extras.contains(extra))
584 });
585 }
586 }
587
588 for dist in &packages {
592 for dep in &dist.dependencies {
593 if !by_id.contains_key(&dep.package_id) {
594 return Err(LockErrorKind::UnrecognizedDependency {
595 id: dist.id.clone(),
596 dependency: dep.clone(),
597 }
598 .into());
599 }
600 }
601
602 for dependencies in dist.optional_dependencies.values() {
604 for dep in dependencies {
605 if !by_id.contains_key(&dep.package_id) {
606 return Err(LockErrorKind::UnrecognizedDependency {
607 id: dist.id.clone(),
608 dependency: dep.clone(),
609 }
610 .into());
611 }
612 }
613 }
614
615 for dependencies in dist.dependency_groups.values() {
617 for dep in dependencies {
618 if !by_id.contains_key(&dep.package_id) {
619 return Err(LockErrorKind::UnrecognizedDependency {
620 id: dist.id.clone(),
621 dependency: dep.clone(),
622 }
623 .into());
624 }
625 }
626 }
627
628 if let Some(requires_hash) = dist.id.source.requires_hash() {
631 for wheel in &dist.wheels {
632 if requires_hash != wheel.hash.is_some() {
633 return Err(LockErrorKind::Hash {
634 id: dist.id.clone(),
635 artifact_type: "wheel",
636 expected: requires_hash,
637 }
638 .into());
639 }
640 }
641 }
642 }
643 let lock = Self {
644 version,
645 revision,
646 fork_markers,
647 conflicts,
648 supported_environments,
649 required_environments,
650 requires_python,
651 options,
652 packages,
653 by_id,
654 manifest,
655 };
656 Ok(lock)
657 }
658
659 #[must_use]
661 pub fn with_manifest(mut self, manifest: ResolverManifest) -> Self {
662 self.manifest = manifest;
663 self
664 }
665
666 #[must_use]
668 pub fn with_conflicts(mut self, conflicts: Conflicts) -> Self {
669 self.conflicts = conflicts;
670 self
671 }
672
673 #[must_use]
675 pub fn with_required_environments(mut self, required_environments: Vec<MarkerTree>) -> Self {
676 self.required_environments = required_environments
677 .into_iter()
678 .map(|marker| self.requires_python.complexify_markers(marker))
679 .collect();
680 self
681 }
682
683 pub fn supports_provides_extra(&self) -> bool {
685 (self.version(), self.revision()) >= (1, 1)
687 }
688
689 fn includes_empty_groups(&self) -> bool {
691 (self.version(), self.revision()) >= (1, 1)
694 }
695
696 pub fn version(&self) -> u32 {
698 self.version
699 }
700
701 fn revision(&self) -> u32 {
703 self.revision
704 }
705
706 pub fn len(&self) -> usize {
708 self.packages.len()
709 }
710
711 pub fn is_empty(&self) -> bool {
713 self.packages.is_empty()
714 }
715
716 pub fn packages(&self) -> &[Package] {
718 &self.packages
719 }
720
721 pub fn requires_python(&self) -> &RequiresPython {
723 &self.requires_python
724 }
725
726 pub fn resolution_mode(&self) -> ResolutionMode {
728 self.options.resolution_mode
729 }
730
731 pub fn prerelease_mode(&self) -> PrereleaseMode {
733 self.options.prerelease_mode
734 }
735
736 pub fn fork_strategy(&self) -> ForkStrategy {
738 self.options.fork_strategy
739 }
740
741 pub fn exclude_newer(&self) -> ExcludeNewer {
743 self.options.exclude_newer.clone().into()
746 }
747
748 pub fn conflicts(&self) -> &Conflicts {
750 &self.conflicts
751 }
752
753 pub fn supported_environments(&self) -> &[MarkerTree] {
755 &self.supported_environments
756 }
757
758 fn required_environments(&self) -> &[MarkerTree] {
760 &self.required_environments
761 }
762
763 pub fn members(&self) -> &BTreeSet<PackageName> {
765 &self.manifest.members
766 }
767
768 fn requirements(&self) -> &BTreeSet<Requirement> {
770 &self.manifest.requirements
771 }
772
773 pub(crate) fn dependency_groups(&self) -> &BTreeMap<GroupName, BTreeSet<Requirement>> {
775 &self.manifest.dependency_groups
776 }
777
778 pub fn build_constraints(&self, root: &Path) -> Constraints {
780 Constraints::from_requirements(
781 self.manifest
782 .build_constraints
783 .iter()
784 .cloned()
785 .map(|requirement| requirement.to_absolute(root)),
786 )
787 }
788
789 pub fn auditable<'lock>(
796 &'lock self,
797 extras: &'lock ExtrasSpecificationWithDefaults,
798 groups: &'lock DependencyGroupsWithDefaults,
799 collect_filter: impl Fn(&Package) -> bool,
800 ) -> Auditable<'lock> {
801 let mut by_name_version: BTreeMap<(&PackageName, &Version), &Package> = BTreeMap::default();
806 self.walk_auditable(extras, groups, collect_filter, |package, version| {
807 by_name_version
808 .entry((package.name(), version))
809 .or_insert(package);
810 });
811 let packages = by_name_version
812 .into_iter()
813 .map(|((_, version), package)| (package, version))
814 .collect();
815 Auditable { packages }
816 }
817
818 fn walk_auditable<'lock, F>(
828 &'lock self,
829 extras: &'lock ExtrasSpecificationWithDefaults,
830 groups: &'lock DependencyGroupsWithDefaults,
831 collect_filter: impl Fn(&Package) -> bool,
832 mut visit: F,
833 ) where
834 F: FnMut(&'lock Package, &'lock Version),
835 {
836 fn enqueue_dep<'lock>(
838 lock: &'lock Lock,
839 seen: &mut FxHashSet<(&'lock PackageId, Option<&'lock ExtraName>)>,
840 queue: &mut VecDeque<(&'lock Package, Option<&'lock ExtraName>)>,
841 dep: &'lock Dependency,
842 ) {
843 let dep_pkg = lock.find_by_id(&dep.package_id);
844 for maybe_extra in std::iter::once(None).chain(dep.extra.iter().map(Some)) {
845 if seen.insert((&dep.package_id, maybe_extra)) {
846 queue.push_back((dep_pkg, maybe_extra));
847 }
848 }
849 }
850
851 let workspace_member_ids: FxHashSet<&PackageId> = if self.members().is_empty() {
853 self.root().into_iter().map(|package| &package.id).collect()
854 } else {
855 self.packages
856 .iter()
857 .filter(|package| self.members().contains(&package.id.name))
858 .map(|package| &package.id)
859 .collect()
860 };
861
862 let mut queue: VecDeque<(&Package, Option<&ExtraName>)> = VecDeque::new();
864 let mut seen: FxHashSet<(&PackageId, Option<&ExtraName>)> = FxHashSet::default();
865
866 for package in self
869 .packages
870 .iter()
871 .filter(|p| workspace_member_ids.contains(&p.id))
872 {
873 if seen.insert((&package.id, None)) {
874 queue.push_back((package, None));
875 }
876 if groups.prod() {
877 for extra in extras.extra_names(package.optional_dependencies.keys()) {
878 if seen.insert((&package.id, Some(extra))) {
879 queue.push_back((package, Some(extra)));
880 }
881 }
882 }
883 }
884
885 for requirement in self.requirements() {
887 for package in self
888 .packages
889 .iter()
890 .filter(|p| p.id.name == requirement.name)
891 {
892 if seen.insert((&package.id, None)) {
893 queue.push_back((package, None));
894 }
895 for extra in &*requirement.extras {
896 if seen.insert((&package.id, Some(extra))) {
897 queue.push_back((package, Some(extra)));
898 }
899 }
900 }
901 }
902
903 for (group, requirements) in self.dependency_groups() {
906 if !groups.contains(group) {
907 continue;
908 }
909 for requirement in requirements {
910 for package in self
911 .packages
912 .iter()
913 .filter(|p| p.id.name == requirement.name)
914 {
915 if seen.insert((&package.id, None)) {
916 queue.push_back((package, None));
917 }
918 for extra in &*requirement.extras {
919 if seen.insert((&package.id, Some(extra))) {
920 queue.push_back((package, Some(extra)));
921 }
922 }
923 }
924 }
925 }
926
927 while let Some((package, extra)) = queue.pop_front() {
928 let is_member = workspace_member_ids.contains(&package.id);
929
930 if !is_member && collect_filter(package) {
933 if let Some(version) = package.version() {
934 visit(package, version);
935 } else {
936 trace!(
937 "Skipping audit for `{}` because it has no version information",
938 package.name()
939 );
940 }
941 }
942
943 if is_member && extra.is_none() {
945 for dep in package
946 .dependency_groups
947 .iter()
948 .filter(|(group, _)| groups.contains(group))
949 .flat_map(|(_, deps)| deps)
950 {
951 enqueue_dep(self, &mut seen, &mut queue, dep);
952 }
953 }
954
955 let dependencies: &[Dependency] = match extra {
958 Some(extra) => package
959 .optional_dependencies
960 .get(extra)
961 .map(Vec::as_slice)
962 .unwrap_or_default(),
963 None if is_member && !groups.prod() => &[],
964 None => &package.dependencies,
965 };
966
967 for dep in dependencies {
968 enqueue_dep(self, &mut seen, &mut queue, dep);
969 }
970 }
971 }
972
973 pub fn root(&self) -> Option<&Package> {
975 self.packages.iter().find(|package| {
976 let (Source::Editable(path) | Source::Virtual(path)) = &package.id.source else {
977 return false;
978 };
979 path.as_ref() == Path::new("")
980 })
981 }
982
983 pub fn simplified_supported_environments(&self) -> Vec<MarkerTree> {
993 self.supported_environments()
994 .iter()
995 .copied()
996 .map(|marker| self.simplify_environment(marker))
997 .collect()
998 }
999
1000 pub fn simplified_required_environments(&self) -> Vec<MarkerTree> {
1003 self.required_environments()
1004 .iter()
1005 .copied()
1006 .map(|marker| self.simplify_environment(marker))
1007 .collect()
1008 }
1009
1010 pub fn simplify_environment(&self, marker: MarkerTree) -> MarkerTree {
1013 self.requires_python.simplify_markers(marker)
1014 }
1015
1016 pub fn fork_markers(&self) -> &[UniversalMarker] {
1019 self.fork_markers.as_slice()
1020 }
1021
1022 pub fn check_marker_coverage(&self) -> Result<(), (MarkerTree, MarkerTree)> {
1026 let fork_markers_union = if self.fork_markers().is_empty() {
1027 self.requires_python.to_marker_tree()
1028 } else {
1029 let mut fork_markers_union = MarkerTree::FALSE;
1030 for fork_marker in self.fork_markers() {
1031 fork_markers_union.or(fork_marker.pep508());
1032 }
1033 fork_markers_union
1034 };
1035 let mut environments_union = if !self.supported_environments.is_empty() {
1036 let mut environments_union = MarkerTree::FALSE;
1037 for fork_marker in &self.supported_environments {
1038 environments_union.or(*fork_marker);
1039 }
1040 environments_union
1041 } else {
1042 MarkerTree::TRUE
1043 };
1044 environments_union.and(self.requires_python.to_marker_tree());
1046 if fork_markers_union.negate().is_disjoint(environments_union) {
1047 Ok(())
1048 } else {
1049 Err((fork_markers_union, environments_union))
1050 }
1051 }
1052
1053 pub fn requires_python_coverage(
1063 &self,
1064 new_requires_python: &RequiresPython,
1065 ) -> Result<(), (MarkerTree, MarkerTree)> {
1066 let fork_markers_union = if self.fork_markers().is_empty() {
1067 self.requires_python.to_marker_tree()
1068 } else {
1069 let mut fork_markers_union = MarkerTree::FALSE;
1070 for fork_marker in self.fork_markers() {
1071 fork_markers_union.or(fork_marker.pep508());
1072 }
1073 fork_markers_union
1074 };
1075 let new_requires_python = new_requires_python.to_marker_tree();
1076 if fork_markers_union.is_disjoint(new_requires_python) {
1077 Err((fork_markers_union, new_requires_python))
1078 } else {
1079 Ok(())
1080 }
1081 }
1082
1083 pub fn to_toml(&self) -> Result<String, toml_edit::ser::Error> {
1085 debug_assert!(self.check_marker_coverage().is_ok());
1088
1089 let mut doc = toml_edit::DocumentMut::new();
1092 doc.insert("version", value(i64::from(self.version)));
1093
1094 if self.revision > 0 {
1095 doc.insert("revision", value(i64::from(self.revision)));
1096 }
1097
1098 doc.insert("requires-python", value(self.requires_python.to_string()));
1099
1100 if !self.fork_markers.is_empty() {
1101 let fork_markers = each_element_on_its_line_array(
1102 simplified_universal_markers(&self.fork_markers, &self.requires_python).into_iter(),
1103 );
1104 if !fork_markers.is_empty() {
1105 doc.insert("resolution-markers", value(fork_markers));
1106 }
1107 }
1108
1109 if !self.supported_environments.is_empty() {
1110 let supported_environments = each_element_on_its_line_array(
1111 self.supported_environments
1112 .iter()
1113 .copied()
1114 .map(|marker| SimplifiedMarkerTree::new(&self.requires_python, marker))
1115 .filter_map(SimplifiedMarkerTree::try_to_string),
1116 );
1117 doc.insert("supported-markers", value(supported_environments));
1118 }
1119
1120 if !self.required_environments.is_empty() {
1121 let required_environments = each_element_on_its_line_array(
1122 self.required_environments
1123 .iter()
1124 .copied()
1125 .map(|marker| SimplifiedMarkerTree::new(&self.requires_python, marker))
1126 .filter_map(SimplifiedMarkerTree::try_to_string),
1127 );
1128 doc.insert("required-markers", value(required_environments));
1129 }
1130
1131 if !self.conflicts.is_empty() {
1132 let mut list = Array::new();
1133 for set in self.conflicts.iter() {
1134 list.push(each_element_on_its_line_array(set.iter().map(|item| {
1135 let mut table = InlineTable::new();
1136 table.insert("package", Value::from(item.package().to_string()));
1137 match item.kind() {
1138 ConflictKind::Project => {}
1139 ConflictKind::Extra(extra) => {
1140 table.insert("extra", Value::from(extra.to_string()));
1141 }
1142 ConflictKind::Group(group) => {
1143 table.insert("group", Value::from(group.to_string()));
1144 }
1145 }
1146 table
1147 })));
1148 }
1149 doc.insert("conflicts", value(list));
1150 }
1151
1152 {
1156 let mut options_table = Table::new();
1157
1158 if self.options.resolution_mode != ResolutionMode::default() {
1159 options_table.insert(
1160 "resolution-mode",
1161 value(self.options.resolution_mode.to_string()),
1162 );
1163 }
1164 if self.options.prerelease_mode != PrereleaseMode::default() {
1165 options_table.insert(
1166 "prerelease-mode",
1167 value(self.options.prerelease_mode.to_string()),
1168 );
1169 }
1170 if self.options.fork_strategy != ForkStrategy::default() {
1171 options_table.insert(
1172 "fork-strategy",
1173 value(self.options.fork_strategy.to_string()),
1174 );
1175 }
1176 let exclude_newer = ExcludeNewer::from(self.options.exclude_newer.clone());
1177 if !exclude_newer.is_empty() {
1178 if let Some(global) = &exclude_newer.global {
1180 if let Some(span) = global.span() {
1181 let mut noop = value(ExcludeNewerValue::PLACEHOLDER);
1185 if let Item::Value(ref mut v) = noop {
1186 v.decor_mut().set_suffix(" # This has no effect and is included for backwards compatibility when using relative exclude-newer values.");
1187 }
1188 options_table.insert("exclude-newer", noop);
1189 options_table.insert("exclude-newer-span", value(span.to_string()));
1190 } else {
1191 options_table.insert("exclude-newer", value(global.to_string()));
1192 }
1193 }
1194
1195 if !exclude_newer.package.is_empty() {
1197 let mut package_table = toml_edit::Table::new();
1198 for (name, setting) in &exclude_newer.package {
1199 match setting {
1200 ExcludeNewerOverride::Enabled(exclude_newer_value) => {
1201 if let Some(span) = exclude_newer_value.span() {
1202 let mut inline = toml_edit::InlineTable::new();
1206 inline
1207 .insert("timestamp", ExcludeNewerValue::PLACEHOLDER.into());
1208 inline.insert("span", span.to_string().into());
1209 package_table.insert(name.as_ref(), Item::Value(inline.into()));
1210 } else {
1211 package_table.insert(
1213 name.as_ref(),
1214 value(exclude_newer_value.to_string()),
1215 );
1216 }
1217 }
1218 ExcludeNewerOverride::Disabled => {
1219 package_table.insert(name.as_ref(), value(false));
1220 }
1221 }
1222 }
1223 options_table.insert("exclude-newer-package", Item::Table(package_table));
1224 }
1225 }
1226
1227 if !options_table.is_empty() {
1228 doc.insert("options", Item::Table(options_table));
1229 }
1230 }
1231
1232 {
1234 let mut manifest_table = Table::new();
1235
1236 if !self.manifest.members.is_empty() {
1237 manifest_table.insert(
1238 "members",
1239 value(each_element_on_its_line_array(
1240 self.manifest
1241 .members
1242 .iter()
1243 .map(std::string::ToString::to_string),
1244 )),
1245 );
1246 }
1247
1248 if !self.manifest.requirements.is_empty() {
1249 let requirements = self
1250 .manifest
1251 .requirements
1252 .iter()
1253 .map(|requirement| {
1254 serde::Serialize::serialize(
1255 &requirement,
1256 toml_edit::ser::ValueSerializer::new(),
1257 )
1258 })
1259 .collect::<Result<Vec<_>, _>>()?;
1260 let requirements = match requirements.as_slice() {
1261 [] => Array::new(),
1262 [requirement] => Array::from_iter([requirement]),
1263 requirements => each_element_on_its_line_array(requirements.iter()),
1264 };
1265 manifest_table.insert("requirements", value(requirements));
1266 }
1267
1268 if !self.manifest.constraints.is_empty() {
1269 let constraints = self
1270 .manifest
1271 .constraints
1272 .iter()
1273 .map(|requirement| {
1274 serde::Serialize::serialize(
1275 &requirement,
1276 toml_edit::ser::ValueSerializer::new(),
1277 )
1278 })
1279 .collect::<Result<Vec<_>, _>>()?;
1280 let constraints = match constraints.as_slice() {
1281 [] => Array::new(),
1282 [requirement] => Array::from_iter([requirement]),
1283 constraints => each_element_on_its_line_array(constraints.iter()),
1284 };
1285 manifest_table.insert("constraints", value(constraints));
1286 }
1287
1288 if !self.manifest.overrides.is_empty() {
1289 let overrides = self
1290 .manifest
1291 .overrides
1292 .iter()
1293 .map(|requirement| {
1294 serde::Serialize::serialize(
1295 &requirement,
1296 toml_edit::ser::ValueSerializer::new(),
1297 )
1298 })
1299 .collect::<Result<Vec<_>, _>>()?;
1300 let overrides = match overrides.as_slice() {
1301 [] => Array::new(),
1302 [requirement] => Array::from_iter([requirement]),
1303 overrides => each_element_on_its_line_array(overrides.iter()),
1304 };
1305 manifest_table.insert("overrides", value(overrides));
1306 }
1307
1308 if !self.manifest.excludes.is_empty() {
1309 let excludes = self
1310 .manifest
1311 .excludes
1312 .iter()
1313 .map(|name| {
1314 serde::Serialize::serialize(&name, toml_edit::ser::ValueSerializer::new())
1315 })
1316 .collect::<Result<Vec<_>, _>>()?;
1317 let excludes = match excludes.as_slice() {
1318 [] => Array::new(),
1319 [name] => Array::from_iter([name]),
1320 excludes => each_element_on_its_line_array(excludes.iter()),
1321 };
1322 manifest_table.insert("excludes", value(excludes));
1323 }
1324
1325 if !self.manifest.build_constraints.is_empty() {
1326 let build_constraints = self
1327 .manifest
1328 .build_constraints
1329 .iter()
1330 .map(|requirement| {
1331 serde::Serialize::serialize(
1332 &requirement,
1333 toml_edit::ser::ValueSerializer::new(),
1334 )
1335 })
1336 .collect::<Result<Vec<_>, _>>()?;
1337 let build_constraints = match build_constraints.as_slice() {
1338 [] => Array::new(),
1339 [requirement] => Array::from_iter([requirement]),
1340 build_constraints => each_element_on_its_line_array(build_constraints.iter()),
1341 };
1342 manifest_table.insert("build-constraints", value(build_constraints));
1343 }
1344
1345 if !self.manifest.dependency_groups.is_empty() {
1346 let mut dependency_groups = Table::new();
1347 for (extra, requirements) in &self.manifest.dependency_groups {
1348 let requirements = requirements
1349 .iter()
1350 .map(|requirement| {
1351 serde::Serialize::serialize(
1352 &requirement,
1353 toml_edit::ser::ValueSerializer::new(),
1354 )
1355 })
1356 .collect::<Result<Vec<_>, _>>()?;
1357 let requirements = match requirements.as_slice() {
1358 [] => Array::new(),
1359 [requirement] => Array::from_iter([requirement]),
1360 requirements => each_element_on_its_line_array(requirements.iter()),
1361 };
1362 if !requirements.is_empty() {
1363 dependency_groups.insert(extra.as_ref(), value(requirements));
1364 }
1365 }
1366 if !dependency_groups.is_empty() {
1367 manifest_table.insert("dependency-groups", Item::Table(dependency_groups));
1368 }
1369 }
1370
1371 if !self.manifest.dependency_metadata.is_empty() {
1372 let mut tables = ArrayOfTables::new();
1373 for metadata in &self.manifest.dependency_metadata {
1374 let mut table = Table::new();
1375 table.insert("name", value(metadata.name.to_string()));
1376 if let Some(version) = metadata.version.as_ref() {
1377 table.insert("version", value(version.to_string()));
1378 }
1379 if !metadata.requires_dist.is_empty() {
1380 table.insert(
1381 "requires-dist",
1382 value(serde::Serialize::serialize(
1383 &metadata.requires_dist,
1384 toml_edit::ser::ValueSerializer::new(),
1385 )?),
1386 );
1387 }
1388 if let Some(requires_python) = metadata.requires_python.as_ref() {
1389 table.insert("requires-python", value(requires_python.to_string()));
1390 }
1391 if !metadata.provides_extra.is_empty() {
1392 table.insert(
1393 "provides-extras",
1394 value(serde::Serialize::serialize(
1395 &metadata.provides_extra,
1396 toml_edit::ser::ValueSerializer::new(),
1397 )?),
1398 );
1399 }
1400 tables.push(table);
1401 }
1402 manifest_table.insert("dependency-metadata", Item::ArrayOfTables(tables));
1403 }
1404
1405 if !manifest_table.is_empty() {
1406 doc.insert("manifest", Item::Table(manifest_table));
1407 }
1408 }
1409
1410 let mut dist_count_by_name: FxHashMap<PackageName, u64> = FxHashMap::default();
1415 for dist in &self.packages {
1416 *dist_count_by_name.entry(dist.id.name.clone()).or_default() += 1;
1417 }
1418
1419 let mut packages = ArrayOfTables::new();
1420 for dist in &self.packages {
1421 packages.push(dist.to_toml(&self.requires_python, &dist_count_by_name)?);
1422 }
1423
1424 doc.insert("package", Item::ArrayOfTables(packages));
1425 Ok(doc.to_string())
1426 }
1427
1428 pub fn find_by_name(&self, name: &PackageName) -> Result<Option<&Package>, String> {
1432 let mut found_dist = None;
1433 for dist in &self.packages {
1434 if &dist.id.name == name {
1435 if found_dist.is_some() {
1436 return Err(format!("found multiple packages matching `{name}`"));
1437 }
1438 found_dist = Some(dist);
1439 }
1440 }
1441 Ok(found_dist)
1442 }
1443
1444 fn find_by_markers(
1454 &self,
1455 name: &PackageName,
1456 marker_env: &MarkerEnvironment,
1457 ) -> Result<Option<&Package>, String> {
1458 let mut found_dist = None;
1459 for dist in &self.packages {
1460 if &dist.id.name == name {
1461 if dist.fork_markers.is_empty()
1462 || dist
1463 .fork_markers
1464 .iter()
1465 .any(|marker| marker.evaluate_no_extras(marker_env))
1466 {
1467 if found_dist.is_some() {
1468 return Err(format!("found multiple packages matching `{name}`"));
1469 }
1470 found_dist = Some(dist);
1471 }
1472 }
1473 }
1474 Ok(found_dist)
1475 }
1476
1477 fn find_by_id(&self, id: &PackageId) -> &Package {
1478 let index = *self.by_id.get(id).expect("locked package for ID");
1479
1480 (self.packages.get(index).expect("valid index for package")) as _
1481 }
1482
1483 fn satisfies_provides_extra<'lock>(
1485 &self,
1486 provides_extra: Box<[ExtraName]>,
1487 package: &'lock Package,
1488 ) -> SatisfiesResult<'lock> {
1489 if !self.supports_provides_extra() {
1490 return SatisfiesResult::Satisfied;
1491 }
1492
1493 let expected: BTreeSet<_> = provides_extra.iter().collect();
1494 let actual: BTreeSet<_> = package.metadata.provides_extra.iter().collect();
1495
1496 if expected != actual {
1497 let expected = Box::into_iter(provides_extra).collect();
1498 return SatisfiesResult::MismatchedPackageProvidesExtra(
1499 &package.id.name,
1500 package.id.version.as_ref(),
1501 expected,
1502 actual,
1503 );
1504 }
1505
1506 SatisfiesResult::Satisfied
1507 }
1508
1509 fn satisfies_requires_dist<'lock>(
1511 &self,
1512 requires_dist: Box<[Requirement]>,
1513 dependency_groups: BTreeMap<GroupName, Box<[Requirement]>>,
1514 package: &'lock Package,
1515 root: &Path,
1516 ) -> Result<SatisfiesResult<'lock>, LockError> {
1517 let flattened = if package.is_dynamic() {
1519 Some(
1520 FlatRequiresDist::from_requirements(requires_dist.clone(), &package.id.name)
1521 .into_iter()
1522 .map(|requirement| {
1523 normalize_requirement(requirement, root, &self.requires_python)
1524 })
1525 .collect::<Result<BTreeSet<_>, _>>()?,
1526 )
1527 } else {
1528 None
1529 };
1530
1531 let expected: BTreeSet<_> = Box::into_iter(requires_dist)
1533 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1534 .collect::<Result<_, _>>()?;
1535 let actual: BTreeSet<_> = package
1536 .metadata
1537 .requires_dist
1538 .iter()
1539 .cloned()
1540 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1541 .collect::<Result<_, _>>()?;
1542
1543 if expected != actual && flattened.is_none_or(|expected| expected != actual) {
1544 return Ok(SatisfiesResult::MismatchedPackageRequirements(
1545 &package.id.name,
1546 package.id.version.as_ref(),
1547 expected,
1548 actual,
1549 ));
1550 }
1551
1552 let expected: BTreeMap<GroupName, BTreeSet<Requirement>> = dependency_groups
1554 .into_iter()
1555 .filter(|(_, requirements)| self.includes_empty_groups() || !requirements.is_empty())
1556 .map(|(group, requirements)| {
1557 Ok::<_, LockError>((
1558 group,
1559 Box::into_iter(requirements)
1560 .map(|requirement| {
1561 normalize_requirement(requirement, root, &self.requires_python)
1562 })
1563 .collect::<Result<_, _>>()?,
1564 ))
1565 })
1566 .collect::<Result<_, _>>()?;
1567 let actual: BTreeMap<GroupName, BTreeSet<Requirement>> = package
1568 .metadata
1569 .dependency_groups
1570 .iter()
1571 .filter(|(_, requirements)| self.includes_empty_groups() || !requirements.is_empty())
1572 .map(|(group, requirements)| {
1573 Ok::<_, LockError>((
1574 group.clone(),
1575 requirements
1576 .iter()
1577 .cloned()
1578 .map(|requirement| {
1579 normalize_requirement(requirement, root, &self.requires_python)
1580 })
1581 .collect::<Result<_, _>>()?,
1582 ))
1583 })
1584 .collect::<Result<_, _>>()?;
1585
1586 if expected != actual {
1587 return Ok(SatisfiesResult::MismatchedPackageDependencyGroups(
1588 &package.id.name,
1589 package.id.version.as_ref(),
1590 expected,
1591 actual,
1592 ));
1593 }
1594
1595 Ok(SatisfiesResult::Satisfied)
1596 }
1597
1598 #[instrument(skip_all)]
1600 pub async fn satisfies<Context: BuildContext>(
1601 &self,
1602 root: &Path,
1603 packages: &BTreeMap<PackageName, WorkspaceMember>,
1604 members: &[PackageName],
1605 required_members: &BTreeMap<PackageName, Editability>,
1606 requirements: &[Requirement],
1607 constraints: &[Requirement],
1608 overrides: &[Requirement],
1609 excludes: &[PackageName],
1610 build_constraints: &[Requirement],
1611 dependency_groups: &BTreeMap<GroupName, Vec<Requirement>>,
1612 dependency_metadata: &DependencyMetadata,
1613 indexes: Option<&IndexLocations>,
1614 tags: &Tags,
1615 markers: &MarkerEnvironment,
1616 build_options: &BuildOptions,
1617 hasher: &HashStrategy,
1618 index: &InMemoryIndex,
1619 database: &DistributionDatabase<'_, Context>,
1620 ) -> Result<SatisfiesResult<'_>, LockError> {
1621 let mut queue: VecDeque<&Package> = VecDeque::new();
1622 let mut seen = FxHashSet::default();
1623
1624 {
1626 let expected = members.iter().cloned().collect::<BTreeSet<_>>();
1627 let actual = &self.manifest.members;
1628 if expected != *actual {
1629 return Ok(SatisfiesResult::MismatchedMembers(expected, actual));
1630 }
1631 }
1632
1633 for (name, member) in packages {
1636 let source = self.find_by_name(name).ok().flatten();
1637
1638 let value = required_members.get(name);
1640 let is_required_member = value.is_some();
1641 let editability = value.copied().flatten();
1642
1643 let expected_virtual = !member.pyproject_toml().is_package(!is_required_member);
1645 let actual_virtual =
1646 source.map(|package| matches!(package.id.source, Source::Virtual(..)));
1647 if actual_virtual != Some(expected_virtual) {
1648 return Ok(SatisfiesResult::MismatchedVirtual(
1649 name.clone(),
1650 expected_virtual,
1651 ));
1652 }
1653
1654 let expected_editable = if expected_virtual {
1656 false
1657 } else {
1658 editability.unwrap_or(true)
1659 };
1660 let actual_editable =
1661 source.map(|package| matches!(package.id.source, Source::Editable(..)));
1662 if actual_editable != Some(expected_editable) {
1663 return Ok(SatisfiesResult::MismatchedEditable(
1664 name.clone(),
1665 expected_editable,
1666 ));
1667 }
1668 }
1669
1670 {
1672 let expected: BTreeSet<_> = requirements
1673 .iter()
1674 .cloned()
1675 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1676 .collect::<Result<_, _>>()?;
1677 let actual: BTreeSet<_> = self
1678 .manifest
1679 .requirements
1680 .iter()
1681 .cloned()
1682 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1683 .collect::<Result<_, _>>()?;
1684 if expected != actual {
1685 return Ok(SatisfiesResult::MismatchedRequirements(expected, actual));
1686 }
1687 }
1688
1689 {
1691 let expected: BTreeSet<_> = constraints
1692 .iter()
1693 .cloned()
1694 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1695 .collect::<Result<_, _>>()?;
1696 let actual: BTreeSet<_> = self
1697 .manifest
1698 .constraints
1699 .iter()
1700 .cloned()
1701 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1702 .collect::<Result<_, _>>()?;
1703 if expected != actual {
1704 return Ok(SatisfiesResult::MismatchedConstraints(expected, actual));
1705 }
1706 }
1707
1708 {
1710 let expected: BTreeSet<_> = overrides
1711 .iter()
1712 .cloned()
1713 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1714 .collect::<Result<_, _>>()?;
1715 let actual: BTreeSet<_> = self
1716 .manifest
1717 .overrides
1718 .iter()
1719 .cloned()
1720 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1721 .collect::<Result<_, _>>()?;
1722 if expected != actual {
1723 return Ok(SatisfiesResult::MismatchedOverrides(expected, actual));
1724 }
1725 }
1726
1727 {
1729 let expected: BTreeSet<_> = excludes.iter().cloned().collect();
1730 let actual: BTreeSet<_> = self.manifest.excludes.iter().cloned().collect();
1731 if expected != actual {
1732 return Ok(SatisfiesResult::MismatchedExcludes(expected, actual));
1733 }
1734 }
1735
1736 {
1738 let expected: BTreeSet<_> = build_constraints
1739 .iter()
1740 .cloned()
1741 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1742 .collect::<Result<_, _>>()?;
1743 let actual: BTreeSet<_> = self
1744 .manifest
1745 .build_constraints
1746 .iter()
1747 .cloned()
1748 .map(|requirement| normalize_requirement(requirement, root, &self.requires_python))
1749 .collect::<Result<_, _>>()?;
1750 if expected != actual {
1751 return Ok(SatisfiesResult::MismatchedBuildConstraints(
1752 expected, actual,
1753 ));
1754 }
1755 }
1756
1757 {
1759 let expected: BTreeMap<GroupName, BTreeSet<Requirement>> = dependency_groups
1760 .iter()
1761 .filter(|(_, requirements)| !requirements.is_empty())
1762 .map(|(group, requirements)| {
1763 Ok::<_, LockError>((
1764 group.clone(),
1765 requirements
1766 .iter()
1767 .cloned()
1768 .map(|requirement| {
1769 normalize_requirement(requirement, root, &self.requires_python)
1770 })
1771 .collect::<Result<_, _>>()?,
1772 ))
1773 })
1774 .collect::<Result<_, _>>()?;
1775 let actual: BTreeMap<GroupName, BTreeSet<Requirement>> = self
1776 .manifest
1777 .dependency_groups
1778 .iter()
1779 .filter(|(_, requirements)| !requirements.is_empty())
1780 .map(|(group, requirements)| {
1781 Ok::<_, LockError>((
1782 group.clone(),
1783 requirements
1784 .iter()
1785 .cloned()
1786 .map(|requirement| {
1787 normalize_requirement(requirement, root, &self.requires_python)
1788 })
1789 .collect::<Result<_, _>>()?,
1790 ))
1791 })
1792 .collect::<Result<_, _>>()?;
1793 if expected != actual {
1794 return Ok(SatisfiesResult::MismatchedDependencyGroups(
1795 expected, actual,
1796 ));
1797 }
1798 }
1799
1800 {
1802 let expected = dependency_metadata
1803 .values()
1804 .cloned()
1805 .collect::<BTreeSet<_>>();
1806 let actual = &self.manifest.dependency_metadata;
1807 if expected != *actual {
1808 return Ok(SatisfiesResult::MismatchedStaticMetadata(expected, actual));
1809 }
1810 }
1811
1812 let mut remotes = indexes.map(|locations| {
1814 locations
1815 .allowed_indexes()
1816 .into_iter()
1817 .filter_map(|index| match index.url() {
1818 IndexUrl::Pypi(_) | IndexUrl::Url(_) => {
1819 Some(UrlString::from(index.url().without_credentials().as_ref()))
1820 }
1821 IndexUrl::Path(_) => None,
1822 })
1823 .collect::<BTreeSet<_>>()
1824 });
1825
1826 let mut locals = indexes.map(|locations| {
1827 locations
1828 .allowed_indexes()
1829 .into_iter()
1830 .filter_map(|index| match index.url() {
1831 IndexUrl::Pypi(_) | IndexUrl::Url(_) => None,
1832 IndexUrl::Path(url) => {
1833 let path = url.to_file_path().ok()?;
1834 let path = try_relative_to_if(&path, root, !url.was_given_absolute())
1835 .ok()?
1836 .into_boxed_path();
1837 Some(path)
1838 }
1839 })
1840 .collect::<BTreeSet<_>>()
1841 });
1842
1843 for root_name in packages.keys() {
1845 let root = self
1846 .find_by_name(root_name)
1847 .expect("found too many packages matching root");
1848
1849 let Some(root) = root else {
1850 return Ok(SatisfiesResult::MissingRoot(root_name.clone()));
1852 };
1853
1854 if seen.insert(&root.id) {
1855 queue.push_back(root);
1856 }
1857 }
1858
1859 let root_requirements = requirements
1862 .iter()
1863 .chain(dependency_groups.values().flatten())
1864 .collect::<Vec<_>>();
1865
1866 for requirement in &root_requirements {
1867 if let RequirementSource::Registry {
1868 index: Some(index), ..
1869 } = &requirement.source
1870 {
1871 match &index.url {
1872 IndexUrl::Pypi(_) | IndexUrl::Url(_) => {
1873 if let Some(remotes) = remotes.as_mut() {
1874 remotes.insert(UrlString::from(
1875 index.url().without_credentials().as_ref(),
1876 ));
1877 }
1878 }
1879 IndexUrl::Path(url) => {
1880 if let Some(locals) = locals.as_mut() {
1881 if let Some(path) = url.to_file_path().ok().and_then(|path| {
1882 try_relative_to_if(&path, root, !url.was_given_absolute()).ok()
1883 }) {
1884 locals.insert(path.into_boxed_path());
1885 }
1886 }
1887 }
1888 }
1889 }
1890 }
1891
1892 if !root_requirements.is_empty() {
1893 let names = root_requirements
1894 .iter()
1895 .map(|requirement| &requirement.name)
1896 .collect::<FxHashSet<_>>();
1897
1898 let by_name: FxHashMap<_, Vec<_>> = self.packages.iter().fold(
1899 FxHashMap::with_capacity_and_hasher(self.packages.len(), FxBuildHasher),
1900 |mut by_name, package| {
1901 if names.contains(&package.id.name) {
1902 by_name.entry(&package.id.name).or_default().push(package);
1903 }
1904 by_name
1905 },
1906 );
1907
1908 for requirement in root_requirements {
1909 for package in by_name.get(&requirement.name).into_iter().flatten() {
1910 if !package.id.source.is_source_tree() {
1911 continue;
1912 }
1913
1914 let marker = if package.fork_markers.is_empty() {
1915 requirement.marker
1916 } else {
1917 let mut combined = MarkerTree::FALSE;
1918 for fork_marker in &package.fork_markers {
1919 combined.or(fork_marker.pep508());
1920 }
1921 combined.and(requirement.marker);
1922 combined
1923 };
1924 if marker.is_false() {
1925 continue;
1926 }
1927 if !marker.evaluate(markers, &[]) {
1928 continue;
1929 }
1930
1931 if seen.insert(&package.id) {
1932 queue.push_back(package);
1933 }
1934 }
1935 }
1936 }
1937
1938 while let Some(package) = queue.pop_front() {
1939 if let Source::Registry(index) = &package.id.source {
1941 match index {
1942 RegistrySource::Url(url) => {
1943 if remotes
1944 .as_ref()
1945 .is_some_and(|remotes| !remotes.contains(url))
1946 {
1947 let name = &package.id.name;
1948 let version = &package
1949 .id
1950 .version
1951 .as_ref()
1952 .expect("version for registry source");
1953 return Ok(SatisfiesResult::MissingRemoteIndex(name, version, url));
1954 }
1955 }
1956 RegistrySource::Path(path) => {
1957 if locals.as_ref().is_some_and(|locals| !locals.contains(path)) {
1958 let name = &package.id.name;
1959 let version = &package
1960 .id
1961 .version
1962 .as_ref()
1963 .expect("version for registry source");
1964 return Ok(SatisfiesResult::MissingLocalIndex(name, version, path));
1965 }
1966 }
1967 }
1968 }
1969
1970 if package.id.source.is_immutable() {
1972 continue;
1973 }
1974
1975 if matches!(&package.id.source, Source::Direct(..))
1979 && database.client().unmanaged.connectivity().is_offline()
1980 {
1981 trace!(
1982 "Skipping metadata validation for `{}` because its direct URL cannot be refreshed while offline",
1983 package.id
1984 );
1985 } else if let Some(version) = package.id.version.as_ref() {
1986 let statically_satisfied = if let Some(source_tree) =
1990 package.id.source.as_source_tree()
1991 && let Some(SourceTreeRequiresDist {
1992 version: static_version,
1993 metadata,
1994 }) = Self::source_tree_requires_dist(source_tree, root, package, database)
1995 .await?
1996 {
1997 if metadata.dynamic {
2000 return Ok(SatisfiesResult::MismatchedDynamic(&package.id.name, false));
2001 }
2002
2003 if let Some(static_version) = static_version {
2004 if static_version != *version {
2006 return Ok(SatisfiesResult::MismatchedVersion(
2007 &package.id.name,
2008 version.clone(),
2009 Some(static_version),
2010 ));
2011 }
2012
2013 match self.satisfies_provides_extra(metadata.provides_extra, package) {
2015 SatisfiesResult::Satisfied => {}
2016 result => return Ok(result),
2017 }
2018
2019 match self.satisfies_requires_dist(
2021 metadata.requires_dist,
2022 metadata.dependency_groups,
2023 package,
2024 root,
2025 )? {
2026 SatisfiesResult::Satisfied => true,
2027 result => return Ok(result),
2028 }
2029 } else {
2030 false
2031 }
2032 } else {
2033 false
2034 };
2035
2036 if !statically_satisfied {
2037 let HashedDist { dist, .. } = package.to_dist(
2040 root,
2041 TagPolicy::Preferred(tags),
2042 build_options,
2043 markers,
2044 )?;
2045
2046 let metadata = {
2047 let id = dist.distribution_id();
2048 if let Some(archive) =
2049 index
2050 .distributions()
2051 .get(&id)
2052 .as_deref()
2053 .and_then(|response| {
2054 if let MetadataResponse::Found(archive, ..) = response {
2055 Some(archive)
2056 } else {
2057 None
2058 }
2059 })
2060 {
2061 archive.metadata.clone()
2063 } else {
2064 let archive = database
2066 .get_or_build_wheel_metadata(&dist, hasher.get(&dist))
2067 .await
2068 .map_err(|err| LockErrorKind::Resolution {
2069 id: package.id.clone(),
2070 err,
2071 })?;
2072
2073 let metadata = archive.metadata.clone();
2074
2075 index
2077 .distributions()
2078 .done(id, Arc::new(MetadataResponse::Found(archive)));
2079
2080 metadata
2081 }
2082 };
2083
2084 if package.id.source.is_source_tree() && metadata.dynamic {
2087 return Ok(SatisfiesResult::MismatchedDynamic(&package.id.name, false));
2088 }
2089
2090 if metadata.version != *version {
2092 return Ok(SatisfiesResult::MismatchedVersion(
2093 &package.id.name,
2094 version.clone(),
2095 Some(metadata.version.clone()),
2096 ));
2097 }
2098
2099 match self.satisfies_provides_extra(metadata.provides_extra, package) {
2101 SatisfiesResult::Satisfied => {}
2102 result => return Ok(result),
2103 }
2104
2105 match self.satisfies_requires_dist(
2107 metadata.requires_dist,
2108 metadata.dependency_groups,
2109 package,
2110 root,
2111 )? {
2112 SatisfiesResult::Satisfied => {}
2113 result => return Ok(result),
2114 }
2115 }
2116 } else if let Some(source_tree) = package.id.source.as_source_tree() {
2117 let metadata =
2127 Self::source_tree_requires_dist(source_tree, root, package, database)
2128 .await?
2129 .map(|metadata| metadata.metadata);
2130
2131 let satisfied = metadata.is_some_and(|metadata| {
2132 if !metadata.dynamic {
2134 debug!("Static `requires-dist` for `{}` is out-of-date; falling back to distribution database", package.id);
2135 return false;
2136 }
2137
2138 if let SatisfiesResult::Satisfied = self.satisfies_provides_extra(metadata.provides_extra, package, ) {
2140 debug!("Static `provides-extra` for `{}` is up-to-date", package.id);
2141 } else {
2142 debug!("Static `provides-extra` for `{}` is out-of-date; falling back to distribution database", package.id);
2143 return false;
2144 }
2145
2146 match self.satisfies_requires_dist(metadata.requires_dist, metadata.dependency_groups, package, root) {
2148 Ok(SatisfiesResult::Satisfied) => {
2149 debug!("Static `requires-dist` for `{}` is up-to-date", package.id);
2150 },
2151 Ok(..) => {
2152 debug!("Static `requires-dist` for `{}` is out-of-date; falling back to distribution database", package.id);
2153 return false;
2154 },
2155 Err(..) => {
2156 debug!("Static `requires-dist` for `{}` is invalid; falling back to distribution database", package.id);
2157 return false;
2158 },
2159 }
2160
2161 true
2162 });
2163
2164 if !satisfied {
2170 let HashedDist { dist, .. } = package.to_dist(
2171 root,
2172 TagPolicy::Preferred(tags),
2173 build_options,
2174 markers,
2175 )?;
2176
2177 let metadata = {
2178 let id = dist.distribution_id();
2179 if let Some(archive) =
2180 index
2181 .distributions()
2182 .get(&id)
2183 .as_deref()
2184 .and_then(|response| {
2185 if let MetadataResponse::Found(archive, ..) = response {
2186 Some(archive)
2187 } else {
2188 None
2189 }
2190 })
2191 {
2192 archive.metadata.clone()
2194 } else {
2195 let archive = database
2197 .get_or_build_wheel_metadata(&dist, hasher.get(&dist))
2198 .await
2199 .map_err(|err| LockErrorKind::Resolution {
2200 id: package.id.clone(),
2201 err,
2202 })?;
2203
2204 let metadata = archive.metadata.clone();
2205
2206 index
2208 .distributions()
2209 .done(id, Arc::new(MetadataResponse::Found(archive)));
2210
2211 metadata
2212 }
2213 };
2214
2215 if !metadata.dynamic {
2217 return Ok(SatisfiesResult::MismatchedDynamic(&package.id.name, true));
2218 }
2219
2220 match self.satisfies_provides_extra(metadata.provides_extra, package) {
2222 SatisfiesResult::Satisfied => {}
2223 result => return Ok(result),
2224 }
2225
2226 match self.satisfies_requires_dist(
2228 metadata.requires_dist,
2229 metadata.dependency_groups,
2230 package,
2231 root,
2232 )? {
2233 SatisfiesResult::Satisfied => {}
2234 result => return Ok(result),
2235 }
2236 }
2237 } else {
2238 return Ok(SatisfiesResult::MissingVersion(&package.id.name));
2239 }
2240
2241 for requirement in package
2246 .metadata
2247 .requires_dist
2248 .iter()
2249 .chain(package.metadata.dependency_groups.values().flatten())
2250 {
2251 if let RequirementSource::Registry {
2252 index: Some(index), ..
2253 } = &requirement.source
2254 {
2255 match &index.url {
2256 IndexUrl::Pypi(_) | IndexUrl::Url(_) => {
2257 if let Some(remotes) = remotes.as_mut() {
2258 remotes.insert(UrlString::from(
2259 index.url().without_credentials().as_ref(),
2260 ));
2261 }
2262 }
2263 IndexUrl::Path(url) => {
2264 if let Some(locals) = locals.as_mut() {
2265 if let Some(path) = url.to_file_path().ok().and_then(|path| {
2266 try_relative_to_if(&path, root, !url.was_given_absolute()).ok()
2267 }) {
2268 locals.insert(path.into_boxed_path());
2269 }
2270 }
2271 }
2272 }
2273 }
2274 }
2275
2276 for dep in &package.dependencies {
2278 if seen.insert(&dep.package_id) {
2279 let dep_dist = self.find_by_id(&dep.package_id);
2280 queue.push_back(dep_dist);
2281 }
2282 }
2283
2284 for dependencies in package.optional_dependencies.values() {
2285 for dep in dependencies {
2286 if seen.insert(&dep.package_id) {
2287 let dep_dist = self.find_by_id(&dep.package_id);
2288 queue.push_back(dep_dist);
2289 }
2290 }
2291 }
2292
2293 for dependencies in package.dependency_groups.values() {
2294 for dep in dependencies {
2295 if seen.insert(&dep.package_id) {
2296 let dep_dist = self.find_by_id(&dep.package_id);
2297 queue.push_back(dep_dist);
2298 }
2299 }
2300 }
2301 }
2302
2303 Ok(SatisfiesResult::Satisfied)
2304 }
2305
2306 async fn source_tree_requires_dist<Context: BuildContext>(
2307 source_tree: &Path,
2308 root: &Path,
2309 package: &Package,
2310 database: &DistributionDatabase<'_, Context>,
2311 ) -> Result<Option<SourceTreeRequiresDist>, LockError> {
2312 let parent = root.join(source_tree);
2313 let path = parent.join("pyproject.toml");
2314 match fs_err::tokio::read_to_string(&path).await {
2315 Ok(contents) => {
2316 let pyproject_toml = PyProjectToml::from_toml(&contents, path.user_display())
2317 .map_err(|err| LockErrorKind::InvalidPyprojectToml {
2318 path: path.clone(),
2319 err,
2320 })?;
2321 let version = pyproject_toml
2322 .project
2323 .as_ref()
2324 .and_then(|project| project.version.clone());
2325 let metadata = database
2326 .requires_dist(&parent, &pyproject_toml)
2327 .await
2328 .map_err(|err| LockErrorKind::Resolution {
2329 id: package.id.clone(),
2330 err,
2331 })?;
2332 Ok(metadata.map(|metadata| SourceTreeRequiresDist { version, metadata }))
2333 }
2334 Err(err) if err.kind() == io::ErrorKind::NotFound => Ok(None),
2335 Err(err) => Err(LockErrorKind::UnreadablePyprojectToml { path, err }.into()),
2336 }
2337 }
2338}
2339
2340#[derive(Debug)]
2348pub struct Auditable<'lock> {
2349 packages: Vec<(&'lock Package, &'lock Version)>,
2351}
2352
2353struct SourceTreeRequiresDist {
2354 version: Option<Version>,
2355 metadata: RequiresDist,
2356}
2357
2358impl<'lock> Auditable<'lock> {
2359 pub fn len(&self) -> usize {
2361 self.packages.len()
2362 }
2363
2364 pub fn is_empty(&self) -> bool {
2366 self.packages.is_empty()
2367 }
2368
2369 pub fn packages(&self) -> impl Iterator<Item = (&'lock PackageName, &'lock Version)> + '_ {
2371 self.packages
2372 .iter()
2373 .map(|(package, version)| (package.name(), *version))
2374 }
2375
2376 pub fn projects(&self, root: &Path) -> Result<Vec<(&'lock PackageName, IndexUrl)>, LockError> {
2380 let mut seen: FxHashSet<(&PackageName, String)> = FxHashSet::default();
2381 let mut projects: Vec<(&PackageName, IndexUrl)> = Vec::with_capacity(self.packages.len());
2382 for (package, _version) in &self.packages {
2383 if let Some(index) = package.index(root)?
2384 && seen.insert((package.name(), index.url().to_string()))
2385 {
2386 projects.push((package.name(), index));
2387 }
2388 }
2389 Ok(projects)
2390 }
2391}
2392
2393#[derive(Debug, Copy, Clone)]
2394enum TagPolicy<'tags> {
2395 Required(&'tags Tags),
2397 Preferred(&'tags Tags),
2400}
2401
2402impl<'tags> TagPolicy<'tags> {
2403 fn tags(&self) -> &'tags Tags {
2405 match self {
2406 Self::Required(tags) | Self::Preferred(tags) => tags,
2407 }
2408 }
2409}
2410
2411#[derive(Debug)]
2413pub enum SatisfiesResult<'lock> {
2414 Satisfied,
2416 MismatchedMembers(BTreeSet<PackageName>, &'lock BTreeSet<PackageName>),
2418 MismatchedVirtual(PackageName, bool),
2420 MismatchedEditable(PackageName, bool),
2422 MismatchedDynamic(&'lock PackageName, bool),
2424 MismatchedVersion(&'lock PackageName, Version, Option<Version>),
2426 MismatchedRequirements(BTreeSet<Requirement>, BTreeSet<Requirement>),
2428 MismatchedConstraints(BTreeSet<Requirement>, BTreeSet<Requirement>),
2430 MismatchedOverrides(BTreeSet<Requirement>, BTreeSet<Requirement>),
2432 MismatchedExcludes(BTreeSet<PackageName>, BTreeSet<PackageName>),
2434 MismatchedBuildConstraints(BTreeSet<Requirement>, BTreeSet<Requirement>),
2436 MismatchedDependencyGroups(
2438 BTreeMap<GroupName, BTreeSet<Requirement>>,
2439 BTreeMap<GroupName, BTreeSet<Requirement>>,
2440 ),
2441 MismatchedStaticMetadata(BTreeSet<StaticMetadata>, &'lock BTreeSet<StaticMetadata>),
2443 MissingRoot(PackageName),
2445 MissingRemoteIndex(&'lock PackageName, &'lock Version, &'lock UrlString),
2447 MissingLocalIndex(&'lock PackageName, &'lock Version, &'lock Path),
2449 MismatchedPackageRequirements(
2451 &'lock PackageName,
2452 Option<&'lock Version>,
2453 BTreeSet<Requirement>,
2454 BTreeSet<Requirement>,
2455 ),
2456 MismatchedPackageProvidesExtra(
2458 &'lock PackageName,
2459 Option<&'lock Version>,
2460 BTreeSet<ExtraName>,
2461 BTreeSet<&'lock ExtraName>,
2462 ),
2463 MismatchedPackageDependencyGroups(
2465 &'lock PackageName,
2466 Option<&'lock Version>,
2467 BTreeMap<GroupName, BTreeSet<Requirement>>,
2468 BTreeMap<GroupName, BTreeSet<Requirement>>,
2469 ),
2470 MissingVersion(&'lock PackageName),
2472}
2473
2474#[derive(Clone, Debug, Default, serde::Deserialize, PartialEq, Eq)]
2476#[serde(rename_all = "kebab-case")]
2477struct ResolverOptions {
2478 #[serde(default)]
2480 resolution_mode: ResolutionMode,
2481 #[serde(default)]
2483 prerelease_mode: PrereleaseMode,
2484 #[serde(default)]
2486 fork_strategy: ForkStrategy,
2487 #[serde(flatten)]
2489 exclude_newer: ExcludeNewerWire,
2490}
2491
2492#[expect(clippy::struct_field_names)]
2493#[derive(Clone, Debug, Default, serde::Deserialize, PartialEq, Eq)]
2494#[serde(rename_all = "kebab-case")]
2495struct ExcludeNewerWire {
2496 exclude_newer: Option<Timestamp>,
2497 exclude_newer_span: Option<ExcludeNewerSpan>,
2498 #[serde(default, skip_serializing_if = "ExcludeNewerPackage::is_empty")]
2499 exclude_newer_package: ExcludeNewerPackage,
2500}
2501
2502impl From<ExcludeNewerWire> for ExcludeNewer {
2503 fn from(wire: ExcludeNewerWire) -> Self {
2504 let global = match (wire.exclude_newer, wire.exclude_newer_span) {
2505 (Some(timestamp), None) => Some(ExcludeNewerValue::absolute(timestamp)),
2506 (Some(_), Some(span)) => Some(ExcludeNewerValue::relative(span)),
2509 (None, Some(span)) => Some(ExcludeNewerValue::relative(span)),
2512 (None, None) => None,
2513 };
2514 Self {
2515 global,
2516 package: wire.exclude_newer_package,
2517 }
2518 }
2519}
2520
2521impl From<ExcludeNewer> for ExcludeNewerWire {
2522 fn from(exclude_newer: ExcludeNewer) -> Self {
2523 let (timestamp, span) = match exclude_newer.global {
2524 Some(ExcludeNewerValue::Absolute(timestamp)) => (Some(timestamp), None),
2525 Some(ExcludeNewerValue::Relative(span)) => (None, Some(span)),
2526 None => (None, None),
2527 };
2528 Self {
2529 exclude_newer: timestamp,
2530 exclude_newer_span: span,
2531 exclude_newer_package: exclude_newer.package,
2532 }
2533 }
2534}
2535
2536#[derive(Clone, Debug, Default, serde::Deserialize, PartialEq, Eq)]
2537#[serde(rename_all = "kebab-case")]
2538pub struct ResolverManifest {
2539 #[serde(default)]
2541 members: BTreeSet<PackageName>,
2542 #[serde(default)]
2547 requirements: BTreeSet<Requirement>,
2548 #[serde(default)]
2554 dependency_groups: BTreeMap<GroupName, BTreeSet<Requirement>>,
2555 #[serde(default)]
2557 constraints: BTreeSet<Requirement>,
2558 #[serde(default)]
2560 overrides: BTreeSet<Requirement>,
2561 #[serde(default)]
2563 excludes: BTreeSet<PackageName>,
2564 #[serde(default)]
2566 build_constraints: BTreeSet<Requirement>,
2567 #[serde(default)]
2569 dependency_metadata: BTreeSet<StaticMetadata>,
2570}
2571
2572impl ResolverManifest {
2573 pub fn new(
2576 members: impl IntoIterator<Item = PackageName>,
2577 requirements: impl IntoIterator<Item = Requirement>,
2578 constraints: impl IntoIterator<Item = Requirement>,
2579 overrides: impl IntoIterator<Item = Requirement>,
2580 excludes: impl IntoIterator<Item = PackageName>,
2581 build_constraints: impl IntoIterator<Item = Requirement>,
2582 dependency_groups: impl IntoIterator<Item = (GroupName, Vec<Requirement>)>,
2583 dependency_metadata: impl IntoIterator<Item = StaticMetadata>,
2584 ) -> Self {
2585 Self {
2586 members: members.into_iter().collect(),
2587 requirements: requirements.into_iter().collect(),
2588 constraints: constraints.into_iter().collect(),
2589 overrides: overrides.into_iter().collect(),
2590 excludes: excludes.into_iter().collect(),
2591 build_constraints: build_constraints.into_iter().collect(),
2592 dependency_groups: dependency_groups
2593 .into_iter()
2594 .map(|(group, requirements)| (group, requirements.into_iter().collect()))
2595 .collect(),
2596 dependency_metadata: dependency_metadata.into_iter().collect(),
2597 }
2598 }
2599
2600 pub fn relative_to(self, root: &Path) -> Result<Self, io::Error> {
2602 Ok(Self {
2603 members: self.members,
2604 requirements: self
2605 .requirements
2606 .into_iter()
2607 .map(|requirement| requirement.relative_to(root))
2608 .collect::<Result<BTreeSet<_>, _>>()?,
2609 constraints: self
2610 .constraints
2611 .into_iter()
2612 .map(|requirement| requirement.relative_to(root))
2613 .collect::<Result<BTreeSet<_>, _>>()?,
2614 overrides: self
2615 .overrides
2616 .into_iter()
2617 .map(|requirement| requirement.relative_to(root))
2618 .collect::<Result<BTreeSet<_>, _>>()?,
2619 excludes: self.excludes,
2620 build_constraints: self
2621 .build_constraints
2622 .into_iter()
2623 .map(|requirement| requirement.relative_to(root))
2624 .collect::<Result<BTreeSet<_>, _>>()?,
2625 dependency_groups: self
2626 .dependency_groups
2627 .into_iter()
2628 .map(|(group, requirements)| {
2629 Ok::<_, io::Error>((
2630 group,
2631 requirements
2632 .into_iter()
2633 .map(|requirement| requirement.relative_to(root))
2634 .collect::<Result<BTreeSet<_>, _>>()?,
2635 ))
2636 })
2637 .collect::<Result<BTreeMap<_, _>, _>>()?,
2638 dependency_metadata: self.dependency_metadata,
2639 })
2640 }
2641}
2642
2643#[derive(Clone, Debug, serde::Deserialize)]
2644#[serde(rename_all = "kebab-case")]
2645struct LockWire {
2646 version: u32,
2647 revision: Option<u32>,
2648 requires_python: RequiresPython,
2649 #[serde(rename = "resolution-markers", default)]
2652 fork_markers: Vec<SimplifiedMarkerTree>,
2653 #[serde(rename = "supported-markers", default)]
2654 supported_environments: Vec<SimplifiedMarkerTree>,
2655 #[serde(rename = "required-markers", default)]
2656 required_environments: Vec<SimplifiedMarkerTree>,
2657 #[serde(rename = "conflicts", default)]
2658 conflicts: Option<Conflicts>,
2659 #[serde(default)]
2661 options: ResolverOptions,
2662 #[serde(default)]
2663 manifest: ResolverManifest,
2664 #[serde(rename = "package", alias = "distribution", default)]
2665 packages: Vec<PackageWire>,
2666}
2667
2668impl TryFrom<LockWire> for Lock {
2669 type Error = LockError;
2670
2671 fn try_from(wire: LockWire) -> Result<Self, LockError> {
2672 let mut unambiguous_package_ids: FxHashMap<PackageName, PackageId> = FxHashMap::default();
2677 let mut ambiguous = FxHashSet::default();
2678 for dist in &wire.packages {
2679 if ambiguous.contains(&dist.id.name) {
2680 continue;
2681 }
2682 if let Some(id) = unambiguous_package_ids.remove(&dist.id.name) {
2683 ambiguous.insert(id.name);
2684 continue;
2685 }
2686 unambiguous_package_ids.insert(dist.id.name.clone(), dist.id.clone());
2687 }
2688
2689 let packages = wire
2690 .packages
2691 .into_iter()
2692 .map(|dist| dist.unwire(&wire.requires_python, &unambiguous_package_ids))
2693 .collect::<Result<Vec<_>, _>>()?;
2694 let supported_environments = wire
2695 .supported_environments
2696 .into_iter()
2697 .map(|simplified_marker| simplified_marker.into_marker(&wire.requires_python))
2698 .collect();
2699 let required_environments = wire
2700 .required_environments
2701 .into_iter()
2702 .map(|simplified_marker| simplified_marker.into_marker(&wire.requires_python))
2703 .collect();
2704 let fork_markers = wire
2705 .fork_markers
2706 .into_iter()
2707 .map(|simplified_marker| simplified_marker.into_marker(&wire.requires_python))
2708 .map(UniversalMarker::from_combined)
2709 .collect();
2710 let mut options = wire.options;
2711 if options.exclude_newer.exclude_newer_span.is_some() {
2712 options.exclude_newer.exclude_newer = None;
2713 }
2714 let lock = Self::new(
2715 wire.version,
2716 wire.revision.unwrap_or(0),
2717 packages,
2718 wire.requires_python,
2719 options,
2720 wire.manifest,
2721 wire.conflicts.unwrap_or_else(Conflicts::empty),
2722 supported_environments,
2723 required_environments,
2724 fork_markers,
2725 )?;
2726
2727 Ok(lock)
2728 }
2729}
2730
2731#[derive(Clone, Debug, serde::Deserialize)]
2735#[serde(rename_all = "kebab-case")]
2736pub struct LockVersion {
2737 version: u32,
2738}
2739
2740impl LockVersion {
2741 pub fn version(&self) -> u32 {
2743 self.version
2744 }
2745}
2746
2747#[derive(Clone, Debug, PartialEq, Eq)]
2748pub struct Package {
2749 pub(crate) id: PackageId,
2750 sdist: Option<SourceDist>,
2751 wheels: Vec<Wheel>,
2752 fork_markers: Vec<UniversalMarker>,
2758 dependencies: Vec<Dependency>,
2760 optional_dependencies: BTreeMap<ExtraName, Vec<Dependency>>,
2762 dependency_groups: BTreeMap<GroupName, Vec<Dependency>>,
2764 metadata: PackageMetadata,
2766}
2767
2768impl Package {
2769 pub fn is_from_pypi_registry(&self) -> bool {
2770 self.id.source.is_pypi_registry()
2771 }
2772
2773 fn from_annotated_dist(
2774 annotated_dist: &AnnotatedDist,
2775 fork_markers: Vec<UniversalMarker>,
2776 root: &Path,
2777 ) -> Result<Self, LockError> {
2778 let id = PackageId::from_annotated_dist(annotated_dist, root)?;
2779 let sdist = SourceDist::from_annotated_dist(&id, annotated_dist)?;
2780 let wheels = Wheel::from_annotated_dist(annotated_dist)?;
2781 let requires_dist = if id.source.is_immutable() {
2782 BTreeSet::default()
2783 } else {
2784 annotated_dist
2785 .metadata
2786 .as_ref()
2787 .expect("metadata is present")
2788 .requires_dist
2789 .iter()
2790 .cloned()
2791 .map(|requirement| requirement.relative_to(root))
2792 .collect::<Result<_, _>>()
2793 .map_err(LockErrorKind::RequirementRelativePath)?
2794 };
2795 let provides_extra = if id.source.is_immutable() {
2796 Box::default()
2797 } else {
2798 annotated_dist
2799 .metadata
2800 .as_ref()
2801 .expect("metadata is present")
2802 .provides_extra
2803 .clone()
2804 };
2805 let dependency_groups = if id.source.is_immutable() {
2806 BTreeMap::default()
2807 } else {
2808 annotated_dist
2809 .metadata
2810 .as_ref()
2811 .expect("metadata is present")
2812 .dependency_groups
2813 .iter()
2814 .map(|(group, requirements)| {
2815 let requirements = requirements
2816 .iter()
2817 .cloned()
2818 .map(|requirement| requirement.relative_to(root))
2819 .collect::<Result<_, _>>()
2820 .map_err(LockErrorKind::RequirementRelativePath)?;
2821 Ok::<_, LockError>((group.clone(), requirements))
2822 })
2823 .collect::<Result<_, _>>()?
2824 };
2825 Ok(Self {
2826 id,
2827 sdist,
2828 wheels,
2829 fork_markers,
2830 dependencies: vec![],
2831 optional_dependencies: BTreeMap::default(),
2832 dependency_groups: BTreeMap::default(),
2833 metadata: PackageMetadata {
2834 requires_dist,
2835 provides_extra,
2836 dependency_groups,
2837 },
2838 })
2839 }
2840
2841 fn add_dependency(
2843 &mut self,
2844 requires_python: &RequiresPython,
2845 annotated_dist: &AnnotatedDist,
2846 marker: UniversalMarker,
2847 root: &Path,
2848 ) -> Result<(), LockError> {
2849 let new_dep =
2850 Dependency::from_annotated_dist(requires_python, annotated_dist, marker, root)?;
2851 for existing_dep in &mut self.dependencies {
2852 if existing_dep.package_id == new_dep.package_id
2853 && existing_dep.simplified_marker == new_dep.simplified_marker
2876 {
2877 existing_dep.extra.extend(new_dep.extra);
2878 return Ok(());
2879 }
2880 }
2881
2882 self.dependencies.push(new_dep);
2883 Ok(())
2884 }
2885
2886 fn add_optional_dependency(
2888 &mut self,
2889 requires_python: &RequiresPython,
2890 extra: ExtraName,
2891 annotated_dist: &AnnotatedDist,
2892 marker: UniversalMarker,
2893 root: &Path,
2894 ) -> Result<(), LockError> {
2895 let dep = Dependency::from_annotated_dist(requires_python, annotated_dist, marker, root)?;
2896 let optional_deps = self.optional_dependencies.entry(extra).or_default();
2897 for existing_dep in &mut *optional_deps {
2898 if existing_dep.package_id == dep.package_id
2899 && existing_dep.simplified_marker == dep.simplified_marker
2902 {
2903 existing_dep.extra.extend(dep.extra);
2904 return Ok(());
2905 }
2906 }
2907
2908 optional_deps.push(dep);
2909 Ok(())
2910 }
2911
2912 fn add_group_dependency(
2914 &mut self,
2915 requires_python: &RequiresPython,
2916 group: GroupName,
2917 annotated_dist: &AnnotatedDist,
2918 marker: UniversalMarker,
2919 root: &Path,
2920 ) -> Result<(), LockError> {
2921 let dep = Dependency::from_annotated_dist(requires_python, annotated_dist, marker, root)?;
2922 let deps = self.dependency_groups.entry(group).or_default();
2923 for existing_dep in &mut *deps {
2924 if existing_dep.package_id == dep.package_id
2925 && existing_dep.simplified_marker == dep.simplified_marker
2928 {
2929 existing_dep.extra.extend(dep.extra);
2930 return Ok(());
2931 }
2932 }
2933
2934 deps.push(dep);
2935 Ok(())
2936 }
2937
2938 fn to_dist(
2940 &self,
2941 workspace_root: &Path,
2942 tag_policy: TagPolicy<'_>,
2943 build_options: &BuildOptions,
2944 markers: &MarkerEnvironment,
2945 ) -> Result<HashedDist, LockError> {
2946 let no_binary = build_options.no_binary_package(&self.id.name);
2947 let no_build = build_options.no_build_package(&self.id.name);
2948
2949 if !no_binary {
2950 if let Some(best_wheel_index) = self.find_best_wheel(tag_policy) {
2951 let hashes = {
2952 let wheel = &self.wheels[best_wheel_index];
2953 HashDigests::from(
2954 wheel
2955 .hash
2956 .iter()
2957 .chain(wheel.zstd.iter().flat_map(|z| z.hash.iter()))
2958 .map(|h| h.0.clone())
2959 .collect::<Vec<_>>(),
2960 )
2961 };
2962
2963 let dist = match &self.id.source {
2964 Source::Registry(source) => {
2965 let wheels = self
2966 .wheels
2967 .iter()
2968 .map(|wheel| wheel.to_registry_wheel(source, workspace_root))
2969 .collect::<Result<_, LockError>>()?;
2970 let reg_built_dist = RegistryBuiltDist {
2971 wheels,
2972 best_wheel_index,
2973 sdist: None,
2974 };
2975 Dist::Built(BuiltDist::Registry(reg_built_dist))
2976 }
2977 Source::Path(path) => {
2978 let filename: WheelFilename =
2979 self.wheels[best_wheel_index].filename.clone();
2980 let install_path = absolute_path(workspace_root, path)?;
2981 let path_dist = PathBuiltDist {
2982 filename,
2983 url: verbatim_url(&install_path, &self.id)?,
2984 install_path: absolute_path(workspace_root, path)?.into_boxed_path(),
2985 };
2986 let built_dist = BuiltDist::Path(path_dist);
2987 Dist::Built(built_dist)
2988 }
2989 Source::Direct(url, direct) => {
2990 let filename: WheelFilename =
2991 self.wheels[best_wheel_index].filename.clone();
2992 let url = DisplaySafeUrl::from(ParsedArchiveUrl {
2993 url: url.to_url().map_err(LockErrorKind::InvalidUrl)?,
2994 subdirectory: direct.subdirectory.clone(),
2995 ext: DistExtension::Wheel,
2996 });
2997 let direct_dist = DirectUrlBuiltDist {
2998 filename,
2999 location: Box::new(url.clone()),
3000 url: VerbatimUrl::from_url(url),
3001 };
3002 let built_dist = BuiltDist::DirectUrl(direct_dist);
3003 Dist::Built(built_dist)
3004 }
3005 Source::Git(url, git) => {
3006 let Some(install_path) = git.path.as_ref() else {
3007 return Err(LockErrorKind::InvalidWheelSource {
3008 id: self.id.clone(),
3009 source_type: "Git",
3010 }
3011 .into());
3012 };
3013
3014 let mut url = url.to_url().map_err(LockErrorKind::InvalidUrl)?;
3017 url.set_fragment(None);
3018 url.set_query(None);
3019
3020 let git_url = GitUrl::from_commit(
3022 url,
3023 GitReference::from(git.kind.clone()),
3024 git.precise,
3025 git.lfs,
3026 )?;
3027
3028 let url = DisplaySafeUrl::from(ParsedGitPathUrl {
3030 url: git_url.clone(),
3031 install_path: install_path.clone(),
3032 ext: DistExtension::Wheel,
3033 });
3034
3035 let filename: WheelFilename =
3036 self.wheels[best_wheel_index].filename.clone();
3037
3038 let git_dist = GitPathBuiltDist {
3039 filename,
3040 git: Box::new(git_url),
3041 install_path: install_path.clone(),
3042 url: VerbatimUrl::from_url(url),
3043 };
3044 let built_dist = BuiltDist::GitPath(git_dist);
3045 Dist::Built(built_dist)
3046 }
3047 Source::Directory(_) => {
3048 return Err(LockErrorKind::InvalidWheelSource {
3049 id: self.id.clone(),
3050 source_type: "directory",
3051 }
3052 .into());
3053 }
3054 Source::Editable(_) => {
3055 return Err(LockErrorKind::InvalidWheelSource {
3056 id: self.id.clone(),
3057 source_type: "editable",
3058 }
3059 .into());
3060 }
3061 Source::Virtual(_) => {
3062 return Err(LockErrorKind::InvalidWheelSource {
3063 id: self.id.clone(),
3064 source_type: "virtual",
3065 }
3066 .into());
3067 }
3068 };
3069
3070 return Ok(HashedDist { dist, hashes });
3071 }
3072 }
3073
3074 if let Some(sdist) = self.to_source_dist(workspace_root)? {
3075 if !no_build || sdist.is_virtual() {
3079 let hashes = self
3080 .sdist
3081 .as_ref()
3082 .and_then(|s| s.hash())
3083 .map(|hash| HashDigests::from(vec![hash.0.clone()]))
3084 .unwrap_or_else(|| HashDigests::from(vec![]));
3085 return Ok(HashedDist {
3086 dist: Dist::Source(sdist),
3087 hashes,
3088 });
3089 }
3090 }
3091
3092 match (no_binary, no_build) {
3093 (true, true) => Err(LockErrorKind::NoBinaryNoBuild {
3094 id: self.id.clone(),
3095 }
3096 .into()),
3097 (true, false) if self.id.source.is_wheel() => Err(LockErrorKind::NoBinaryWheelOnly {
3098 id: self.id.clone(),
3099 }
3100 .into()),
3101 (true, false) => Err(LockErrorKind::NoBinary {
3102 id: self.id.clone(),
3103 }
3104 .into()),
3105 (false, true) => Err(LockErrorKind::NoBuild {
3106 id: self.id.clone(),
3107 }
3108 .into()),
3109 (false, false) if self.id.source.is_wheel() => Err(LockError {
3110 kind: Box::new(LockErrorKind::IncompatibleWheelOnly {
3111 id: self.id.clone(),
3112 }),
3113 hint: self.tag_hint(tag_policy, markers),
3114 }),
3115 (false, false) => Err(LockError {
3116 kind: Box::new(LockErrorKind::NeitherSourceDistNorWheel {
3117 id: self.id.clone(),
3118 }),
3119 hint: self.tag_hint(tag_policy, markers),
3120 }),
3121 }
3122 }
3123
3124 fn tag_hint(
3126 &self,
3127 tag_policy: TagPolicy<'_>,
3128 markers: &MarkerEnvironment,
3129 ) -> Option<WheelTagHint> {
3130 let filenames = self
3131 .wheels
3132 .iter()
3133 .map(|wheel| &wheel.filename)
3134 .collect::<Vec<_>>();
3135 WheelTagHint::from_wheels(
3136 &self.id.name,
3137 self.id.version.as_ref(),
3138 &filenames,
3139 tag_policy.tags(),
3140 markers,
3141 )
3142 }
3143
3144 fn to_source_dist(
3149 &self,
3150 workspace_root: &Path,
3151 ) -> Result<Option<uv_distribution_types::SourceDist>, LockError> {
3152 let sdist = match &self.id.source {
3153 Source::Path(path) => {
3154 let DistExtension::Source(ext) = DistExtension::from_path(path).map_err(|err| {
3156 LockErrorKind::MissingExtension {
3157 id: self.id.clone(),
3158 err,
3159 }
3160 })?
3161 else {
3162 return Ok(None);
3163 };
3164 let install_path = absolute_path(workspace_root, path)?;
3165 let given = path.to_str().expect("lock file paths must be UTF-8");
3166 let path_dist = PathSourceDist {
3167 name: self.id.name.clone(),
3168 version: self.id.version.clone(),
3169 url: verbatim_url(&install_path, &self.id)?.with_given(given),
3170 install_path: install_path.into_boxed_path(),
3171 ext,
3172 };
3173 uv_distribution_types::SourceDist::Path(path_dist)
3174 }
3175 Source::Directory(path) => {
3176 let install_path = absolute_path(workspace_root, path)?;
3177 let given = path.to_str().expect("lock file paths must be UTF-8");
3178 let dir_dist = DirectorySourceDist {
3179 name: self.id.name.clone(),
3180 url: verbatim_url(&install_path, &self.id)?.with_given(given),
3181 install_path: install_path.into_boxed_path(),
3182 editable: Some(false),
3183 r#virtual: Some(false),
3184 };
3185 uv_distribution_types::SourceDist::Directory(dir_dist)
3186 }
3187 Source::Editable(path) => {
3188 let install_path = absolute_path(workspace_root, path)?;
3189 let given = path.to_str().expect("lock file paths must be UTF-8");
3190 let dir_dist = DirectorySourceDist {
3191 name: self.id.name.clone(),
3192 url: verbatim_url(&install_path, &self.id)?.with_given(given),
3193 install_path: install_path.into_boxed_path(),
3194 editable: Some(true),
3195 r#virtual: Some(false),
3196 };
3197 uv_distribution_types::SourceDist::Directory(dir_dist)
3198 }
3199 Source::Virtual(path) => {
3200 let install_path = absolute_path(workspace_root, path)?;
3201 let given = path.to_str().expect("lock file paths must be UTF-8");
3202 let dir_dist = DirectorySourceDist {
3203 name: self.id.name.clone(),
3204 url: verbatim_url(&install_path, &self.id)?.with_given(given),
3205 install_path: install_path.into_boxed_path(),
3206 editable: Some(false),
3207 r#virtual: Some(true),
3208 };
3209 uv_distribution_types::SourceDist::Directory(dir_dist)
3210 }
3211 Source::Git(url, git) => {
3212 let mut url = url.to_url().map_err(LockErrorKind::InvalidUrl)?;
3215 url.set_fragment(None);
3216 url.set_query(None);
3217
3218 let git_url = GitUrl::from_commit(
3219 url,
3220 GitReference::from(git.kind.clone()),
3221 git.precise,
3222 git.lfs,
3223 )?;
3224
3225 if let Some(install_path) = git.path.as_ref() {
3226 let DistExtension::Source(ext) = DistExtension::from_path(install_path)
3228 .map_err(|err| LockErrorKind::MissingExtension {
3229 id: self.id.clone(),
3230 err,
3231 })?
3232 else {
3233 return Ok(None);
3234 };
3235
3236 let url = DisplaySafeUrl::from(ParsedGitPathUrl {
3238 url: git_url.clone(),
3239 install_path: install_path.clone(),
3240 ext: DistExtension::Source(ext),
3241 });
3242
3243 let git_dist = GitPathSourceDist {
3244 name: self.id.name.clone(),
3245 url: VerbatimUrl::from_url(url),
3246 git: Box::new(git_url),
3247 install_path: install_path.clone(),
3248 ext,
3249 };
3250 uv_distribution_types::SourceDist::GitPath(git_dist)
3251 } else {
3252 let url = DisplaySafeUrl::from(ParsedGitDirectoryUrl {
3254 url: git_url.clone(),
3255 subdirectory: git.subdirectory.clone(),
3256 });
3257
3258 let git_dist = GitDirectorySourceDist {
3259 name: self.id.name.clone(),
3260 url: VerbatimUrl::from_url(url),
3261 git: Box::new(git_url),
3262 subdirectory: git.subdirectory.clone(),
3263 };
3264 uv_distribution_types::SourceDist::GitDirectory(git_dist)
3265 }
3266 }
3267 Source::Direct(url, direct) => {
3268 let DistExtension::Source(ext) =
3270 DistExtension::from_path(url.base_str()).map_err(|err| {
3271 LockErrorKind::MissingExtension {
3272 id: self.id.clone(),
3273 err,
3274 }
3275 })?
3276 else {
3277 return Ok(None);
3278 };
3279 let location = url.to_url().map_err(LockErrorKind::InvalidUrl)?;
3280 let url = DisplaySafeUrl::from(ParsedArchiveUrl {
3281 url: location.clone(),
3282 subdirectory: direct.subdirectory.clone(),
3283 ext: DistExtension::Source(ext),
3284 });
3285 let direct_dist = DirectUrlSourceDist {
3286 name: self.id.name.clone(),
3287 location: Box::new(location),
3288 subdirectory: direct.subdirectory.clone(),
3289 ext,
3290 url: VerbatimUrl::from_url(url),
3291 };
3292 uv_distribution_types::SourceDist::DirectUrl(direct_dist)
3293 }
3294 Source::Registry(RegistrySource::Url(url)) => {
3295 let Some(ref sdist) = self.sdist else {
3296 return Ok(None);
3297 };
3298
3299 let name = &self.id.name;
3300 let version = self
3301 .id
3302 .version
3303 .as_ref()
3304 .expect("version for registry source");
3305
3306 let file_url = sdist.url().ok_or_else(|| LockErrorKind::MissingUrl {
3307 name: name.clone(),
3308 version: version.clone(),
3309 })?;
3310 let filename = sdist
3311 .filename()
3312 .ok_or_else(|| LockErrorKind::MissingFilename {
3313 id: self.id.clone(),
3314 })?;
3315 let ext = SourceDistExtension::from_path(filename.as_ref()).map_err(|err| {
3316 LockErrorKind::MissingExtension {
3317 id: self.id.clone(),
3318 err,
3319 }
3320 })?;
3321 let file = Box::new(uv_distribution_types::File {
3322 dist_info_metadata: false,
3323 filename: SmallString::from(filename),
3324 hashes: sdist.hash().map_or(HashDigests::empty(), |hash| {
3325 HashDigests::from(hash.0.clone())
3326 }),
3327 requires_python: None,
3328 size: sdist.size(),
3329 upload_time_utc_ms: sdist.upload_time().map(Timestamp::as_millisecond),
3330 url: FileLocation::AbsoluteUrl(file_url.clone()),
3331 yanked: None,
3332 zstd: None,
3333 });
3334
3335 let index = IndexUrl::from(VerbatimUrl::from_url(
3336 url.to_url().map_err(LockErrorKind::InvalidUrl)?,
3337 ));
3338
3339 let reg_dist = RegistrySourceDist {
3340 name: name.clone(),
3341 version: version.clone(),
3342 file,
3343 ext,
3344 index,
3345 wheels: vec![],
3346 };
3347 uv_distribution_types::SourceDist::Registry(reg_dist)
3348 }
3349 Source::Registry(RegistrySource::Path(path)) => {
3350 let Some(ref sdist) = self.sdist else {
3351 return Ok(None);
3352 };
3353
3354 let name = &self.id.name;
3355 let version = self
3356 .id
3357 .version
3358 .as_ref()
3359 .expect("version for registry source");
3360
3361 let file_url = match sdist {
3362 SourceDist::Url { url: file_url, .. } => {
3363 FileLocation::AbsoluteUrl(file_url.clone())
3364 }
3365 SourceDist::Path {
3366 path: file_path, ..
3367 } => {
3368 let file_path = workspace_root.join(path).join(file_path);
3369 let file_url =
3370 DisplaySafeUrl::from_file_path(&file_path).map_err(|()| {
3371 LockErrorKind::PathToUrl {
3372 path: file_path.into_boxed_path(),
3373 }
3374 })?;
3375 FileLocation::AbsoluteUrl(UrlString::from(file_url))
3376 }
3377 SourceDist::Metadata { .. } => {
3378 return Err(LockErrorKind::MissingPath {
3379 name: name.clone(),
3380 version: version.clone(),
3381 }
3382 .into());
3383 }
3384 };
3385 let filename = sdist
3386 .filename()
3387 .ok_or_else(|| LockErrorKind::MissingFilename {
3388 id: self.id.clone(),
3389 })?;
3390 let ext = SourceDistExtension::from_path(filename.as_ref()).map_err(|err| {
3391 LockErrorKind::MissingExtension {
3392 id: self.id.clone(),
3393 err,
3394 }
3395 })?;
3396 let file = Box::new(uv_distribution_types::File {
3397 dist_info_metadata: false,
3398 filename: SmallString::from(filename),
3399 hashes: sdist.hash().map_or(HashDigests::empty(), |hash| {
3400 HashDigests::from(hash.0.clone())
3401 }),
3402 requires_python: None,
3403 size: sdist.size(),
3404 upload_time_utc_ms: sdist.upload_time().map(Timestamp::as_millisecond),
3405 url: file_url,
3406 yanked: None,
3407 zstd: None,
3408 });
3409
3410 let index = IndexUrl::from(
3411 VerbatimUrl::from_absolute_path(workspace_root.join(path))
3412 .map_err(LockErrorKind::RegistryVerbatimUrl)?,
3413 );
3414
3415 let reg_dist = RegistrySourceDist {
3416 name: name.clone(),
3417 version: version.clone(),
3418 file,
3419 ext,
3420 index,
3421 wheels: vec![],
3422 };
3423 uv_distribution_types::SourceDist::Registry(reg_dist)
3424 }
3425 };
3426
3427 Ok(Some(sdist))
3428 }
3429
3430 fn to_toml(
3431 &self,
3432 requires_python: &RequiresPython,
3433 dist_count_by_name: &FxHashMap<PackageName, u64>,
3434 ) -> Result<Table, toml_edit::ser::Error> {
3435 let mut table = Table::new();
3436
3437 self.id.to_toml(None, &mut table);
3438
3439 if !self.fork_markers.is_empty() {
3440 let fork_markers = each_element_on_its_line_array(
3441 simplified_universal_markers(&self.fork_markers, requires_python).into_iter(),
3442 );
3443 if !fork_markers.is_empty() {
3444 table.insert("resolution-markers", value(fork_markers));
3445 }
3446 }
3447
3448 if !self.dependencies.is_empty() {
3449 let deps = each_element_on_its_line_array(self.dependencies.iter().map(|dep| {
3450 dep.to_toml(requires_python, dist_count_by_name)
3451 .into_inline_table()
3452 }));
3453 table.insert("dependencies", value(deps));
3454 }
3455
3456 if !self.optional_dependencies.is_empty() {
3457 let mut optional_deps = Table::new();
3458 for (extra, deps) in &self.optional_dependencies {
3459 let deps = each_element_on_its_line_array(deps.iter().map(|dep| {
3460 dep.to_toml(requires_python, dist_count_by_name)
3461 .into_inline_table()
3462 }));
3463 if !deps.is_empty() {
3464 optional_deps.insert(extra.as_ref(), value(deps));
3465 }
3466 }
3467 if !optional_deps.is_empty() {
3468 table.insert("optional-dependencies", Item::Table(optional_deps));
3469 }
3470 }
3471
3472 if !self.dependency_groups.is_empty() {
3473 let mut dependency_groups = Table::new();
3474 for (extra, deps) in &self.dependency_groups {
3475 let deps = each_element_on_its_line_array(deps.iter().map(|dep| {
3476 dep.to_toml(requires_python, dist_count_by_name)
3477 .into_inline_table()
3478 }));
3479 if !deps.is_empty() {
3480 dependency_groups.insert(extra.as_ref(), value(deps));
3481 }
3482 }
3483 if !dependency_groups.is_empty() {
3484 table.insert("dev-dependencies", Item::Table(dependency_groups));
3485 }
3486 }
3487
3488 if let Some(ref sdist) = self.sdist {
3489 table.insert("sdist", value(sdist.to_toml()?));
3490 }
3491
3492 if !self.wheels.is_empty() {
3493 let wheels = each_element_on_its_line_array(
3494 self.wheels
3495 .iter()
3496 .map(Wheel::to_toml)
3497 .collect::<Result<Vec<_>, _>>()?
3498 .into_iter(),
3499 );
3500 table.insert("wheels", value(wheels));
3501 }
3502
3503 {
3505 let mut metadata_table = Table::new();
3506
3507 if !self.metadata.requires_dist.is_empty() {
3508 let requires_dist = self
3509 .metadata
3510 .requires_dist
3511 .iter()
3512 .map(|requirement| {
3513 serde::Serialize::serialize(
3514 &requirement,
3515 toml_edit::ser::ValueSerializer::new(),
3516 )
3517 })
3518 .collect::<Result<Vec<_>, _>>()?;
3519 let requires_dist = match requires_dist.as_slice() {
3520 [] => Array::new(),
3521 [requirement] => Array::from_iter([requirement]),
3522 requires_dist => each_element_on_its_line_array(requires_dist.iter()),
3523 };
3524 metadata_table.insert("requires-dist", value(requires_dist));
3525 }
3526
3527 if !self.metadata.dependency_groups.is_empty() {
3528 let mut dependency_groups = Table::new();
3529 for (extra, deps) in &self.metadata.dependency_groups {
3530 let deps = deps
3531 .iter()
3532 .map(|requirement| {
3533 serde::Serialize::serialize(
3534 &requirement,
3535 toml_edit::ser::ValueSerializer::new(),
3536 )
3537 })
3538 .collect::<Result<Vec<_>, _>>()?;
3539 let deps = match deps.as_slice() {
3540 [] => Array::new(),
3541 [requirement] => Array::from_iter([requirement]),
3542 deps => each_element_on_its_line_array(deps.iter()),
3543 };
3544 dependency_groups.insert(extra.as_ref(), value(deps));
3545 }
3546 if !dependency_groups.is_empty() {
3547 metadata_table.insert("requires-dev", Item::Table(dependency_groups));
3548 }
3549 }
3550
3551 if !self.metadata.provides_extra.is_empty() {
3552 let provides_extras = self
3553 .metadata
3554 .provides_extra
3555 .iter()
3556 .map(|extra| {
3557 serde::Serialize::serialize(&extra, toml_edit::ser::ValueSerializer::new())
3558 })
3559 .collect::<Result<Vec<_>, _>>()?;
3560 let provides_extras = Array::from_iter(provides_extras);
3562 metadata_table.insert("provides-extras", value(provides_extras));
3563 }
3564
3565 if !metadata_table.is_empty() {
3566 table.insert("metadata", Item::Table(metadata_table));
3567 }
3568 }
3569
3570 Ok(table)
3571 }
3572
3573 fn find_best_wheel(&self, tag_policy: TagPolicy<'_>) -> Option<usize> {
3574 type WheelPriority<'lock> = (TagPriority, Option<&'lock BuildTag>);
3575
3576 let mut best: Option<(WheelPriority, usize)> = None;
3577 for (i, wheel) in self.wheels.iter().enumerate() {
3578 let TagCompatibility::Compatible(tag_priority) =
3579 wheel.filename.compatibility(tag_policy.tags())
3580 else {
3581 continue;
3582 };
3583 let build_tag = wheel.filename.build_tag();
3584 let wheel_priority = (tag_priority, build_tag);
3585 match best {
3586 None => {
3587 best = Some((wheel_priority, i));
3588 }
3589 Some((best_priority, _)) => {
3590 if wheel_priority > best_priority {
3591 best = Some((wheel_priority, i));
3592 }
3593 }
3594 }
3595 }
3596
3597 let best = best.map(|(_, i)| i);
3598 match tag_policy {
3599 TagPolicy::Required(_) => best,
3600 TagPolicy::Preferred(_) => best.or_else(|| self.wheels.first().map(|_| 0)),
3601 }
3602 }
3603
3604 pub fn name(&self) -> &PackageName {
3606 &self.id.name
3607 }
3608
3609 pub fn version(&self) -> Option<&Version> {
3611 self.id.version.as_ref()
3612 }
3613
3614 pub fn git_sha(&self) -> Option<&GitOid> {
3616 match &self.id.source {
3617 Source::Git(_, git) => Some(&git.precise),
3618 _ => None,
3619 }
3620 }
3621
3622 pub(crate) fn fork_markers(&self) -> &[UniversalMarker] {
3624 self.fork_markers.as_slice()
3625 }
3626
3627 pub fn is_included_by_marker(&self, marker: MarkerTree) -> bool {
3629 self.fork_markers.is_empty()
3630 || self
3631 .fork_markers
3632 .iter()
3633 .any(|fork_marker| !fork_marker.pep508().is_disjoint(marker))
3634 }
3635
3636 pub fn index(&self, root: &Path) -> Result<Option<IndexUrl>, LockError> {
3638 match &self.id.source {
3639 Source::Registry(RegistrySource::Url(url)) => {
3640 let index = IndexUrl::from(VerbatimUrl::from_url(
3641 url.to_url().map_err(LockErrorKind::InvalidUrl)?,
3642 ));
3643 Ok(Some(index))
3644 }
3645 Source::Registry(RegistrySource::Path(path)) => {
3646 let index = IndexUrl::from(
3647 VerbatimUrl::from_absolute_path(root.join(path))
3648 .map_err(LockErrorKind::RegistryVerbatimUrl)?,
3649 );
3650 Ok(Some(index))
3651 }
3652 _ => Ok(None),
3653 }
3654 }
3655
3656 fn hashes(&self) -> HashDigests {
3658 let mut hashes = Vec::with_capacity(
3659 usize::from(self.sdist.as_ref().and_then(|sdist| sdist.hash()).is_some())
3660 + self
3661 .wheels
3662 .iter()
3663 .map(|wheel| usize::from(wheel.hash.is_some()))
3664 .sum::<usize>(),
3665 );
3666 if let Some(ref sdist) = self.sdist {
3667 if let Some(hash) = sdist.hash() {
3668 hashes.push(hash.0.clone());
3669 }
3670 }
3671 for wheel in &self.wheels {
3672 hashes.extend(wheel.hash.as_ref().map(|h| h.0.clone()));
3673 if let Some(zstd) = wheel.zstd.as_ref() {
3674 hashes.extend(zstd.hash.as_ref().map(|h| h.0.clone()));
3675 }
3676 }
3677 HashDigests::from(hashes)
3678 }
3679
3680 pub fn as_git_ref(&self) -> Result<Option<ResolvedRepositoryReference>, LockError> {
3682 match &self.id.source {
3683 Source::Git(url, git) => Ok(Some(ResolvedRepositoryReference {
3684 reference: RepositoryReference {
3685 url: RepositoryUrl::new(&url.to_url().map_err(LockErrorKind::InvalidUrl)?),
3686 reference: GitReference::from(git.kind.clone()),
3687 },
3688 sha: git.precise,
3689 })),
3690 _ => Ok(None),
3691 }
3692 }
3693
3694 fn is_dynamic(&self) -> bool {
3696 self.id.version.is_none()
3697 }
3698
3699 pub fn provides_extras(&self) -> &[ExtraName] {
3701 &self.metadata.provides_extra
3702 }
3703
3704 pub fn dependency_groups(&self) -> &BTreeMap<GroupName, BTreeSet<Requirement>> {
3706 &self.metadata.dependency_groups
3707 }
3708
3709 pub fn dependencies(&self) -> &[Dependency] {
3711 &self.dependencies
3712 }
3713
3714 pub fn optional_dependencies(&self) -> &BTreeMap<ExtraName, Vec<Dependency>> {
3716 &self.optional_dependencies
3717 }
3718
3719 pub fn resolved_dependency_groups(&self) -> &BTreeMap<GroupName, Vec<Dependency>> {
3721 &self.dependency_groups
3722 }
3723
3724 fn as_install_target(&self) -> InstallTarget<'_> {
3726 InstallTarget {
3727 name: self.name(),
3728 is_local: self.id.source.is_local(),
3729 }
3730 }
3731}
3732
3733fn verbatim_url(path: &Path, id: &PackageId) -> Result<VerbatimUrl, LockError> {
3735 let url =
3736 VerbatimUrl::from_normalized_path(path).map_err(|err| LockErrorKind::VerbatimUrl {
3737 id: id.clone(),
3738 err,
3739 })?;
3740 Ok(url)
3741}
3742
3743fn absolute_path(workspace_root: &Path, path: &Path) -> Result<PathBuf, LockError> {
3745 let path = uv_fs::normalize_absolute_path(&workspace_root.join(path))
3746 .map_err(LockErrorKind::AbsolutePath)?;
3747 Ok(path)
3748}
3749
3750#[derive(Clone, Debug, serde::Deserialize)]
3751#[serde(rename_all = "kebab-case")]
3752struct PackageWire {
3753 #[serde(flatten)]
3754 id: PackageId,
3755 #[serde(default)]
3756 metadata: PackageMetadata,
3757 #[serde(default)]
3758 sdist: Option<SourceDist>,
3759 #[serde(default)]
3760 wheels: Vec<Wheel>,
3761 #[serde(default, rename = "resolution-markers")]
3762 fork_markers: Vec<SimplifiedMarkerTree>,
3763 #[serde(default)]
3764 dependencies: Vec<DependencyWire>,
3765 #[serde(default)]
3766 optional_dependencies: BTreeMap<ExtraName, Vec<DependencyWire>>,
3767 #[serde(default, rename = "dev-dependencies", alias = "dependency-groups")]
3768 dependency_groups: BTreeMap<GroupName, Vec<DependencyWire>>,
3769}
3770
3771#[derive(Clone, Default, Debug, Eq, PartialEq, serde::Deserialize)]
3772#[serde(rename_all = "kebab-case")]
3773struct PackageMetadata {
3774 #[serde(default)]
3775 requires_dist: BTreeSet<Requirement>,
3776 #[serde(default, rename = "provides-extras")]
3777 provides_extra: Box<[ExtraName]>,
3778 #[serde(default, rename = "requires-dev", alias = "dependency-groups")]
3779 dependency_groups: BTreeMap<GroupName, BTreeSet<Requirement>>,
3780}
3781
3782impl PackageWire {
3783 fn unwire(
3784 self,
3785 requires_python: &RequiresPython,
3786 unambiguous_package_ids: &FxHashMap<PackageName, PackageId>,
3787 ) -> Result<Package, LockError> {
3788 if !uv_flags::contains(uv_flags::EnvironmentFlags::SKIP_WHEEL_FILENAME_CHECK) {
3790 if let Some(version) = &self.id.version {
3791 for wheel in &self.wheels {
3792 if *version != wheel.filename.version
3793 && *version != wheel.filename.version.clone().without_local()
3794 {
3795 return Err(LockError::from(LockErrorKind::InconsistentVersions {
3796 name: self.id.name,
3797 version: version.clone(),
3798 wheel: wheel.clone(),
3799 }));
3800 }
3801 }
3802 }
3805 }
3806
3807 let unwire_deps = |deps: Vec<DependencyWire>| -> Result<Vec<Dependency>, LockError> {
3808 deps.into_iter()
3809 .map(|dep| dep.unwire(requires_python, unambiguous_package_ids))
3810 .collect()
3811 };
3812
3813 Ok(Package {
3814 id: self.id,
3815 metadata: self.metadata,
3816 sdist: self.sdist,
3817 wheels: self.wheels,
3818 fork_markers: self
3819 .fork_markers
3820 .into_iter()
3821 .map(|simplified_marker| simplified_marker.into_marker(requires_python))
3822 .map(UniversalMarker::from_combined)
3823 .collect(),
3824 dependencies: unwire_deps(self.dependencies)?,
3825 optional_dependencies: self
3826 .optional_dependencies
3827 .into_iter()
3828 .map(|(extra, deps)| Ok((extra, unwire_deps(deps)?)))
3829 .collect::<Result<_, LockError>>()?,
3830 dependency_groups: self
3831 .dependency_groups
3832 .into_iter()
3833 .map(|(group, deps)| Ok((group, unwire_deps(deps)?)))
3834 .collect::<Result<_, LockError>>()?,
3835 })
3836 }
3837}
3838
3839#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord, serde::Deserialize)]
3842#[serde(rename_all = "kebab-case")]
3843pub(crate) struct PackageId {
3844 pub(crate) name: PackageName,
3845 version: Option<Version>,
3846 source: Source,
3847}
3848
3849impl PackageId {
3850 fn from_annotated_dist(annotated_dist: &AnnotatedDist, root: &Path) -> Result<Self, LockError> {
3851 let source = Source::from_resolved_dist(&annotated_dist.dist, root)?;
3853 let version = if source.is_source_tree()
3855 && annotated_dist
3856 .metadata
3857 .as_ref()
3858 .is_some_and(|metadata| metadata.dynamic)
3859 {
3860 None
3861 } else {
3862 Some(annotated_dist.version.clone())
3863 };
3864 let name = annotated_dist.name.clone();
3865 Ok(Self {
3866 name,
3867 version,
3868 source,
3869 })
3870 }
3871
3872 fn to_toml(&self, dist_count_by_name: Option<&FxHashMap<PackageName, u64>>, table: &mut Table) {
3879 let count = dist_count_by_name.and_then(|map| map.get(&self.name).copied());
3880 table.insert("name", value(self.name.to_string()));
3881 if count.map(|count| count > 1).unwrap_or(true) {
3882 if let Some(version) = &self.version {
3883 table.insert("version", value(version.to_string()));
3884 }
3885 self.source.to_toml(table);
3886 }
3887 }
3888}
3889
3890impl Display for PackageId {
3891 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
3892 if let Some(version) = &self.version {
3893 write!(f, "{}=={} @ {}", self.name, version, self.source)
3894 } else {
3895 write!(f, "{} @ {}", self.name, self.source)
3896 }
3897 }
3898}
3899
3900#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord, serde::Deserialize)]
3901#[serde(rename_all = "kebab-case")]
3902struct PackageIdForDependency {
3903 name: PackageName,
3904 version: Option<Version>,
3905 source: Option<Source>,
3906}
3907
3908impl PackageIdForDependency {
3909 fn unwire(
3910 self,
3911 unambiguous_package_ids: &FxHashMap<PackageName, PackageId>,
3912 ) -> Result<PackageId, LockError> {
3913 let unambiguous_package_id = unambiguous_package_ids.get(&self.name);
3914 let source = self.source.map(Ok::<_, LockError>).unwrap_or_else(|| {
3915 let Some(package_id) = unambiguous_package_id else {
3916 return Err(LockErrorKind::MissingDependencySource {
3917 name: self.name.clone(),
3918 }
3919 .into());
3920 };
3921 Ok(package_id.source.clone())
3922 })?;
3923 let version = if let Some(version) = self.version {
3924 Some(version)
3925 } else {
3926 if let Some(package_id) = unambiguous_package_id {
3927 package_id.version.clone()
3928 } else {
3929 if source.is_source_tree() {
3932 None
3933 } else {
3934 return Err(LockErrorKind::MissingDependencyVersion {
3935 name: self.name.clone(),
3936 }
3937 .into());
3938 }
3939 }
3940 };
3941 Ok(PackageId {
3942 name: self.name,
3943 version,
3944 source,
3945 })
3946 }
3947}
3948
3949impl From<PackageId> for PackageIdForDependency {
3950 fn from(id: PackageId) -> Self {
3951 Self {
3952 name: id.name,
3953 version: id.version,
3954 source: Some(id.source),
3955 }
3956 }
3957}
3958
3959#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord, serde::Deserialize)]
3967#[serde(try_from = "SourceWire")]
3968enum Source {
3969 Registry(RegistrySource),
3971 Git(UrlString, GitSource),
3973 Direct(UrlString, DirectSource),
3975 Path(Box<Path>),
3977 Directory(Box<Path>),
3979 Editable(Box<Path>),
3981 Virtual(Box<Path>),
3983}
3984
3985impl Source {
3986 fn from_resolved_dist(resolved_dist: &ResolvedDist, root: &Path) -> Result<Self, LockError> {
3987 match *resolved_dist {
3988 ResolvedDist::Installed { .. } => unreachable!(),
3990 ResolvedDist::Installable { ref dist, .. } => Self::from_dist(dist, root),
3991 }
3992 }
3993
3994 fn from_dist(dist: &Dist, root: &Path) -> Result<Self, LockError> {
3995 match *dist {
3996 Dist::Built(ref built_dist) => Self::from_built_dist(built_dist, root),
3997 Dist::Source(ref source_dist) => Self::from_source_dist(source_dist, root),
3998 }
3999 }
4000
4001 fn from_built_dist(built_dist: &BuiltDist, root: &Path) -> Result<Self, LockError> {
4002 match *built_dist {
4003 BuiltDist::Registry(ref reg_dist) => Self::from_registry_built_dist(reg_dist, root),
4004 BuiltDist::DirectUrl(ref direct_dist) => Ok(Self::from_direct_built_dist(direct_dist)),
4005 BuiltDist::Path(ref path_dist) => Self::from_path_built_dist(path_dist, root),
4006 BuiltDist::GitPath(ref git_dist) => Self::from_git_path_built_dist(git_dist, root),
4007 }
4008 }
4009
4010 fn from_source_dist(
4011 source_dist: &uv_distribution_types::SourceDist,
4012 root: &Path,
4013 ) -> Result<Self, LockError> {
4014 match *source_dist {
4015 uv_distribution_types::SourceDist::Registry(ref reg_dist) => {
4016 Self::from_registry_source_dist(reg_dist, root)
4017 }
4018 uv_distribution_types::SourceDist::DirectUrl(ref direct_dist) => {
4019 Ok(Self::from_direct_source_dist(direct_dist))
4020 }
4021 uv_distribution_types::SourceDist::GitDirectory(ref git_dist) => {
4022 Ok(Self::from_git_directory_source_dist(git_dist))
4023 }
4024 uv_distribution_types::SourceDist::GitPath(ref git_dist) => {
4025 Self::from_git_path_source_dist(git_dist, root)
4026 }
4027 uv_distribution_types::SourceDist::Path(ref path_dist) => {
4028 Self::from_path_source_dist(path_dist, root)
4029 }
4030 uv_distribution_types::SourceDist::Directory(ref directory) => {
4031 Self::from_directory_source_dist(directory, root)
4032 }
4033 }
4034 }
4035
4036 fn from_registry_built_dist(
4037 reg_dist: &RegistryBuiltDist,
4038 root: &Path,
4039 ) -> Result<Self, LockError> {
4040 Self::from_index_url(®_dist.best_wheel().index, root)
4041 }
4042
4043 fn from_registry_source_dist(
4044 reg_dist: &RegistrySourceDist,
4045 root: &Path,
4046 ) -> Result<Self, LockError> {
4047 Self::from_index_url(®_dist.index, root)
4048 }
4049
4050 fn from_direct_built_dist(direct_dist: &DirectUrlBuiltDist) -> Self {
4051 Self::Direct(
4052 normalize_url(direct_dist.url.to_url()),
4053 DirectSource { subdirectory: None },
4054 )
4055 }
4056
4057 fn from_direct_source_dist(direct_dist: &DirectUrlSourceDist) -> Self {
4058 Self::Direct(
4059 normalize_url(direct_dist.url.to_url()),
4060 DirectSource {
4061 subdirectory: direct_dist.subdirectory.clone(),
4062 },
4063 )
4064 }
4065
4066 fn from_path_built_dist(path_dist: &PathBuiltDist, root: &Path) -> Result<Self, LockError> {
4067 let path = try_relative_to_if(
4068 &path_dist.install_path,
4069 root,
4070 !path_dist.url.was_given_absolute(),
4071 )
4072 .map_err(LockErrorKind::DistributionRelativePath)?;
4073 Ok(Self::Path(path.into_boxed_path()))
4074 }
4075
4076 fn from_path_source_dist(path_dist: &PathSourceDist, root: &Path) -> Result<Self, LockError> {
4077 let path = try_relative_to_if(
4078 &path_dist.install_path,
4079 root,
4080 !path_dist.url.was_given_absolute(),
4081 )
4082 .map_err(LockErrorKind::DistributionRelativePath)?;
4083 Ok(Self::Path(path.into_boxed_path()))
4084 }
4085
4086 fn from_directory_source_dist(
4087 directory_dist: &DirectorySourceDist,
4088 root: &Path,
4089 ) -> Result<Self, LockError> {
4090 let path = try_relative_to_if(
4091 &directory_dist.install_path,
4092 root,
4093 !directory_dist.url.was_given_absolute(),
4094 )
4095 .map_err(LockErrorKind::DistributionRelativePath)?;
4096 if directory_dist.editable.unwrap_or(false) {
4097 Ok(Self::Editable(path.into_boxed_path()))
4098 } else if directory_dist.r#virtual.unwrap_or(false) {
4099 Ok(Self::Virtual(path.into_boxed_path()))
4100 } else {
4101 Ok(Self::Directory(path.into_boxed_path()))
4102 }
4103 }
4104
4105 fn from_index_url(index_url: &IndexUrl, root: &Path) -> Result<Self, LockError> {
4106 match index_url {
4107 IndexUrl::Pypi(_) | IndexUrl::Url(_) => {
4108 let redacted = index_url.without_credentials();
4110 let source = RegistrySource::Url(UrlString::from(redacted.as_ref()));
4111 Ok(Self::Registry(source))
4112 }
4113 IndexUrl::Path(url) => {
4114 let path = url
4115 .to_file_path()
4116 .map_err(|()| LockErrorKind::UrlToPath { url: url.to_url() })?;
4117 let path = try_relative_to_if(&path, root, !url.was_given_absolute())
4118 .map_err(LockErrorKind::IndexRelativePath)?;
4119 let source = RegistrySource::Path(path.into_boxed_path());
4120 Ok(Self::Registry(source))
4121 }
4122 }
4123 }
4124
4125 fn from_git_path_built_dist(
4126 git_dist: &GitPathBuiltDist,
4127 root: &Path,
4128 ) -> Result<Self, LockError> {
4129 let path = relative_to(&git_dist.install_path, root)
4130 .or_else(|_| std::path::absolute(&git_dist.install_path))
4131 .map_err(LockErrorKind::DistributionRelativePath)?;
4132 Ok(Self::Git(
4133 UrlString::from(locked_git_url(
4134 &git_dist.git,
4135 None,
4136 Some(git_dist.install_path.as_path()),
4137 )),
4138 GitSource {
4139 kind: GitSourceKind::from(git_dist.git.reference().clone()),
4140 precise: git_dist.git.precise().unwrap_or_else(|| {
4141 panic!("Git distribution is missing a precise hash: {git_dist}")
4142 }),
4143 subdirectory: None,
4144 path: Some(path),
4145 lfs: git_dist.git.lfs(),
4146 },
4147 ))
4148 }
4149
4150 fn from_git_path_source_dist(
4151 git_dist: &GitPathSourceDist,
4152 root: &Path,
4153 ) -> Result<Self, LockError> {
4154 let path = relative_to(&git_dist.install_path, root)
4155 .or_else(|_| std::path::absolute(&git_dist.install_path))
4156 .map_err(LockErrorKind::DistributionRelativePath)?;
4157 Ok(Self::Git(
4158 UrlString::from(locked_git_url(
4159 &git_dist.git,
4160 None,
4161 Some(git_dist.install_path.as_path()),
4162 )),
4163 GitSource {
4164 kind: GitSourceKind::from(git_dist.git.reference().clone()),
4165 precise: git_dist.git.precise().unwrap_or_else(|| {
4166 panic!("Git distribution is missing a precise hash: {git_dist}")
4167 }),
4168 subdirectory: None,
4169 path: Some(path),
4170 lfs: git_dist.git.lfs(),
4171 },
4172 ))
4173 }
4174
4175 fn from_git_directory_source_dist(git_dist: &GitDirectorySourceDist) -> Self {
4176 Self::Git(
4177 UrlString::from(locked_git_url(
4178 &git_dist.git,
4179 git_dist.subdirectory.as_deref(),
4180 None,
4181 )),
4182 GitSource {
4183 kind: GitSourceKind::from(git_dist.git.reference().clone()),
4184 precise: git_dist.git.precise().unwrap_or_else(|| {
4185 panic!("Git distribution is missing a precise hash: {git_dist}")
4186 }),
4187 subdirectory: git_dist.subdirectory.clone(),
4188 path: None,
4189 lfs: git_dist.git.lfs(),
4190 },
4191 )
4192 }
4193
4194 fn is_pypi_registry(&self) -> bool {
4196 matches!(
4197 self,
4198 Self::Registry(RegistrySource::Url(url)) if url.as_ref() == PYPI_URL.as_str()
4199 )
4200 }
4201
4202 fn is_immutable(&self) -> bool {
4209 matches!(self, Self::Registry(..) | Self::Git(_, _))
4210 }
4211
4212 fn is_wheel(&self) -> bool {
4214 match self {
4215 Self::Path(path) => {
4216 matches!(
4217 DistExtension::from_path(path).ok(),
4218 Some(DistExtension::Wheel)
4219 )
4220 }
4221 Self::Direct(url, _) => {
4222 matches!(
4223 DistExtension::from_path(url.as_ref()).ok(),
4224 Some(DistExtension::Wheel)
4225 )
4226 }
4227 Self::Directory(..) => false,
4228 Self::Editable(..) => false,
4229 Self::Virtual(..) => false,
4230 Self::Git(..) => false,
4231 Self::Registry(..) => false,
4232 }
4233 }
4234
4235 fn is_source_tree(&self) -> bool {
4237 match self {
4238 Self::Directory(..) | Self::Editable(..) | Self::Virtual(..) => true,
4239 Self::Path(..) | Self::Git(..) | Self::Registry(..) | Self::Direct(..) => false,
4240 }
4241 }
4242
4243 fn as_source_tree(&self) -> Option<&Path> {
4245 match self {
4246 Self::Directory(path) | Self::Editable(path) | Self::Virtual(path) => Some(path),
4247 Self::Path(..) | Self::Git(..) | Self::Registry(..) | Self::Direct(..) => None,
4248 }
4249 }
4250
4251 fn to_toml(&self, table: &mut Table) {
4252 let mut source_table = InlineTable::new();
4253 match self {
4254 Self::Registry(source) => match source {
4255 RegistrySource::Url(url) => {
4256 source_table.insert("registry", Value::from(url.as_ref()));
4257 }
4258 RegistrySource::Path(path) => {
4259 source_table.insert(
4260 "registry",
4261 Value::from(PortablePath::from(path).to_string()),
4262 );
4263 }
4264 },
4265 Self::Git(url, _) => {
4266 source_table.insert("git", Value::from(url.as_ref()));
4267 }
4268 Self::Direct(url, DirectSource { subdirectory }) => {
4269 source_table.insert("url", Value::from(url.as_ref()));
4270 if let Some(ref subdirectory) = *subdirectory {
4271 source_table.insert(
4272 "subdirectory",
4273 Value::from(PortablePath::from(subdirectory).to_string()),
4274 );
4275 }
4276 }
4277 Self::Path(path) => {
4278 source_table.insert("path", Value::from(PortablePath::from(path).to_string()));
4279 }
4280 Self::Directory(path) => {
4281 source_table.insert(
4282 "directory",
4283 Value::from(PortablePath::from(path).to_string()),
4284 );
4285 }
4286 Self::Editable(path) => {
4287 source_table.insert(
4288 "editable",
4289 Value::from(PortablePath::from(path).to_string()),
4290 );
4291 }
4292 Self::Virtual(path) => {
4293 source_table.insert("virtual", Value::from(PortablePath::from(path).to_string()));
4294 }
4295 }
4296 table.insert("source", value(source_table));
4297 }
4298
4299 fn is_local(&self) -> bool {
4301 matches!(
4302 self,
4303 Self::Path(_) | Self::Directory(_) | Self::Editable(_) | Self::Virtual(_)
4304 )
4305 }
4306}
4307
4308impl Display for Source {
4309 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
4310 match self {
4311 Self::Registry(RegistrySource::Url(url)) | Self::Git(url, _) | Self::Direct(url, _) => {
4312 write!(f, "{}+{}", self.name(), url)
4313 }
4314 Self::Registry(RegistrySource::Path(path))
4315 | Self::Path(path)
4316 | Self::Directory(path)
4317 | Self::Editable(path)
4318 | Self::Virtual(path) => {
4319 write!(f, "{}+{}", self.name(), PortablePath::from(path))
4320 }
4321 }
4322 }
4323}
4324
4325impl Source {
4326 fn name(&self) -> &str {
4327 match self {
4328 Self::Registry(..) => "registry",
4329 Self::Git(..) => "git",
4330 Self::Direct(..) => "direct",
4331 Self::Path(..) => "path",
4332 Self::Directory(..) => "directory",
4333 Self::Editable(..) => "editable",
4334 Self::Virtual(..) => "virtual",
4335 }
4336 }
4337
4338 fn requires_hash(&self) -> Option<bool> {
4346 match self {
4347 Self::Registry(..) => None,
4348 Self::Direct(..) | Self::Path(..) => Some(true),
4349 Self::Git(.., GitSource { path, .. }) => Some(path.is_some()),
4350 Self::Directory(..) | Self::Editable(..) | Self::Virtual(..) => Some(false),
4351 }
4352 }
4353}
4354
4355#[derive(Clone, Debug, serde::Deserialize)]
4356#[serde(untagged, rename_all = "kebab-case")]
4357enum SourceWire {
4358 Registry {
4359 registry: RegistrySourceWire,
4360 },
4361 Git {
4362 git: String,
4363 },
4364 Direct {
4365 url: UrlString,
4366 subdirectory: Option<PortablePathBuf>,
4367 },
4368 Path {
4369 path: PortablePathBuf,
4370 },
4371 Directory {
4372 directory: PortablePathBuf,
4373 },
4374 Editable {
4375 editable: PortablePathBuf,
4376 },
4377 Virtual {
4378 r#virtual: PortablePathBuf,
4379 },
4380}
4381
4382impl TryFrom<SourceWire> for Source {
4383 type Error = LockError;
4384
4385 fn try_from(wire: SourceWire) -> Result<Self, LockError> {
4386 use self::SourceWire::{Direct, Directory, Editable, Git, Path, Registry, Virtual};
4387
4388 match wire {
4389 Registry { registry } => Ok(Self::Registry(registry.into())),
4390 Git { git } => {
4391 let url = DisplaySafeUrl::parse(&git)
4392 .map_err(|err| SourceParseError::InvalidUrl {
4393 given: git.clone(),
4394 err,
4395 })
4396 .map_err(LockErrorKind::InvalidGitSourceUrl)?;
4397
4398 let git_source = GitSource::from_url(&url)
4399 .map_err(|err| match err {
4400 GitSourceError::InvalidSha => SourceParseError::InvalidSha { given: git },
4401 GitSourceError::MissingSha => SourceParseError::MissingSha { given: git },
4402 })
4403 .map_err(LockErrorKind::InvalidGitSourceUrl)?;
4404
4405 Ok(Self::Git(UrlString::from(url), git_source))
4406 }
4407 Direct { url, subdirectory } => Ok(Self::Direct(
4408 url,
4409 DirectSource {
4410 subdirectory: subdirectory.map(Box::<std::path::Path>::from),
4411 },
4412 )),
4413 Path { path } => Ok(Self::Path(path.into())),
4414 Directory { directory } => Ok(Self::Directory(directory.into())),
4415 Editable { editable } => Ok(Self::Editable(editable.into())),
4416 Virtual { r#virtual } => Ok(Self::Virtual(r#virtual.into())),
4417 }
4418 }
4419}
4420
4421#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
4423enum RegistrySource {
4424 Url(UrlString),
4426 Path(Box<Path>),
4428}
4429
4430impl Display for RegistrySource {
4431 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
4432 match self {
4433 Self::Url(url) => write!(f, "{url}"),
4434 Self::Path(path) => write!(f, "{}", path.display()),
4435 }
4436 }
4437}
4438
4439#[derive(Clone, Debug)]
4440enum RegistrySourceWire {
4441 Url(UrlString),
4443 Path(PortablePathBuf),
4445}
4446
4447impl<'de> serde::de::Deserialize<'de> for RegistrySourceWire {
4448 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
4449 where
4450 D: serde::de::Deserializer<'de>,
4451 {
4452 struct Visitor;
4453
4454 impl serde::de::Visitor<'_> for Visitor {
4455 type Value = RegistrySourceWire;
4456
4457 fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
4458 formatter.write_str("a valid URL or a file path")
4459 }
4460
4461 fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
4462 where
4463 E: serde::de::Error,
4464 {
4465 if split_scheme(value).is_some_and(|(scheme, _)| Scheme::parse(scheme).is_some()) {
4466 Ok(
4467 serde::Deserialize::deserialize(serde::de::value::StrDeserializer::new(
4468 value,
4469 ))
4470 .map(RegistrySourceWire::Url)?,
4471 )
4472 } else {
4473 Ok(
4474 serde::Deserialize::deserialize(serde::de::value::StrDeserializer::new(
4475 value,
4476 ))
4477 .map(RegistrySourceWire::Path)?,
4478 )
4479 }
4480 }
4481 }
4482
4483 deserializer.deserialize_str(Visitor)
4484 }
4485}
4486
4487impl From<RegistrySourceWire> for RegistrySource {
4488 fn from(wire: RegistrySourceWire) -> Self {
4489 match wire {
4490 RegistrySourceWire::Url(url) => Self::Url(url),
4491 RegistrySourceWire::Path(path) => Self::Path(path.into()),
4492 }
4493 }
4494}
4495
4496#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord, serde::Deserialize)]
4497#[serde(rename_all = "kebab-case")]
4498struct DirectSource {
4499 subdirectory: Option<Box<Path>>,
4500}
4501
4502#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
4507struct GitSource {
4508 precise: GitOid,
4509 subdirectory: Option<Box<Path>>,
4510 path: Option<PathBuf>,
4511 kind: GitSourceKind,
4512 lfs: GitLfs,
4513}
4514
4515#[derive(Clone, Debug, Eq, PartialEq)]
4517enum GitSourceError {
4518 InvalidSha,
4519 MissingSha,
4520}
4521
4522impl GitSource {
4523 fn from_url(url: &Url) -> Result<Self, GitSourceError> {
4526 let mut kind = GitSourceKind::DefaultBranch;
4527 let mut subdirectory = None;
4528 let mut lfs = GitLfs::Disabled;
4529 let mut path = None;
4530 for (key, val) in url.query_pairs() {
4531 match &*key {
4532 "tag" => kind = GitSourceKind::Tag(val.into_owned()),
4533 "branch" => kind = GitSourceKind::Branch(val.into_owned()),
4534 "rev" => kind = GitSourceKind::Rev(val.into_owned()),
4535 "subdirectory" => subdirectory = Some(PortablePathBuf::from(val.as_ref()).into()),
4536 "lfs" => lfs = GitLfs::from(val.eq_ignore_ascii_case("true")),
4537 "path" => {
4538 path = Some(PathBuf::from(Box::<Path>::from(PortablePathBuf::from(
4539 val.as_ref(),
4540 ))));
4541 }
4542 _ => {}
4543 }
4544 }
4545
4546 let precise = GitOid::from_str(url.fragment().ok_or(GitSourceError::MissingSha)?)
4547 .map_err(|_| GitSourceError::InvalidSha)?;
4548
4549 Ok(Self {
4550 precise,
4551 subdirectory,
4552 path,
4553 kind,
4554 lfs,
4555 })
4556 }
4557}
4558
4559#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord, serde::Deserialize)]
4560#[serde(rename_all = "kebab-case")]
4561enum GitSourceKind {
4562 Tag(String),
4563 Branch(String),
4564 Rev(String),
4565 DefaultBranch,
4566}
4567
4568#[derive(Clone, Debug, serde::Deserialize, PartialEq, Eq)]
4570#[serde(rename_all = "kebab-case")]
4571struct SourceDistMetadata {
4572 hash: Option<Hash>,
4574 size: Option<u64>,
4578 #[serde(alias = "upload_time")]
4580 upload_time: Option<Timestamp>,
4581}
4582
4583#[derive(Clone, Debug, serde::Deserialize, PartialEq, Eq)]
4588#[serde(from = "SourceDistWire")]
4589enum SourceDist {
4590 Url {
4591 url: UrlString,
4592 #[serde(flatten)]
4593 metadata: SourceDistMetadata,
4594 },
4595 Path {
4596 path: Box<Path>,
4597 #[serde(flatten)]
4598 metadata: SourceDistMetadata,
4599 },
4600 Metadata {
4601 #[serde(flatten)]
4602 metadata: SourceDistMetadata,
4603 },
4604}
4605
4606impl SourceDist {
4607 fn filename(&self) -> Option<Cow<'_, str>> {
4608 match self {
4609 Self::Metadata { .. } => None,
4610 Self::Url { url, .. } => url.filename().ok(),
4611 Self::Path { path, .. } => path.file_name().map(|filename| filename.to_string_lossy()),
4612 }
4613 }
4614
4615 fn url(&self) -> Option<&UrlString> {
4616 match self {
4617 Self::Metadata { .. } => None,
4618 Self::Url { url, .. } => Some(url),
4619 Self::Path { .. } => None,
4620 }
4621 }
4622
4623 fn hash(&self) -> Option<&Hash> {
4624 match self {
4625 Self::Metadata { metadata } => metadata.hash.as_ref(),
4626 Self::Url { metadata, .. } => metadata.hash.as_ref(),
4627 Self::Path { metadata, .. } => metadata.hash.as_ref(),
4628 }
4629 }
4630
4631 fn size(&self) -> Option<u64> {
4632 match self {
4633 Self::Metadata { metadata } => metadata.size,
4634 Self::Url { metadata, .. } => metadata.size,
4635 Self::Path { metadata, .. } => metadata.size,
4636 }
4637 }
4638
4639 fn upload_time(&self) -> Option<Timestamp> {
4640 match self {
4641 Self::Metadata { metadata } => metadata.upload_time,
4642 Self::Url { metadata, .. } => metadata.upload_time,
4643 Self::Path { metadata, .. } => metadata.upload_time,
4644 }
4645 }
4646}
4647
4648impl SourceDist {
4649 fn from_annotated_dist(
4650 id: &PackageId,
4651 annotated_dist: &AnnotatedDist,
4652 ) -> Result<Option<Self>, LockError> {
4653 match annotated_dist.dist {
4654 ResolvedDist::Installed { .. } => unreachable!(),
4656 ResolvedDist::Installable { ref dist, .. } => Self::from_dist(
4657 id,
4658 dist,
4659 annotated_dist.hashes.as_slice(),
4660 annotated_dist.index(),
4661 ),
4662 }
4663 }
4664
4665 fn from_dist(
4666 id: &PackageId,
4667 dist: &Dist,
4668 hashes: &[HashDigest],
4669 index: Option<&IndexUrl>,
4670 ) -> Result<Option<Self>, LockError> {
4671 match *dist {
4672 Dist::Built(BuiltDist::Registry(ref built_dist)) => {
4673 let Some(sdist) = built_dist.sdist.as_ref() else {
4674 return Ok(None);
4675 };
4676 Self::from_registry_dist(sdist, index)
4677 }
4678 Dist::Built(_) => Ok(None),
4679 Dist::Source(ref source_dist) => Self::from_source_dist(id, source_dist, hashes, index),
4680 }
4681 }
4682
4683 fn from_source_dist(
4684 id: &PackageId,
4685 source_dist: &uv_distribution_types::SourceDist,
4686 hashes: &[HashDigest],
4687 index: Option<&IndexUrl>,
4688 ) -> Result<Option<Self>, LockError> {
4689 match *source_dist {
4690 uv_distribution_types::SourceDist::Registry(ref reg_dist) => {
4691 Self::from_registry_dist(reg_dist, index)
4692 }
4693 uv_distribution_types::SourceDist::DirectUrl(_) => {
4694 Self::from_direct_dist(id, hashes).map(Some)
4695 }
4696 uv_distribution_types::SourceDist::Path(_) => {
4697 Self::from_path_dist(id, hashes).map(Some)
4698 }
4699 uv_distribution_types::SourceDist::GitPath(_) => {
4700 Self::from_git_path_dist(id, hashes).map(Some)
4701 }
4702 uv_distribution_types::SourceDist::GitDirectory(_)
4703 | uv_distribution_types::SourceDist::Directory(_) => Ok(None),
4704 }
4705 }
4706
4707 fn from_registry_dist(
4708 reg_dist: &RegistrySourceDist,
4709 index: Option<&IndexUrl>,
4710 ) -> Result<Option<Self>, LockError> {
4711 if index.is_none_or(|index| *index != reg_dist.index) {
4714 return Ok(None);
4715 }
4716
4717 match ®_dist.index {
4718 IndexUrl::Pypi(_) | IndexUrl::Url(_) => {
4719 let url = normalize_file_location(®_dist.file.url)
4720 .map_err(LockErrorKind::InvalidUrl)
4721 .map_err(LockError::from)?;
4722 let hash = reg_dist.file.hashes.iter().max().cloned().map(Hash::from);
4723 let size = reg_dist.file.size;
4724 let upload_time = reg_dist
4725 .file
4726 .upload_time_utc_ms
4727 .map(Timestamp::from_millisecond)
4728 .transpose()
4729 .map_err(LockErrorKind::InvalidTimestamp)?;
4730 Ok(Some(Self::Url {
4731 url,
4732 metadata: SourceDistMetadata {
4733 hash,
4734 size,
4735 upload_time,
4736 },
4737 }))
4738 }
4739 IndexUrl::Path(path) => {
4740 let index_path = path
4741 .to_file_path()
4742 .map_err(|()| LockErrorKind::UrlToPath { url: path.to_url() })?;
4743 let url = reg_dist
4744 .file
4745 .url
4746 .to_url()
4747 .map_err(LockErrorKind::InvalidUrl)?;
4748
4749 if url.scheme() == "file" {
4750 let reg_dist_path = url
4751 .to_file_path()
4752 .map_err(|()| LockErrorKind::UrlToPath { url })?;
4753 let path =
4754 try_relative_to_if(®_dist_path, index_path, !path.was_given_absolute())
4755 .map_err(LockErrorKind::DistributionRelativePath)?
4756 .into_boxed_path();
4757 let hash = reg_dist.file.hashes.iter().max().cloned().map(Hash::from);
4758 let size = reg_dist.file.size;
4759 let upload_time = reg_dist
4760 .file
4761 .upload_time_utc_ms
4762 .map(Timestamp::from_millisecond)
4763 .transpose()
4764 .map_err(LockErrorKind::InvalidTimestamp)?;
4765 Ok(Some(Self::Path {
4766 path,
4767 metadata: SourceDistMetadata {
4768 hash,
4769 size,
4770 upload_time,
4771 },
4772 }))
4773 } else {
4774 let url = normalize_file_location(®_dist.file.url)
4775 .map_err(LockErrorKind::InvalidUrl)
4776 .map_err(LockError::from)?;
4777 let hash = reg_dist.file.hashes.iter().max().cloned().map(Hash::from);
4778 let size = reg_dist.file.size;
4779 let upload_time = reg_dist
4780 .file
4781 .upload_time_utc_ms
4782 .map(Timestamp::from_millisecond)
4783 .transpose()
4784 .map_err(LockErrorKind::InvalidTimestamp)?;
4785 Ok(Some(Self::Url {
4786 url,
4787 metadata: SourceDistMetadata {
4788 hash,
4789 size,
4790 upload_time,
4791 },
4792 }))
4793 }
4794 }
4795 }
4796 }
4797
4798 fn from_direct_dist(id: &PackageId, hashes: &[HashDigest]) -> Result<Self, LockError> {
4799 let Some(hash) = hashes.iter().max().cloned().map(Hash::from) else {
4800 let kind = LockErrorKind::Hash {
4801 id: id.clone(),
4802 artifact_type: "direct URL source distribution",
4803 expected: true,
4804 };
4805 return Err(kind.into());
4806 };
4807 Ok(Self::Metadata {
4808 metadata: SourceDistMetadata {
4809 hash: Some(hash),
4810 size: None,
4811 upload_time: None,
4812 },
4813 })
4814 }
4815
4816 fn from_path_dist(id: &PackageId, hashes: &[HashDigest]) -> Result<Self, LockError> {
4817 let Some(hash) = hashes.iter().max().cloned().map(Hash::from) else {
4818 let kind = LockErrorKind::Hash {
4819 id: id.clone(),
4820 artifact_type: "path source distribution",
4821 expected: true,
4822 };
4823 return Err(kind.into());
4824 };
4825 Ok(Self::Metadata {
4826 metadata: SourceDistMetadata {
4827 hash: Some(hash),
4828 size: None,
4829 upload_time: None,
4830 },
4831 })
4832 }
4833
4834 fn from_git_path_dist(id: &PackageId, hashes: &[HashDigest]) -> Result<Self, LockError> {
4835 let Some(hash) = hashes.iter().max().cloned().map(Hash::from) else {
4836 let kind = LockErrorKind::Hash {
4837 id: id.clone(),
4838 artifact_type: "Git archive source distribution",
4839 expected: true,
4840 };
4841 return Err(kind.into());
4842 };
4843 Ok(Self::Metadata {
4844 metadata: SourceDistMetadata {
4845 hash: Some(hash),
4846 size: None,
4847 upload_time: None,
4848 },
4849 })
4850 }
4851}
4852
4853#[derive(Clone, Debug, serde::Deserialize)]
4854#[serde(untagged, rename_all = "kebab-case")]
4855enum SourceDistWire {
4856 Url {
4857 url: UrlString,
4858 #[serde(flatten)]
4859 metadata: SourceDistMetadata,
4860 },
4861 Path {
4862 path: PortablePathBuf,
4863 #[serde(flatten)]
4864 metadata: SourceDistMetadata,
4865 },
4866 Metadata {
4867 #[serde(flatten)]
4868 metadata: SourceDistMetadata,
4869 },
4870}
4871
4872impl SourceDist {
4873 fn to_toml(&self) -> Result<InlineTable, toml_edit::ser::Error> {
4875 let mut table = InlineTable::new();
4876 match self {
4877 Self::Metadata { .. } => {}
4878 Self::Url { url, .. } => {
4879 table.insert("url", Value::from(url.as_ref()));
4880 }
4881 Self::Path { path, .. } => {
4882 table.insert("path", Value::from(PortablePath::from(path).to_string()));
4883 }
4884 }
4885 if let Some(hash) = self.hash() {
4886 table.insert("hash", Value::from(hash.to_string()));
4887 }
4888 if let Some(size) = self.size() {
4889 table.insert(
4890 "size",
4891 toml_edit::ser::ValueSerializer::new().serialize_u64(size)?,
4892 );
4893 }
4894 if let Some(upload_time) = self.upload_time() {
4895 table.insert("upload-time", Value::from(upload_time.to_string()));
4896 }
4897 Ok(table)
4898 }
4899}
4900
4901impl From<SourceDistWire> for SourceDist {
4902 fn from(wire: SourceDistWire) -> Self {
4903 match wire {
4904 SourceDistWire::Url { url, metadata } => Self::Url { url, metadata },
4905 SourceDistWire::Path { path, metadata } => Self::Path {
4906 path: path.into(),
4907 metadata,
4908 },
4909 SourceDistWire::Metadata { metadata } => Self::Metadata { metadata },
4910 }
4911 }
4912}
4913
4914impl From<GitReference> for GitSourceKind {
4915 fn from(value: GitReference) -> Self {
4916 match value {
4917 GitReference::Branch(branch) => Self::Branch(branch),
4918 GitReference::Tag(tag) => Self::Tag(tag),
4919 GitReference::BranchOrTag(rev) => Self::Rev(rev),
4920 GitReference::BranchOrTagOrCommit(rev) => Self::Rev(rev),
4921 GitReference::NamedRef(rev) => Self::Rev(rev),
4922 GitReference::DefaultBranch => Self::DefaultBranch,
4923 }
4924 }
4925}
4926
4927impl From<GitSourceKind> for GitReference {
4928 fn from(value: GitSourceKind) -> Self {
4929 match value {
4930 GitSourceKind::Branch(branch) => Self::Branch(branch),
4931 GitSourceKind::Tag(tag) => Self::Tag(tag),
4932 GitSourceKind::Rev(rev) => Self::from_rev(rev),
4933 GitSourceKind::DefaultBranch => Self::DefaultBranch,
4934 }
4935 }
4936}
4937
4938fn locked_git_url(
4940 git: &GitUrl,
4941 subdirectory: Option<&Path>,
4942 path: Option<&Path>,
4943) -> DisplaySafeUrl {
4944 let mut url = git.url().clone();
4945
4946 url.remove_credentials();
4948
4949 url.set_fragment(None);
4951 url.set_query(None);
4952
4953 if let Some(subdirectory) = subdirectory
4955 .map(PortablePath::from)
4956 .as_ref()
4957 .map(PortablePath::to_string)
4958 {
4959 url.query_pairs_mut()
4960 .append_pair("subdirectory", &subdirectory);
4961 }
4962
4963 if let Some(path) = path
4965 .map(PortablePath::from)
4966 .as_ref()
4967 .map(PortablePath::to_string)
4968 {
4969 url.query_pairs_mut().append_pair("path", &path);
4970 }
4971
4972 if git.lfs().enabled() {
4974 url.query_pairs_mut().append_pair("lfs", "true");
4975 }
4976
4977 match git.reference() {
4979 GitReference::Branch(branch) => {
4980 url.query_pairs_mut().append_pair("branch", branch.as_str());
4981 }
4982 GitReference::Tag(tag) => {
4983 url.query_pairs_mut().append_pair("tag", tag.as_str());
4984 }
4985 GitReference::BranchOrTag(rev)
4986 | GitReference::BranchOrTagOrCommit(rev)
4987 | GitReference::NamedRef(rev) => {
4988 url.query_pairs_mut().append_pair("rev", rev.as_str());
4989 }
4990 GitReference::DefaultBranch => {}
4991 }
4992
4993 url.set_fragment(git.precise().as_ref().map(GitOid::to_string).as_deref());
4995
4996 url
4997}
4998
4999#[derive(Clone, Debug, serde::Deserialize, PartialEq, Eq)]
5000struct ZstdWheel {
5001 hash: Option<Hash>,
5002 size: Option<u64>,
5003}
5004
5005#[derive(Clone, Debug, serde::Deserialize, PartialEq, Eq)]
5007#[serde(try_from = "WheelWire")]
5008struct Wheel {
5009 url: WheelWireSource,
5014 hash: Option<Hash>,
5020 size: Option<u64>,
5024 upload_time: Option<Timestamp>,
5028 filename: WheelFilename,
5035 zstd: Option<ZstdWheel>,
5037}
5038
5039impl Wheel {
5040 fn from_annotated_dist(annotated_dist: &AnnotatedDist) -> Result<Vec<Self>, LockError> {
5041 match annotated_dist.dist {
5042 ResolvedDist::Installed { .. } => unreachable!(),
5044 ResolvedDist::Installable { ref dist, .. } => Self::from_dist(
5045 dist,
5046 annotated_dist.hashes.as_slice(),
5047 annotated_dist.index(),
5048 ),
5049 }
5050 }
5051
5052 fn from_dist(
5053 dist: &Dist,
5054 hashes: &[HashDigest],
5055 index: Option<&IndexUrl>,
5056 ) -> Result<Vec<Self>, LockError> {
5057 match *dist {
5058 Dist::Built(ref built_dist) => Self::from_built_dist(built_dist, hashes, index),
5059 Dist::Source(uv_distribution_types::SourceDist::Registry(ref source_dist)) => {
5060 source_dist
5061 .wheels
5062 .iter()
5063 .filter(|wheel| {
5064 index.is_some_and(|index| *index == wheel.index)
5067 })
5068 .map(Self::from_registry_wheel)
5069 .collect()
5070 }
5071 Dist::Source(_) => Ok(vec![]),
5072 }
5073 }
5074
5075 fn from_built_dist(
5076 built_dist: &BuiltDist,
5077 hashes: &[HashDigest],
5078 index: Option<&IndexUrl>,
5079 ) -> Result<Vec<Self>, LockError> {
5080 match *built_dist {
5081 BuiltDist::Registry(ref reg_dist) => Self::from_registry_dist(reg_dist, index),
5082 BuiltDist::DirectUrl(ref direct_dist) => {
5083 Ok(vec![Self::from_direct_dist(direct_dist, hashes)])
5084 }
5085 BuiltDist::Path(ref path_dist) => Ok(vec![Self::from_path_dist(path_dist, hashes)]),
5086 BuiltDist::GitPath(ref git_dist) => {
5087 Ok(vec![Self::from_git_path_dist(git_dist, hashes)])
5088 }
5089 }
5090 }
5091
5092 fn from_registry_dist(
5093 reg_dist: &RegistryBuiltDist,
5094 index: Option<&IndexUrl>,
5095 ) -> Result<Vec<Self>, LockError> {
5096 reg_dist
5097 .wheels
5098 .iter()
5099 .filter(|wheel| {
5100 index.is_some_and(|index| *index == wheel.index)
5103 })
5104 .map(Self::from_registry_wheel)
5105 .collect()
5106 }
5107
5108 fn from_registry_wheel(wheel: &RegistryBuiltWheel) -> Result<Self, LockError> {
5109 let url = match &wheel.index {
5110 IndexUrl::Pypi(_) | IndexUrl::Url(_) => {
5111 let url = normalize_file_location(&wheel.file.url)
5112 .map_err(LockErrorKind::InvalidUrl)
5113 .map_err(LockError::from)?;
5114 WheelWireSource::Url { url }
5115 }
5116 IndexUrl::Path(path) => {
5117 let index_path = path
5118 .to_file_path()
5119 .map_err(|()| LockErrorKind::UrlToPath { url: path.to_url() })?;
5120 let wheel_url = wheel.file.url.to_url().map_err(LockErrorKind::InvalidUrl)?;
5121
5122 if wheel_url.scheme() == "file" {
5123 let wheel_path = wheel_url
5124 .to_file_path()
5125 .map_err(|()| LockErrorKind::UrlToPath { url: wheel_url })?;
5126 let path =
5127 try_relative_to_if(&wheel_path, index_path, !path.was_given_absolute())
5128 .map_err(LockErrorKind::DistributionRelativePath)?
5129 .into_boxed_path();
5130 WheelWireSource::Path { path }
5131 } else {
5132 let url = normalize_file_location(&wheel.file.url)
5133 .map_err(LockErrorKind::InvalidUrl)
5134 .map_err(LockError::from)?;
5135 WheelWireSource::Url { url }
5136 }
5137 }
5138 };
5139 let filename = wheel.filename.clone();
5140 let hash = wheel.file.hashes.iter().max().cloned().map(Hash::from);
5141 let size = wheel.file.size;
5142 let upload_time = wheel
5143 .file
5144 .upload_time_utc_ms
5145 .map(Timestamp::from_millisecond)
5146 .transpose()
5147 .map_err(LockErrorKind::InvalidTimestamp)?;
5148 let zstd = wheel.file.zstd.as_ref().map(|zstd| ZstdWheel {
5149 hash: zstd.hashes.iter().max().cloned().map(Hash::from),
5150 size: zstd.size,
5151 });
5152 Ok(Self {
5153 url,
5154 hash,
5155 size,
5156 upload_time,
5157 filename,
5158 zstd,
5159 })
5160 }
5161
5162 fn from_direct_dist(direct_dist: &DirectUrlBuiltDist, hashes: &[HashDigest]) -> Self {
5163 Self {
5164 url: WheelWireSource::Url {
5165 url: normalize_url(direct_dist.url.to_url()),
5166 },
5167 hash: hashes.iter().max().cloned().map(Hash::from),
5168 size: None,
5169 upload_time: None,
5170 filename: direct_dist.filename.clone(),
5171 zstd: None,
5172 }
5173 }
5174
5175 fn from_path_dist(path_dist: &PathBuiltDist, hashes: &[HashDigest]) -> Self {
5176 Self {
5177 url: WheelWireSource::Filename {
5178 filename: path_dist.filename.clone(),
5179 },
5180 hash: hashes.iter().max().cloned().map(Hash::from),
5181 size: None,
5182 upload_time: None,
5183 filename: path_dist.filename.clone(),
5184 zstd: None,
5185 }
5186 }
5187
5188 fn from_git_path_dist(path_dist: &GitPathBuiltDist, hashes: &[HashDigest]) -> Self {
5189 Self {
5190 url: WheelWireSource::Filename {
5191 filename: path_dist.filename.clone(),
5192 },
5193 hash: hashes.iter().max().cloned().map(Hash::from),
5194 size: None,
5195 upload_time: None,
5196 filename: path_dist.filename.clone(),
5197 zstd: None,
5198 }
5199 }
5200
5201 fn to_registry_wheel(
5202 &self,
5203 source: &RegistrySource,
5204 root: &Path,
5205 ) -> Result<RegistryBuiltWheel, LockError> {
5206 let filename: WheelFilename = self.filename.clone();
5207
5208 match source {
5209 RegistrySource::Url(url) => {
5210 let file_location = match &self.url {
5211 WheelWireSource::Url { url: file_url } => {
5212 FileLocation::AbsoluteUrl(file_url.clone())
5213 }
5214 WheelWireSource::Path { .. } | WheelWireSource::Filename { .. } => {
5215 return Err(LockErrorKind::MissingUrl {
5216 name: filename.name,
5217 version: filename.version,
5218 }
5219 .into());
5220 }
5221 };
5222 let file = Box::new(uv_distribution_types::File {
5223 dist_info_metadata: false,
5224 filename: SmallString::from(filename.to_string()),
5225 hashes: self.hash.iter().map(|h| h.0.clone()).collect(),
5226 requires_python: None,
5227 size: self.size,
5228 upload_time_utc_ms: self.upload_time.map(Timestamp::as_millisecond),
5229 url: file_location,
5230 yanked: None,
5231 zstd: self
5232 .zstd
5233 .as_ref()
5234 .map(|zstd| uv_distribution_types::Zstd {
5235 hashes: zstd.hash.iter().map(|h| h.0.clone()).collect(),
5236 size: zstd.size,
5237 })
5238 .map(Box::new),
5239 });
5240 let index = IndexUrl::from(VerbatimUrl::from_url(
5241 url.to_url().map_err(LockErrorKind::InvalidUrl)?,
5242 ));
5243 Ok(RegistryBuiltWheel {
5244 filename,
5245 file,
5246 index,
5247 })
5248 }
5249 RegistrySource::Path(index_path) => {
5250 let file_location = match &self.url {
5251 WheelWireSource::Url { url: file_url } => {
5252 FileLocation::AbsoluteUrl(file_url.clone())
5253 }
5254 WheelWireSource::Path { path: file_path } => {
5255 let file_path = root.join(index_path).join(file_path);
5256 let file_url =
5257 DisplaySafeUrl::from_file_path(&file_path).map_err(|()| {
5258 LockErrorKind::PathToUrl {
5259 path: file_path.into_boxed_path(),
5260 }
5261 })?;
5262 FileLocation::AbsoluteUrl(UrlString::from(file_url))
5263 }
5264 WheelWireSource::Filename { .. } => {
5265 return Err(LockErrorKind::MissingPath {
5266 name: filename.name,
5267 version: filename.version,
5268 }
5269 .into());
5270 }
5271 };
5272 let file = Box::new(uv_distribution_types::File {
5273 dist_info_metadata: false,
5274 filename: SmallString::from(filename.to_string()),
5275 hashes: self.hash.iter().map(|h| h.0.clone()).collect(),
5276 requires_python: None,
5277 size: self.size,
5278 upload_time_utc_ms: self.upload_time.map(Timestamp::as_millisecond),
5279 url: file_location,
5280 yanked: None,
5281 zstd: self
5282 .zstd
5283 .as_ref()
5284 .map(|zstd| uv_distribution_types::Zstd {
5285 hashes: zstd.hash.iter().map(|h| h.0.clone()).collect(),
5286 size: zstd.size,
5287 })
5288 .map(Box::new),
5289 });
5290 let index = IndexUrl::from(
5291 VerbatimUrl::from_absolute_path(root.join(index_path))
5292 .map_err(LockErrorKind::RegistryVerbatimUrl)?,
5293 );
5294 Ok(RegistryBuiltWheel {
5295 filename,
5296 file,
5297 index,
5298 })
5299 }
5300 }
5301 }
5302}
5303
5304#[derive(Clone, Debug, serde::Deserialize)]
5305#[serde(rename_all = "kebab-case")]
5306struct WheelWire {
5307 #[serde(flatten)]
5308 url: WheelWireSource,
5309 hash: Option<Hash>,
5315 size: Option<u64>,
5319 #[serde(alias = "upload_time")]
5323 upload_time: Option<Timestamp>,
5324 #[serde(alias = "zstd")]
5326 zstd: Option<ZstdWheel>,
5327}
5328
5329#[derive(Clone, Debug, serde::Deserialize, PartialEq, Eq)]
5330#[serde(untagged, rename_all = "kebab-case")]
5331enum WheelWireSource {
5332 Url {
5334 url: UrlString,
5339 },
5340 Path {
5342 path: Box<Path>,
5344 },
5345 Filename {
5349 filename: WheelFilename,
5352 },
5353}
5354
5355impl Wheel {
5356 fn to_toml(&self) -> Result<InlineTable, toml_edit::ser::Error> {
5358 let mut table = InlineTable::new();
5359 match &self.url {
5360 WheelWireSource::Url { url } => {
5361 table.insert("url", Value::from(url.as_ref()));
5362 }
5363 WheelWireSource::Path { path } => {
5364 table.insert("path", Value::from(PortablePath::from(path).to_string()));
5365 }
5366 WheelWireSource::Filename { filename } => {
5367 table.insert("filename", Value::from(filename.to_string()));
5368 }
5369 }
5370 if let Some(ref hash) = self.hash {
5371 table.insert("hash", Value::from(hash.to_string()));
5372 }
5373 if let Some(size) = self.size {
5374 table.insert(
5375 "size",
5376 toml_edit::ser::ValueSerializer::new().serialize_u64(size)?,
5377 );
5378 }
5379 if let Some(upload_time) = self.upload_time {
5380 table.insert("upload-time", Value::from(upload_time.to_string()));
5381 }
5382 if let Some(zstd) = &self.zstd {
5383 let mut inner = InlineTable::new();
5384 if let Some(ref hash) = zstd.hash {
5385 inner.insert("hash", Value::from(hash.to_string()));
5386 }
5387 if let Some(size) = zstd.size {
5388 inner.insert(
5389 "size",
5390 toml_edit::ser::ValueSerializer::new().serialize_u64(size)?,
5391 );
5392 }
5393 table.insert("zstd", Value::from(inner));
5394 }
5395 Ok(table)
5396 }
5397}
5398
5399impl TryFrom<WheelWire> for Wheel {
5400 type Error = String;
5401
5402 fn try_from(wire: WheelWire) -> Result<Self, String> {
5403 let filename = match &wire.url {
5404 WheelWireSource::Url { url } => {
5405 let filename = url.filename().map_err(|err| err.to_string())?;
5406 filename.parse::<WheelFilename>().map_err(|err| {
5407 format!("failed to parse `{filename}` as wheel filename: {err}")
5408 })?
5409 }
5410 WheelWireSource::Path { path } => {
5411 let filename = path
5412 .file_name()
5413 .and_then(|file_name| file_name.to_str())
5414 .ok_or_else(|| {
5415 format!("path `{}` has no filename component", path.display())
5416 })?;
5417 filename.parse::<WheelFilename>().map_err(|err| {
5418 format!("failed to parse `{filename}` as wheel filename: {err}")
5419 })?
5420 }
5421 WheelWireSource::Filename { filename } => filename.clone(),
5422 };
5423
5424 Ok(Self {
5425 url: wire.url,
5426 hash: wire.hash,
5427 size: wire.size,
5428 upload_time: wire.upload_time,
5429 zstd: wire.zstd,
5430 filename,
5431 })
5432 }
5433}
5434
5435#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
5437pub struct Dependency {
5438 package_id: PackageId,
5439 extra: BTreeSet<ExtraName>,
5440 simplified_marker: SimplifiedMarkerTree,
5460 complexified_marker: UniversalMarker,
5464}
5465
5466impl Dependency {
5467 fn new(
5468 requires_python: &RequiresPython,
5469 package_id: PackageId,
5470 extra: BTreeSet<ExtraName>,
5471 complexified_marker: UniversalMarker,
5472 ) -> Self {
5473 let simplified_marker =
5474 SimplifiedMarkerTree::new(requires_python, complexified_marker.combined());
5475 let complexified_marker = simplified_marker.into_marker(requires_python);
5476 Self {
5477 package_id,
5478 extra,
5479 simplified_marker,
5480 complexified_marker: UniversalMarker::from_combined(complexified_marker),
5481 }
5482 }
5483
5484 fn from_annotated_dist(
5485 requires_python: &RequiresPython,
5486 annotated_dist: &AnnotatedDist,
5487 complexified_marker: UniversalMarker,
5488 root: &Path,
5489 ) -> Result<Self, LockError> {
5490 let package_id = PackageId::from_annotated_dist(annotated_dist, root)?;
5491 let extra = annotated_dist.extra.iter().cloned().collect();
5492 Ok(Self::new(
5493 requires_python,
5494 package_id,
5495 extra,
5496 complexified_marker,
5497 ))
5498 }
5499
5500 fn to_toml(
5502 &self,
5503 _requires_python: &RequiresPython,
5504 dist_count_by_name: &FxHashMap<PackageName, u64>,
5505 ) -> Table {
5506 let mut table = Table::new();
5507 self.package_id
5508 .to_toml(Some(dist_count_by_name), &mut table);
5509 if !self.extra.is_empty() {
5510 let extra_array = self
5511 .extra
5512 .iter()
5513 .map(ToString::to_string)
5514 .collect::<Array>();
5515 table.insert("extra", value(extra_array));
5516 }
5517 if let Some(marker) = self.simplified_marker.try_to_string() {
5518 table.insert("marker", value(marker));
5519 }
5520
5521 table
5522 }
5523
5524 pub fn package_name(&self) -> &PackageName {
5526 &self.package_id.name
5527 }
5528
5529 pub fn extra(&self) -> &BTreeSet<ExtraName> {
5531 &self.extra
5532 }
5533}
5534
5535impl Display for Dependency {
5536 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
5537 match (self.extra.is_empty(), self.package_id.version.as_ref()) {
5538 (true, Some(version)) => write!(f, "{}=={}", self.package_id.name, version),
5539 (true, None) => write!(f, "{}", self.package_id.name),
5540 (false, Some(version)) => write!(
5541 f,
5542 "{}[{}]=={}",
5543 self.package_id.name,
5544 self.extra.iter().join(","),
5545 version
5546 ),
5547 (false, None) => write!(
5548 f,
5549 "{}[{}]",
5550 self.package_id.name,
5551 self.extra.iter().join(",")
5552 ),
5553 }
5554 }
5555}
5556
5557#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord, serde::Deserialize)]
5559#[serde(rename_all = "kebab-case")]
5560struct DependencyWire {
5561 #[serde(flatten)]
5562 package_id: PackageIdForDependency,
5563 #[serde(default)]
5564 extra: BTreeSet<ExtraName>,
5565 #[serde(default)]
5566 marker: SimplifiedMarkerTree,
5567}
5568
5569impl DependencyWire {
5570 fn unwire(
5571 self,
5572 requires_python: &RequiresPython,
5573 unambiguous_package_ids: &FxHashMap<PackageName, PackageId>,
5574 ) -> Result<Dependency, LockError> {
5575 let complexified_marker = self.marker.into_marker(requires_python);
5576 Ok(Dependency {
5577 package_id: self.package_id.unwire(unambiguous_package_ids)?,
5578 extra: self.extra,
5579 simplified_marker: self.marker,
5580 complexified_marker: UniversalMarker::from_combined(complexified_marker),
5581 })
5582 }
5583}
5584
5585#[derive(Clone, Debug, PartialEq, Eq)]
5590struct Hash(HashDigest);
5591
5592impl From<HashDigest> for Hash {
5593 fn from(hd: HashDigest) -> Self {
5594 Self(hd)
5595 }
5596}
5597
5598impl FromStr for Hash {
5599 type Err = HashParseError;
5600
5601 fn from_str(s: &str) -> Result<Self, HashParseError> {
5602 let (algorithm, digest) = s.split_once(':').ok_or(HashParseError(
5603 "expected '{algorithm}:{digest}', but found no ':' in hash digest",
5604 ))?;
5605 let algorithm = algorithm
5606 .parse()
5607 .map_err(|_| HashParseError("unrecognized hash algorithm"))?;
5608 Ok(Self(HashDigest {
5609 algorithm,
5610 digest: digest.into(),
5611 }))
5612 }
5613}
5614
5615impl Display for Hash {
5616 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
5617 write!(f, "{}:{}", self.0.algorithm, self.0.digest)
5618 }
5619}
5620
5621impl<'de> serde::Deserialize<'de> for Hash {
5622 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
5623 where
5624 D: serde::de::Deserializer<'de>,
5625 {
5626 struct Visitor;
5627
5628 impl serde::de::Visitor<'_> for Visitor {
5629 type Value = Hash;
5630
5631 fn expecting(&self, f: &mut Formatter) -> std::fmt::Result {
5632 f.write_str("a string")
5633 }
5634
5635 fn visit_str<E: serde::de::Error>(self, v: &str) -> Result<Self::Value, E> {
5636 Hash::from_str(v).map_err(serde::de::Error::custom)
5637 }
5638 }
5639
5640 deserializer.deserialize_str(Visitor)
5641 }
5642}
5643
5644impl From<Hash> for Hashes {
5645 fn from(value: Hash) -> Self {
5646 match value.0.algorithm {
5647 HashAlgorithm::Md5 => Self {
5648 md5: Some(value.0.digest),
5649 sha256: None,
5650 sha384: None,
5651 sha512: None,
5652 blake2b: None,
5653 },
5654 HashAlgorithm::Sha256 => Self {
5655 md5: None,
5656 sha256: Some(value.0.digest),
5657 sha384: None,
5658 sha512: None,
5659 blake2b: None,
5660 },
5661 HashAlgorithm::Sha384 => Self {
5662 md5: None,
5663 sha256: None,
5664 sha384: Some(value.0.digest),
5665 sha512: None,
5666 blake2b: None,
5667 },
5668 HashAlgorithm::Sha512 => Self {
5669 md5: None,
5670 sha256: None,
5671 sha384: None,
5672 sha512: Some(value.0.digest),
5673 blake2b: None,
5674 },
5675 HashAlgorithm::Blake2b => Self {
5676 md5: None,
5677 sha256: None,
5678 sha384: None,
5679 sha512: None,
5680 blake2b: Some(value.0.digest),
5681 },
5682 }
5683 }
5684}
5685
5686fn normalize_file_location(location: &FileLocation) -> Result<UrlString, ToUrlError> {
5688 match location {
5689 FileLocation::AbsoluteUrl(absolute) => Ok(absolute.without_fragment().into_owned()),
5690 FileLocation::RelativeUrl(_, _) => Ok(normalize_url(location.to_url()?)),
5691 }
5692}
5693
5694fn normalize_url(mut url: DisplaySafeUrl) -> UrlString {
5696 url.set_fragment(None);
5697 UrlString::from(url)
5698}
5699
5700fn normalize_requirement(
5710 mut requirement: Requirement,
5711 root: &Path,
5712 requires_python: &RequiresPython,
5713) -> Result<Requirement, LockError> {
5714 requirement.extras.sort();
5716 requirement.groups.sort();
5717
5718 match requirement.source {
5720 RequirementSource::GitDirectory {
5721 git,
5722 subdirectory,
5723 url: _,
5724 } => {
5725 let git = {
5727 let mut repository = git.url().clone();
5728
5729 repository.remove_credentials();
5731
5732 repository.set_fragment(None);
5734 repository.set_query(None);
5735
5736 GitUrl::from_fields(
5737 repository,
5738 git.reference().clone(),
5739 git.precise(),
5740 git.lfs(),
5741 )?
5742 };
5743
5744 let url = DisplaySafeUrl::from(ParsedGitDirectoryUrl {
5746 url: git.clone(),
5747 subdirectory: subdirectory.clone(),
5748 });
5749
5750 Ok(Requirement {
5751 name: requirement.name,
5752 extras: requirement.extras,
5753 groups: requirement.groups,
5754 marker: requires_python.simplify_markers(requirement.marker),
5755 source: RequirementSource::GitDirectory {
5756 git,
5757 subdirectory,
5758 url: VerbatimUrl::from_url(url),
5759 },
5760 origin: None,
5761 })
5762 }
5763 RequirementSource::GitPath {
5764 git,
5765 install_path,
5766 ext,
5767 url: _,
5768 } => {
5769 let git = {
5771 let mut repository = git.url().clone();
5772
5773 repository.remove_credentials();
5775
5776 repository.set_fragment(None);
5778 repository.set_query(None);
5779
5780 GitUrl::from_fields(
5781 repository,
5782 git.reference().clone(),
5783 git.precise(),
5784 git.lfs(),
5785 )?
5786 };
5787
5788 let url = DisplaySafeUrl::from(ParsedGitPathUrl {
5790 url: git.clone(),
5791 install_path: install_path.clone(),
5792 ext,
5793 });
5794
5795 Ok(Requirement {
5796 name: requirement.name,
5797 extras: requirement.extras,
5798 groups: requirement.groups,
5799 marker: requires_python.simplify_markers(requirement.marker),
5800 source: RequirementSource::GitPath {
5801 git,
5802 install_path,
5803 ext,
5804 url: VerbatimUrl::from_url(url),
5805 },
5806 origin: None,
5807 })
5808 }
5809 RequirementSource::Path {
5810 install_path,
5811 ext,
5812 url: _,
5813 } => {
5814 let path = root.join(&install_path);
5815 let install_path = normalize_path(path).into_owned().into_boxed_path();
5816 let url = VerbatimUrl::from_normalized_path(&install_path)
5817 .map_err(LockErrorKind::RequirementVerbatimUrl)?;
5818
5819 Ok(Requirement {
5820 name: requirement.name,
5821 extras: requirement.extras,
5822 groups: requirement.groups,
5823 marker: requires_python.simplify_markers(requirement.marker),
5824 source: RequirementSource::Path {
5825 install_path,
5826 ext,
5827 url,
5828 },
5829 origin: None,
5830 })
5831 }
5832 RequirementSource::Directory {
5833 install_path,
5834 editable,
5835 r#virtual,
5836 url: _,
5837 } => {
5838 let path = root.join(&install_path);
5839 let install_path = normalize_path(path).into_owned().into_boxed_path();
5840 let url = VerbatimUrl::from_normalized_path(&install_path)
5841 .map_err(LockErrorKind::RequirementVerbatimUrl)?;
5842
5843 Ok(Requirement {
5844 name: requirement.name,
5845 extras: requirement.extras,
5846 groups: requirement.groups,
5847 marker: requires_python.simplify_markers(requirement.marker),
5848 source: RequirementSource::Directory {
5849 install_path,
5850 editable: Some(editable.unwrap_or(false)),
5851 r#virtual: Some(r#virtual.unwrap_or(false)),
5852 url,
5853 },
5854 origin: None,
5855 })
5856 }
5857 RequirementSource::Registry {
5858 specifier,
5859 index,
5860 conflict,
5861 } => {
5862 let index = index
5864 .map(|index| index.url.into_url())
5865 .map(|mut index| {
5866 index.remove_credentials();
5867 index
5868 })
5869 .map(|index| IndexMetadata::from(IndexUrl::from(VerbatimUrl::from_url(index))));
5870 Ok(Requirement {
5871 name: requirement.name,
5872 extras: requirement.extras,
5873 groups: requirement.groups,
5874 marker: requires_python.simplify_markers(requirement.marker),
5875 source: RequirementSource::Registry {
5876 specifier,
5877 index,
5878 conflict,
5879 },
5880 origin: None,
5881 })
5882 }
5883 RequirementSource::Url {
5884 mut location,
5885 subdirectory,
5886 ext,
5887 url: _,
5888 } => {
5889 location.remove_credentials();
5891
5892 location.set_fragment(None);
5894
5895 let url = DisplaySafeUrl::from(ParsedArchiveUrl {
5897 url: location.clone(),
5898 subdirectory: subdirectory.clone(),
5899 ext,
5900 });
5901
5902 Ok(Requirement {
5903 name: requirement.name,
5904 extras: requirement.extras,
5905 groups: requirement.groups,
5906 marker: requires_python.simplify_markers(requirement.marker),
5907 source: RequirementSource::Url {
5908 location,
5909 subdirectory,
5910 ext,
5911 url: VerbatimUrl::from_url(url),
5912 },
5913 origin: None,
5914 })
5915 }
5916 }
5917}
5918
5919#[derive(Debug)]
5920pub struct LockError {
5921 kind: Box<LockErrorKind>,
5922 hint: Option<WheelTagHint>,
5923}
5924
5925impl std::error::Error for LockError {
5926 fn source(&self) -> Option<&(dyn Error + 'static)> {
5927 self.kind.source()
5928 }
5929}
5930
5931impl uv_errors::Hint for LockError {
5932 fn hints(&self) -> uv_errors::Hints<'_> {
5933 if let Some(hint) = &self.hint {
5934 uv_errors::Hints::from(hint.to_string())
5935 } else {
5936 uv_errors::Hints::none()
5937 }
5938 }
5939}
5940
5941impl std::fmt::Display for LockError {
5942 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
5943 write!(f, "{}", self.kind)
5944 }
5945}
5946
5947impl LockError {
5948 pub fn is_resolution(&self) -> bool {
5950 matches!(&*self.kind, LockErrorKind::Resolution { .. })
5951 }
5952
5953 pub fn is_no_build(&self) -> bool {
5955 matches!(
5956 &*self.kind,
5957 LockErrorKind::NoBuild { .. } | LockErrorKind::NoBinaryNoBuild { .. }
5958 )
5959 }
5960}
5961
5962impl<E> From<E> for LockError
5963where
5964 LockErrorKind: From<E>,
5965{
5966 fn from(err: E) -> Self {
5967 Self {
5968 kind: Box::new(LockErrorKind::from(err)),
5969 hint: None,
5970 }
5971 }
5972}
5973
5974#[derive(Debug, Clone, PartialEq, Eq)]
5975#[expect(clippy::enum_variant_names)]
5976enum WheelTagHint {
5977 LanguageTags {
5980 package: PackageName,
5981 version: Option<Version>,
5982 tags: BTreeSet<LanguageTag>,
5983 best: Option<LanguageTag>,
5984 },
5985 AbiTags {
5988 package: PackageName,
5989 version: Option<Version>,
5990 tags: BTreeSet<AbiTag>,
5991 best: Option<AbiTag>,
5992 },
5993 PlatformTags {
5996 package: PackageName,
5997 version: Option<Version>,
5998 tags: BTreeSet<PlatformTag>,
5999 best: Option<PlatformTag>,
6000 markers: MarkerEnvironment,
6001 },
6002}
6003
6004impl WheelTagHint {
6005 fn from_wheels(
6007 name: &PackageName,
6008 version: Option<&Version>,
6009 filenames: &[&WheelFilename],
6010 tags: &Tags,
6011 markers: &MarkerEnvironment,
6012 ) -> Option<Self> {
6013 let incompatibility = filenames
6014 .iter()
6015 .map(|filename| {
6016 tags.compatibility(
6017 filename.python_tags(),
6018 filename.abi_tags(),
6019 filename.platform_tags(),
6020 )
6021 })
6022 .max()?;
6023 match incompatibility {
6024 TagCompatibility::Incompatible(IncompatibleTag::Python) => {
6025 let best = tags.python_tag();
6026 let tags = Self::python_tags(filenames.iter().copied()).collect::<BTreeSet<_>>();
6027 if tags.is_empty() {
6028 None
6029 } else {
6030 Some(Self::LanguageTags {
6031 package: name.clone(),
6032 version: version.cloned(),
6033 tags,
6034 best,
6035 })
6036 }
6037 }
6038 TagCompatibility::Incompatible(IncompatibleTag::Abi) => {
6039 let best = tags.abi_tag();
6040 let tags = Self::abi_tags(filenames.iter().copied())
6041 .filter(|tag| *tag != AbiTag::None)
6050 .collect::<BTreeSet<_>>();
6051 if tags.is_empty() {
6052 None
6053 } else {
6054 Some(Self::AbiTags {
6055 package: name.clone(),
6056 version: version.cloned(),
6057 tags,
6058 best,
6059 })
6060 }
6061 }
6062 TagCompatibility::Incompatible(IncompatibleTag::Platform) => {
6063 let best = tags.platform_tag().cloned();
6064 let incompatible_tags = Self::platform_tags(filenames.iter().copied(), tags)
6065 .cloned()
6066 .collect::<BTreeSet<_>>();
6067 if incompatible_tags.is_empty() {
6068 None
6069 } else {
6070 Some(Self::PlatformTags {
6071 package: name.clone(),
6072 version: version.cloned(),
6073 tags: incompatible_tags,
6074 best,
6075 markers: markers.clone(),
6076 })
6077 }
6078 }
6079 _ => None,
6080 }
6081 }
6082
6083 fn python_tags<'a>(
6085 filenames: impl Iterator<Item = &'a WheelFilename> + 'a,
6086 ) -> impl Iterator<Item = LanguageTag> + 'a {
6087 filenames.flat_map(WheelFilename::python_tags).copied()
6088 }
6089
6090 fn abi_tags<'a>(
6092 filenames: impl Iterator<Item = &'a WheelFilename> + 'a,
6093 ) -> impl Iterator<Item = AbiTag> + 'a {
6094 filenames.flat_map(WheelFilename::abi_tags).copied()
6095 }
6096
6097 fn platform_tags<'a>(
6100 filenames: impl Iterator<Item = &'a WheelFilename> + 'a,
6101 tags: &'a Tags,
6102 ) -> impl Iterator<Item = &'a PlatformTag> + 'a {
6103 filenames.flat_map(move |filename| {
6104 if filename.python_tags().iter().any(|wheel_py| {
6105 filename
6106 .abi_tags()
6107 .iter()
6108 .any(|wheel_abi| tags.is_compatible_abi(*wheel_py, *wheel_abi))
6109 }) {
6110 filename.platform_tags().iter()
6111 } else {
6112 [].iter()
6113 }
6114 })
6115 }
6116
6117 fn suggest_environment_marker(markers: &MarkerEnvironment) -> String {
6118 let sys_platform = markers.sys_platform();
6119 let platform_machine = markers.platform_machine();
6120
6121 if platform_machine.is_empty() {
6123 format!("sys_platform == '{sys_platform}'")
6124 } else {
6125 format!("sys_platform == '{sys_platform}' and platform_machine == '{platform_machine}'")
6126 }
6127 }
6128}
6129
6130impl std::fmt::Display for WheelTagHint {
6131 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
6132 match self {
6133 Self::LanguageTags {
6134 package,
6135 version,
6136 tags,
6137 best,
6138 } => {
6139 if let Some(best) = best {
6140 let s = if tags.len() == 1 { "" } else { "s" };
6141 let best = if let Some(pretty) = best.pretty() {
6142 format!("{} (`{}`)", pretty.cyan(), best.cyan())
6143 } else {
6144 format!("{}", best.cyan())
6145 };
6146 if let Some(version) = version {
6147 write!(
6148 f,
6149 "You're using {}, but `{}` ({}) only has wheels with the following Python implementation tag{s}: {}",
6150 best,
6151 package.cyan(),
6152 format!("v{version}").cyan(),
6153 tags.iter()
6154 .map(|tag| format!("`{}`", tag.cyan()))
6155 .join(", "),
6156 )
6157 } else {
6158 write!(
6159 f,
6160 "You're using {}, but `{}` only has wheels with the following Python implementation tag{s}: {}",
6161 best,
6162 package.cyan(),
6163 tags.iter()
6164 .map(|tag| format!("`{}`", tag.cyan()))
6165 .join(", "),
6166 )
6167 }
6168 } else {
6169 let s = if tags.len() == 1 { "" } else { "s" };
6170 if let Some(version) = version {
6171 write!(
6172 f,
6173 "Wheels are available for `{}` ({}) with the following Python implementation tag{s}: {}",
6174 package.cyan(),
6175 format!("v{version}").cyan(),
6176 tags.iter()
6177 .map(|tag| format!("`{}`", tag.cyan()))
6178 .join(", "),
6179 )
6180 } else {
6181 write!(
6182 f,
6183 "Wheels are available for `{}` with the following Python implementation tag{s}: {}",
6184 package.cyan(),
6185 tags.iter()
6186 .map(|tag| format!("`{}`", tag.cyan()))
6187 .join(", "),
6188 )
6189 }
6190 }
6191 }
6192 Self::AbiTags {
6193 package,
6194 version,
6195 tags,
6196 best,
6197 } => {
6198 if let Some(best) = best {
6199 let s = if tags.len() == 1 { "" } else { "s" };
6200 let best = if let Some(pretty) = best.pretty() {
6201 format!("{} (`{}`)", pretty.cyan(), best.cyan())
6202 } else {
6203 format!("{}", best.cyan())
6204 };
6205 if let Some(version) = version {
6206 write!(
6207 f,
6208 "You're using {}, but `{}` ({}) only has wheels with the following Python ABI tag{s}: {}",
6209 best,
6210 package.cyan(),
6211 format!("v{version}").cyan(),
6212 tags.iter()
6213 .map(|tag| format!("`{}`", tag.cyan()))
6214 .join(", "),
6215 )
6216 } else {
6217 write!(
6218 f,
6219 "You're using {}, but `{}` only has wheels with the following Python ABI tag{s}: {}",
6220 best,
6221 package.cyan(),
6222 tags.iter()
6223 .map(|tag| format!("`{}`", tag.cyan()))
6224 .join(", "),
6225 )
6226 }
6227 } else {
6228 let s = if tags.len() == 1 { "" } else { "s" };
6229 if let Some(version) = version {
6230 write!(
6231 f,
6232 "Wheels are available for `{}` ({}) with the following Python ABI tag{s}: {}",
6233 package.cyan(),
6234 format!("v{version}").cyan(),
6235 tags.iter()
6236 .map(|tag| format!("`{}`", tag.cyan()))
6237 .join(", "),
6238 )
6239 } else {
6240 write!(
6241 f,
6242 "Wheels are available for `{}` with the following Python ABI tag{s}: {}",
6243 package.cyan(),
6244 tags.iter()
6245 .map(|tag| format!("`{}`", tag.cyan()))
6246 .join(", "),
6247 )
6248 }
6249 }
6250 }
6251 Self::PlatformTags {
6252 package,
6253 version,
6254 tags,
6255 best,
6256 markers,
6257 } => {
6258 let s = if tags.len() == 1 { "" } else { "s" };
6259 if let Some(best) = best {
6260 let example_marker = Self::suggest_environment_marker(markers);
6261 let best = if let Some(pretty) = best.pretty() {
6262 format!("{} (`{}`)", pretty.cyan(), best.cyan())
6263 } else {
6264 format!("`{}`", best.cyan())
6265 };
6266 let package_ref = if let Some(version) = version {
6267 format!("`{}` ({})", package.cyan(), format!("v{version}").cyan())
6268 } else {
6269 format!("`{}`", package.cyan())
6270 };
6271 write!(
6272 f,
6273 "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",
6274 best,
6275 package_ref,
6276 tags.iter()
6277 .map(|tag| format!("`{}`", tag.cyan()))
6278 .join(", "),
6279 format!("\"{example_marker}\"").cyan(),
6280 "tool.uv.required-environments".green()
6281 )
6282 } else {
6283 if let Some(version) = version {
6284 write!(
6285 f,
6286 "Wheels are available for `{}` ({}) on the following platform{s}: {}",
6287 package.cyan(),
6288 format!("v{version}").cyan(),
6289 tags.iter()
6290 .map(|tag| format!("`{}`", tag.cyan()))
6291 .join(", "),
6292 )
6293 } else {
6294 write!(
6295 f,
6296 "Wheels are available for `{}` on the following platform{s}: {}",
6297 package.cyan(),
6298 tags.iter()
6299 .map(|tag| format!("`{}`", tag.cyan()))
6300 .join(", "),
6301 )
6302 }
6303 }
6304 }
6305 }
6306 }
6307}
6308
6309#[derive(Debug, thiserror::Error)]
6316enum LockErrorKind {
6317 #[error("Found duplicate package `{id}`", id = id.cyan())]
6320 DuplicatePackage {
6321 id: PackageId,
6323 },
6324 #[error("For package `{id}`, found duplicate dependency `{dependency}`", id = id.cyan(), dependency = dependency.cyan())]
6327 DuplicateDependency {
6328 id: PackageId,
6331 dependency: Dependency,
6333 },
6334 #[error("For package `{id}`, found duplicate dependency `{dependency}`", id = format!("{id}[{extra}]").cyan(), dependency = dependency.cyan())]
6338 DuplicateOptionalDependency {
6339 id: PackageId,
6342 extra: ExtraName,
6344 dependency: Dependency,
6346 },
6347 #[error("For package `{id}`, found duplicate dependency `{dependency}`", id = format!("{id}:{group}").cyan(), dependency = dependency.cyan())]
6351 DuplicateDevDependency {
6352 id: PackageId,
6355 group: GroupName,
6357 dependency: Dependency,
6359 },
6360 #[error(transparent)]
6363 InvalidUrl(
6364 #[from]
6367 ToUrlError,
6368 ),
6369 #[error("Failed to parse file extension for `{id}`; expected one of: {err}", id = id.cyan())]
6372 MissingExtension {
6373 id: PackageId,
6375 err: ExtensionError,
6377 },
6378 #[error("Failed to parse Git URL")]
6380 InvalidGitSourceUrl(
6381 #[source]
6384 SourceParseError,
6385 ),
6386 #[error("Failed to parse timestamp")]
6387 InvalidTimestamp(
6388 #[source]
6391 jiff::Error,
6392 ),
6393 #[error("For package `{id}`, found dependency `{dependency}` with no locked package", id = id.cyan(), dependency = dependency.cyan())]
6397 UnrecognizedDependency {
6398 id: PackageId,
6400 dependency: Dependency,
6403 },
6404 #[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" })]
6407 Hash {
6408 id: PackageId,
6410 artifact_type: &'static str,
6413 expected: bool,
6415 },
6416 #[error("Found package `{id}` with extra `{extra}` but no base package", id = id.cyan(), extra = extra.cyan())]
6419 MissingExtraBase {
6420 id: PackageId,
6422 extra: ExtraName,
6424 },
6425 #[error("Found package `{id}` with development dependency group `{group}` but no base package", id = id.cyan())]
6429 MissingDevBase {
6430 id: PackageId,
6432 group: GroupName,
6434 },
6435 #[error("Wheels cannot come from {source_type} sources")]
6438 InvalidWheelSource {
6439 id: PackageId,
6441 source_type: &'static str,
6443 },
6444 #[error("Found registry distribution `{name}` ({version}) without a valid URL", name = name.cyan(), version = format!("v{version}").cyan())]
6447 MissingUrl {
6448 name: PackageName,
6450 version: Version,
6452 },
6453 #[error("Found registry distribution `{name}` ({version}) without a valid path", name = name.cyan(), version = format!("v{version}").cyan())]
6456 MissingPath {
6457 name: PackageName,
6459 version: Version,
6461 },
6462 #[error("Found registry distribution `{id}` without a valid filename", id = id.cyan())]
6465 MissingFilename {
6466 id: PackageId,
6468 },
6469 #[error("Distribution `{id}` can't be installed because it doesn't have a source distribution or wheel for the current platform", id = id.cyan())]
6472 NeitherSourceDistNorWheel {
6473 id: PackageId,
6475 },
6476 #[error("Distribution `{id}` can't be installed because it is marked as both `--no-binary` and `--no-build`", id = id.cyan())]
6478 NoBinaryNoBuild {
6479 id: PackageId,
6481 },
6482 #[error("Distribution `{id}` can't be installed because it is marked as `--no-binary` but has no source distribution", id = id.cyan())]
6485 NoBinary {
6486 id: PackageId,
6488 },
6489 #[error("Distribution `{id}` can't be installed because it is marked as `--no-build` but has no binary distribution", id = id.cyan())]
6492 NoBuild {
6493 id: PackageId,
6495 },
6496 #[error("Distribution `{id}` can't be installed because the binary distribution is incompatible with the current platform", id = id.cyan())]
6499 IncompatibleWheelOnly {
6500 id: PackageId,
6502 },
6503 #[error("Distribution `{id}` can't be installed because it is marked as `--no-binary` but is itself a binary distribution", id = id.cyan())]
6505 NoBinaryWheelOnly {
6506 id: PackageId,
6508 },
6509 #[error("Found dependency `{id}` with no locked distribution", id = id.cyan())]
6511 VerbatimUrl {
6512 id: PackageId,
6514 #[source]
6516 err: VerbatimUrlError,
6517 },
6518 #[error("Could not compute relative path between workspace and distribution")]
6520 DistributionRelativePath(
6521 #[source]
6523 io::Error,
6524 ),
6525 #[error("Could not compute relative path between workspace and index")]
6527 IndexRelativePath(
6528 #[source]
6530 io::Error,
6531 ),
6532 #[error("Could not compute absolute path from workspace root and lockfile path")]
6534 AbsolutePath(
6535 #[source]
6537 io::Error,
6538 ),
6539 #[error("Dependency `{name}` has missing `version` field but has more than one matching package", name = name.cyan())]
6542 MissingDependencyVersion {
6543 name: PackageName,
6545 },
6546 #[error("Dependency `{name}` has missing `source` field but has more than one matching package", name = name.cyan())]
6549 MissingDependencySource {
6550 name: PackageName,
6552 },
6553 #[error("Could not compute relative path between workspace and requirement")]
6555 RequirementRelativePath(
6556 #[source]
6558 io::Error,
6559 ),
6560 #[error("Could not convert between URL and path")]
6562 RequirementVerbatimUrl(
6563 #[source]
6565 VerbatimUrlError,
6566 ),
6567 #[error("Could not convert between URL and path")]
6569 RegistryVerbatimUrl(
6570 #[source]
6572 VerbatimUrlError,
6573 ),
6574 #[error("Failed to convert path to URL: {path}", path = path.display().cyan())]
6576 PathToUrl { path: Box<Path> },
6577 #[error("Failed to convert URL to path: {url}", url = url.cyan())]
6579 UrlToPath { url: DisplaySafeUrl },
6580 #[error("Found multiple packages matching `{name}`", name = name.cyan())]
6583 MultipleRootPackages {
6584 name: PackageName,
6586 },
6587 #[error("Could not find root package `{name}`", name = name.cyan())]
6589 MissingRootPackage {
6590 name: PackageName,
6592 },
6593 #[error("Failed to generate package metadata for `{id}`", id = id.cyan())]
6595 Resolution {
6596 id: PackageId,
6598 #[source]
6600 err: uv_distribution::Error,
6601 },
6602 #[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())]
6605 InconsistentVersions {
6606 name: PackageName,
6608 version: Version,
6610 wheel: Wheel,
6612 },
6613 #[error(
6614 "Found conflicting extras `{package1}[{extra1}]` \
6615 and `{package2}[{extra2}]` enabled simultaneously"
6616 )]
6617 ConflictingExtra {
6618 package1: PackageName,
6619 extra1: ExtraName,
6620 package2: PackageName,
6621 extra2: ExtraName,
6622 },
6623 #[error(transparent)]
6624 GitUrlParse(#[from] GitUrlParseError),
6625 #[error("Failed to read `{path}`")]
6626 UnreadablePyprojectToml {
6627 path: PathBuf,
6628 #[source]
6629 err: std::io::Error,
6630 },
6631 #[error("Failed to parse `{path}`")]
6632 InvalidPyprojectToml {
6633 path: PathBuf,
6634 #[source]
6635 err: uv_pypi_types::MetadataError,
6636 },
6637 #[error("Workspace member `{id}` has non-local source", id = id.cyan())]
6639 NonLocalWorkspaceMember {
6640 id: PackageId,
6642 },
6643}
6644
6645#[derive(Debug, thiserror::Error)]
6647enum SourceParseError {
6648 #[error("Invalid URL in source `{given}`")]
6650 InvalidUrl {
6651 given: String,
6653 #[source]
6655 err: DisplaySafeUrlError,
6656 },
6657 #[error("Missing SHA in source `{given}`")]
6659 MissingSha {
6660 given: String,
6662 },
6663 #[error("Invalid SHA in source `{given}`")]
6665 InvalidSha {
6666 given: String,
6668 },
6669}
6670
6671#[derive(Clone, Debug, Eq, PartialEq)]
6673struct HashParseError(&'static str);
6674
6675impl std::error::Error for HashParseError {}
6676
6677impl Display for HashParseError {
6678 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
6679 Display::fmt(self.0, f)
6680 }
6681}
6682
6683fn each_element_on_its_line_array(elements: impl Iterator<Item = impl Into<Value>>) -> Array {
6694 let mut array = elements
6695 .map(|item| {
6696 let mut value = item.into();
6697 value.decor_mut().set_prefix("\n ");
6699 value
6700 })
6701 .collect::<Array>();
6702 array.set_trailing_comma(true);
6705 array.set_trailing("\n");
6707 array
6708}
6709
6710fn simplified_universal_markers(
6715 markers: &[UniversalMarker],
6716 requires_python: &RequiresPython,
6717) -> Vec<String> {
6718 canonical_marker_trees(markers, requires_python)
6719 .into_iter()
6720 .filter_map(MarkerTree::try_to_string)
6721 .collect()
6722}
6723
6724fn canonicalize_universal_markers(
6731 markers: &[UniversalMarker],
6732 requires_python: &RequiresPython,
6733) -> Vec<UniversalMarker> {
6734 canonical_marker_trees(markers, requires_python)
6735 .into_iter()
6736 .map(|marker| {
6737 let simplified = SimplifiedMarkerTree::new(requires_python, marker);
6738 UniversalMarker::from_combined(simplified.into_marker(requires_python))
6739 })
6740 .collect()
6741}
6742
6743fn canonical_marker_trees(
6745 markers: &[UniversalMarker],
6746 requires_python: &RequiresPython,
6747) -> Vec<MarkerTree> {
6748 let mut pep508_only = vec![];
6749 let mut seen = FxHashSet::default();
6750 for marker in markers {
6751 let simplified =
6752 SimplifiedMarkerTree::new(requires_python, marker.pep508()).as_simplified_marker_tree();
6753 if seen.insert(simplified) {
6754 pep508_only.push(simplified);
6755 }
6756 }
6757 let any_overlap = pep508_only
6758 .iter()
6759 .tuple_combinations()
6760 .any(|(&marker1, &marker2)| !marker1.is_disjoint(marker2));
6761 let markers = if !any_overlap {
6762 pep508_only
6763 } else {
6764 markers
6765 .iter()
6766 .map(|marker| {
6767 SimplifiedMarkerTree::new(requires_python, marker.combined())
6768 .as_simplified_marker_tree()
6769 })
6770 .collect()
6771 };
6772 markers
6773 .into_iter()
6774 .filter(|marker| !marker.is_true())
6775 .collect()
6776}
6777
6778fn is_wheel_unreachable_for_marker(
6786 filename: &WheelFilename,
6787 requires_python: &RequiresPython,
6788 marker: &UniversalMarker,
6789 tags: Option<&Tags>,
6790) -> bool {
6791 if let Some(tags) = tags
6792 && !filename.compatibility(tags).is_compatible()
6793 {
6794 return true;
6795 }
6796 if !requires_python.matches_wheel_tag(filename) {
6798 return true;
6799 }
6800
6801 let platform_tags = filename.platform_tags();
6810
6811 if platform_tags.iter().all(PlatformTag::is_any) {
6812 return false;
6813 }
6814
6815 if platform_tags.iter().all(PlatformTag::is_linux) {
6816 if platform_tags.iter().all(PlatformTag::is_arm) {
6817 if marker.is_disjoint(*LINUX_ARM_MARKERS) {
6818 return true;
6819 }
6820 } else if platform_tags.iter().all(PlatformTag::is_x86_64) {
6821 if marker.is_disjoint(*LINUX_X86_64_MARKERS) {
6822 return true;
6823 }
6824 } else if platform_tags.iter().all(PlatformTag::is_x86) {
6825 if marker.is_disjoint(*LINUX_X86_MARKERS) {
6826 return true;
6827 }
6828 } else if platform_tags.iter().all(PlatformTag::is_ppc64le) {
6829 if marker.is_disjoint(*LINUX_PPC64LE_MARKERS) {
6830 return true;
6831 }
6832 } else if platform_tags.iter().all(PlatformTag::is_ppc64) {
6833 if marker.is_disjoint(*LINUX_PPC64_MARKERS) {
6834 return true;
6835 }
6836 } else if platform_tags.iter().all(PlatformTag::is_s390x) {
6837 if marker.is_disjoint(*LINUX_S390X_MARKERS) {
6838 return true;
6839 }
6840 } else if platform_tags.iter().all(PlatformTag::is_riscv64) {
6841 if marker.is_disjoint(*LINUX_RISCV64_MARKERS) {
6842 return true;
6843 }
6844 } else if platform_tags.iter().all(PlatformTag::is_loongarch64) {
6845 if marker.is_disjoint(*LINUX_LOONGARCH64_MARKERS) {
6846 return true;
6847 }
6848 } else if platform_tags.iter().all(PlatformTag::is_armv7l) {
6849 if marker.is_disjoint(*LINUX_ARMV7L_MARKERS) {
6850 return true;
6851 }
6852 } else if platform_tags.iter().all(PlatformTag::is_armv6l) {
6853 if marker.is_disjoint(*LINUX_ARMV6L_MARKERS) {
6854 return true;
6855 }
6856 } else if marker.is_disjoint(*LINUX_MARKERS) {
6857 return true;
6858 }
6859 }
6860
6861 if platform_tags.iter().all(PlatformTag::is_windows) {
6862 if platform_tags.iter().all(PlatformTag::is_arm) {
6863 if marker.is_disjoint(*WINDOWS_ARM_MARKERS) {
6864 return true;
6865 }
6866 } else if platform_tags.iter().all(PlatformTag::is_x86_64) {
6867 if marker.is_disjoint(*WINDOWS_X86_64_MARKERS) {
6868 return true;
6869 }
6870 } else if platform_tags.iter().all(PlatformTag::is_x86) {
6871 if marker.is_disjoint(*WINDOWS_X86_MARKERS) {
6872 return true;
6873 }
6874 } else if marker.is_disjoint(*WINDOWS_MARKERS) {
6875 return true;
6876 }
6877 }
6878
6879 if platform_tags.iter().all(PlatformTag::is_macos) {
6880 if platform_tags.iter().all(PlatformTag::is_arm) {
6881 if marker.is_disjoint(*MAC_ARM_MARKERS) {
6882 return true;
6883 }
6884 } else if platform_tags.iter().all(PlatformTag::is_x86_64) {
6885 if marker.is_disjoint(*MAC_X86_64_MARKERS) {
6886 return true;
6887 }
6888 } else if platform_tags.iter().all(PlatformTag::is_x86) {
6889 if marker.is_disjoint(*MAC_X86_MARKERS) {
6890 return true;
6891 }
6892 } else if marker.is_disjoint(*MAC_MARKERS) {
6893 return true;
6894 }
6895 }
6896
6897 if platform_tags.iter().all(PlatformTag::is_android) {
6898 if platform_tags.iter().all(PlatformTag::is_arm) {
6899 if marker.is_disjoint(*ANDROID_ARM_MARKERS) {
6900 return true;
6901 }
6902 } else if platform_tags.iter().all(PlatformTag::is_x86_64) {
6903 if marker.is_disjoint(*ANDROID_X86_64_MARKERS) {
6904 return true;
6905 }
6906 } else if platform_tags.iter().all(PlatformTag::is_x86) {
6907 if marker.is_disjoint(*ANDROID_X86_MARKERS) {
6908 return true;
6909 }
6910 } else if marker.is_disjoint(*ANDROID_MARKERS) {
6911 return true;
6912 }
6913 }
6914
6915 if platform_tags.iter().all(PlatformTag::is_arm) {
6916 if marker.is_disjoint(*ARM_MARKERS) {
6917 return true;
6918 }
6919 }
6920
6921 if platform_tags.iter().all(PlatformTag::is_x86_64) {
6922 if marker.is_disjoint(*X86_64_MARKERS) {
6923 return true;
6924 }
6925 }
6926
6927 if platform_tags.iter().all(PlatformTag::is_x86) {
6928 if marker.is_disjoint(*X86_MARKERS) {
6929 return true;
6930 }
6931 }
6932
6933 if platform_tags.iter().all(PlatformTag::is_ppc64le) {
6934 if marker.is_disjoint(*PPC64LE_MARKERS) {
6935 return true;
6936 }
6937 }
6938
6939 if platform_tags.iter().all(PlatformTag::is_ppc64) {
6940 if marker.is_disjoint(*PPC64_MARKERS) {
6941 return true;
6942 }
6943 }
6944
6945 if platform_tags.iter().all(PlatformTag::is_s390x) {
6946 if marker.is_disjoint(*S390X_MARKERS) {
6947 return true;
6948 }
6949 }
6950
6951 if platform_tags.iter().all(PlatformTag::is_riscv64) {
6952 if marker.is_disjoint(*RISCV64_MARKERS) {
6953 return true;
6954 }
6955 }
6956
6957 if platform_tags.iter().all(PlatformTag::is_loongarch64) {
6958 if marker.is_disjoint(*LOONGARCH64_MARKERS) {
6959 return true;
6960 }
6961 }
6962
6963 if platform_tags.iter().all(PlatformTag::is_armv7l) {
6964 if marker.is_disjoint(*ARMV7L_MARKERS) {
6965 return true;
6966 }
6967 }
6968
6969 if platform_tags.iter().all(PlatformTag::is_armv6l) {
6970 if marker.is_disjoint(*ARMV6L_MARKERS) {
6971 return true;
6972 }
6973 }
6974
6975 false
6976}
6977
6978pub(crate) fn is_wheel_unreachable(
6979 filename: &WheelFilename,
6980 graph: &ResolverOutput,
6981 requires_python: &RequiresPython,
6982 node_index: NodeIndex,
6983 tags: Option<&Tags>,
6984) -> bool {
6985 is_wheel_unreachable_for_marker(
6986 filename,
6987 requires_python,
6988 graph.graph[node_index].marker(),
6989 tags,
6990 )
6991}
6992
6993#[cfg(test)]
6994mod tests {
6995 use uv_warnings::anstream;
6996
6997 use super::*;
6998
6999 macro_rules! assert_stripped_snapshot {
7001 ($expr:expr, @$snapshot:literal) => {{
7002 let expr = format!("{}", $expr);
7003 let expr = format!("{}", anstream::adapter::strip_str(&expr));
7004 insta::assert_snapshot!(expr, @$snapshot);
7005 }};
7006 }
7007
7008 #[test]
7009 fn missing_dependency_source_unambiguous() {
7010 let data = r#"
7011version = 1
7012requires-python = ">=3.12"
7013
7014[[package]]
7015name = "a"
7016version = "0.1.0"
7017source = { registry = "https://pypi.org/simple" }
7018sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7019
7020[[package]]
7021name = "b"
7022version = "0.1.0"
7023source = { registry = "https://pypi.org/simple" }
7024sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7025
7026[[package.dependencies]]
7027name = "a"
7028version = "0.1.0"
7029"#;
7030 let result: Result<Lock, _> = toml::from_str(data);
7031 insta::assert_debug_snapshot!(result);
7032 }
7033
7034 #[test]
7035 fn missing_dependency_version_unambiguous() {
7036 let data = r#"
7037version = 1
7038requires-python = ">=3.12"
7039
7040[[package]]
7041name = "a"
7042version = "0.1.0"
7043source = { registry = "https://pypi.org/simple" }
7044sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7045
7046[[package]]
7047name = "b"
7048version = "0.1.0"
7049source = { registry = "https://pypi.org/simple" }
7050sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7051
7052[[package.dependencies]]
7053name = "a"
7054source = { registry = "https://pypi.org/simple" }
7055"#;
7056 let result: Result<Lock, _> = toml::from_str(data);
7057 insta::assert_debug_snapshot!(result);
7058 }
7059
7060 #[test]
7061 fn missing_dependency_source_version_unambiguous() {
7062 let data = r#"
7063version = 1
7064requires-python = ">=3.12"
7065
7066[[package]]
7067name = "a"
7068version = "0.1.0"
7069source = { registry = "https://pypi.org/simple" }
7070sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7071
7072[[package]]
7073name = "b"
7074version = "0.1.0"
7075source = { registry = "https://pypi.org/simple" }
7076sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7077
7078[[package.dependencies]]
7079name = "a"
7080"#;
7081 let result: Result<Lock, _> = toml::from_str(data);
7082 insta::assert_debug_snapshot!(result);
7083 }
7084
7085 #[test]
7086 fn missing_dependency_source_ambiguous() {
7087 let data = r#"
7088version = 1
7089requires-python = ">=3.12"
7090
7091[[package]]
7092name = "a"
7093version = "0.1.0"
7094source = { registry = "https://pypi.org/simple" }
7095sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7096
7097[[package]]
7098name = "a"
7099version = "0.1.1"
7100source = { registry = "https://pypi.org/simple" }
7101sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7102
7103[[package]]
7104name = "b"
7105version = "0.1.0"
7106source = { registry = "https://pypi.org/simple" }
7107sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7108
7109[[package.dependencies]]
7110name = "a"
7111version = "0.1.0"
7112"#;
7113 let result = toml::from_str::<Lock>(data).unwrap_err();
7114 assert_stripped_snapshot!(result, @"Dependency `a` has missing `source` field but has more than one matching package");
7115 }
7116
7117 #[test]
7118 fn missing_dependency_version_ambiguous() {
7119 let data = r#"
7120version = 1
7121requires-python = ">=3.12"
7122
7123[[package]]
7124name = "a"
7125version = "0.1.0"
7126source = { registry = "https://pypi.org/simple" }
7127sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7128
7129[[package]]
7130name = "a"
7131version = "0.1.1"
7132source = { registry = "https://pypi.org/simple" }
7133sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7134
7135[[package]]
7136name = "b"
7137version = "0.1.0"
7138source = { registry = "https://pypi.org/simple" }
7139sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7140
7141[[package.dependencies]]
7142name = "a"
7143source = { registry = "https://pypi.org/simple" }
7144"#;
7145 let result = toml::from_str::<Lock>(data).unwrap_err();
7146 assert_stripped_snapshot!(result, @"Dependency `a` has missing `version` field but has more than one matching package");
7147 }
7148
7149 #[test]
7150 fn missing_dependency_source_version_ambiguous() {
7151 let data = r#"
7152version = 1
7153requires-python = ">=3.12"
7154
7155[[package]]
7156name = "a"
7157version = "0.1.0"
7158source = { registry = "https://pypi.org/simple" }
7159sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7160
7161[[package]]
7162name = "a"
7163version = "0.1.1"
7164source = { registry = "https://pypi.org/simple" }
7165sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7166
7167[[package]]
7168name = "b"
7169version = "0.1.0"
7170source = { registry = "https://pypi.org/simple" }
7171sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7172
7173[[package.dependencies]]
7174name = "a"
7175"#;
7176 let result = toml::from_str::<Lock>(data).unwrap_err();
7177 assert_stripped_snapshot!(result, @"Dependency `a` has missing `source` field but has more than one matching package");
7178 }
7179
7180 #[test]
7181 fn missing_dependency_version_dynamic() {
7182 let data = r#"
7183version = 1
7184requires-python = ">=3.12"
7185
7186[[package]]
7187name = "a"
7188source = { editable = "path/to/a" }
7189
7190[[package]]
7191name = "a"
7192version = "0.1.1"
7193source = { registry = "https://pypi.org/simple" }
7194sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7195
7196[[package]]
7197name = "b"
7198version = "0.1.0"
7199source = { registry = "https://pypi.org/simple" }
7200sdist = { url = "https://example.com", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 0 }
7201
7202[[package.dependencies]]
7203name = "a"
7204source = { editable = "path/to/a" }
7205"#;
7206 let result = toml::from_str::<Lock>(data);
7207 insta::assert_debug_snapshot!(result);
7208 }
7209
7210 #[test]
7211 fn hash_optional_missing() {
7212 let data = r#"
7213version = 1
7214requires-python = ">=3.12"
7215
7216[[package]]
7217name = "anyio"
7218version = "4.3.0"
7219source = { registry = "https://pypi.org/simple" }
7220wheels = [{ url = "https://files.pythonhosted.org/packages/14/fd/2f20c40b45e4fb4324834aea24bd4afdf1143390242c0b33774da0e2e34f/anyio-4.3.0-py3-none-any.whl" }]
7221"#;
7222 let result: Result<Lock, _> = toml::from_str(data);
7223 insta::assert_debug_snapshot!(result);
7224 }
7225
7226 #[test]
7227 fn hash_optional_present() {
7228 let data = r#"
7229version = 1
7230requires-python = ">=3.12"
7231
7232[[package]]
7233name = "anyio"
7234version = "4.3.0"
7235source = { registry = "https://pypi.org/simple" }
7236wheels = [{ url = "https://files.pythonhosted.org/packages/14/fd/2f20c40b45e4fb4324834aea24bd4afdf1143390242c0b33774da0e2e34f/anyio-4.3.0-py3-none-any.whl", hash = "sha256:048e05d0f6caeed70d731f3db756d35dcc1f35747c8c403364a8332c630441b8" }]
7237"#;
7238 let result: Result<Lock, _> = toml::from_str(data);
7239 insta::assert_debug_snapshot!(result);
7240 }
7241
7242 #[test]
7243 fn hash_required_present() {
7244 let data = r#"
7245version = 1
7246requires-python = ">=3.12"
7247
7248[[package]]
7249name = "anyio"
7250version = "4.3.0"
7251source = { path = "file:///foo/bar" }
7252wheels = [{ url = "file:///foo/bar/anyio-4.3.0-py3-none-any.whl", hash = "sha256:048e05d0f6caeed70d731f3db756d35dcc1f35747c8c403364a8332c630441b8" }]
7253"#;
7254 let result: Result<Lock, _> = toml::from_str(data);
7255 insta::assert_debug_snapshot!(result);
7256 }
7257
7258 #[test]
7259 fn source_direct_no_subdir() {
7260 let data = r#"
7261version = 1
7262requires-python = ">=3.12"
7263
7264[[package]]
7265name = "anyio"
7266version = "4.3.0"
7267source = { url = "https://burntsushi.net" }
7268"#;
7269 let result: Result<Lock, _> = toml::from_str(data);
7270 insta::assert_debug_snapshot!(result);
7271 }
7272
7273 #[test]
7274 fn source_direct_has_subdir() {
7275 let data = r#"
7276version = 1
7277requires-python = ">=3.12"
7278
7279[[package]]
7280name = "anyio"
7281version = "4.3.0"
7282source = { url = "https://burntsushi.net", subdirectory = "wat/foo/bar" }
7283"#;
7284 let result: Result<Lock, _> = toml::from_str(data);
7285 insta::assert_debug_snapshot!(result);
7286 }
7287
7288 #[test]
7289 fn source_directory() {
7290 let data = r#"
7291version = 1
7292requires-python = ">=3.12"
7293
7294[[package]]
7295name = "anyio"
7296version = "4.3.0"
7297source = { directory = "path/to/dir" }
7298"#;
7299 let result: Result<Lock, _> = toml::from_str(data);
7300 insta::assert_debug_snapshot!(result);
7301 }
7302
7303 #[test]
7304 fn source_editable() {
7305 let data = r#"
7306version = 1
7307requires-python = ">=3.12"
7308
7309[[package]]
7310name = "anyio"
7311version = "4.3.0"
7312source = { editable = "path/to/dir" }
7313"#;
7314 let result: Result<Lock, _> = toml::from_str(data);
7315 insta::assert_debug_snapshot!(result);
7316 }
7317
7318 #[test]
7321 fn registry_source_windows_drive_letter() {
7322 let data = r#"
7323version = 1
7324requires-python = ">=3.12"
7325
7326[[package]]
7327name = "tqdm"
7328version = "1000.0.0"
7329source = { registry = "C:/Users/user/links" }
7330wheels = [
7331 { path = "C:/Users/user/links/tqdm-1000.0.0-py3-none-any.whl" },
7332]
7333"#;
7334 let lock: Lock = toml::from_str(data).unwrap();
7335 assert_eq!(
7336 lock.packages[0].id.source,
7337 Source::Registry(RegistrySource::Path(
7338 Path::new("C:/Users/user/links").into()
7339 ))
7340 );
7341 }
7342}