hpcflow-new2 0.2.0a71__tar.gz → 0.2.0a73__tar.gz

{hpcflow_new2-0.2.0a71 → hpcflow_new2-0.2.0a73}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hpcflow-new2
-Version: 0.2.0a71
+Version: 0.2.0a73
 Summary: Computational workflow management
 License: MIT
 Author: aplowman

hpcflow_new2-0.2.0a73/hpcflow/_version.py

@@ -0,0 +1 @@
+__version__ = "0.2.0a73"

{hpcflow_new2-0.2.0a71 → hpcflow_new2-0.2.0a73}/hpcflow/sdk/cli.py

@@ -2,6 +2,7 @@ from typing import Dict, List
 import click
 from colorama import init as colorama_init
 from termcolor import colored
+from rich.pretty import pprint
 
 from hpcflow import __version__, _app_name
 from hpcflow.sdk.config.cli import get_config_CLI
@@ -205,7 +206,7 @@ def _make_API_CLI(app):
     @click.argument("py_test_args", nargs=-1, type=click.UNPROCESSED)
     @click.pass_context
     def test_hpcflow(ctx, py_test_args):
-        """Run hpcflow test suite.".
+        """Run hpcFlow test suite.
 
         PY_TEST_ARGS are arguments passed on to Pytest.
 
@@ -401,7 +402,7 @@ def _make_submission_CLI(app):
     def OS_info_callback(ctx, param, value):
         if not value or ctx.resilient_parsing:
             return
-        click.echo(app.get_OS_info())
+        pprint(app.get_OS_info())
         ctx.exit()
 
     @click.group()
@@ -422,7 +423,8 @@ def _make_submission_CLI(app):
     @click.option("--exclude-os", is_flag=True, default=False)
     @click.pass_context
     def shell_info(ctx, shell_name, exclude_os):
-        click.echo(app.get_shell_info(shell_name, exclude_os))
+        """Show information about the specified shell, such as the version."""
+        pprint(app.get_shell_info(shell_name, exclude_os))
         ctx.exit()
 
     return submission
@@ -549,7 +551,7 @@ def _make_template_components_CLI(app):
     @click.command()
     def tc(help=True):
         """For showing template component data."""
-        click.echo(app.template_components)
+        pprint(app.template_components)
 
     return tc
 
@@ -563,9 +565,10 @@ def _make_show_CLI(app):
 
     @click.command()
     @click.option(
+        "-r",
         "--max-recent",
         default=3,
-        help="If True, show only recently finished workflows",
+        help="The maximum number of inactive submissions to show.",
     )
     @click.option(
         "--no-update",
@@ -592,7 +595,7 @@ def _make_show_CLI(app):
         callback=show_legend_callback,
     )
     def show(max_recent, full, no_update):
-        """Show information about recent workflows."""
+        """Show information about running and recently active workflows."""
         app.show(max_recent=max_recent, full=full, no_update=no_update)
 
     return show
@@ -604,6 +607,11 @@ def _make_zip_CLI(app):
     @click.option("--log")
     @workflow_ref_type_opt
     def zip_workflow(workflow_ref, ref_type, log=None):
+        """Generate a copy of the specified workflow in the zip file format.
+
+        WORKFLOW_REF is the local ID (that provided by the `show` command}) or the
+        workflow path.
+        """
         workflow_path = app._resolve_workflow_reference(workflow_ref, ref_type)
         wk = app.Workflow(workflow_path)
         wk.to_zip(log=log)
@@ -616,6 +624,12 @@ def _make_cancel_CLI(app):
     @click.argument("workflow_ref")
     @workflow_ref_type_opt
     def cancel(workflow_ref, ref_type):
+        """Stop all running jobscripts of the specified workflow.
+
+        WORKFLOW_REF is the local ID (that provided by the `show` command}) or the
+        workflow path.
+
+        """
         app.cancel(workflow_ref, ref_type)
 
     return cancel
@@ -624,7 +638,8 @@ def _make_cancel_CLI(app):
 def _make_open_CLI(app):
     @click.group(name="open")
     def open_file():
-        """Open a file (e.g. {app_name}'s log file) using the default application."""
+        """Open a file (for example {app_name}'s log file) using the default
+        application."""
 
     @open_file.command()
     @click.option("--path", is_flag=True, default=False)
@@ -689,7 +704,7 @@ def _make_open_CLI(app):
     @click.option("--path", is_flag=True, default=False)
     @workflow_ref_type_opt
     def workflow(workflow_ref, ref_type, path=False):
-        """Open a workflow directory in e.g. File Explorer in Windows."""
+        """Open a workflow directory using, for example, File Explorer on Windows."""
         workflow_path = app._resolve_workflow_reference(workflow_ref, ref_type)
         if path:
             click.echo(workflow_path)
