Implements trace for failures

[thepabloaguilar]

All context can be found on #409 issue!

Just a little explanation about _get_trace function:

def _get_trace(_self) -> List[FrameInfo]:
    current_stack = stack()
    return current_stack[2:]

The return is the current call stack starting from the third position, to avoid two non useful calls on the call stack and you can see in the example below what calls they're:

Complete call stack

/home/pabloaguilar/Projects/returns/returns/tracing.py:41 in `_get_trace`
/home/pabloaguilar/Projects/returns/returns/result.py:376 in `__init__`
/home/pabloaguilar/Projects/returns/returns/result.py:521 in `Failure`
/home/pabloaguilar/Projects/returns/example.py:33 in `my_func_one`
/home/pabloaguilar/Projects/returns/example.py:67 in `<module>`

call stack starting from third position

/home/pabloaguilar/Projects/returns/returns/result.py:521 in `Failure`
/home/pabloaguilar/Projects/returns/example.py:33 in `my_func_one`
/home/pabloaguilar/Projects/returns/example.py:67 in `<module>`

closes #409

[codecov]

Codecov Report

Merging #422 into master will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master      #422   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           47        48    +1     
  Lines         1192      1221   +29     
  Branches       154       154           
=========================================
+ Hits          1192      1221   +29     

Impacted Files	Coverage Δ
returns/io.py	100.00% <100.00%> (ø)
returns/primitives/tracing.py	100.00% <100.00%> (ø)
returns/result.py	100.00% <100.00%> (ø)

---

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 cf1018f...91cecbe. Read the comment docs.

[thepabloaguilar]

Should I have add something to CHANGELOG.md?

[sobolevn]

Thanks a lot! Some polishing is required and we are ready to go!

[sobolevn]

Awesome!

I also got an idea that we should add an opportunity to test traces with out pytest plugins.
This should help people to predict which paths the code will take.

But, I am not sure about an API. Do you have any ideas?

[thepabloaguilar]

Awesome!

I also got an idea that we should add an opportunity to test traces with out pytest plugins.
This should help people to predict which paths the code will take.

But, I am not sure about an API. Do you have any ideas?

I didn't understand your idea, sorry!
Could you provide an example or more details?

[sobolevn]

I didn't understand your idea, sorry!
Could you provide an example or more details?

I will create a new issue for it.

[sobolevn]

Looks like almost done!

I am pretty sure that this is the last round of review and we are going to merge this soon.
You have my gratitude, thanks a lot! 🥇

[thepabloaguilar]

Looks like almost done!

I am pretty sure that this is the last round of review and we are going to merge this soon.
You have my gratitude, thanks a lot!

Thanks man, it's a pleasure to contribute to returns!

[sobolevn]

Thanks again!

P.S. Can you please take a look at #258? I am researching possible design ideas right now. I would love to hear your thoughts.

[thepabloaguilar]

P.S. Can you please take a look at #258? I am researching possible design ideas right now. I would love to hear your thoughts.

Yes, I'll take a look asap!