1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
use std::borrow::Cow;
use std::collections::BTreeSet;
use either::Either;
use uv_configuration::{Constraints, DependencyModifierScope, DependencyModifiers};
use uv_distribution_types::{Requirement, ResolutionRecorder};
use uv_normalize::PackageName;
use uv_types::RequestedRequirements;
use crate::preferences::Preferences;
use crate::{DependencyMode, Exclusions, ResolverEnvironment};
/// A manifest of requirements, constraints, and preferences.
#[derive(Clone, Debug)]
pub struct Manifest {
/// Records which settings are consulted after package selection rules are initialized.
pub(super) recorder: Option<ResolutionRecorder>,
/// The direct requirements for the project.
pub(super) requirements: Vec<Requirement>,
/// The constraints for the project.
pub(super) constraints: Constraints,
/// The dependency modifiers for the project.
pub(super) modifiers: DependencyModifiers,
/// The preferences for the project.
///
/// These represent "preferred" versions of a given package. For example, they may be the
/// versions that are already installed in the environment, or already pinned in an existing
/// lockfile.
pub(super) preferences: Preferences,
/// The name of the project.
pub(super) project: Option<PackageName>,
/// Members of the project's workspace.
pub(super) workspace_members: BTreeSet<PackageName>,
/// The installed packages to exclude from consideration during resolution.
///
/// These typically represent packages that are being upgraded or reinstalled
/// and should be pulled from a remote source like a package index.
pub(super) exclusions: Exclusions,
/// The lookahead requirements for the project.
///
/// These represent transitive dependencies that should be incorporated when making
/// determinations around "allowed" versions (for example, "allowed" URLs or "allowed"
/// pre-release versions).
pub(super) lookaheads: Vec<RequestedRequirements>,
}
impl Manifest {
/// Record which settings are consulted during resolution, excluding package selection setup.
#[must_use]
pub fn with_recorder(mut self, recorder: Option<ResolutionRecorder>) -> Self {
self.recorder = recorder;
self
}
pub fn new(
requirements: Vec<Requirement>,
constraints: Constraints,
modifiers: DependencyModifiers,
preferences: Preferences,
project: Option<PackageName>,
workspace_members: BTreeSet<PackageName>,
exclusions: Exclusions,
lookaheads: Vec<RequestedRequirements>,
) -> Self {
Self {
recorder: None,
requirements,
constraints,
modifiers,
preferences,
project,
workspace_members,
exclusions,
lookaheads: Vec::new(),
}
.with_lookaheads(lookaheads)
}
pub fn simple(requirements: Vec<Requirement>) -> Self {
Self {
recorder: None,
requirements,
constraints: Constraints::default(),
modifiers: DependencyModifiers::default(),
preferences: Preferences::default(),
project: None,
exclusions: Exclusions::default(),
workspace_members: BTreeSet::new(),
lookaheads: Vec::new(),
}
}
#[must_use]
pub fn with_constraints(mut self, constraints: Constraints) -> Self {
self.constraints = constraints;
self
}
#[must_use]
pub fn with_lookaheads(mut self, mut lookaheads: Vec<RequestedRequirements>) -> Self {
// Package metadata defaults to forced-relative paths. Restore the user's path preference for
// the current project and workspace members before merging requirement URLs.
for lookahead in &mut lookaheads {
if self.workspace_members.contains(lookahead.package())
|| self.project.as_ref() == Some(lookahead.package())
{
for requirement in lookahead.requirements_mut() {
requirement.set_force_relative(false);
}
}
}
self.lookaheads = lookaheads;
self
}
/// Return an iterator over all requirements, constraints, and overrides, in priority order,
/// such that requirements come first, followed by constraints, followed by overrides.
///
/// At time of writing, this is used for:
/// - Determining which requirements should allow yanked versions.
/// - Determining which requirements should allow pre-release versions (e.g., `torch>=2.2.0a1`).
/// - Determining which requirements should allow direct URLs (e.g., `torch @ https://...`).
pub(crate) fn requirements<'a>(
&'a self,
env: &'a ResolverEnvironment,
mode: DependencyMode,
) -> impl Iterator<Item = Cow<'a, Requirement>> + 'a {
self.requirements_no_overrides(env, mode)
.chain(self.overrides(env))
}
/// Return all requirements that affect manifest-wide candidate selection policy.
///
/// Scoped overrides are included even when their scope is not selected. Whether a scoped
/// override applies is only known during resolution, after yanked-version policy has already
/// been initialized.
pub(crate) fn candidate_selection_requirements<'a>(
&'a self,
env: &'a ResolverEnvironment,
mode: DependencyMode,
) -> impl Iterator<Item = Cow<'a, Requirement>> + 'a {
self.requirements(env, mode).chain(
self.modifiers
.scoped_overrides()
.map(Cow::Borrowed)
.filter(move |requirement| {
requirement.evaluate_markers(env.marker_environment(), &[])
}),
)
}
/// Like [`Self::requirements`], but without the overrides.
pub(crate) fn requirements_no_overrides<'a>(
&'a self,
env: &'a ResolverEnvironment,
mode: DependencyMode,
) -> impl Iterator<Item = Cow<'a, Requirement>> + 'a {
match mode {
// Include all direct and transitive requirements, with constraints and overrides applied.
DependencyMode::Transitive => Either::Left(
self.lookaheads
.iter()
.flat_map(move |lookahead| {
self.modifiers
.apply(
DependencyModifierScope::Package(
lookahead.package(),
lookahead.version(),
),
lookahead.requirements(),
)
.filter(move |requirement| {
requirement
.evaluate_markers(env.marker_environment(), lookahead.extras())
})
})
.chain(
self.modifiers
.apply(DependencyModifierScope::Global, &self.requirements)
.filter(move |requirement| {
requirement.evaluate_markers(env.marker_environment(), &[])
}),
)
.chain(
self.constraints
.requirements()
.filter(|requirement| !self.modifiers.is_excluded(&requirement.name))
.filter(move |requirement| {
requirement.evaluate_markers(env.marker_environment(), &[])
})
.map(Cow::Borrowed),
),
),
// Include direct requirements, with constraints and overrides applied.
DependencyMode::Direct => Either::Right(
self.modifiers
.apply(DependencyModifierScope::Global, &self.requirements)
.chain(self.constraints.requirements().map(Cow::Borrowed))
.filter(|requirement| !self.modifiers.is_excluded(&requirement.name))
.filter(move |requirement| {
requirement.evaluate_markers(env.marker_environment(), &[])
}),
),
}
}
/// Only the overrides from [`Self::requirements`].
pub(crate) fn overrides<'a>(
&'a self,
env: &'a ResolverEnvironment,
) -> impl Iterator<Item = Cow<'a, Requirement>> + 'a {
self.modifiers
.global_overrides()
.filter(move |requirement| requirement.evaluate_markers(env.marker_environment(), &[]))
.map(Cow::Borrowed)
}
/// Return an iterator over the names of all user-provided requirements.
///
/// This includes:
/// - Direct requirements
/// - Dependencies of editable requirements
/// - Transitive dependencies of local package requirements
///
/// At time of writing, this is used for:
/// - Determining which packages should use the "lowest-compatible version" of a package, when
/// the `lowest-direct` strategy is in use.
pub(crate) fn user_requirements<'a>(
&'a self,
env: &'a ResolverEnvironment,
mode: DependencyMode,
) -> impl Iterator<Item = Cow<'a, Requirement>> + 'a {
match mode {
// Include direct requirements, dependencies of editables, and transitive dependencies
// of local packages.
DependencyMode::Transitive => Either::Left(
self.lookaheads
.iter()
.filter(|lookahead| lookahead.direct())
.flat_map(move |lookahead| {
self.modifiers
.apply(
DependencyModifierScope::Package(
lookahead.package(),
lookahead.version(),
),
lookahead.requirements(),
)
.filter(move |requirement| {
requirement
.evaluate_markers(env.marker_environment(), lookahead.extras())
})
})
.chain(
self.modifiers
.apply(DependencyModifierScope::Global, &self.requirements)
.filter(move |requirement| {
requirement.evaluate_markers(env.marker_environment(), &[])
}),
),
),
// Restrict to the direct requirements.
DependencyMode::Direct => Either::Right(
self.modifiers
.apply(DependencyModifierScope::Global, self.requirements.iter())
.filter(move |requirement| {
requirement.evaluate_markers(env.marker_environment(), &[])
}),
),
}
}
/// Returns the number of input requirements.
pub fn num_requirements(&self) -> usize {
self.requirements.len()
}
}