@@ -705,6 +720,10 @@ def _make_open_CLI(app):
         else:
             utils.open_file(dir_path)
 
+    open_file.help = open_file.help.format(app_name=app.name)
+    log.help = log.help.format(app_name=app.name)
+    config.help = config.help.format(app_name=app.name)
+
     return open_file
 
 

{hpcflow_new2-0.2.0a71 → hpcflow_new2-0.2.0a73}/hpcflow/sdk/core/object_list.py

@@ -47,7 +47,7 @@ class ObjectList(JSONLike):
         return len(self._objects)
 
     def __repr__(self):
-        return f"{self.__class__.__name__}({[self._get_item(i) for i in self._objects]})"
+        return repr(self._objects)
 
     def __str__(self):
         return str([self._get_item(i) for i in self._objects])

{hpcflow_new2-0.2.0a71 → hpcflow_new2-0.2.0a73}/hpcflow/sdk/core/parameters.py

@@ -340,6 +340,11 @@ class SchemaInput(SchemaParameter):
         obj._task_schema = self._task_schema
         return obj
 
+    @property
+    def default_value(self):
+        if not self.multiple and "default" in self.single_labelled_data:
+            return self.single_labelled_data["default"]
+
     @property
     def task_schema(self):
         return self._task_schema
@@ -358,6 +363,11 @@ class SchemaInput(SchemaParameter):
         if not self.multiple:
             return next(iter(self.labelled_info()))["labelled_type"]
 
+    @property
+    def single_labelled_data(self):
+        if not self.multiple:
+            return self.labels[self.single_label]
+
     def labelled_info(self):
         for k, v in self.labels.items():
             label = f"[{k}]" if k else ""

{hpcflow_new2-0.2.0a71 → hpcflow_new2-0.2.0a73}/hpcflow/sdk/core/task_schema.py

@@ -3,10 +3,13 @@ import copy
 from dataclasses import dataclass, field
 from typing import Dict, List, Optional, Tuple, Union
 
+from rich import print as rich_print
+from rich.table import Table
+
 from hpcflow.sdk import app
 from hpcflow.sdk.core.parameters import Parameter
 from .json_like import ChildObjectSpec, JSONLike
-from .parameters import ParameterPropagationMode, SchemaInput
+from .parameters import NullDefault, ParameterPropagationMode, SchemaInput
 from .utils import check_valid_py_identifier
 
 
@@ -82,13 +85,34 @@ class TaskSchema(JSONLike):
         #     )
 
     def __repr__(self):
-        return (
-            f"{self.__class__.__name__}("
-            f"objective={self.objective.name!r}, "
-            f"input_types={self.input_types!r}, "
-            f"output_types={self.output_types!r}"
-            f")"
-        )
+        return f"{self.__class__.__name__}({self.objective.name!r})"
+
+    @property
+    def info(self):
+        """Show attributes of the task schema."""
+        tab = Table(show_header=False)
+        tab.add_column()
+        tab.add_column()
+        tab.add_row("Objective", self.objective.name)
+        tab.add_row("Actions", str(self.actions))
+
+        tab_ins = Table(show_header=False, box=None)
+        tab_ins.add_column()
+        for inp in self.inputs:
+            def_str = ""
+            if not inp.multiple:
+                if inp.default_value is not NullDefault.NULL:
+                    def_str = f" [i]default[/i]={inp.default_value}"
+            tab_ins.add_row(inp.parameter.typ + def_str)
+
+        tab_outs = Table(show_header=False, box=None)
+        tab_outs.add_column()
+        for out in self.outputs:
+            tab_outs.add_row(out.parameter.typ)
+
+        tab.add_row("Inputs", tab_ins)
+        tab.add_row("Outputs", tab_outs)
+        rich_print(tab)
 
     def __eq__(self, other):
         if type(other) is not self.__class__:

{hpcflow_new2-0.2.0a71 → hpcflow_new2-0.2.0a73}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [tool.poetry]
 name = "hpcflow-new2"
-version = "0.2.0a71"
+version = "0.2.0a73"
 
 description = "Computational workflow management"
 authors = ["aplowman <adam.plowman@manchester.ac.uk>"]
@@ -65,7 +65,7 @@ hook-dirs = "hpcflow.__pyinstaller:get_hook_dirs"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "0.2.0a71"
+version = "0.2.0a73"
 tag_format = "v$version"
 version_files = [ 
     "pyproject.toml:version",

hpcflow_new2-0.2.0a71/hpcflow/_version.py

@@ -1 +0,0 @@
-__version__ = "0.2.0a71"