hpcflow-new2 0.2.0a178__py3-none-any.whl → 0.2.0a180__py3-none-any.whl

hpcflow/sdk/core/rule.py

@@ -1,3 +1,7 @@
+"""
+Rules apply conditions to workflow elements or loops.
+"""
+
 from __future__ import annotations
 from typing import Dict, Optional, Union
 
@@ -11,7 +15,27 @@ from hpcflow.sdk.log import TimeIt
 
 
 class Rule(JSONLike):
-    """Class to represent a testable condition on an element iteration or run."""
+    """
+    Class to represent a testable condition on an element iteration or run.
+
+    Exactly one of ``check_exists``, ``check_missing`` and ``condition`` must be provided.
+
+    Parameters
+    ----------
+    check_exists: str
+        If set, check this attribute exists.
+    check_missing: str
+        If set, check this attribute does *not* exist.
+    path: str
+        Where to look up the attribute to check.
+        If not specified, determined by context.
+    condition: ConditionLike
+        A general condition to check (or kwargs used to generate one).
+    cast: str
+        If set, a cast to apply prior to running the general check.
+    doc: str
+        Optional descriptive text.
+    """
 
     def __init__(
         self,
@@ -31,11 +55,17 @@ class Rule(JSONLike):
         if isinstance(condition, dict):
             condition = ConditionLike.from_json_like(condition)
 
+        #: If set, this rule checks this attribute exists.
         self.check_exists = check_exists
+        #: If set, this rule checks this attribute does *not* exist.
         self.check_missing = check_missing
+        #: Where to look up the attribute to check (if not determined by context).
         self.path = path
+        #: A general condition for this rule to check.
         self.condition = condition
+        #: If set, a cast to apply prior to running the general check.
         self.cast = cast
+        #: Optional descriptive text.
         self.doc = doc
 
     def __repr__(self):

hpcflow/sdk/core/run_dir_files.py

@@ -1,3 +1,7 @@
+"""
+Model of files in the run directory.
+"""
+
 import re
 from hpcflow.sdk.core.utils import JSONLikeDirSnapShot
 
@@ -8,7 +12,7 @@ class RunDirAppFiles:
 
     _app_attr = "app"
 
-    CMD_FILES_RE_PATTERN = r"js_\d+_act_\d+\.?\w*"
+    _CMD_FILES_RE_PATTERN = r"js_\d+_act_\d+\.?\w*"
 
     @classmethod
     def get_log_file_name(cls):
@@ -22,10 +26,16 @@ class RunDirAppFiles:
 
     @staticmethod
     def get_run_file_prefix(js_idx: int, js_action_idx: int):
+        """
+        Get the common prefix for files associated with a run.
+        """
         return f"js_{js_idx}_act_{js_action_idx}"
 
     @classmethod
     def get_commands_file_name(cls, js_idx: int, js_action_idx: int, shell):
+        """
+        Get the name of the file containing commands.
+        """
         return cls.get_run_file_prefix(js_idx, js_action_idx) + shell.JS_EXT
 
     @classmethod
@@ -56,7 +66,7 @@ class RunDirAppFiles:
             if (
                 k == cls.get_log_file_name()
                 or k == cls.get_std_file_name()
-                or re.match(cls.CMD_FILES_RE_PATTERN, k)
+                or re.match(cls._CMD_FILES_RE_PATTERN, k)
             ):
                 ss_js["data"].pop(k)