[thrashxr]

I have made things!

Two async examples in the README fail when copied and run.

The Future example returns an IO container, not a plain value:

>>> assert anyio.run(second().awaitable) == 2
AssertionError
>>> anyio.run(second().awaitable)
<IO: 2>

The FutureResult example passes the function instead of calling it:

>>> anyio.run(raising.awaitable)
AttributeError: 'function' object has no attribute 'awaitable'

With the call fixed, the comparison is still False, because two separate ValueError instances are not equal:

>>> anyio.run(raising().awaitable) == IOFailure(ValueError('Not so fast!'))
False

This compares against IO(2) in the first example, and in the second one calls raising() and checks the result type and its string form, the same way docs/pages/future.rst does.

Checklist

• I have double checked that there are no unrelated changes in this pull request (old patches, accidental config files, etc)
• I have created at least one test case for the changes I have made
• I have updated the documentation for the changes I have made
• I have added my changes to the CHANGELOG.md

Docs-only change (README examples), so no new tests or CHANGELOG entry. I ran the fixed examples locally and the existing test suite passes.

Related issues

Refs #1618

[sobolevn]

Thanks!

[codspeed]

Merging this PR will not alter performance

1 note

ℹ️ 2 benchmarks have no flamegraph

The flamegraph wasn't generated: the symbols of the profiling trace could not be resolved, because no information about the language frames was collected.

See affected benchmarks

✅ 22 untouched benchmarks

---

_{Comparing thrashxr:fix-readme-async-examples (ded0425) with master (808c168)}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (82ef3ef) to head (ded0425).
⚠️ Report is 645 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##            master     #2553    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           80        82     +2     
  Lines         2485      2692   +207     
  Branches       437        44   -393     
==========================================
+ Hits          2485      2692   +207     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.