Skip to content

Update third-party library removal policy #14636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update third-party library removal policy #14636

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79ce641
Update description of third-party library removal policy
donBarbos Aug 24, 2025
aed0599
use bold for stubsabot
donBarbos Aug 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 9 additions & 13 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,28 +436,24 @@ following criteria is met:
* the upstream package was declared or appears to be unmaintained, and
retaining the stubs causes maintenance issues in typeshed.

If a package ships its own `py.typed` file, please follow these steps:
Case 1: If a package ships its own `py.typed` file, please follow these steps:

1. Open an issue with the earliest month of removal in the subject.
2. A maintainer will add the
["stubs: removal" label](https://github.com/python/typeshed/labels/%22stubs%3A%20removal%22).
3. Open a PR that sets the `obsolete_since` field in the `METADATA.toml`
file to the first version of the package that shipped `py.typed`.
4. After at least six months, open a PR to remove the stubs.
1. Make sure **stubsabot** open a PR that sets the `obsolete_since` field in the
`METADATA.toml` file to the first version of the package that shipped `py.typed`.
2. After at least six months, make sure **stubsabot** open a PR to remove the stubs.

If third-party stubs should be removed for other reasons, please follow these
steps:
Case 2: If third-party stubs should be removed for other reasons, please follow
these steps:

1. Open an issue explaining why the stubs should be removed.
2. A maintainer will add the
["stubs: removal" label](https://github.com/python/typeshed/labels/%22stubs%3A%20removal%22).
3. Open a PR that sets the `no_longer_updated` field in the `METADATA.toml`
file to `true`.
4. When a new version of the package was automatically uploaded to PyPI
(which can take up to a day), open a PR to remove the stubs.
4. When a new version of the package was automatically uploaded to PyPI (which
can take up to a day), make sure **stubsabot** open a PR to remove the stubs.

Don't forget to make sure the library is not in the [`pyrightconfig.stricter.json`](./pyrightconfig.stricter.json)
exclusion list. If feeling kindly, please update [mypy](https://github.com/python/mypy/blob/master/mypy/stubinfo.py)
If feeling kindly, please update [mypy](https://github.com/python/mypy/blob/master/mypy/stubinfo.py)
for any stub obsoletions or removals.

### Marking PRs as "deferred"
Expand Down