Adding instance ID to repr strings, improving readability of WorkflowStep's repr string, and adding docstrings.

Also adding docstring to parallel_steps() because pydocstyle yelled about it. At first it also yelled about object_from_state() and now it doesn't, so... I guess we'll see what the CI run says because I'm not familiar enough with this function to write a docstring for it.

Author: AlexTate

cwltool/workflow.py

@@ -455,4 +455,11 @@ def visit(self, op: Callable[[CommentedMap], None]) -> None:
         self.embedded_tool.visit(op)
 
     def __repr__(self) -> str:
-        return f"<{self.__class__.__name__} [{os.path.basename(self.id)}]>"
+        """Return a non-expression string representation of the object instance."""
+        if "#" in self.id:
+            wf_file, step_id = self.id.rsplit("#", 1)
+            step_name = "#".join([os.path.basename(wf_file), step_id])
+        else:
+            step_name = self.id
+
+        return f"<{self.__class__.__name__} [{step_name}] at {hex(id(self))}>"

cwltool/workflow_job.py

@@ -67,7 +67,8 @@ def job(
         yield from self.step.job(joborder, output_callback, runtimeContext)
 
     def __repr__(self) -> str:
-        return f"<{self.__class__.__name__} [{self.name}]>"
+        """Return a non-expression string representation of the object instance."""
+        return f"<{self.__class__.__name__} [{self.name}] at {hex(id(self))}>"
 
 
 class ReceiveScatterOutput:
@@ -137,6 +138,7 @@ def parallel_steps(
     rc: ReceiveScatterOutput,
     runtimeContext: RuntimeContext,
 ) -> JobsGeneratorType:
+    """Yield scatter jobs (or None if there's no work to do) until all scatter jobs complete."""
     while rc.completed < rc.total:
         made_progress = False
         for index, step in enumerate(steps):
@@ -859,7 +861,8 @@ def job(
             # or all outputs have been produced.
 
     def __repr__(self) -> str:
-        return f"<{self.__class__.__name__} [{self.name}]>"
+        """Return a non-expression string representation of the object instance."""
+        return f"<{self.__class__.__name__} [{self.name}] at {hex(id(self))}>"
 
 
 class WorkflowJobLoopStep: