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

{dv_flow_mgr-0.0.2.14149088756a1 → 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.14149088756a1
+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.14149088756a1 → 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.14149088756a1 → 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.14149088756a1"
+version = "0.0.2.14150065664a1"
 dependencies = [
     'jq',
     'pydantic',

{dv_flow_mgr-0.0.2.14149088756a1 → dv_flow_mgr-0.0.2.14150065664a1}/src/dv_flow/mgr/__init__.py

@@ -24,6 +24,7 @@ from .pkg_rgy import PkgRgy
 from .task_data import *
 from .task_def import *
 from .task_graph_builder import TaskGraphBuilder
+from .task_run_ctxt import TaskRunCtxt
 from .task_runner import TaskRunner
 from .task_node_ctor_wrapper import task
 from .task_runner import TaskSetRunner

{dv_flow_mgr-0.0.2.14149088756a1 → dv_flow_mgr-0.0.2.14150065664a1}/src/dv_flow/mgr/task_node.py

@@ -111,7 +111,7 @@ class TaskNode(object):
             "rundir": rundir,
             "input": input.model_dump(warnings=False),
             "needs": [need[0].name for need in self.needs],
-            "commands": [cmd.dump_model() for cmd in ctxt._exec_info],
+            "commands": [cmd.model_dump() for cmd in ctxt._exec_info],
             "result": {
                 "status": self.result.status,
                 "changed": self.result.changed,

{dv_flow_mgr-0.0.2.14149088756a1 → dv_flow_mgr-0.0.2.14150065664a1}/src/dv_flow/mgr/task_node_leaf.py

@@ -116,10 +116,10 @@ class TaskNodeLeaf(TaskNode):
             inputs=inputs,
             memento=memento)
         
-        ctxt = TaskRunCtxt(runner=self, rundir=input.rundir)
+        ctxt = TaskRunCtxt(runner=runner, rundir=input.rundir)
 
         self._log.debug("--> Call task method %s" % str(self.task))
-        self.result : TaskDataResult = await self.task(self, input)
+        self.result : TaskDataResult = await self.task(ctxt, input)
         self._log.debug("<-- Call task method %s" % str(self.task))
 
         self.result.markers.extend(ctxt._markers)

{dv_flow_mgr-0.0.2.14149088756a1 → 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)
 
@@ -40,13 +53,29 @@ class TaskRunCtxt(object):
         self._exec_info.append(ExecInfo(cmd=cmd, status=status))
 
         if status != 0:
-            self.error_marker("Command failed: %s" % " ".join(cmd))
+            self.error("Command failed: %s" % " ".join(cmd))
+
+        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)
+        
+        if not os.path.isdir(os.path.dirname(path)):
+            os.makedirs(os.path.dirname(path))
+
+        with open(path, "w") as fp:
+            fp.write(content)
+
 
     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.14149088756a1 → 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.14149088756a1
+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