dv-flow-mgr 0.0.2.14149347362a1__py3-none-any.whl → 0.0.2.14150065664a1__py3-none-any.whl

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.dist-info → dv_flow_mgr-0.0.2.14150065664a1.dist-info}/METADATA

@@ -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.dist-info → dv_flow_mgr-0.0.2.14150065664a1.dist-info}/RECORD

@@ -31,7 +31,7 @@ dv_flow/mgr/task_node_ctor_wrapper.py,sha256=Nb1CVcPHZofnb-iLWDHQWAxlTOdbRrnR9Dd
 dv_flow/mgr/task_node_leaf.py,sha256=IXPYnjDJvfXEKWfmiyIMdS9DKcUU-PxGNPwyJBiOXyw,7584
 dv_flow/mgr/task_output.py,sha256=ZwyvwnYj_gHOEFAEOH3m24Xfc4Cn77hb1j7LkX8_3C4,1086
 dv_flow/mgr/task_params_ctor.py,sha256=BPkbnoCtzhCxc1g8CJ6VimCcm5UAu92PXeDMhQ4lYsQ,1957
-dv_flow/mgr/task_run_ctxt.py,sha256=aMc9Gs-jmy3JYo4uVL5EM8qESnPOb4PvNzJ2mMffaxs,2046
+dv_flow/mgr/task_run_ctxt.py,sha256=t2kGR-GbUC3s5YTYLxYmP43LRUvGKjqdGK5clRpAkzw,2624
 dv_flow/mgr/task_runner.py,sha256=-919VntXAe2XSuFW2dFpgvUre-NkILBnDBbAKBZYn5w,9594
 dv_flow/mgr/type.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dv_flow/mgr/type_def.py,sha256=NDeyplKrPnWwEv4yHkhXEMK9d9j39b5MOeLB-1Mchqo,1095
@@ -50,9 +50,9 @@ dv_flow/mgr/util/__main__.py,sha256=F0LXpCDpYTPalSo0dc1h_qZkip5v1AZYYh-vcYbh5s0,
 dv_flow/mgr/util/util.py,sha256=yg9oTPRiO87mkCSOQpOtlG9vyKPQzY3qp4OJkEMbWyY,1443
 dv_flow/mgr/util/cmds/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dv_flow/mgr/util/cmds/cmd_schema.py,sha256=lrEI-Jwb8j4I4yYOn9hq7_7NYbK8leVxLesrHyEWm-E,1879
-dv_flow_mgr-0.0.2.14149347362a1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dv_flow_mgr-0.0.2.14149347362a1.dist-info/METADATA,sha256=Mg43r4Ns0KbrU9KatpLHgLPC1oYpX12Pf9rG0jjSQ-o,13336
-dv_flow_mgr-0.0.2.14149347362a1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-dv_flow_mgr-0.0.2.14149347362a1.dist-info/entry_points.txt,sha256=1roy8wAFM48LabOvr6jiOw0MUs-qE8X3Vf8YykPazxk,50
-dv_flow_mgr-0.0.2.14149347362a1.dist-info/top_level.txt,sha256=amfVTkggzYPtWwLqNmRukfz1Buu0pGS2SrYBBLhXm04,8
-dv_flow_mgr-0.0.2.14149347362a1.dist-info/RECORD,,
+dv_flow_mgr-0.0.2.14150065664a1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dv_flow_mgr-0.0.2.14150065664a1.dist-info/METADATA,sha256=9jJBGIp_ylYV8SgeRvZh0P1EcYH4cQHSLaHEF2Mr_QA,13336
+dv_flow_mgr-0.0.2.14150065664a1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+dv_flow_mgr-0.0.2.14150065664a1.dist-info/entry_points.txt,sha256=1roy8wAFM48LabOvr6jiOw0MUs-qE8X3Vf8YykPazxk,50
+dv_flow_mgr-0.0.2.14150065664a1.dist-info/top_level.txt,sha256=amfVTkggzYPtWwLqNmRukfz1Buu0pGS2SrYBBLhXm04,8
+dv_flow_mgr-0.0.2.14150065664a1.dist-info/RECORD,,