A highly opinionated flake8 plugin for Trio-related problems.
Project description
flake8-trio
A highly opinionated flake8 plugin for Trio-related problems.
This can include anything from outright bugs, to pointless/dead code, to likely performance issues, to minor points of idiom that might signal a misunderstanding.
It may well be too noisy for anyone with different opinions, that's OK.
Pairs well with flake8-async and flake8-bugbear.
Installation
pip install flake8-trio
List of warnings
- TRIO100: a
with trio.fail_after(...):orwith trio.move_on_after(...):context does not contain anyawaitstatements. This makes it pointless, as the timeout can only be triggered by a checkpoint. - TRIO101:
yieldinside a nursery or cancel scope is only safe when implementing a context manager - otherwise, it breaks exception handling. - TRIO102: it's unsafe to await inside
finally:orexcept BaseException/trio.Cancelledunless you use a shielded cancel scope with a timeout. - TRIO103:
except BaseExceptionandexcept trio.Cancelledwith a code path that doesn't re-raise. Note that anyraisestatements in loops are ignored since it's tricky to parse loop flow withbreak,continueand/or the zero-iteration case. - TRIO104:
CancelledandBaseExceptionmust be re-raised - when a user tries toreturnorraisea different exception. - TRIO105: Calling a trio async function without immediately
awaiting it. - TRIO106: trio must be imported with
import triofor the linter to work. - TRIO107: exit or
returnfrom async function with no guaranteed checkpoint or exception since function definition. - TRIO108: exit, yield or return from async iterable with no guaranteed checkpoint since possible function entry (yield or function definition)
Checkpoints are
await,async for, andasync with(on one of enter/exit). - TRIO109: Async function definition with a
timeoutparameter - usetrio.[fail/move_on]_[after/at]instead - TRIO110:
while <condition>: await trio.sleep()should be replaced by atrio.Event.
Changelog
22.8.3
- TRIO108 now gives multiple error messages; one for each path lacking a guaranteed checkpoint
22.8.2
- Merged TRIO108 into TRIO107
- TRIO108 now handles checkpointing in async iterators
22.8.1
- Added TRIO109: Async definitions should not have a
timeoutparameter. Usetrio.[fail/move_on]_[at/after] - Added TRIO110:
while <condition>: await trio.sleep()should be replaced by atrio.Event.
22.7.6
- Extend TRIO102 to also check inside
except BaseExceptionandexcept trio.Cancelled - Extend TRIO104 to also check for
yield - Update error messages on TRIO102 and TRIO103
22.7.5
- Add TRIO103:
except BaseExceptionorexcept trio.Cancelledwith a code path that doesn't re-raise - Add TRIO104: "Cancelled and BaseException must be re-raised" if user tries to return or raise a different exception.
- Added TRIO107: Async functions must have at least one checkpoint on every code path, unless an exception is raised
- Added TRIO108: Early return from async function must have at least one checkpoint on every code path before it.
22.7.4
- Added TRIO105 check for not immediately
awaiting async trio functions. - Added TRIO106 check that trio is imported in a form that the plugin can easily parse.
22.7.3
- Added TRIO102 check for unsafe checkpoints inside
finally:blocks
22.7.2
- Avoid
TRIO100false-alarms on cancel scopes containingasync fororasync with.
22.7.1
- Initial release with TRIO100 and TRIO101
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
flake8-trio-22.8.3.tar.gz
(22.9 kB
view hashes)
Built Distribution
Close
Hashes for flake8_trio-22.8.3-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9043c670afaf0bebfd2d08a83c0add8af9e518e10bf2262707ebef085e229559 |
|
| MD5 | 52b25c05f78745e8ca6c948a268b6325 |
|
| BLAKE2b-256 | d988a0849e6d36071483173dfa37d15e88ab3b6c62e5cd5717cc07703da9264b |
