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.

Sign up for GitHub

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

Build backend: Add --list option #9610

Merged
merged 4 commits into from
Dec 4, 2024
Merged

Build backend: Add --list option #9610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
58d621b
Build backend: Add `--list` option
konstin Dec 3, 2024
018b47f
Add missing filters
konstin Dec 3, 2024
8b43ee4
Talk about PEP 517 in list
konstin Dec 3, 2024
2e55b8a
Fix windows CI
konstin Dec 3, 2024
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
14 changes: 13 additions & 1 deletion crates/uv-cli/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2171,6 +2171,18 @@ pub struct BuildArgs {
#[arg(long)]
pub wheel: bool,

/// When using the uv build backend, list the files that would be included when building.
///
/// Skips building the actual distribution, except when the source distribution is needed to
/// build the wheel. The file list is collected directly without a PEP 517 environment. It only
/// works with the uv build backend, there is no PEP 517 file list build hook.
///
/// This option can be combined with `--sdist` and `--wheel` for inspecting different build
/// paths.
Copy link
Member

Choose a reason for hiding this comment

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

Should you mention in the docs here that this conflicts with --force-pep517? I might even spare a sentence or two saying why that conflict exists. (I'm guessing that in the fast path, it's easier to have a side channel asking the build backend to emit extra output? I haven't read the rest of the PR yet.)

Copy link
Member Author

Choose a reason for hiding this comment

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

I added an explanation about how this doesn't go through PEP 517.

// Hidden while in preview.
#[arg(long, hide = true)]
pub list: bool,

#[arg(long, overrides_with("no_build_logs"), hide = true)]
pub build_logs: bool,

Expand All @@ -2183,7 +2195,7 @@ pub struct BuildArgs {
/// By default, uv won't create a PEP 517 build environment for packages using the uv build
/// backend, but use a fast path that calls into the build backend directly. This option forces
/// always using PEP 517.
#[arg(long)]
#[arg(long, conflicts_with = "list")]
pub force_pep517: bool,

/// Constrain build dependencies using the given requirements files when building
Expand Down
Loading
Loading