Merge pull request #3226 from mashehu/add-toggle-all-shortcut

create: add shortcut to toggle all switches

.github/workflows/update-textual-snapshots.yml

@@ -46,7 +46,7 @@ jobs:
       - name: Run pytest to update snapshots
         id: pytest
         run: |
-          python3 -m pytest tests/test_create_app.py --snapshot-update --color=yes  --durations=0
+          python3 -m pytest tests/pipelines/test_create_app.py --snapshot-update --color=yes  --durations=0
         continue-on-error: true
 
       # indication that the run has finished

CHANGELOG.md

@@ -18,6 +18,7 @@
 ### General
 
 - Include .nf-core.yml in `nf-core pipelines bump-version` ([#3220](https://github.com/nf-core/tools/pull/3220))
+- create: add shortcut to toggle all switches ([#3226](https://github.com/nf-core/tools/pull/3226))
 
 ## [v3.0.2 - Titanium Tapir Patch](https://github.com/nf-core/tools/releases/tag/3.0.2) - [2024-10-11]
 

CONTRIBUTING.md

@@ -153,7 +153,7 @@ Optionally followed by the description that you want to add to the changelog.
 
 - Update Textual snapshots:
 
-If the Textual snapshots (run by `tests/test_crate_app.py`) fail, an HTML report is generated and uploaded as an artifact.
+If the Textual snapshots (run by `tests/pipelines/test_crate_app.py`) fail, an HTML report is generated and uploaded as an artifact.
 If you are sure that these changes are correct, you can automatically update the snapshots form the PR by posting a comment with the magic words:
 
 ```

nf_core/pipelines/create/__init__.py

@@ -1,14 +1,11 @@
 """A Textual app to create a pipeline."""
 
 import logging
-from pathlib import Path
 
 import click
-import yaml
 from textual.app import App
-from textual.widgets import Button
+from textual.widgets import Button, Switch
 
-import nf_core
 from nf_core.pipelines.create import utils
 from nf_core.pipelines.create.basicdetails import BasicDetails
 from nf_core.pipelines.create.custompipeline import CustomPipeline
@@ -46,6 +43,7 @@ class PipelineCreateApp(App[utils.CreateConfig]):
     BINDINGS = [
         ("d", "toggle_dark", "Toggle dark mode"),
         ("q", "quit", "Quit"),
+        ("a", "toggle_all", "Toggle all"),
     ]
     SCREENS = {
         "welcome": WelcomeScreen(),
@@ -105,3 +103,14 @@ def on_button_pressed(self, event: Button.Pressed) -> None:
     def action_toggle_dark(self) -> None:
         """An action to toggle dark mode."""
         self.dark: bool = not self.dark
+
+    def action_toggle_all(self) -> None:
+        """An action to toggle all Switches."""
+        switches = self.query(Switch)
+        if not switches:
+            return  # No Switches widgets found
+        # Determine the new state based on the first switch
+        new_state = not switches.first().value if switches.first() else True
+        for switch in switches:
+            switch.value = new_state
+        self.refresh()

nf_core/pipelines/create/custompipeline.py

@@ -2,9 +2,9 @@
 
 from textual import on
 from textual.app import ComposeResult
-from textual.containers import Center, ScrollableContainer
+from textual.containers import Center, Horizontal, ScrollableContainer
 from textual.screen import Screen
-from textual.widgets import Button, Footer, Header, Markdown, Switch
+from textual.widgets import Button, Footer, Header, Markdown, Static, Switch
 
 from nf_core.pipelines.create.utils import PipelineFeature
 
@@ -22,7 +22,13 @@ def compose(self) -> ComposeResult:
                 """
             )
         )
+        yield Horizontal(
+            Switch(id="toggle_all", value=True),
+            Static("Toggle all features", classes="feature_title"),
+            classes="custom_grid",
+        )
         yield ScrollableContainer(id="features")
+
         yield Center(
             Button("Back", id="back", variant="default"),
             Button("Continue", id="continue", variant="success"),
@@ -35,6 +41,7 @@ def on_mount(self) -> None:
                 self.query_one("#features").mount(
                     PipelineFeature(feature["help_text"], feature["short_description"], feature["description"], name)
                 )
+        self.query_one("#toggle_all", Switch).value = True
 
     @on(Button.Pressed, "#continue")
     def on_button_pressed(self, event: Button.Pressed) -> None:
@@ -45,3 +52,10 @@ def on_button_pressed(self, event: Button.Pressed) -> None:
             if not this_switch.value:
                 skip.append(this_switch.id)
         self.parent.TEMPLATE_CONFIG.__dict__.update({"skip_features": skip, "is_nfcore": False})
+
+    @on(Switch.Changed, "#toggle_all")
+    def on_toggle_all(self, event: Switch.Changed) -> None:
+        """Handle toggling all switches."""
+        new_state = event.value
+        for feature in self.query("PipelineFeature"):
+            feature.query_one(Switch).value = new_state

nf_core/utils.py

@@ -323,7 +323,7 @@ def fetch_wf_config(wf_path: Path, cache_config: bool = True) -> dict:
 
     # If we can, save a cached copy
     # HINT: during testing phase (in test_download, for example) we don't want
-    # to save configuration copy in $HOME, otherwise the tests/test_download.py::DownloadTest::test_wf_use_local_configs
+    # to save configuration copy in $HOME, otherwise the tests/pipelines/test_download.py::DownloadTest::test_wf_use_local_configs
     # will fail after the first attempt. It's better to not save temporary data
     # in others folders than tmp when doing tests in general
     if cache_path and cache_config: