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: Async functions must have at least one checkpoint on every code path, unless an exception is raised.
- TRIO108: Early return from async function must have at least one checkpoint on every code path before it, unless an exception is raised.
Checkpoints are
await,async withasync for.
Changelog
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.7.6.tar.gz
(17.1 kB
view details)
Built Distribution
File details
Details for the file flake8-trio-22.7.6.tar.gz.
File metadata
- Download URL: flake8-trio-22.7.6.tar.gz
- Upload date:
- Size: 17.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ba755a39b4fb7bf583d15e61fc9588e0d4e4f3c2a771ef243fc33fc5737a061e |
|
| MD5 | a6e98bf0cd7a81a239d0be90492634db |
|
| BLAKE2b-256 | b42dcd734710417981ec456c606820d5ba757919e27b35a6d2262046465196ec |
Provenance
File details
Details for the file flake8_trio-22.7.6-py3-none-any.whl.
File metadata
- Download URL: flake8_trio-22.7.6-py3-none-any.whl
- Upload date:
- Size: 8.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2daf9f15fe1d775a46bd2236d73d50d69875f3e866bf1683ee481e9e0f5733b7 |
|
| MD5 | 2ba0226baeaf2ae63ef3a19d6ed81a15 |
|
| BLAKE2b-256 | a6932726a3ad19e9278ef6c8df6c932bd0cc39afc4ae3755a934b4b00d8ec75f |
