pioduino/uv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Refactor development dependency configuration (#8309)

Browse Source 
Part of #8090
Unblocks https://github.com/astral-sh/uv/pull/8274

Refactors `DevMode` and `DevSpecification` into a shared type
`DevGroupsSpecification` that allows us to track if `--dev` was
implicitly or explicitly provided.
This commit is contained in:
Zanie Blue
2024-10-18 11:57:58 -05:00
parent fc2e79c6ce
commit d2e1f180ef
11 changed files with 166 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/uv-configuration/src/dev.rs
+103 -46
View File
@@ -13,31 +13,44 @@ pub enum DevMode {
}
impl DevMode {
/// Determine the [`DevMode`] policy from the command-line arguments.
pub fn from_args(dev: bool, no_dev: bool, only_dev: bool) -> Self {
if only_dev {
Self::Only
} else if no_dev {
Self::Exclude
} else if dev {
Self::Include
} else {
Self::default()
/// Iterate over the group names to include.
pub fn iter(&self) -> impl Iterator<Item = &GroupName> {
match self {
Self::Exclude => Either::Left(std::iter::empty()),
Self::Include | Self::Only => Either::Right(std::iter::once(&*DEV_DEPENDENCIES)),
}
}
/// Returns `true` if the specification allows for production dependencies.
pub fn prod(&self) -> bool {
matches!(self, Self::Exclude | Self::Include)
}
}
#[derive(Debug, Clone)]
pub enum DevSpecification {
/// Include dev dependencies from the specified group.
pub struct DevGroupsSpecification {
/// Legacy option for `dependency-group.dev` and `tool.uv.dev-dependencies`.
///
/// Requested via the `--dev`, `--no-dev`, and `--only-dev` flags.
dev: Option<DevMode>,
/// The groups to include.
///
/// Requested via the `--group` and `--only-group` options.
groups: GroupsSpecification,
}
#[derive(Debug, Clone)]
pub enum GroupsSpecification {
/// Include dependencies from the specified groups.
Include(Vec<GroupName>),
/// Do not include dev dependencies.
/// Do not include dependencies from groups.
Exclude,
/// Include dev dependencies from the specified groups, and exclude all non-dev dependencies.
/// Only include dependencies from the specified groups, exclude all other dependencies.
Only(Vec<GroupName>),
}
impl DevSpecification {
impl GroupsSpecification {
/// Returns an [`Iterator`] over the group names to include.
pub fn iter(&self) -> impl Iterator<Item = &GroupName> {
match self {
@@ -52,18 +65,16 @@ impl DevSpecification {
}
}
impl From<DevMode> for DevSpecification {
fn from(mode: DevMode) -> Self {
match mode {
DevMode::Include => Self::Include(vec![DEV_DEPENDENCIES.clone()]),
DevMode::Exclude => Self::Exclude,
DevMode::Only => Self::Only(vec![DEV_DEPENDENCIES.clone()]),
impl DevGroupsSpecification {
/// Returns an [`Iterator`] over the group names to include.
pub fn iter(&self) -> impl Iterator<Item = &GroupName> {
match self.dev {
None => Either::Left(self.groups.iter()),
Some(ref dev_mode) => Either::Right(self.groups.iter().chain(dev_mode.iter())),
}
}
}
impl DevSpecification {
/// Determine the [`DevSpecification`] policy from the command-line arguments.
/// Determine the [`DevGroupsSpecification`] policy from the command-line arguments.
pub fn from_args(
dev: bool,
no_dev: bool,
@@ -71,29 +82,75 @@ impl DevSpecification {
group: Vec<GroupName>,
only_group: Vec<GroupName>,
) -> Self {
let from_mode = DevSpecification::from(DevMode::from_args(dev, no_dev, only_dev));
if !group.is_empty() {
match from_mode {
DevSpecification::Exclude => Self::Include(group),
DevSpecification::Include(dev) => {
Self::Include(group.into_iter().chain(dev).collect())
}
DevSpecification::Only(_) => {
unreachable!("cannot specify both `--only-dev` and `--group`")
}
}
} else if !only_group.is_empty() {
match from_mode {
DevSpecification::Exclude => Self::Only(only_group),
DevSpecification::Only(dev) => {
Self::Only(only_group.into_iter().chain(dev).collect())
}
// TODO(zanieb): `dev` defaults to true we can't tell if `--dev` was provided in
// conflict with `--only-group` here
DevSpecification::Include(_) => Self::Only(only_group),
}
let dev_mode = if only_dev {
Some(DevMode::Only)
} else if no_dev {
Some(DevMode::Exclude)
} else if dev {
Some(DevMode::Include)
} else {
from_mode
None
};
let groups = if !group.is_empty() {
if matches!(dev_mode, Some(DevMode::Only)) {
unreachable!("cannot specify both `--only-dev` and `--group`")
};
GroupsSpecification::Include(group)
} else if !only_group.is_empty() {
if matches!(dev_mode, Some(DevMode::Include)) {
unreachable!("cannot specify both `--dev` and `--only-group`")
};
GroupsSpecification::Only(only_group)
} else {
GroupsSpecification::Exclude
};
Self {
dev: dev_mode,
groups,
}
}
/// Return a new [`DevGroupsSpecification`] with development dependencies included by default.
///
/// This is appropriate in projects, where the `dev` group is synced by default.
#[must_use]
pub fn with_default_dev(self) -> Self {
match self.dev {
Some(_) => self,
None => match self.groups {
// Only include the default `dev` group if `--only-group` wasn't used
GroupsSpecification::Only(_) => self,
GroupsSpecification::Exclude | GroupsSpecification::Include(_) => Self {
dev: Some(DevMode::Include),
..self
},
},
}
}
/// Returns `true` if the specification allows for production dependencies.
pub fn prod(&self) -> bool {
(self.dev.is_none() || self.dev.as_ref().is_some_and(DevMode::prod)) && self.groups.prod()
}
pub fn dev_mode(&self) -> Option<&DevMode> {
self.dev.as_ref()
}
}
impl From<DevMode> for DevGroupsSpecification {
fn from(dev: DevMode) -> Self {
Self {
dev: Some(dev),
groups: GroupsSpecification::Exclude,
}
}
}
impl From<GroupsSpecification> for DevGroupsSpecification {
fn from(groups: GroupsSpecification) -> Self {
Self { dev: None, groups }
}
}
crates/uv-resolver/src/lock/mod.rs
+2 -2
View File
@@ -15,7 +15,7 @@ use toml_edit::{value, Array, ArrayOfTables, InlineTable, Item, Table, Value};
use url::Url;
use uv_cache_key::RepositoryUrl;
use uv_configuration::{BuildOptions, DevSpecification, ExtrasSpecification, InstallOptions};
use uv_configuration::{BuildOptions, DevGroupsSpecification, ExtrasSpecification, InstallOptions};
use uv_distribution::DistributionDatabase;
use uv_distribution_filename::{DistExtension, ExtensionError, SourceDistExtension, WheelFilename};
use uv_distribution_types::{
@@ -580,7 +580,7 @@ impl Lock {
marker_env: &ResolverMarkerEnvironment,
tags: &Tags,
extras: &ExtrasSpecification,
dev: &DevSpecification,
dev: &DevGroupsSpecification,
build_options: &BuildOptions,
install_options: &InstallOptions,
) -> Result<Resolution, LockError> {
crates/uv-resolver/src/lock/requirements_txt.rs
+2 -2
View File
@@ -10,7 +10,7 @@ use petgraph::{Directed, Graph};
use rustc_hash::{FxBuildHasher, FxHashMap, FxHashSet};
use url::Url;
use uv_configuration::{DevSpecification, EditableMode, ExtrasSpecification, InstallOptions};
use uv_configuration::{DevGroupsSpecification, EditableMode, ExtrasSpecification, InstallOptions};
use uv_distribution_filename::{DistExtension, SourceDistExtension};
use uv_fs::Simplified;
use uv_git::GitReference;
@@ -43,7 +43,7 @@ impl<'lock> RequirementsTxtExport<'lock> {
lock: &'lock Lock,
root_name: &PackageName,
extras: &ExtrasSpecification,
dev: &DevSpecification,
dev: &DevGroupsSpecification,
editable: EditableMode,
hashes: bool,
install_options: &'lock InstallOptions,
crates/uv-resolver/src/lock/tree.rs
+12 -19
View File
@@ -7,7 +7,7 @@ use petgraph::visit::Dfs;
use petgraph::Direction;
use rustc_hash::{FxHashMap, FxHashSet};
use uv_configuration::DevMode;
use uv_configuration::DevGroupsSpecification;
use uv_normalize::{ExtraName, GroupName, PackageName};
use uv_pypi_types::ResolverMarkerEnvironment;
@@ -34,7 +34,7 @@ impl<'env> TreeDisplay<'env> {
depth: usize,
prune: &[PackageName],
packages: &[PackageName],
dev: DevMode,
dev: &DevGroupsSpecification,
no_dedupe: bool,
invert: bool,
) -> Self {
@@ -134,8 +134,6 @@ impl<'env> TreeDisplay<'env> {
}
}
let mut modified = false;
// Step 1: Filter out packages that aren't reachable on this platform.
if let Some(environment_markers) = markers {
let mut reachable = FxHashSet::default();
@@ -167,12 +165,11 @@ impl<'env> TreeDisplay<'env> {
// Remove the unreachable nodes from the graph.
graph.retain_nodes(|_, index| reachable.contains(&index));
modified = true;
}
// Step 2: Filter the graph to those that are reachable in production or development, if
// `--no-dev` or `--only-dev` were specified, respectively.
if dev != DevMode::Include {
{
let mut reachable = FxHashSet::default();
// Perform a DFS from the root nodes to find the reachable nodes, following only the
@@ -189,27 +186,24 @@ impl<'env> TreeDisplay<'env> {
while let Some(node) = stack.pop_front() {
reachable.insert(node);
for edge in graph.edges_directed(node, Direction::Outgoing) {
if matches!(edge.weight(), Edge::Prod(_) | Edge::Optional(_, _)) {
let include = match edge.weight() {
Edge::Prod(_) => dev.prod(),
Edge::Optional(_, _) => dev.prod(),
Edge::Dev(group, _) => dev.iter().contains(*group),
};
if include {
stack.push_back(edge.target());
}
}
}
// Remove the unreachable nodes from the graph.
graph.retain_nodes(|_, index| {
if reachable.contains(&index) {
dev != DevMode::Only
} else {
dev != DevMode::Exclude
}
});
modified = true;
graph.retain_nodes(|_, index| reachable.contains(&index));
}
// Step 3: Reverse the graph.
if invert {
graph.reverse();
modified = true;
}
// Step 4: Filter the graph to those nodes reachable from the target packages.
@@ -230,11 +224,10 @@ impl<'env> TreeDisplay<'env> {
// Remove the unreachable nodes from the graph.
graph.retain_nodes(|_, index| reachable.contains(&index));
modified = true;
}
// If the graph was modified, re-create the inverse map.
if modified {
// Re-create the inverse map.
{
inverse.clear();
for node in graph.node_indices() {
inverse.insert(graph[node], node);
crates/uv/src/commands/project/add.rs
+9 -6
View File
@@ -13,8 +13,8 @@ use uv_cache::Cache;
use uv_cache_key::RepositoryUrl;
use uv_client::{BaseClientBuilder, Connectivity, FlatIndexClient, RegistryClientBuilder};
use uv_configuration::{
Concurrency, Constraints, DevMode, DevSpecification, EditableMode, ExtrasSpecification,
InstallOptions, LowerBound, SourceStrategy,
Concurrency, Constraints, DevGroupsSpecification, DevMode, EditableMode, ExtrasSpecification,
GroupsSpecification, InstallOptions, LowerBound, SourceStrategy,
};
use uv_dispatch::BuildDispatch;
use uv_distribution::DistributionDatabase;
@@ -811,22 +811,25 @@ async fn lock_and_sync(
let (extras, dev) = match dependency_type {
DependencyType::Production => {
let extras = ExtrasSpecification::None;
let dev = DevSpecification::from(DevMode::Exclude);
let dev = DevGroupsSpecification::from(DevMode::Exclude);
(extras, dev)
}
DependencyType::Dev => {
let extras = ExtrasSpecification::None;
let dev = DevSpecification::from(DevMode::Include);
let dev = DevGroupsSpecification::from(DevMode::Include);
(extras, dev)
}
DependencyType::Optional(ref extra_name) => {
let extras = ExtrasSpecification::Some(vec![extra_name.clone()]);
let dev = DevSpecification::from(DevMode::Exclude);
let dev = DevGroupsSpecification::from(DevMode::Exclude);
(extras, dev)
}
DependencyType::Group(ref group_name) => {
let extras = ExtrasSpecification::None;
let dev = DevSpecification::Include(vec![group_name.clone()]);
let dev =
DevGroupsSpecification::from(GroupsSpecification::Include(
vec![group_name.clone()],
));
(extras, dev)
}
};
crates/uv/src/commands/project/export.rs
+3 -3
View File
@@ -8,7 +8,7 @@ use std::path::{Path, PathBuf};
use uv_cache::Cache;
use uv_client::Connectivity;
use uv_configuration::{
Concurrency, DevMode, DevSpecification, EditableMode, ExportFormat, ExtrasSpecification,
Concurrency, DevGroupsSpecification, EditableMode, ExportFormat, ExtrasSpecification,
InstallOptions, LowerBound,
};
use uv_normalize::PackageName;
@@ -33,7 +33,7 @@ pub(crate) async fn export(
install_options: InstallOptions,
output_file: Option<PathBuf>,
extras: ExtrasSpecification,
dev: DevMode,
dev: DevGroupsSpecification,
editable: EditableMode,
locked: bool,
frozen: bool,
@@ -142,7 +142,7 @@ pub(crate) async fn export(
&lock,
project.project_name(),
&extras,
&DevSpecification::from(dev),
&dev.with_default_dev(),
editable,
hashes,
&install_options,
crates/uv/src/commands/project/remove.rs
+3 -3
View File
@@ -6,8 +6,8 @@ use owo_colors::OwoColorize;
use uv_cache::Cache;
use uv_client::Connectivity;
use uv_configuration::{
Concurrency, DevMode, DevSpecification, EditableMode, ExtrasSpecification, InstallOptions,
LowerBound,
Concurrency, DevGroupsSpecification, DevMode, EditableMode, ExtrasSpecification,
InstallOptions, LowerBound,
};
use uv_fs::Simplified;
use uv_pep508::PackageName;
@@ -216,7 +216,7 @@ pub(crate) async fn remove(
&venv,
&lock,
&extras,
&DevSpecification::from(dev),
&DevGroupsSpecification::from(dev),
EditableMode::Editable,
install_options,
Modifications::Exact,
crates/uv/src/commands/project/run.rs
+10 -10
View File
@@ -17,8 +17,8 @@ use uv_cache::Cache;
use uv_cli::ExternalCommand;
use uv_client::{BaseClientBuilder, Connectivity};
use uv_configuration::{
Concurrency, DevMode, DevSpecification, EditableMode, ExtrasSpecification, InstallOptions,
LowerBound, SourceStrategy,
Concurrency, DevGroupsSpecification, DevMode, EditableMode, ExtrasSpecification,
InstallOptions, LowerBound, SourceStrategy,
};
use uv_distribution::LoweredRequirement;
use uv_fs::which::is_executable;
@@ -68,7 +68,7 @@ pub(crate) async fn run(
no_project: bool,
no_config: bool,
extras: ExtrasSpecification,
dev: DevMode,
dev: DevGroupsSpecification,
editable: EditableMode,
python: Option<String>,
settings: ResolverInstallerSettings,
@@ -336,10 +336,10 @@ pub(crate) async fn run(
if !extras.is_empty() {
warn_user!("Extras are not supported for Python scripts with inline metadata");
}
if matches!(dev, DevMode::Exclude) {
if matches!(dev.dev_mode(), Some(DevMode::Exclude)) {
warn_user!("`--no-dev` is not supported for Python scripts with inline metadata");
}
if matches!(dev, DevMode::Only) {
if matches!(dev.dev_mode(), Some(DevMode::Only)) {
warn_user!("`--only-dev` is not supported for Python scripts with inline metadata");
}
if package.is_some() {
@@ -413,10 +413,10 @@ pub(crate) async fn run(
if !extras.is_empty() {
warn_user!("Extras have no effect when used alongside `--no-project`");
}
if matches!(dev, DevMode::Exclude) {
if matches!(dev.dev_mode(), Some(DevMode::Exclude)) {
warn_user!("`--no-dev` has no effect when used alongside `--no-project`");
}
if matches!(dev, DevMode::Only) {
if matches!(dev.dev_mode(), Some(DevMode::Only)) {
warn_user!("`--only-dev` has no effect when used alongside `--no-project`");
}
if locked {
@@ -433,10 +433,10 @@ pub(crate) async fn run(
if !extras.is_empty() {
warn_user!("Extras have no effect when used outside of a project");
}
if matches!(dev, DevMode::Exclude) {
if matches!(dev.dev_mode(), Some(DevMode::Exclude)) {
warn_user!("`--no-dev` has no effect when used outside of a project");
}
if matches!(dev, DevMode::Only) {
if matches!(dev.dev_mode(), Some(DevMode::Only)) {
warn_user!("`--only-dev` has no effect when used outside of a project");
}
if locked {
@@ -591,7 +591,7 @@ pub(crate) async fn run(
&venv,
result.lock(),
&extras,
&DevSpecification::from(dev),
&dev.with_default_dev(),
editable,
install_options,
Modifications::Sufficient,
crates/uv/src/commands/project/sync.rs
+4 -4
View File
@@ -8,7 +8,7 @@ use uv_auth::store_credentials;
use uv_cache::Cache;
use uv_client::{Connectivity, FlatIndexClient, RegistryClientBuilder};
use uv_configuration::{
Concurrency, Constraints, DevSpecification, EditableMode, ExtrasSpecification,
Concurrency, Constraints, DevGroupsSpecification, EditableMode, ExtrasSpecification,
HashCheckingMode, InstallOptions, LowerBound,
};
use uv_dispatch::BuildDispatch;
@@ -43,7 +43,7 @@ pub(crate) async fn sync(
frozen: bool,
package: Option<PackageName>,
extras: ExtrasSpecification,
dev: DevSpecification,
dev: DevGroupsSpecification,
editable: EditableMode,
install_options: InstallOptions,
modifications: Modifications,
@@ -155,7 +155,7 @@ pub(crate) async fn sync(
&venv,
&lock,
&extras,
&dev,
&dev.with_default_dev(),
editable,
install_options,
modifications,
@@ -179,7 +179,7 @@ pub(super) async fn do_sync(
venv: &PythonEnvironment,
lock: &Lock,
extras: &ExtrasSpecification,
dev: &DevSpecification,
dev: &DevGroupsSpecification,
editable: EditableMode,
install_options: InstallOptions,
modifications: Modifications,
crates/uv/src/commands/project/tree.rs
+3 -3
View File
@@ -5,7 +5,7 @@ use anyhow::Result;
use uv_cache::Cache;
use uv_client::Connectivity;
use uv_configuration::{Concurrency, DevMode, LowerBound, TargetTriple};
use uv_configuration::{Concurrency, DevGroupsSpecification, LowerBound, TargetTriple};
use uv_pep508::PackageName;
use uv_python::{PythonDownloads, PythonPreference, PythonRequest, PythonVersion};
use uv_resolver::TreeDisplay;
@@ -22,7 +22,7 @@ use crate::settings::ResolverSettings;
#[allow(clippy::fn_params_excessive_bools)]
pub(crate) async fn tree(
project_dir: &Path,
dev: DevMode,
dev: DevGroupsSpecification,
locked: bool,
frozen: bool,
universal: bool,
@@ -97,7 +97,7 @@ pub(crate) async fn tree(
depth.into(),
&prune,
&package,
dev,
&dev.with_default_dev(),
no_dedupe,
invert,
);
crates/uv/src/settings.rs
+15 -12
View File
@@ -19,10 +19,10 @@ use uv_cli::{
};
use uv_client::Connectivity;
use uv_configuration::{
BuildOptions, Concurrency, ConfigSettings, DevMode, DevSpecification, EditableMode,
ExportFormat, ExtrasSpecification, HashCheckingMode, IndexStrategy, InstallOptions,
KeyringProviderType, NoBinary, NoBuild, PreviewMode, ProjectBuildBackend, Reinstall,
SourceStrategy, TargetTriple, TrustedHost, TrustedPublishing, Upgrade, VersionControlSystem,
BuildOptions, Concurrency, ConfigSettings, DevGroupsSpecification, EditableMode, ExportFormat,
ExtrasSpecification, HashCheckingMode, IndexStrategy, InstallOptions, KeyringProviderType,
NoBinary, NoBuild, PreviewMode, ProjectBuildBackend, Reinstall, SourceStrategy, TargetTriple,
TrustedHost, TrustedPublishing, Upgrade, VersionControlSystem,
};
use uv_distribution_types::{DependencyMetadata, Index, IndexLocations};
use uv_install_wheel::linker::LinkMode;
@@ -227,7 +227,7 @@ pub(crate) struct RunSettings {
pub(crate) locked: bool,
pub(crate) frozen: bool,
pub(crate) extras: ExtrasSpecification,
pub(crate) dev: DevMode,
pub(crate) dev: DevGroupsSpecification,
pub(crate) editable: EditableMode,
pub(crate) with: Vec<String>,
pub(crate) with_editable: Vec<String>,
@@ -280,7 +280,8 @@ impl RunSettings {
flag(all_extras, no_all_extras).unwrap_or_default(),
extra.unwrap_or_default(),
),
dev: DevMode::from_args(dev, no_dev, only_dev),
// TODO(zanieb): Support `--group` here
dev: DevGroupsSpecification::from_args(dev, no_dev, only_dev, vec![], vec![]),
editable: EditableMode::from_args(no_editable),
with,
with_editable,
@@ -693,7 +694,7 @@ pub(crate) struct SyncSettings {
pub(crate) locked: bool,
pub(crate) frozen: bool,
pub(crate) extras: ExtrasSpecification,
pub(crate) dev: DevSpecification,
pub(crate) dev: DevGroupsSpecification,
pub(crate) editable: EditableMode,
pub(crate) install_options: InstallOptions,
pub(crate) modifications: Modifications,
@@ -743,7 +744,7 @@ impl SyncSettings {
flag(all_extras, no_all_extras).unwrap_or_default(),
extra.unwrap_or_default(),
),
dev: DevSpecification::from_args(dev, no_dev, only_dev, group, only_group),
dev: DevGroupsSpecification::from_args(dev, no_dev, only_dev, group, only_group),
editable: EditableMode::from_args(no_editable),
install_options: InstallOptions::new(
no_install_project,
@@ -1001,7 +1002,7 @@ impl RemoveSettings {
#[allow(clippy::struct_excessive_bools)]
#[derive(Debug, Clone)]
pub(crate) struct TreeSettings {
pub(crate) dev: DevMode,
pub(crate) dev: DevGroupsSpecification,
pub(crate) locked: bool,
pub(crate) frozen: bool,
pub(crate) universal: bool,
@@ -1034,7 +1035,8 @@ impl TreeSettings {
} = args;
Self {
dev: DevMode::from_args(dev, no_dev, false),
// TODO(zanieb): Support `--group` here
dev: DevGroupsSpecification::from_args(dev, no_dev, false, vec![], vec![]),
locked,
frozen,
universal,
@@ -1058,7 +1060,7 @@ pub(crate) struct ExportSettings {
pub(crate) format: ExportFormat,
pub(crate) package: Option<PackageName>,
pub(crate) extras: ExtrasSpecification,
pub(crate) dev: DevMode,
pub(crate) dev: DevGroupsSpecification,
pub(crate) editable: EditableMode,
pub(crate) hashes: bool,
pub(crate) install_options: InstallOptions,
@@ -1108,7 +1110,8 @@ impl ExportSettings {
flag(all_extras, no_all_extras).unwrap_or_default(),
extra.unwrap_or_default(),
),
dev: DevMode::from_args(dev, no_dev, only_dev),
// TODO(zanieb): Support `--group` here
dev: DevGroupsSpecification::from_args(dev, no_dev, only_dev, vec![], vec![]),
editable: EditableMode::from_args(no_editable),
hashes: flag(hashes, no_hashes).unwrap_or(true),
install_options: InstallOptions::new(