feature request: Allow attaching Reports to Reports

[afmireski]

Implemented a way to properly link additional color_eyre::Reports to a Report: report and with_report.

• All existing tests passed
• Documentation for new methods added
• Usage examples provided

closes #198

[afmireski]

Accepted suggestions from cargo fmt and cargo clippy to fix the CI errors related to rustfmt and clippy.

• All existing tests passed

[afmireski]

Regarding the macOS-latest CI failure, I believe updating the pyo3 crate to a more recent version that supports Python 3.13 might resolve the issue.

Since version 22.0, pyo3 seems to be adding support for Python 3.13.
However, I consider upgrading package versions a critical decision that shouldn't be made alone.

My proposal is to update the eyre Cargo.toml as follows:

[dependencies]
...
pyo3 = { version = "0.23.1", optional = true, default-features = false }
...

[dev-dependencies]
...
pyo3 = { version = "0.23.1", default-features = false, features = ["auto-initialize"] }

@yaahc, would this be a valid approach? I'm open to any suggestions or feedback.

[yaahc]

tenatively that sounds fine, the only concern would be whats the MSRV for that version of pyo3 since we'd inherit it

[afmireski]

Looking at the release history of the pyo3 crate, the current version being used (0.20) has a MSRV of 1.56.0. Starting from version 0.22.0, the MSRV was raised to 1.63.0.
Is it okay if I proceed with the change?

• crate.io version history
• Release 0.22.0 Notes

[afmireski]

Bump pyo3 crate version to 0.23.1.

• All existing tests passed

Observations:

• The MSRV for Eyre remains 1.65.0 since pyo3 0.23.1 has an MSRV of 1.63.0.
• test_pyo3.rs was refactored to fix some compiler errors caused by the pyo3 version upgrade.

[afmireski]

Hi, @yaahc I hope you're doing well! When you have some time, could you kindly take a look at my PR? Let me know if anything needs adjustment. Thanks!

[vultix]

If you have any backtrace or spantrace information in this report, it won't be printed. That feels like a motivating use case for this feature

[afmireski]

Hello @vultix , thank you very much for the feedback!

If it's not too much trouble, could you explain in more detail what seems to be wrong?

When running the examples I added, the backtrace information appears to be displayed correctly, very similar to how it is shown when running the error examples:

I would really appreciate any clarification you can provide.

[sclu1034]

The motivation in #198 (by me) was "render [...] including helpful sections like from wrap_err or with_suggestion".

Your screenshot does show one backtrace. It's for the parent error, which is regular behavior, unaffected by this PR.
But there should be three backtraces shown. The two "Report" sections at the bottom, the actual new feature, only show an error message, when they should show all their HelpInfo sections. That's what would set this apart from the existing with_error.

[Rolv-Apneseth]

This would be a really nice feature to have, but I agree that having the backtrace for all reports is quite important. Does the PR need any kind of help to get there @afmireski?

[LeoniePhiline]

The removal of the pyo3 feature in #278 obsoletes some of the above discussion and will slightly simplify this PR.