python / python/typeshed

Upstreaming stubs for `aiofiles`

Open
#14,669 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

stubs: removal
Dominant language
Python
Stars
5.1k
Forks
2.1k
Avg merge
1d 19h
Merged PRs (30d)
82

Description

Typeshed currently hosts stubs for aiofiles: https://github.com/python/typeshed/tree/main/stubs/aiofiles

I asked aiofiles if they'd be happy to inline the stubs, and it looks like they would: https://github.com/Tinche/aiofiles/issues/49#issuecomment-3209499246

I've given this a go here: https://github.com/Tinche/aiofiles/pull/222

Please feel free to leave comments or suggestions in the PR! (I've basically just vendored the stubs from typeshed, and add some basic CI scripting to get everything to run)

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

Start with the existing stubs under typeshed's stubs/aiofiles directory and review the referenced aiofiles pull request, #222. Check the basic CI scripting described there and the discussion in aiofiles issue #49. Done means the stubs and CI changes have been reviewed and the upstreaming work is resolved in the aiofiles project.

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
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.