adding verbose as an optional argument to Task.result

[djarecka]

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Summary

the additional argument allows to return results values together with input fields that correspond to a specific value.
If True or val - values of input fields is provided, if ind - indices of input fields are provided

Checklist

• All tests passing
• I have added tests to cover my changes
• I have updated documentation (if necessary)
• My code follows the code style of this project
  (we are using black: you can pip install pre-commit,
  run pre-commit install in the pydra directory
  and black will be run automatically with each commit)

Acknowledgment

• I acknowledge that this contribution will be available under the Apache 2 license.

[djarecka]

@nicolocin @satra - I've added an option to print the values or indices of the inputs together with the results. This is only a simple form that just uses state properties.

It also works for workflow if splitter/combiner is set on a workflow level. If it's on the node level, than wf doesn't have any state. This would have to be changed when results is being saved in files, we can think about it at some point, but not in this pr.

[codecov]

Codecov Report

Merging #241 into master will decrease coverage by 2.71%.
The diff coverage is 78.57%.

@@            Coverage Diff             @@
##           master     #241      +/-   ##
==========================================
- Coverage   86.72%   84.00%   -2.72%     
==========================================
  Files          17       17              
  Lines        2870     2889      +19     
  Branches      768      778      +10     
==========================================
- Hits         2489     2427      -62     
- Misses        238      325      +87     
+ Partials      143      137       -6     

Flag	Coverage Δ
#unittests	84.00% <78.57%> (-2.72%)	⬇️

Impacted Files	Coverage Δ
pydra/engine/core.py	89.00% <78.57%> (-0.43%)	⬇️
pydra/engine/workers.py	38.00% <0.00%> (-47.34%)	⬇️
pydra/__init__.py	86.66% <0.00%> (-6.67%)	⬇️
pydra/engine/submitter.py	87.50% <0.00%> (-3.85%)	⬇️
pydra/engine/helpers.py	88.63% <0.00%> (-0.46%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5c5991d...52dd86e. Read the comment docs.

[nicolocin]

@djarecka - This is great thanks a lot! Though would something more descriptive like return_inputs be better? verbose just sounds kind of vague.

Maybe add an example in one of the more complicated workflows in the intro_workflow tutorial so documentation is updated?

[djarecka]

@nicolocin - ok, can change the name

regarding notebooks - you are right, the notebooks should be updated, but this is not the only thing that should be updated, I would do it in a separate PR, will work on this this week