Start adding basic details screen. Missing: validation. Not working: …

…Hide URL Question of pipeline configs
nf-core · mirpedrol · May 25, 2024 · May 25, 2024 · May 25, 2024 · May 25, 2024
commit 5f6b2a4195b29e667b560208c06b865e22b7de26
diff --git a/nf_core/configs/create/__init__.py b/nf_core/configs/create/__init__.py
@@ -6,7 +6,8 @@
 from textual.app import App
 from textual.widgets import Button
 
-## nf-core question page imports
+## nf-core question page (screen) imports
+from nf_core.configs.create.basicdetails import BasicDetails
 from nf_core.configs.create.configtype import ChooseConfigType
 from nf_core.configs.create.utils import CreateConfig
 from nf_core.configs.create.welcome import WelcomeScreen
@@ -46,10 +47,10 @@ class ConfigsCreateApp(App[CreateConfig]):
     ]
 
     ## New question screens (sections) loaded here
-    SCREENS = {
-        "welcome": WelcomeScreen(),
-        "choose_type": ChooseConfigType(),
-    }
+    SCREENS = {"welcome": WelcomeScreen(), "choose_type": ChooseConfigType(), "basic_details": BasicDetails()}
+
+    # Tracking variables
+    CONFIG_TYPE = None
 
     # Log handler
     LOG_HANDLER = log_handler
@@ -64,6 +65,17 @@ def on_button_pressed(self, event: Button.Pressed) -> None:
         """Handle all button pressed events."""
         if event.button.id == "lets_go":
             self.push_screen("choose_type")
+        elif event.button.id == "type_infrastructure":
+            self.CONFIG_TYPE = "infrastructure"
+            self.push_screen("basic_details")
+        elif event.button.id == "type_pipeline":
+            self.CONFIG_TYPE = "pipeline"
+            self.push_screen("basic_details")
+        ## General options
+        if event.button.id == "close_app":
+            self.exit(return_code=0)
+        if event.button.id == "back":
+            self.pop_screen()
 
     ## User theme options
     def action_toggle_dark(self) -> None:

diff --git a/nf_core/configs/create/basicdetails.py b/nf_core/configs/create/basicdetails.py
@@ -0,0 +1,119 @@
+"""Get basic contact information to set in params to help with debugging. By
+displaying such info in the pipeline run header on run execution"""
+
+from textwrap import dedent
+
+from textual.app import ComposeResult
+from textual.containers import Center, Horizontal
+from textual.screen import Screen
+from textual.widgets import Button, Footer, Header, Markdown
+
+from nf_core.pipelines.create.utils import TextInput
+
+config_exists_warn = """
+> ⚠️  **The config file you are trying to create already exists.**
+>
+> If you continue, you will **overwrite** the existing config.
+> Please change the config name to create a different config!.
+"""
+
+
+class BasicDetails(Screen):
+    """Name, description, author, etc."""
+
+    def compose(self) -> ComposeResult:
+        yield Header()
+        yield Footer()
+        yield Markdown(
+            dedent(
+                """
+                # Basic details
+                """
+            )
+        )
+        ## TODO Add validation, <config_name>.conf already exists?
+        yield TextInput(
+            "config_name",
+            "custom",
+            "Config Name. Used for naming resulting file.",
+            "",
+            classes="column",
+        )
+        with Horizontal():
+            yield TextInput(
+                "authorname",
+                "Boaty McBoatFace",
+                "Author full name.",
+                classes="column",
+            )
+
+            yield TextInput(
+                "authorhandle",
+                "@BoatyMcBoatFace",
+                "Author Git(Hub) handle.",
+                classes="column",
+            )
+
+        yield TextInput(
+            "description",
+            "Description",
+            "A short description of your config.",
+        )
+        yield TextInput(
+            "institutional_url",
+            "https://nf-co.re",
+            "URL of infrastructure website or owning institutional.",
+            disabled=self.parent.CONFIG_TYPE == "pipeline",  ## TODO not working, why?
+        )
+        ## TODO: reactivate once validation ready
+        # yield Markdown(dedent(config_exists_warn), id="exist_warn", classes="hide")
+        yield Center(
+            Button("Back", id="back", variant="default"),
+            Button("Next", id="next", variant="success"),
+            classes="cta",
+        )
+
+    ## TODO: update functions
+    # @on(Input.Changed)
+    # @on(Input.Submitted)
+    # def show_exists_warn(self):
+    #     """Check if the pipeline exists on every input change or submitted.
+    #     If the pipeline exists, show warning message saying that it will be overriden."""
+    #     config = {}
+    #     for text_input in self.query("TextInput"):
+    #         this_input = text_input.query_one(Input)
+    #         config[text_input.field_id] = this_input.value
+    #     if Path(config["org"] + "-" + config["name"]).is_dir():
+    #         remove_hide_class(self.parent, "exist_warn")
+    #     else:
+    #         add_hide_class(self.parent, "exist_warn")
+
+    # def on_screen_resume(self):
+    #     """Hide warn message on screen resume.
+    #     Update displayed value on screen resume."""
+    #     add_hide_class(self.parent, "exist_warn")
+    #     for text_input in self.query("TextInput"):
+    #         if text_input.field_id == "org":
+    #             text_input.disabled = self.parent.CONFIG_TYPE == "infrastructure"
+
+    # @on(Button.Pressed)
+    # def on_button_pressed(self, event: Button.Pressed) -> None:
+    #     """Save fields to the config."""
+    #     config = {}
+    #     for text_input in self.query("TextInput"):
+    #         this_input = text_input.query_one(Input)
+    #         validation_result = this_input.validate(this_input.value)
+    #         config[text_input.field_id] = this_input.value
+    #         if not validation_result.is_valid:
+    #             text_input.query_one(".validation_msg").update("\n".join(validation_result.failure_descriptions))
+    #         else:
+    #             text_input.query_one(".validation_msg").update("")
+    #     try:
+    #         self.parent.TEMPLATE_CONFIG = CreateConfig(**config)
+    #         if event.button.id == "next":
+    #             if self.parent.CONFIG_TYPE == "infrastructure":
+    #                 self.parent.push_screen("type_infrastructure")
+    #             elif self.parent.CONFIG_TYPE == "pipeline":
+    #                 self.parent.push_screen("type_pipeline")
+    #     except ValueError:
+    #         pass
diff --git a/nf_core/configs/create/configtype.py b/nf_core/configs/create/configtype.py
@@ -1,3 +1,5 @@
+"""Select which type of config to create to guide questions and order"""
+
 from textual.app import ComposeResult
 from textual.containers import Center, Grid
 from textual.screen import Screen

diff --git a/nf_core/configs/create/create.tcss b/nf_core/configs/create/create.tcss
diff --git a/nf_core/configs/create/utils.py b/nf_core/configs/create/utils.py
@@ -1,3 +1,5 @@
+"""Config creation specific functions and classes"""
+
 from typing import Optional
 
 from pydantic import BaseModel

diff --git a/nf_core/configs/create/welcome.py b/nf_core/configs/create/welcome.py
@@ -1,3 +1,5 @@
+"""Intro information to help inform user what we are about to do"""
+
 from textual.app import ComposeResult
 from textual.containers import Center
 from textual.screen import Screen