Merge pull request #285 from caracal-pipeline/issue-284

fixes #284
caracal-pipeline · May 2, 2024 · 7e38d89 · 7e38d89
2 parents 8a0007a + cc73754
commit 7e38d89
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 20 deletions.
diff --git a/scabha/configuratt/deps.py b/scabha/configuratt/deps.py
@@ -15,9 +15,9 @@
 @dataclass
 class FailRecord(object):
     filename: str
-    origin: Optional[str]
-    modulename: Optional[str]
-    fname: Optional[str]
+    origin: Optional[str] = None
+    modulename: Optional[str] = None
+    fname: Optional[str] = None
 
 @dataclass
 class RequirementRecord(object):

diff --git a/stimela/commands/doc.py b/stimela/commands/doc.py
@@ -82,7 +82,7 @@ def load_recipe(name: str, section: Dict):
 
     # load config and recipes from all given files
     if files_to_load:
-        load_recipe_files(files_to_load)
+        top_level_recipes = load_recipe_files(files_to_load)
 
     destroy_progress_bar()
 
@@ -109,9 +109,10 @@ def load_recipe(name: str, section: Dict):
 
     # if nothing was specified, and only one cab/only one recipe is defined, print that
     if not names_to_document:
-        if len(stimela.CONFIG.lib.recipes) == 1 and not stimela.CONFIG.cabs:
-            recipes_to_document.update(stimela.CONFIG.lib.recipes.keys())
-        elif len(stimela.CONFIG.cabs) == 1 and not stimela.CONFIG.lib.recipes:
+        if len(top_level_recipes) == 1:
+            recipes_to_document.update(top_level_recipes)
+            log.info("a single top-level recipe is defined, documenting it by default. Use -l to list all defined recipes/cabs")
+        elif len(stimela.CONFIG.cabs) == 1 and not top_level_recipes:
             cabs_to_document.update(stimela.CONFIG.cabs.keys())
 
     if recipes_to_document or cabs_to_document:
@@ -132,14 +133,14 @@ def load_recipe(name: str, section: Dict):
             subtree = top_tree.add("Recipes:")
             table = Table.grid("", "", padding=(0,2))
             for name, recipe in stimela.CONFIG.lib.recipes.items():
-                table.add_row(f"[bold]{name}[/bold]", recipe.info)
+                table.add_row(f"[bold]{name}[/bold]", getattr(recipe, 'info', ''))
             subtree.add(table)
 
         if stimela.CONFIG.cabs:
             subtree = top_tree.add("Cabs:")
             table = Table.grid("", "", padding=(0,2))
             for name, cab in stimela.CONFIG.cabs.items():
-                table.add_row(f"[bold]{name}[/bold]", cab.info)
+                table.add_row(f"[bold]{name}[/bold]", getattr(cab, 'info', ''))
             subtree.add(table)            
 
     rich_print(top_tree)

diff --git a/stimela/kitchen/recipe.py b/stimela/kitchen/recipe.py
@@ -563,13 +563,27 @@ def _add_alias(self, alias_name: str, alias_target: Union[str, Tuple],
                 # define schema based on copy of the target, but preserve default
                 io[alias_name] = copy.copy(schema)
                 alias_schema = io[alias_name] 
-                # check that 
-                # default set from own schema, ignoring parameter setting 
+                # if default set in recipe schema, ignore any parameter setting in the step 
                 if orig_schema is not None and orig_schema.default is not UNSET:
-                    # also clear parameter setting to propagate our default
                     if step_param_name in step.params:
                         del step.params[step_param_name]
                     alias_schema.default = orig_schema.default
+                # else check if explicit value or a default is specified in the step -- make it the recipe default
+                else:
+                    if step_param_name in step.params:
+                        defval = step.params[step_param_name]
+                    elif step_param_name in step.cargo.defaults:
+                        defval = step.cargo.defaults[step_param_name]
+                    else:
+                        defval = schema.default
+                    if defval is not UNSET:
+                        alias_schema.required = False
+                        alias_schema.default = defval
+                        ## see https://github.com/caracal-pipeline/stimela/issues/284. No longer convinced
+                        ## these parameters should be marked as Hidden. After all, the recipe explicitly specifies them!
+                        ## mark it as hidden -- no need to expose parameters that are internally set this way
+                        # alias_schema.category = ParameterCategory.Hidden
+                # propagate info from recipe schema
                 if orig_schema and orig_schema.info:
                     alias_schema.info = orig_schema.info
                 # required flag overrides, if set from our own schema
@@ -580,14 +594,6 @@ def _add_alias(self, alias_name: str, alias_target: Union[str, Tuple],
                     alias_schema.category = category
                 elif orig_schema is not None and orig_schema.category is not None:
                     alias_schema.category = orig_schema.category
-                # parameter is not required if alias target is set in step
-                if step_param_name in step.params or \
-                        step_param_name in step.cargo.defaults or \
-                        schema.default is not UNSET:
-                    alias_schema.required = False
-                    alias_schema.default = UNSET
-                    # mark it as hidden -- no need to expose parameters that are internally set this way
-                    alias_schema.category = ParameterCategory.Hidden
 
             # if step parameter is implicit, mark the alias as implicit. Note that this only applies to outputs
             if schema.implicit: