Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add --package support to uv build #6990

Merged
merged 1 commit into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions crates/uv-cli/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1955,6 +1955,15 @@ pub struct BuildArgs {
#[arg(value_parser = parse_file_path)]
pub src: Option<PathBuf>,

/// Build a specific package in the workspace.
///
/// The workspace will be discovered from the provided source directory, or the current
/// directory if no source directory is provided.
///
/// If the workspace member does not exist, uv will exit with an error.
#[arg(long)]
pub package: Option<PackageName>,
Copy link
Member Author

@charliermarsh charliermarsh Sep 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a huge fan of the interaction between src and package because I feel like it shows some warts between an API that's designed for projects vs. a general-purpose API for building an arbitrary directory.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mind the interaction as described.


/// The output directory to which distributions should be written.
///
/// Defaults to the `dist` subdirectory within the source directory, or the
Expand Down
70 changes: 49 additions & 21 deletions crates/uv/src/commands/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,20 @@ use uv_client::{BaseClientBuilder, Connectivity, FlatIndexClient, RegistryClient
use uv_configuration::{BuildKind, BuildOutput, Concurrency};
use uv_dispatch::BuildDispatch;
use uv_fs::{Simplified, CWD};
use uv_normalize::PackageName;
use uv_python::{
EnvironmentPreference, PythonDownloads, PythonEnvironment, PythonInstallation,
PythonPreference, PythonRequest, PythonVersionFile, VersionRequest,
};
use uv_resolver::{FlatIndex, RequiresPython};
use uv_types::{BuildContext, BuildIsolation, HashStrategy};
use uv_warnings::warn_user_once;
use uv_workspace::{DiscoveryOptions, VirtualProject, WorkspaceError};
use uv_workspace::{DiscoveryOptions, Workspace};

/// Build source distributions and wheels.
#[allow(clippy::fn_params_excessive_bools)]
pub(crate) async fn build(
src: Option<PathBuf>,
package: Option<PackageName>,
output_dir: Option<PathBuf>,
sdist: bool,
wheel: bool,
Expand All @@ -44,6 +45,7 @@ pub(crate) async fn build(
) -> Result<ExitStatus> {
let assets = build_impl(
src.as_deref(),
package.as_ref(),
output_dir.as_deref(),
sdist,
wheel,
Expand Down Expand Up @@ -82,6 +84,7 @@ pub(crate) async fn build(
#[allow(clippy::fn_params_excessive_bools)]
async fn build_impl(
src: Option<&Path>,
package: Option<&PackageName>,
output_dir: Option<&Path>,
sdist: bool,
wheel: bool,
Expand Down Expand Up @@ -118,6 +121,7 @@ async fn build_impl(
.connectivity(connectivity)
.native_tls(native_tls);

// Determine the source to build.
let src = if let Some(src) = src {
let src = std::path::absolute(src)?;
let metadata = match fs_err::tokio::metadata(&src).await {
Expand All @@ -139,9 +143,37 @@ async fn build_impl(
Source::Directory(Cow::Borrowed(&*CWD))
};

let src_dir = match src {
Source::Directory(ref src) => src,
Source::File(ref src) => src.parent().unwrap(),
// Attempt to discover the workspace; on failure, save the error for later.
let workspace = Workspace::discover(src.directory(), &DiscoveryOptions::default()).await;

// If a `--package` was provided, adjust the source directory.
let src = if let Some(package) = package {
if matches!(src, Source::File(_)) {
return Err(anyhow::anyhow!(
"Cannot specify a `--package` when building from a file"
));
}

let workspace = match workspace {
Ok(ref workspace) => workspace,
Err(err) => {
return Err(
anyhow::anyhow!("`--package` was provided, but no workspace was found")
.context(err),
)
}
};

let project = workspace
.packages()
.get(package)
.ok_or_else(|| anyhow::anyhow!("Package `{}` not found in workspace", package))?
.root()
.clone();

Source::Directory(Cow::Owned(project))
} else {
src
};

let output_dir = if let Some(output_dir) = output_dir {
Expand All @@ -158,26 +190,15 @@ async fn build_impl(

// (2) Request from `.python-version`
if interpreter_request.is_none() {
interpreter_request = PythonVersionFile::discover(&src_dir, no_config, false)
interpreter_request = PythonVersionFile::discover(src.directory(), no_config, false)
.await?
.and_then(PythonVersionFile::into_version);
}

// (3) `Requires-Python` in `pyproject.toml`
if interpreter_request.is_none() {
let project = match VirtualProject::discover(src_dir, &DiscoveryOptions::default()).await {
Ok(project) => Some(project),
Err(WorkspaceError::MissingProject(_)) => None,
Err(WorkspaceError::MissingPyprojectToml) => None,
Err(WorkspaceError::NonWorkspace(_)) => None,
Err(err) => {
warn_user_once!("{err}");
None
}
};

if let Some(project) = project {
interpreter_request = find_requires_python(project.workspace())?
if let Ok(ref workspace) = workspace {
interpreter_request = find_requires_python(workspace)?
.as_ref()
.map(RequiresPython::specifiers)
.map(|specifiers| {
Expand Down Expand Up @@ -463,8 +484,15 @@ enum Source<'a> {
impl<'a> Source<'a> {
fn path(&self) -> &Path {
match self {
Source::File(path) => path.as_ref(),
Source::Directory(path) => path.as_ref(),
Self::File(path) => path.as_ref(),
Self::Directory(path) => path.as_ref(),
}
}

fn directory(&self) -> &Path {
match self {
Self::File(path) => path.parent().unwrap(),
Self::Directory(path) => path,
}
}
}
Expand Down
1 change: 1 addition & 0 deletions crates/uv/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -672,6 +672,7 @@ async fn run(cli: Cli) -> Result<ExitStatus> {

commands::build(
args.src,
args.package,
args.out_dir,
args.sdist,
args.wheel,
Expand Down
3 changes: 3 additions & 0 deletions crates/uv/src/settings.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1616,6 +1616,7 @@ impl PipCheckSettings {
#[derive(Debug, Clone)]
pub(crate) struct BuildSettings {
pub(crate) src: Option<PathBuf>,
pub(crate) package: Option<PackageName>,
pub(crate) out_dir: Option<PathBuf>,
pub(crate) sdist: bool,
pub(crate) wheel: bool,
Expand All @@ -1630,6 +1631,7 @@ impl BuildSettings {
let BuildArgs {
src,
out_dir,
package,
sdist,
wheel,
python,
Expand All @@ -1640,6 +1642,7 @@ impl BuildSettings {

Self {
src,
package,
out_dir,
sdist,
wheel,
Expand Down
Loading
Loading