feat: Option to exclude optional groups from install/sync -G:all (#2655)

* feature #2258 option to exclude groups from sync/install -G:all

* doc #2258 news fragment for option to exclude groups from sync/install -G:all

* misc #2258 changed flag aliases

Author: elramen

news/2258.feature.md

@@ -0,0 +1 @@
+Add option to exclude group(s) when running ```pdm sync/install -G:all``` by adding flag ```--without group1,group2,...```

src/pdm/cli/filters.py

@@ -21,12 +21,14 @@ def __init__(
         dev: bool | None = None,
         groups: Sequence[str] = (),
         group: str | None = None,
+        excluded_groups: Sequence[str] = (),
     ):
         self.project = project
         self.groups = groups
         self.group = group
         self.default = default
         self.dev = dev
+        self.excluded_groups = excluded_groups
 
     @classmethod
     def from_options(cls, project: Project, options: argparse.Namespace) -> GroupSelection:
@@ -37,6 +39,7 @@ def from_options(cls, project: Project, options: argparse.Namespace) -> GroupSel
             default=options.default,
             dev=options.dev,
             groups=options.groups,
+            excluded_groups=options.excluded_groups,
         )
 
     def one(self) -> str:
@@ -83,6 +86,7 @@ def _translated_groups(self) -> list[str]:
             groups_set.update(dev_groups)
         if ":all" in groups:
             groups_set.discard(":all")
+            optional_groups -= set(self.excluded_groups)
             groups_set.update(optional_groups)
 
         invalid_groups = groups_set - set(project.iter_groups())

src/pdm/cli/options.py

@@ -220,6 +220,7 @@ def no_isolation_option(
 groups_group.add_argument(
     "-G",
     "--group",
+    "--with",
     dest="groups",
     metavar="GROUP",
     action=split_lists(","),
@@ -228,6 +229,14 @@ def no_isolation_option(
     'use ":all" to include all groups under the same species.',
     default=[],
 )
+groups_group.add_argument(
+    "--without",
+    dest="excluded_groups",
+    metavar="",
+    action=split_lists(","),
+    help="Exclude groups of optional-dependencies when using :all",
+    default=[],
+)
 groups_group.add_argument(
     "--no-default",
     dest="default",

tests/cli/test_install.py

@@ -312,3 +312,24 @@ def test_fix_package_type_and_update(fixture_project, pdm, working_set):
     pdm(["fix", "package-type"], obj=project, strict=True)
     pdm(["update"], obj=project, strict=True)
     assert "test-package-type-fixer" not in working_set
+
+
+def test_install_all_with_excluded_groups(project, working_set, pdm):
+    project.add_dependencies({"urllib3": parse_requirement("urllib3")}, "url")
+    project.add_dependencies({"pytz": parse_requirement("pytz")}, "tz")
+    project.add_dependencies({"pyopenssl": parse_requirement("pyopenssl")}, "ssl")
+    pdm(["install", "-G", ":all", "--without", "tz,ssl"], obj=project, strict=True)
+    assert "urllib3" in working_set
+    assert "pytz" not in working_set
+    assert "pyopenssl" not in working_set
+
+
+def test_sync_all_with_excluded_groups(project, working_set, pdm):
+    project.add_dependencies({"urllib3": parse_requirement("urllib3")}, "url")
+    project.add_dependencies({"pytz": parse_requirement("pytz")}, "tz")
+    project.add_dependencies({"pyopenssl": parse_requirement("pyopenssl")}, "ssl")
+    pdm(["lock", "-G:all"], obj=project, strict=True)
+    pdm(["sync", "-G", ":all", "--without", "url,tz"], obj=project, strict=True)
+    assert "urllib3" not in working_set
+    assert "pytz" not in working_set
+    assert "pyopenssl" in working_set

tests/test_utils.py

@@ -509,6 +509,20 @@ def test_dependency_group_selection(project, args, golden):
     assert sorted(golden) == sorted(selection)
 
 
+@pytest.mark.parametrize(
+    "args,golden",
+    [
+        ({"groups": [":all"], "excluded_groups": ["web"]}, ["default", "auth", "test", "doc"]),
+        ({"groups": [":all"], "excluded_groups": ["web", "auth"]}, ["default", "test", "doc"]),
+        ({"groups": [":all"], "excluded_groups": ["default", "test"]}, ["default", "web", "auth", "test", "doc"]),
+    ],
+)
+def test_exclude_optional_groups_from_all(project, args, golden):
+    setup_dependencies(project)
+    selection = GroupSelection(project, **args)
+    assert sorted(golden) == sorted(selection)
+
+
 def test_prod_should_not_be_with_dev(project):
     setup_dependencies(project)
     selection = GroupSelection(project, default=True, dev=False, groups=["test"])