Skip to content

Commit d5ecba6

Browse files
zaniebzanieb
committed
Update reference documentation for PEP 735
1 parent 9c24725 commit d5ecba6

File tree

4 files changed

+130
-68
lines changed

4 files changed

+130
-68
lines changed

‎crates/uv-cli/src/lib.rs‎

Lines changed: 64 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2596,34 +2596,38 @@ pub struct RunArgs {
25962596
#[arg(long, overrides_with("all_extras"), hide = true)]
25972597
pub no_all_extras: bool,
25982598

2599-
/// Include development dependencies.
2599+
/// Include the development dependency group.
26002600
///
2601-
/// Development dependencies are defined via `tool.uv.dev-dependencies` in a
2602-
/// `pyproject.toml`.
2601+
/// Development dependencies are defined via `dependency-groups.dev` or
2602+
/// `tool.uv.dev-dependencies` in a `pyproject.toml`.
2603+
///
2604+
/// This option is an alias for `--group dev`.
26032605
///
26042606
/// This option is only available when running in a project.
26052607
#[arg(long, overrides_with("no_dev"), hide = true)]
26062608
pub dev: bool,
26072609

2608-
/// Omit development dependencies.
2610+
/// Omit the development dependency group.
2611+
///
2612+
/// This option is an alias of `--no-group dev`.
26092613
///
26102614
/// This option is only available when running in a project.
26112615
#[arg(long, overrides_with("dev"))]
26122616
pub no_dev: bool,
26132617

2614-
/// Include dependencies from the specified local dependency group.
2618+
/// Include dependencies from the specified dependency group.
26152619
///
26162620
/// May be provided multiple times.
26172621
#[arg(long, conflicts_with("only_group"))]
26182622
pub group: Vec<GroupName>,
26192623

2620-
/// Exclude dependencies from the specified local dependency group.
2624+
/// Exclude dependencies from the specified dependency group.
26212625
///
26222626
/// May be provided multiple times.
26232627
#[arg(long)]
26242628
pub no_group: Vec<GroupName>,
26252629

2626-
/// Only include dependencies from the specified local dependency group.
2630+
/// Only include dependencies from the specified dependency group.
26272631
///
26282632
/// May be provided multiple times.
26292633
///
@@ -2637,9 +2641,11 @@ pub struct RunArgs {
26372641
#[arg(short, long, conflicts_with = "script")]
26382642
pub module: bool,
26392643

2640-
/// Omit non-development dependencies.
2644+
/// Only include the development dependency group.
26412645
///
2642-
/// The project itself will also be omitted.
2646+
/// Omit other dependencies. The project itself will also be omitted.
2647+
///
2648+
/// This option is an alias for `--only-group dev`.
26432649
#[arg(long, conflicts_with("no_dev"))]
26442650
pub only_dev: bool,
26452651

@@ -2794,33 +2800,39 @@ pub struct SyncArgs {
27942800
#[arg(long, overrides_with("all_extras"), hide = true)]
27952801
pub no_all_extras: bool,
27962802

2797-
/// Include development dependencies.
2803+
/// Include the development dependency group.
2804+
///
2805+
/// This option is an alias for `--group dev`.
27982806
#[arg(long, overrides_with("no_dev"), hide = true)]
27992807
pub dev: bool,
28002808

2801-
/// Omit development dependencies.
2809+
/// Omit the development dependency group.
2810+
///
2811+
/// This option is an alias for `--no-group dev`.
28022812
#[arg(long, overrides_with("dev"))]
28032813
pub no_dev: bool,
28042814

2805-
/// Omit non-development dependencies.
2815+
/// Only include the development dependency group.
28062816
///
2807-
/// The project itself will also be omitted.
2817+
/// Omit other dependencies. The project itself will also be omitted.
2818+
///
2819+
/// This option is an alias for `--only-group dev`.
28082820
#[arg(long, conflicts_with("no_dev"))]
28092821
pub only_dev: bool,
28102822

2811-
/// Include dependencies from the specified local dependency group.
2823+
/// Include dependencies from the specified dependency group.
28122824
///
28132825
/// May be provided multiple times.
28142826
#[arg(long, conflicts_with("only_group"))]
28152827
pub group: Vec<GroupName>,
28162828

2817-
/// Exclude dependencies from the specified local dependency group.
2829+
/// Exclude dependencies from the specified dependency group.
28182830
///
28192831
/// May be provided multiple times.
28202832
#[arg(long)]
28212833
pub no_group: Vec<GroupName>,
28222834

2823-
/// Only include dependencies from the specified local dependency group.
2835+
/// Only include dependencies from the specified dependency group.
28242836
///
28252837
/// May be provided multiple times.
28262838
///
@@ -2992,7 +3004,9 @@ pub struct AddArgs {
29923004
#[arg(long, short, group = "sources", value_parser = parse_file_path)]
29933005
pub requirements: Vec<PathBuf>,
29943006

2995-
/// Add the requirements as development dependencies.
3007+
/// Add the requirements to the development dependency group.
3008+
///
3009+
/// This option is an alias for `--group dev`.
29963010
#[arg(long, conflicts_with("optional"), conflicts_with("group"))]
29973011
pub dev: bool,
29983012

@@ -3005,7 +3019,7 @@ pub struct AddArgs {
30053019
#[arg(long, conflicts_with("dev"), conflicts_with("group"))]
30063020
pub optional: Option<ExtraName>,
30073021

3008-
/// Add the requirements to the specified local dependency group.
3022+
/// Add the requirements to the specified dependency group.
30093023
///
30103024
/// These requirements will not be included in the published metadata for the project.
30113025
#[arg(long, conflicts_with("dev"), conflicts_with("optional"))]
@@ -3114,15 +3128,17 @@ pub struct RemoveArgs {
31143128
#[arg(required = true)]
31153129
pub packages: Vec<PackageName>,
31163130

3117-
/// Remove the packages from the development dependencies.
3131+
/// Remove the packages from the development dependency group.
3132+
///
3133+
/// This option is an alias for `--group dev`.
31183134
#[arg(long, conflicts_with("optional"), conflicts_with("group"))]
31193135
pub dev: bool,
31203136

31213137
/// Remove the packages from the project's optional dependencies for the specified extra.
31223138
#[arg(long, conflicts_with("dev"), conflicts_with("group"))]
31233139
pub optional: Option<ExtraName>,
31243140

3125-
/// Remove the packages from the specified local dependency group.
3141+
/// Remove the packages from the specified dependency group.
31263142
#[arg(long, conflicts_with("dev"), conflicts_with("optional"))]
31273143
pub group: Option<GroupName>,
31283144

@@ -3194,36 +3210,42 @@ pub struct TreeArgs {
31943210
#[command(flatten)]
31953211
pub tree: DisplayTreeArgs,
31963212

3197-
/// Include development dependencies.
3213+
/// Include the development dependency group.
3214+
///
3215+
/// Development dependencies are defined via `dependency-groups.dev` or
3216+
/// `tool.uv.dev-dependencies` in a `pyproject.toml`.
31983217
///
3199-
/// Development dependencies are defined via `tool.uv.dev-dependencies` in a
3200-
/// `pyproject.toml`.
3218+
/// This option is an alias for `--group dev`.
32013219
#[arg(long, overrides_with("no_dev"), hide = true)]
32023220
pub dev: bool,
32033221

3204-
/// Omit non-development dependencies.
3222+
/// Only include the development dependency group.
32053223
///
3206-
/// The project itself will also be omitted.
3224+
/// Omit other dependencies. The project itself will also be omitted.
3225+
///
3226+
/// This option is an alias for `--only-group dev`.
32073227
#[arg(long, conflicts_with("no_dev"))]
32083228
pub only_dev: bool,
32093229

3210-
/// Omit development dependencies.
3230+
/// Omit the development dependency group.
3231+
///
3232+
/// This option is an alias for `--no-group dev`.
32113233
#[arg(long, overrides_with("dev"), conflicts_with = "invert")]
32123234
pub no_dev: bool,
32133235

3214-
/// Include dependencies from the specified local dependency group.
3236+
/// Include dependencies from the specified dependency group.
32153237
///
32163238
/// May be provided multiple times.
32173239
#[arg(long, conflicts_with("only_group"))]
32183240
pub group: Vec<GroupName>,
32193241

3220-
/// Exclude dependencies from the specified local dependency group.
3242+
/// Exclude dependencies from the specified dependency group.
32213243
///
32223244
/// May be provided multiple times.
32233245
#[arg(long)]
32243246
pub no_group: Vec<GroupName>,
32253247

3226-
/// Only include dependencies from the specified local dependency group.
3248+
/// Only include dependencies from the specified dependency group.
32273249
///
32283250
/// May be provided multiple times.
32293251
///
@@ -3318,33 +3340,39 @@ pub struct ExportArgs {
33183340
#[arg(long, overrides_with("all_extras"), hide = true)]
33193341
pub no_all_extras: bool,
33203342

3321-
/// Include development dependencies.
3343+
/// Include the development dependency group.
3344+
///
3345+
/// This option is an alias for `--group dev`.
33223346
#[arg(long, overrides_with("no_dev"), hide = true)]
33233347
pub dev: bool,
33243348

3325-
/// Omit development dependencies.
3349+
/// Omit the development dependency group.
3350+
///
3351+
/// This option is an alias for `--no-group dev`.
33263352
#[arg(long, overrides_with("dev"))]
33273353
pub no_dev: bool,
33283354

3329-
/// Omit non-development dependencies.
3355+
/// Only include the development dependency group.
33303356
///
3331-
/// The project itself will also be omitted.
3357+
/// Omit other dependencies. The project itself will also be omitted.
3358+
///
3359+
/// This option is an alias for `--only-group dev`.
33323360
#[arg(long, conflicts_with("no_dev"))]
33333361
pub only_dev: bool,
33343362

3335-
/// Include dependencies from the specified local dependency group.
3363+
/// Include dependencies from the specified dependency group.
33363364
///
33373365
/// May be provided multiple times.
33383366
#[arg(long, conflicts_with("only_group"))]
33393367
pub group: Vec<GroupName>,
33403368

3341-
/// Exclude dependencies from the specified local dependency group.
3369+
/// Exclude dependencies from the specified dependency group.
33423370
///
33433371
/// May be provided multiple times.
33443372
#[arg(long)]
33453373
pub no_group: Vec<GroupName>,
33463374

3347-
/// Only include dependencies from the specified local dependency group.
3375+
/// Only include dependencies from the specified dependency group.
33483376
///
33493377
/// May be provided multiple times.
33503378
///

‎crates/uv-workspace/src/pyproject.rs‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,8 +323,15 @@ pub struct ToolUv {
323323
)]
324324
pub default_groups: Option<Vec<GroupName>>,
325325

326-
/// The project's development dependencies. Development dependencies will be installed by
327-
/// default in `uv run` and `uv sync`, but will not appear in the project's published metadata.
326+
/// The project's development dependencies.
327+
///
328+
/// Development dependencies will be installed by default in `uv run` and `uv sync`, but will
329+
/// not appear in the project's published metadata.
330+
///
331+
/// Use of this field is not recommend anymore. Instead, use the `dependency-groups.dev` field
332+
/// which is a standardized way to declare development dependencies. The contents of
333+
/// `tool.uv.dev-dependencies` and `dependency-groups.dev` are combined to determine the the
334+
/// final requirements of the `dev` dependency group.
328335
#[cfg_attr(
329336
feature = "schemars",
330337
schemars(

0 commit comments

Comments
 (0)