python-trio / python-trio/flake8-async

warn when the type hint of an async generator is not AsyncGenerator

Open
#233 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

postponed
Dominant language
Python
Stars
26
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Typing an async generator as AsyncIterator or AsyncIterable prevents wrapping it with contextlib.aclosing

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no file or test. Start by locating the async-generator type-hint check in flake8-async, then verify how AsyncIterator and AsyncIterable annotations are handled when contextlib.aclosing is relevant. Done means the requested warning is emitted consistently and the behavior is covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.