Support reading docs_info from file

Author: tcompa

fractal_tasks_core/dev/create_manifest.py

@@ -22,6 +22,7 @@
     create_schema_for_single_task,
 )
 from fractal_tasks_core.dev.lib_task_docs import create_docs_info
+from fractal_tasks_core.dev.lib_task_docs import read_docs_info_from_file
 
 
 logging.basicConfig(level=logging.INFO)
@@ -126,11 +127,19 @@ def create_manifest(
                     task_dict[f"args_schema_{kind}"] = schema
 
         # Update docs_info, based on task-function description
-        docs_info = create_docs_info(
-            executable_non_parallel=task_obj.executable_non_parallel,
-            executable_parallel=task_obj.executable_parallel,
-            package=package,
-        )
+        docs_info = task_dict.get("docs_info")
+        if docs_info is None:
+            docs_info = create_docs_info(
+                executable_non_parallel=task_obj.executable_non_parallel,
+                executable_parallel=task_obj.executable_parallel,
+                package=package,
+            )
+        elif docs_info.startswith("file:"):
+            docs_info = read_docs_info_from_file(
+                docs_info=docs_info,
+                task_list_path=task_list_module.__file__,
+            )
+
         if docs_info is not None:
             task_dict["docs_info"] = docs_info
         if docs_link is not None:

fractal_tasks_core/dev/lib_task_docs.py

@@ -57,7 +57,7 @@ def create_docs_info(
     executable_non_parallel: Optional[str] = None,
     executable_parallel: Optional[str] = None,
     package: str = "fractal_tasks_core",
-) -> list[str]:
+) -> str:
     """
     Return task description based on function docstring.
     """
@@ -81,3 +81,39 @@ def create_docs_info(
     docs_info = "".join(docs_info)
     logging.info("[create_docs_info] END")
     return docs_info
+
+
+def read_docs_info_from_file(
+    *,
+    docs_info: str,
+    task_list_path: str,
+) -> str:
+    """
+    Return task description based on the content of a file.
+
+    An example of valid argument is
+    ```
+    docs_info = "file:relative/path/info.md"
+    ```
+    where the path is relative to the folder where `task_list.py` is.
+    """
+    logging.info("[read_docs_info_from_file] START")
+    print(docs_info)
+    print(task_list_path)
+
+    if not docs_info.startswith("file:"):
+        raise ValueError(f"Invalid docs_info='{docs_info}'.")
+    relative_path = Path(docs_info[5:])
+    if relative_path.is_absolute():
+        raise ValueError(
+            f"Invalid docs_info='{docs_info}' (path must be relative)."
+        )
+    base_path = Path(task_list_path).parent
+
+    docs_path = (base_path / relative_path).as_posix()
+
+    logging.info(f"[read_docs_info_from_file] Reading docs from {docs_path}")
+    with open(docs_path, "r") as f:
+        docs_info = f.read()
+    logging.info("[read_docs_info_from_file] END")
+    return docs_info

fractal_tasks_core/dev/task_models.py

@@ -35,6 +35,7 @@ class Config:
     category: Optional[str] = None
     modality: Optional[str] = None
     tags: list[str] = Field(default_factory=list)
+    docs_info: Optional[str] = None
 
 
 class CompoundTask(_BaseTask):