dv-flow-mgr 0.0.2.14149347362a1__tar.gz → 0.0.2.14150065664a1__tar.gz

{dv_flow_mgr-0.0.2.14149347362a1 → dv_flow_mgr-0.0.2.14150065664a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dv-flow-mgr
-Version: 0.0.2.14149347362a1
+Version: 0.0.2.14150065664a1
 Summary: DV Flow Manager is a build system for silicon design
 Author-email: Matthew Ballance <matt.ballance@gmail.com>
 License:                                  Apache License

{dv_flow_mgr-0.0.2.14149347362a1 → dv_flow_mgr-0.0.2.14150065664a1}/docs/pytask_api.rst

@@ -33,6 +33,16 @@ dependencies.
    :members:
    :exclude-members: model_config
 
+TaskRunCtxt
+===========
+
+The task implementaion is passed a task-run context object that
+provides utilities for the task.
+
+.. autoclass:: dv_flow.mgr.TaskRunCtxt
+   :members:
+   :exclude-members: model_config
+
 
 TaskDataResult
 ==============

{dv_flow_mgr-0.0.2.14149347362a1 → dv_flow_mgr-0.0.2.14150065664a1}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dv-flow-mgr"
-version = "0.0.2.14149347362a1"
+version = "0.0.2.14150065664a1"
 dependencies = [
     'jq',
     'pydantic',

{dv_flow_mgr-0.0.2.14149347362a1 → dv_flow_mgr-0.0.2.14150065664a1}/src/dv_flow/mgr/task_run_ctxt.py

@@ -23,6 +23,19 @@ class TaskRunCtxt(object):
                    logfilter=None,
                    cwd=None,
                    env=None):
+        """
+        Executes a command as part of the task's implementation.
+        Output from the command will be saved to the specified logfile,
+        or to a default logfile if not specified. If the command
+        fails, an error marker will be added.
+
+        Example:
+        
+        .. code-block:: python
+
+            status |= await runner.exec(['ls', '-l'], logfile='ls.log')
+
+        """
         if logfile is None:
             logfile = "cmd_%d.log" % (self._exec_info.__len__() + 1)
 
@@ -45,6 +58,7 @@ class TaskRunCtxt(object):
         return status
 
     def create(self, path, content):
+        """Create a file in the task's rundir"""
         if not os.path.isabs(path):
             path = os.path.join(self.rundir, path)
         
@@ -56,10 +70,12 @@ class TaskRunCtxt(object):
 
 
     def marker(self, msg : str, severity : SeverityE, loc : TaskMarkerLoc=None):
+        """Add a marker related to the task's execution"""
         if loc is not None:
             self._markers.append(TaskMarker(msg=msg, severity=severity, loc=loc))
         else:
             self._markers.append(TaskMarker(msg=msg, severity=severity))
 
     def error(self, msg : str, loc : TaskMarkerLoc=None):
+        """Add an error marker related to the task's execution"""
         self.marker(msg=msg, severity=SeverityE.Error, loc=loc)

{dv_flow_mgr-0.0.2.14149347362a1 → dv_flow_mgr-0.0.2.14150065664a1}/src/dv_flow_mgr.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dv-flow-mgr
-Version: 0.0.2.14149347362a1
+Version: 0.0.2.14150065664a1
 Summary: DV Flow Manager is a build system for silicon design
 Author-email: Matthew Ballance <matt.ballance@gmail.com>
 License:                                  Apache License